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;
24 item::{Builder, CompletionKind},
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 mut item = CompletionItem::new(CompletionKind::Keyword, ctx.source_range(), keyword);
80 item.kind(CompletionItemKind::Keyword);
84 pub(crate) fn add_resolution(
86 ctx: &CompletionContext,
87 local_name: hir::Name,
88 resolution: &hir::ScopeDef,
90 self.add_opt(render_resolution(RenderContext::new(ctx), local_name, resolution));
93 pub(crate) fn add_macro(
95 ctx: &CompletionContext,
96 name: Option<hir::Name>,
97 macro_: hir::MacroDef,
99 let name = match name {
103 self.add_opt(render_macro(RenderContext::new(ctx), None, name, macro_));
106 pub(crate) fn add_function(
108 ctx: &CompletionContext,
110 local_name: Option<hir::Name>,
112 self.add_opt(render_fn(RenderContext::new(ctx), None, local_name, func));
115 pub(crate) fn add_method(
117 ctx: &CompletionContext,
119 receiver: Option<hir::Name>,
120 local_name: Option<hir::Name>,
122 self.add_opt(render_method(RenderContext::new(ctx), None, receiver, local_name, func));
125 pub(crate) fn add_const(&mut self, ctx: &CompletionContext, constant: hir::Const) {
126 self.add_opt(render_const(RenderContext::new(ctx), constant));
129 pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) {
130 self.add_opt(render_type_alias(RenderContext::new(ctx), type_alias));
133 pub(crate) fn add_type_alias_with_eq(
135 ctx: &CompletionContext,
136 type_alias: hir::TypeAlias,
138 self.add_opt(render_type_alias_with_eq(RenderContext::new(ctx), type_alias));
141 pub(crate) fn add_qualified_enum_variant(
143 ctx: &CompletionContext,
144 variant: hir::Variant,
147 let item = render_variant(RenderContext::new(ctx), None, None, variant, Some(path));
151 pub(crate) fn add_enum_variant(
153 ctx: &CompletionContext,
154 variant: hir::Variant,
155 local_name: Option<hir::Name>,
157 let item = render_variant(RenderContext::new(ctx), None, local_name, variant, None);
161 pub(crate) fn add_field(
163 ctx: &CompletionContext,
164 receiver: Option<hir::Name>,
168 let item = render_field(RenderContext::new(ctx), receiver, field, ty);
172 pub(crate) fn add_struct_literal(
174 ctx: &CompletionContext,
176 local_name: Option<hir::Name>,
178 let item = render_struct_literal(RenderContext::new(ctx), strukt, local_name);
182 pub(crate) fn add_tuple_field(
184 ctx: &CompletionContext,
185 receiver: Option<hir::Name>,
189 let item = render_tuple_field(RenderContext::new(ctx), receiver, field, ty);
193 pub(crate) fn add_static_lifetime(&mut self, ctx: &CompletionContext) {
195 CompletionItem::new(CompletionKind::Reference, ctx.source_range(), "'static");
196 item.kind(CompletionItemKind::SymbolKind(SymbolKind::LifetimeParam));
197 self.add(item.build());
200 pub(crate) fn add_variant_pat(
202 ctx: &CompletionContext,
203 variant: hir::Variant,
204 local_name: Option<hir::Name>,
206 self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, local_name, None));
209 pub(crate) fn add_qualified_variant_pat(
211 ctx: &CompletionContext,
212 variant: hir::Variant,
215 self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, None, Some(path)));
218 pub(crate) fn add_struct_pat(
220 ctx: &CompletionContext,
222 local_name: Option<hir::Name>,
224 self.add_opt(render_struct_pat(RenderContext::new(ctx), strukt, local_name));
228 /// Calls the callback for each variant of the provided enum with the path to the variant.
229 /// Skips variants that are visible with single segment paths.
230 fn enum_variants_with_paths(
231 acc: &mut Completions,
232 ctx: &CompletionContext,
234 cb: impl Fn(&mut Completions, &CompletionContext, hir::Variant, hir::ModPath),
236 let variants = enum_.variants(ctx.db);
238 let module = if let Some(module) = ctx.scope.module() {
239 // Compute path from the completion site if available.
242 // Otherwise fall back to the enum's definition site.
246 if let Some(impl_) = ctx.impl_def.as_ref().and_then(|impl_| ctx.sema.to_def(impl_)) {
247 if impl_.self_ty(ctx.db).as_adt() == Some(hir::Adt::Enum(enum_)) {
248 for &variant in &variants {
249 let self_path = hir::ModPath::from_segments(
250 hir::PathKind::Plain,
251 iter::once(known::SELF_TYPE).chain(iter::once(variant.name(ctx.db))),
253 cb(acc, ctx, variant, self_path);
258 for variant in variants {
259 if let Some(path) = module.find_use_path(ctx.db, hir::ModuleDef::from(variant)) {
260 // Variants with trivial paths are already added by the existing completion logic,
261 // so we should avoid adding these twice
262 if path.segments().len() > 1 {
263 cb(acc, ctx, variant, path);