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;
10 pub(crate) mod pattern;
11 pub(crate) mod postfix;
12 pub(crate) mod qualified_path;
13 pub(crate) mod record;
14 pub(crate) mod snippet;
15 pub(crate) mod trait_impl;
16 pub(crate) mod unqualified_path;
21 use ide_db::SymbolKind;
27 enum_variant::render_variant,
28 function::{render_fn, render_method},
30 pattern::{render_struct_pat, render_variant_pat},
31 render_field, render_resolution, render_tuple_field,
32 struct_literal::render_struct_literal,
33 type_alias::{render_type_alias, render_type_alias_with_eq},
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 From<Completions> for Vec<CompletionItem> {
46 fn from(val: Completions) -> Self {
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 fn add(&mut self, item: CompletionItem) {
64 fn add_opt(&mut self, item: Option<CompletionItem>) {
65 if let Some(item) = item {
70 pub(crate) fn add_all<I>(&mut self, items: I)
73 I::Item: Into<CompletionItem>,
75 items.into_iter().for_each(|item| self.add(item.into()))
78 pub(crate) fn add_keyword(&mut self, ctx: &CompletionContext, keyword: &'static str) {
79 let item = CompletionItem::new(CompletionItemKind::Keyword, ctx.source_range(), keyword);
83 pub(crate) fn add_resolution(
85 ctx: &CompletionContext,
86 local_name: hir::Name,
87 resolution: hir::ScopeDef,
89 if ctx.is_scope_def_hidden(resolution) {
90 cov_mark::hit!(qualified_path_doc_hidden);
93 self.add_opt(render_resolution(RenderContext::new(ctx), local_name, resolution));
96 pub(crate) fn add_macro(
98 ctx: &CompletionContext,
99 name: Option<hir::Name>,
100 macro_: hir::MacroDef,
102 let name = match name {
106 self.add_opt(render_macro(RenderContext::new(ctx), None, name, macro_));
109 pub(crate) fn add_function(
111 ctx: &CompletionContext,
113 local_name: Option<hir::Name>,
115 if !ctx.is_visible(&func) {
118 self.add(render_fn(RenderContext::new(ctx), None, local_name, func));
121 pub(crate) fn add_method(
123 ctx: &CompletionContext,
125 receiver: Option<hir::Name>,
126 local_name: Option<hir::Name>,
128 if !ctx.is_visible(&func) {
131 self.add(render_method(RenderContext::new(ctx), None, receiver, local_name, func));
134 pub(crate) fn add_const(&mut self, ctx: &CompletionContext, konst: hir::Const) {
135 if !ctx.is_visible(&konst) {
138 self.add_opt(render_const(RenderContext::new(ctx), konst));
141 pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) {
142 if !ctx.is_visible(&type_alias) {
145 self.add_opt(render_type_alias(RenderContext::new(ctx), type_alias));
148 pub(crate) fn add_type_alias_with_eq(
150 ctx: &CompletionContext,
151 type_alias: hir::TypeAlias,
153 self.add_opt(render_type_alias_with_eq(RenderContext::new(ctx), type_alias));
156 pub(crate) fn add_qualified_enum_variant(
158 ctx: &CompletionContext,
159 variant: hir::Variant,
162 let item = render_variant(RenderContext::new(ctx), None, None, variant, Some(path));
166 pub(crate) fn add_enum_variant(
168 ctx: &CompletionContext,
169 variant: hir::Variant,
170 local_name: Option<hir::Name>,
172 let item = render_variant(RenderContext::new(ctx), None, local_name, variant, None);
176 pub(crate) fn add_field(
178 ctx: &CompletionContext,
179 receiver: Option<hir::Name>,
183 if !ctx.is_visible(&field) {
186 let item = render_field(RenderContext::new(ctx), receiver, field, ty);
190 pub(crate) fn add_struct_literal(
192 ctx: &CompletionContext,
194 path: Option<hir::ModPath>,
195 local_name: Option<hir::Name>,
197 let item = render_struct_literal(RenderContext::new(ctx), strukt, path, local_name);
201 pub(crate) fn add_tuple_field(
203 ctx: &CompletionContext,
204 receiver: Option<hir::Name>,
208 let item = render_tuple_field(RenderContext::new(ctx), receiver, field, ty);
212 pub(crate) fn add_static_lifetime(&mut self, ctx: &CompletionContext) {
213 let item = CompletionItem::new(SymbolKind::LifetimeParam, ctx.source_range(), "'static");
214 self.add(item.build());
217 pub(crate) fn add_variant_pat(
219 ctx: &CompletionContext,
220 variant: hir::Variant,
221 local_name: Option<hir::Name>,
223 self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, local_name, None));
226 pub(crate) fn add_qualified_variant_pat(
228 ctx: &CompletionContext,
229 variant: hir::Variant,
232 self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, None, Some(path)));
235 pub(crate) fn add_struct_pat(
237 ctx: &CompletionContext,
239 local_name: Option<hir::Name>,
241 self.add_opt(render_struct_pat(RenderContext::new(ctx), strukt, local_name));
245 /// Calls the callback for each variant of the provided enum with the path to the variant.
246 /// Skips variants that are visible with single segment paths.
247 fn enum_variants_with_paths(
248 acc: &mut Completions,
249 ctx: &CompletionContext,
251 cb: impl Fn(&mut Completions, &CompletionContext, hir::Variant, hir::ModPath),
253 let variants = enum_.variants(ctx.db);
255 let module = if let Some(module) = ctx.scope.module() {
256 // Compute path from the completion site if available.
259 // Otherwise fall back to the enum's definition site.
263 if let Some(impl_) = ctx.impl_def.as_ref().and_then(|impl_| ctx.sema.to_def(impl_)) {
264 if impl_.self_ty(ctx.db).as_adt() == Some(hir::Adt::Enum(enum_)) {
265 for &variant in &variants {
266 let self_path = hir::ModPath::from_segments(
267 hir::PathKind::Plain,
268 iter::once(known::SELF_TYPE).chain(iter::once(variant.name(ctx.db))),
270 cb(acc, ctx, variant, self_path);
275 for variant in variants {
276 if let Some(path) = module.find_use_path(ctx.db, hir::ModuleDef::from(variant)) {
277 // Variants with trivial paths are already added by the existing completion logic,
278 // so we should avoid adding these twice
279 if path.segments().len() > 1 {
280 cb(acc, ctx, variant, path);