1 //! This module defines an accumulator for completions which are going to be presented to user.
3 pub(crate) mod attribute;
5 pub(crate) mod flyimport;
6 pub(crate) mod fn_param;
7 pub(crate) mod keyword;
8 pub(crate) mod lifetime;
9 pub(crate) mod macro_in_item_position;
11 pub(crate) mod pattern;
12 pub(crate) mod postfix;
13 pub(crate) mod qualified_path;
14 pub(crate) mod record;
15 pub(crate) mod snippet;
16 pub(crate) mod trait_impl;
17 pub(crate) mod unqualified_path;
21 use hir::{known, ModPath, ScopeDef, Type};
22 use ide_db::SymbolKind;
25 item::{Builder, CompletionKind},
28 enum_variant::render_variant,
29 function::{render_fn, render_method},
31 pattern::{render_struct_pat, render_variant_pat},
32 render_field, render_resolution, render_tuple_field,
33 type_alias::render_type_alias,
36 CompletionContext, CompletionItem, CompletionItemKind,
39 /// Represents an in-progress set of completions being built.
40 #[derive(Debug, Default)]
41 pub struct Completions {
42 buf: Vec<CompletionItem>,
45 impl Into<Vec<CompletionItem>> for Completions {
46 fn into(self) -> Vec<CompletionItem> {
52 /// Convenience method, which allows to add a freshly created completion into accumulator
53 /// without binding it to the variable.
54 pub(crate) fn add_to(self, acc: &mut Completions) {
60 pub(crate) fn add(&mut self, item: CompletionItem) {
64 pub(crate) fn add_all<I>(&mut self, items: I)
67 I::Item: Into<CompletionItem>,
69 items.into_iter().for_each(|item| self.add(item.into()))
72 pub(crate) fn add_field(&mut self, ctx: &CompletionContext, field: hir::Field, ty: &Type) {
73 let item = render_field(RenderContext::new(ctx), field, ty);
77 pub(crate) fn add_tuple_field(&mut self, ctx: &CompletionContext, field: usize, ty: &Type) {
78 let item = render_tuple_field(RenderContext::new(ctx), field, ty);
82 pub(crate) fn add_static_lifetime(&mut self, ctx: &CompletionContext) {
84 CompletionItem::new(CompletionKind::Reference, ctx.source_range(), "'static");
85 item.kind(CompletionItemKind::SymbolKind(SymbolKind::LifetimeParam));
86 self.add(item.build());
89 pub(crate) fn add_resolution(
91 ctx: &CompletionContext,
93 resolution: &ScopeDef,
95 if let Some(item) = render_resolution(RenderContext::new(ctx), local_name, resolution) {
100 pub(crate) fn add_macro(
102 ctx: &CompletionContext,
103 name: Option<String>,
104 macro_: hir::MacroDef,
106 let name = match name {
110 if let Some(item) = render_macro(RenderContext::new(ctx), None, name, macro_) {
115 pub(crate) fn add_function(
117 ctx: &CompletionContext,
119 local_name: Option<String>,
121 if let Some(item) = render_fn(RenderContext::new(ctx), None, local_name, func) {
126 pub(crate) fn add_method(
128 ctx: &CompletionContext,
130 local_name: Option<String>,
132 if let Some(item) = render_method(RenderContext::new(ctx), None, local_name, func) {
137 pub(crate) fn add_variant_pat(
139 ctx: &CompletionContext,
140 variant: hir::Variant,
141 local_name: Option<hir::Name>,
143 if let Some(item) = render_variant_pat(RenderContext::new(ctx), variant, local_name, None) {
148 pub(crate) fn add_qualified_variant_pat(
150 ctx: &CompletionContext,
151 variant: hir::Variant,
154 if let Some(item) = render_variant_pat(RenderContext::new(ctx), variant, None, Some(path)) {
159 pub(crate) fn add_struct_pat(
161 ctx: &CompletionContext,
163 local_name: Option<hir::Name>,
165 if let Some(item) = render_struct_pat(RenderContext::new(ctx), strukt, local_name) {
170 pub(crate) fn add_const(&mut self, ctx: &CompletionContext, constant: hir::Const) {
171 if let Some(item) = render_const(RenderContext::new(ctx), constant) {
176 pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) {
177 if let Some(item) = render_type_alias(RenderContext::new(ctx), type_alias) {
182 pub(crate) fn add_qualified_enum_variant(
184 ctx: &CompletionContext,
185 variant: hir::Variant,
188 let item = render_variant(RenderContext::new(ctx), None, None, variant, Some(path));
192 pub(crate) fn add_enum_variant(
194 ctx: &CompletionContext,
195 variant: hir::Variant,
196 local_name: Option<String>,
198 let item = render_variant(RenderContext::new(ctx), None, local_name, variant, None);
203 fn complete_enum_variants(
204 acc: &mut Completions,
205 ctx: &CompletionContext,
206 enum_data: hir::Enum,
207 cb: impl Fn(&mut Completions, &CompletionContext, hir::Variant, hir::ModPath),
209 let variants = enum_data.variants(ctx.db);
211 let module = if let Some(module) = ctx.scope.module() {
212 // Compute path from the completion site if available.
215 // Otherwise fall back to the enum's definition site.
216 enum_data.module(ctx.db)
219 if let Some(impl_) = ctx.impl_def.as_ref().and_then(|impl_| ctx.sema.to_def(impl_)) {
220 if impl_.self_ty(ctx.db).as_adt() == Some(hir::Adt::Enum(enum_data)) {
221 for &variant in &variants {
222 let self_path = hir::ModPath::from_segments(
223 hir::PathKind::Plain,
224 iter::once(known::SELF_TYPE).chain(iter::once(variant.name(ctx.db))),
226 cb(acc, ctx, variant, self_path);
231 for variant in variants {
232 if let Some(path) = module.find_use_path(ctx.db, hir::ModuleDef::from(variant)) {
233 // Variants with trivial paths are already added by the existing completion logic,
234 // so we should avoid adding these twice
235 if path.segments().len() > 1 {
236 cb(acc, ctx, variant, path);