//! 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 keyword; pub(crate) mod lifetime; pub(crate) mod macro_in_item_position; pub(crate) mod mod_; 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 either::Either; use hir::{known, HasVisibility}; use ide_db::SymbolKind; use rustc_hash::FxHashSet; use crate::{ item::{Builder, CompletionKind}, render::{ const_::render_const, enum_variant::render_variant, function::{render_fn, render_method}, macro_::render_macro, pattern::{render_struct_pat, render_variant_pat}, render_field, render_resolution, render_tuple_field, type_alias::render_type_alias, RenderContext, }, CompletionContext, CompletionItem, CompletionItemKind, }; /// Represents an in-progress set of completions being built. #[derive(Debug, Default)] pub struct Completions { buf: Vec, } impl Into> for Completions { fn into(self) -> Vec { self.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 { pub(crate) fn add(&mut self, item: CompletionItem) { 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_field( &mut self, ctx: &CompletionContext, receiver: Option, field: hir::Field, ty: &hir::Type, ) { let item = render_field(RenderContext::new(ctx), receiver, field, ty); self.add(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), receiver, field, ty); self.add(item); } pub(crate) fn add_static_lifetime(&mut self, ctx: &CompletionContext) { let mut item = CompletionItem::new(CompletionKind::Reference, ctx.source_range(), "'static"); item.kind(CompletionItemKind::SymbolKind(SymbolKind::LifetimeParam)); self.add(item.build()); } pub(crate) fn add_resolution( &mut self, ctx: &CompletionContext, local_name: hir::Name, resolution: &hir::ScopeDef, ) { if let Some(item) = render_resolution(RenderContext::new(ctx), local_name, resolution) { self.add(item); } } pub(crate) fn add_macro( &mut self, ctx: &CompletionContext, name: Option, macro_: hir::MacroDef, ) { let name = match name { Some(it) => it, None => return, }; if let Some(item) = render_macro(RenderContext::new(ctx), None, name, macro_) { self.add(item); } } pub(crate) fn add_function( &mut self, ctx: &CompletionContext, func: hir::Function, local_name: Option, ) { if let Some(item) = render_fn(RenderContext::new(ctx), None, local_name, func) { self.add(item) } } pub(crate) fn add_method( &mut self, ctx: &CompletionContext, func: hir::Function, receiver: Option, local_name: Option, ) { if let Some(item) = render_method(RenderContext::new(ctx), None, receiver, local_name, func) { self.add(item) } } pub(crate) fn add_variant_pat( &mut self, ctx: &CompletionContext, variant: hir::Variant, local_name: Option, ) { if let Some(item) = render_variant_pat(RenderContext::new(ctx), variant, local_name, None) { self.add(item); } } pub(crate) fn add_qualified_variant_pat( &mut self, ctx: &CompletionContext, variant: hir::Variant, path: hir::ModPath, ) { if let Some(item) = render_variant_pat(RenderContext::new(ctx), variant, None, Some(path)) { self.add(item); } } pub(crate) fn add_struct_pat( &mut self, ctx: &CompletionContext, strukt: hir::Struct, local_name: Option, ) { if let Some(item) = render_struct_pat(RenderContext::new(ctx), strukt, local_name) { self.add(item); } } pub(crate) fn add_const(&mut self, ctx: &CompletionContext, constant: hir::Const) { if let Some(item) = render_const(RenderContext::new(ctx), constant) { self.add(item); } } pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) { if let Some(item) = render_type_alias(RenderContext::new(ctx), type_alias) { self.add(item) } } pub(crate) fn add_qualified_enum_variant( &mut self, ctx: &CompletionContext, variant: hir::Variant, path: hir::ModPath, ) { let item = render_variant(RenderContext::new(ctx), 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), None, local_name, variant, None); self.add(item); } } fn complete_enum_variants( acc: &mut Completions, ctx: &CompletionContext, enum_data: hir::Enum, cb: impl Fn(&mut Completions, &CompletionContext, hir::Variant, hir::ModPath), ) { let variants = enum_data.variants(ctx.db); let module = if let Some(module) = ctx.scope.module() { // Compute path from the completion site if available. module } else { // Otherwise fall back to the enum's definition site. enum_data.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_data)) { 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); } } } } fn complete_fields( ctx: &CompletionContext, receiver: &hir::Type, mut f: impl FnMut(Either, hir::Type), ) { for receiver in receiver.autoderef(ctx.db) { for (field, ty) in receiver.fields(ctx.db) { if ctx.scope.module().map_or(false, |m| !field.is_visible_from(ctx.db, m)) { // Skip private field. FIXME: If the definition location of the // field is editable, we should show the completion continue; } f(Either::Left(field), ty); } for (i, ty) in receiver.tuple_fields(ctx.db).into_iter().enumerate() { // FIXME: Handle visibility f(Either::Right(i), ty); } } } fn complete_methods( ctx: &CompletionContext, receiver: &hir::Type, mut f: impl FnMut(hir::Function), ) { if let Some(krate) = ctx.krate { let mut seen_methods = FxHashSet::default(); let traits_in_scope = ctx.scope.traits_in_scope(); receiver.iterate_method_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, func| { if func.self_param(ctx.db).is_some() && ctx.scope.module().map_or(true, |m| func.is_visible_from(ctx.db, m)) && seen_methods.insert(func.name(ctx.db)) { f(func); } None::<()> }); } }