//! This module defines an accumulator for completions which are going to be presented to user. pub(crate) mod attribute; pub(crate) mod dot; pub(crate) mod flyimport; pub(crate) mod fn_param; pub(crate) mod format_string; pub(crate) mod keyword; pub(crate) mod lifetime; pub(crate) mod mod_; pub(crate) mod use_; pub(crate) mod pattern; pub(crate) mod postfix; pub(crate) mod qualified_path; pub(crate) mod record; pub(crate) mod snippet; pub(crate) mod trait_impl; pub(crate) mod unqualified_path; use std::iter; use hir::{known, ScopeDef}; use ide_db::SymbolKind; use crate::{ context::Visible, item::Builder, render::{ const_::render_const, enum_variant::render_variant, function::{render_fn, render_method}, pattern::{render_struct_pat, render_variant_pat}, render_field, render_resolution, render_tuple_field, struct_literal::render_struct_literal, type_alias::{render_type_alias, render_type_alias_with_eq}, RenderContext, }, CompletionContext, CompletionItem, CompletionItemKind, }; fn module_or_attr(def: ScopeDef) -> Option { match def { ScopeDef::MacroDef(mac) if mac.is_attr() => Some(def), ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) => Some(def), _ => None, } } fn module_or_fn_macro(def: ScopeDef) -> Option { match def { ScopeDef::MacroDef(mac) if mac.is_fn_like() => Some(def), ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) => Some(def), _ => None, } } /// Represents an in-progress set of completions being built. #[derive(Debug, Default)] pub struct Completions { buf: Vec, } impl From for Vec { fn from(val: Completions) -> Self { val.buf } } impl Builder { /// Convenience method, which allows to add a freshly created completion into accumulator /// without binding it to the variable. pub(crate) fn add_to(self, acc: &mut Completions) { acc.add(self.build()) } } impl Completions { fn add(&mut self, item: CompletionItem) { self.buf.push(item) } fn add_opt(&mut self, item: Option) { if let Some(item) = item { self.buf.push(item) } } pub(crate) fn add_all(&mut self, items: I) where I: IntoIterator, I::Item: Into, { items.into_iter().for_each(|item| self.add(item.into())) } pub(crate) fn add_keyword(&mut self, ctx: &CompletionContext, keyword: &'static str) { let item = CompletionItem::new(CompletionItemKind::Keyword, ctx.source_range(), keyword); item.add_to(self); } pub(crate) fn add_resolution( &mut self, ctx: &CompletionContext, local_name: hir::Name, resolution: hir::ScopeDef, ) { if ctx.is_scope_def_hidden(resolution) { cov_mark::hit!(qualified_path_doc_hidden); return; } self.add(render_resolution(RenderContext::new(ctx, false), local_name, resolution)); } pub(crate) fn add_function( &mut self, ctx: &CompletionContext, func: hir::Function, local_name: Option, ) { let is_private_editable = match ctx.is_visible(&func) { Visible::Yes => false, Visible::Editable => true, Visible::No => return, }; self.add(render_fn(RenderContext::new(ctx, is_private_editable), None, local_name, func)); } pub(crate) fn add_method( &mut self, ctx: &CompletionContext, func: hir::Function, receiver: Option, local_name: Option, ) { let is_private_editable = match ctx.is_visible(&func) { Visible::Yes => false, Visible::Editable => true, Visible::No => return, }; self.add(render_method( RenderContext::new(ctx, is_private_editable), None, receiver, local_name, func, )); } pub(crate) fn add_const(&mut self, ctx: &CompletionContext, konst: hir::Const) { let is_private_editable = match ctx.is_visible(&konst) { Visible::Yes => false, Visible::Editable => true, Visible::No => return, }; self.add_opt(render_const(RenderContext::new(ctx, is_private_editable), konst)); } pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) { let is_private_editable = match ctx.is_visible(&type_alias) { Visible::Yes => false, Visible::Editable => true, Visible::No => return, }; self.add_opt(render_type_alias(RenderContext::new(ctx, is_private_editable), type_alias)); } pub(crate) fn add_type_alias_with_eq( &mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias, ) { self.add_opt(render_type_alias_with_eq(RenderContext::new(ctx, false), type_alias)); } pub(crate) fn add_qualified_enum_variant( &mut self, ctx: &CompletionContext, variant: hir::Variant, path: hir::ModPath, ) { let item = render_variant(RenderContext::new(ctx, false), None, None, variant, Some(path)); self.add(item); } pub(crate) fn add_enum_variant( &mut self, ctx: &CompletionContext, variant: hir::Variant, local_name: Option, ) { let item = render_variant(RenderContext::new(ctx, false), None, local_name, variant, None); self.add(item); } pub(crate) fn add_field( &mut self, ctx: &CompletionContext, receiver: Option, field: hir::Field, ty: &hir::Type, ) { let is_private_editable = match ctx.is_visible(&field) { Visible::Yes => false, Visible::Editable => true, Visible::No => return, }; let item = render_field(RenderContext::new(ctx, is_private_editable), receiver, field, ty); self.add(item); } pub(crate) fn add_struct_literal( &mut self, ctx: &CompletionContext, strukt: hir::Struct, path: Option, local_name: Option, ) { let item = render_struct_literal(RenderContext::new(ctx, false), strukt, path, local_name); self.add_opt(item); } pub(crate) fn add_tuple_field( &mut self, ctx: &CompletionContext, receiver: Option, field: usize, ty: &hir::Type, ) { let item = render_tuple_field(RenderContext::new(ctx, false), receiver, field, ty); self.add(item); } pub(crate) fn add_lifetime(&mut self, ctx: &CompletionContext, name: hir::Name) { CompletionItem::new(SymbolKind::LifetimeParam, ctx.source_range(), name.to_smol_str()) .add_to(self) } pub(crate) fn add_label(&mut self, ctx: &CompletionContext, name: hir::Name) { CompletionItem::new(SymbolKind::Label, ctx.source_range(), name.to_smol_str()).add_to(self) } pub(crate) fn add_variant_pat( &mut self, ctx: &CompletionContext, variant: hir::Variant, local_name: Option, ) { self.add_opt(render_variant_pat(RenderContext::new(ctx, false), variant, local_name, None)); } pub(crate) fn add_qualified_variant_pat( &mut self, ctx: &CompletionContext, variant: hir::Variant, path: hir::ModPath, ) { self.add_opt(render_variant_pat(RenderContext::new(ctx, false), variant, None, Some(path))); } pub(crate) fn add_struct_pat( &mut self, ctx: &CompletionContext, strukt: hir::Struct, local_name: Option, ) { self.add_opt(render_struct_pat(RenderContext::new(ctx, false), strukt, local_name)); } } /// Calls the callback for each variant of the provided enum with the path to the variant. /// Skips variants that are visible with single segment paths. fn enum_variants_with_paths( acc: &mut Completions, ctx: &CompletionContext, enum_: hir::Enum, cb: impl Fn(&mut Completions, &CompletionContext, hir::Variant, hir::ModPath), ) { let variants = enum_.variants(ctx.db); let module = if let Some(module) = ctx.module { // Compute path from the completion site if available. module } else { // Otherwise fall back to the enum's definition site. enum_.module(ctx.db) }; if let Some(impl_) = ctx.impl_def.as_ref().and_then(|impl_| ctx.sema.to_def(impl_)) { if impl_.self_ty(ctx.db).as_adt() == Some(hir::Adt::Enum(enum_)) { for &variant in &variants { let self_path = hir::ModPath::from_segments( hir::PathKind::Plain, iter::once(known::SELF_TYPE).chain(iter::once(variant.name(ctx.db))), ); cb(acc, ctx, variant, self_path); } } } for variant in variants { if let Some(path) = module.find_use_path(ctx.db, hir::ModuleDef::from(variant)) { // Variants with trivial paths are already added by the existing completion logic, // so we should avoid adding these twice if path.segments().len() > 1 { cb(acc, ctx, variant, path); } } } }