From f201a40492fb245d95e4bcbc543f36d7b43645b3 Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Fri, 17 Jun 2022 14:18:03 +0200 Subject: [PATCH] Remove ImmediateLocation in favor of PathKind::Type --- .../ide-completion/src/completions/field.rs | 4 +- .../src/completions/flyimport.rs | 10 +- crates/ide-completion/src/completions/type.rs | 43 ++++---- crates/ide-completion/src/context.rs | 98 +++++++++++-------- crates/ide-completion/src/patterns.rs | 89 +---------------- 5 files changed, 87 insertions(+), 157 deletions(-) diff --git a/crates/ide-completion/src/completions/field.rs b/crates/ide-completion/src/completions/field.rs index e2eed52dfa8..c540b87a46f 100644 --- a/crates/ide-completion/src/completions/field.rs +++ b/crates/ide-completion/src/completions/field.rs @@ -3,7 +3,7 @@ use crate::{ context::{ IdentContext, NameContext, NameKind, NameRefContext, NameRefKind, PathCompletionCtx, - PathKind, + PathKind, TypeLocation, }, CompletionContext, Completions, }; @@ -18,7 +18,7 @@ pub(crate) fn complete_field_list(acc: &mut Completions, ctx: &CompletionContext is_absolute_path: false, qualifier: None, parent: None, - kind: PathKind::Type { in_tuple_struct: true, ascription: None }, + kind: PathKind::Type { location: TypeLocation::TupleField }, has_type_args: false, .. })), diff --git a/crates/ide-completion/src/completions/flyimport.rs b/crates/ide-completion/src/completions/flyimport.rs index b724f3cc51e..6266bcef34e 100644 --- a/crates/ide-completion/src/completions/flyimport.rs +++ b/crates/ide-completion/src/completions/flyimport.rs @@ -9,9 +9,9 @@ use syntax::{AstNode, SyntaxNode, T}; use crate::{ context::{ - CompletionContext, NameRefContext, NameRefKind, PathCompletionCtx, PathKind, PatternContext, + CompletionContext, NameRefContext, NameRefKind, PathCompletionCtx, PathKind, + PatternContext, TypeLocation, }, - patterns::ImmediateLocation, render::{render_resolution_with_import, RenderContext}, }; @@ -112,7 +112,7 @@ pub(crate) fn import_on_the_fly(acc: &mut Completions, ctx: &CompletionContext) if !ctx.config.enable_imports_on_the_fly { return None; } - let path_kind = match dbg!(ctx.nameref_ctx()) { + let path_kind = match ctx.nameref_ctx() { Some(NameRefContext { kind: Some(NameRefKind::Path(PathCompletionCtx { @@ -176,8 +176,8 @@ pub(crate) fn import_on_the_fly(acc: &mut Completions, ctx: &CompletionContext) (PathKind::Pat, ItemInNs::Types(_)) => true, (PathKind::Pat, ItemInNs::Values(def)) => matches!(def, hir::ModuleDef::Const(_)), - (PathKind::Type { .. }, ItemInNs::Types(ty)) => { - if matches!(ctx.completion_location, Some(ImmediateLocation::TypeBound)) { + (PathKind::Type { location }, ItemInNs::Types(ty)) => { + if matches!(location, TypeLocation::TypeBound) { matches!(ty, ModuleDef::Trait(_)) } else { true diff --git a/crates/ide-completion/src/completions/type.rs b/crates/ide-completion/src/completions/type.rs index 0e1cccb1831..9d3a1c24293 100644 --- a/crates/ide-completion/src/completions/type.rs +++ b/crates/ide-completion/src/completions/type.rs @@ -5,8 +5,7 @@ use ide_db::FxHashSet; use syntax::{ast, AstNode}; use crate::{ - context::{PathCompletionCtx, PathKind, PathQualifierCtx, TypeAscriptionTarget}, - patterns::ImmediateLocation, + context::{PathCompletionCtx, PathKind, PathQualifierCtx, TypeAscriptionTarget, TypeLocation}, render::render_type_inference, CompletionContext, Completions, }; @@ -14,13 +13,13 @@ use crate::{ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) { let _p = profile::span("complete_type_path"); - let (&is_absolute_path, qualifier) = match ctx.path_context() { + let (&is_absolute_path, location, qualifier) = match ctx.path_context() { Some(PathCompletionCtx { - kind: PathKind::Type { .. }, + kind: PathKind::Type { location }, is_absolute_path, qualifier, .. - }) => (is_absolute_path, qualifier), + }) => (is_absolute_path, location, qualifier), _ => return, }; @@ -32,7 +31,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) ScopeDef::ModuleDef(Function(_) | Variant(_) | Static(_)) | ScopeDef::Local(_) => false, // unless its a constant in a generic arg list position ScopeDef::ModuleDef(Const(_)) | ScopeDef::GenericParam(ConstParam(_)) => { - ctx.expects_generic_arg() + matches!(location, TypeLocation::GenericArgList(_)) } ScopeDef::ImplSelfType(_) => { !ctx.previous_token_is(syntax::T![impl]) && !ctx.previous_token_is(syntax::T![for]) @@ -47,6 +46,14 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) } }; + let add_assoc_item = |acc: &mut Completions, item| match item { + hir::AssocItem::Const(ct) if matches!(location, TypeLocation::GenericArgList(_)) => { + acc.add_const(ctx, ct) + } + hir::AssocItem::Function(_) | hir::AssocItem::Const(_) => (), + hir::AssocItem::TypeAlias(ty) => acc.add_type_alias(ctx, ty), + }; + match qualifier { Some(PathQualifierCtx { is_infer_qualifier, resolution, .. }) => { if *is_infer_qualifier { @@ -54,7 +61,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) .0 .into_iter() .flat_map(|it| hir::Trait::from(it).items(ctx.sema.db)) - .for_each(|item| add_assoc_item(acc, ctx, item)); + .for_each(|item| add_assoc_item(acc, item)); return; } let resolution = match resolution { @@ -98,7 +105,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) Some(ctx.module), None, |item| { - add_assoc_item(acc, ctx, item); + add_assoc_item(acc, item); None::<()> }, ); @@ -114,7 +121,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) hir::PathResolution::Def(hir::ModuleDef::Trait(t)) => { // Handles `Trait::assoc` as well as `::assoc`. for item in t.items(ctx.db) { - add_assoc_item(acc, ctx, item); + add_assoc_item(acc, item); } } hir::PathResolution::TypeParam(_) | hir::PathResolution::SelfType(_) => { @@ -135,7 +142,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) // We might iterate candidates of a trait multiple times here, so deduplicate // them. if seen.insert(item) { - add_assoc_item(acc, ctx, item); + add_assoc_item(acc, item); } None::<()> }, @@ -147,7 +154,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) None if is_absolute_path => acc.add_crate_roots(ctx), None => { acc.add_nameref_keywords_with_colon(ctx); - if let Some(ImmediateLocation::TypeBound) = &ctx.completion_location { + if let TypeLocation::TypeBound = location { ctx.process_all_names(&mut |name, res| { let add_resolution = match res { ScopeDef::ModuleDef(hir::ModuleDef::Macro(mac)) => mac.is_fn_like(ctx.db), @@ -162,7 +169,7 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) }); return; } - if let Some(ImmediateLocation::GenericArgList(arg_list)) = &ctx.completion_location { + if let TypeLocation::GenericArgList(Some(arg_list)) = location { if let Some(path_seg) = arg_list.syntax().parent().and_then(ast::PathSegment::cast) { if path_seg.syntax().ancestors().find_map(ast::TypeBound::cast).is_some() { @@ -189,10 +196,10 @@ pub(crate) fn complete_type_path(acc: &mut Completions, ctx: &CompletionContext) } pub(crate) fn complete_inferred_type(acc: &mut Completions, ctx: &CompletionContext) -> Option<()> { - let pat = match dbg!(ctx.path_context()) { + let pat = match ctx.path_context() { Some( ctx @ PathCompletionCtx { - kind: PathKind::Type { ascription: Some(ascription), .. }, + kind: PathKind::Type { location: TypeLocation::TypeAscription(ascription), .. }, .. }, ) if ctx.is_trivial_path() => ascription, @@ -211,11 +218,3 @@ pub(crate) fn complete_inferred_type(acc: &mut Completions, ctx: &CompletionCont acc.add(render_type_inference(ty_string, ctx)); None } - -fn add_assoc_item(acc: &mut Completions, ctx: &CompletionContext, item: hir::AssocItem) { - match item { - hir::AssocItem::Const(ct) if ctx.expects_generic_arg() => acc.add_const(ctx, ct), - hir::AssocItem::Function(_) | hir::AssocItem::Const(_) => (), - hir::AssocItem::TypeAlias(ty) => acc.add_type_alias(ctx, ty), - } -} diff --git a/crates/ide-completion/src/context.rs b/crates/ide-completion/src/context.rs index b298c372b35..7421a3e98bf 100644 --- a/crates/ide-completion/src/context.rs +++ b/crates/ide-completion/src/context.rs @@ -22,10 +22,7 @@ use syntax::{ use text_edit::Indel; use crate::{ - patterns::{ - determine_location, is_in_loop_body, is_in_token_of_for_loop, previous_token, - ImmediateLocation, - }, + patterns::{is_in_loop_body, is_in_token_of_for_loop, previous_token}, CompletionConfig, }; @@ -102,10 +99,7 @@ pub(super) enum PathKind { is_func_update: Option, }, Type { - in_tuple_struct: bool, - /// Whether this type path is a type ascription or not - /// Original file ast node - ascription: Option, + location: TypeLocation, }, Attr { kind: AttrKind, @@ -123,6 +117,16 @@ pub(super) enum PathKind { Use, } +/// Original file ast nodes +#[derive(Clone, Debug, PartialEq, Eq)] +pub(crate) enum TypeLocation { + TupleField, + TypeAscription(TypeAscriptionTarget), + GenericArgList(Option), + TypeBound, + Other, +} + #[derive(Clone, Debug, PartialEq, Eq)] pub(crate) enum TypeAscriptionTarget { Let(Option), @@ -222,6 +226,7 @@ pub(super) enum NameKind { pub(super) struct NameRefContext { /// NameRef syntax in the original file pub(super) nameref: Option, + // FIXME: This shouldn't be an Option pub(super) kind: Option, } @@ -311,9 +316,9 @@ pub(crate) struct CompletionContext<'a> { /// The parent impl of the cursor position if it exists. pub(super) impl_def: Option, /// Are we completing inside a let statement with a missing semicolon? + // FIXME: This should be part of PathKind::Expr pub(super) incomplete_let: bool, - pub(super) completion_location: Option, pub(super) previous_token: Option, pub(super) ident_ctx: IdentContext, @@ -386,11 +391,6 @@ impl<'a> CompletionContext<'a> { self.dot_receiver().is_some() } - // FIXME: This shouldn't exist - pub(crate) fn expects_generic_arg(&self) -> bool { - matches!(self.completion_location, Some(ImmediateLocation::GenericArgList(_))) - } - pub(crate) fn path_context(&self) -> Option<&PathCompletionCtx> { self.nameref_ctx().and_then(|ctx| match &ctx.kind { Some(NameRefKind::Path(path)) => Some(path), @@ -542,7 +542,6 @@ impl<'a> CompletionContext<'a> { function_def: None, impl_def: None, incomplete_let: false, - completion_location: None, previous_token: None, // dummy value, will be overwritten ident_ctx: IdentContext::UnexpandedAttrTT { fake_attribute_under_caret: None }, @@ -935,8 +934,6 @@ impl<'a> CompletionContext<'a> { return Some(()); } }; - self.completion_location = - determine_location(&self.sema, original_file, offset, &name_like); self.impl_def = self .sema .token_ancestors_with_macros(self.token.clone()) @@ -1094,7 +1091,7 @@ impl<'a> CompletionContext<'a> { match parent { ast::PathSegment(segment) => segment, ast::FieldExpr(field) => { - let receiver = find_in_original_file(field.expr(), original_file); + let receiver = find_opt_node_in_file(original_file, field.expr()); let receiver_is_ambiguous_float_literal = match &receiver { Some(ast::Expr::Literal(l)) => matches! { l.kind(), @@ -1110,7 +1107,7 @@ impl<'a> CompletionContext<'a> { return res; }, ast::MethodCallExpr(method) => { - let receiver = find_in_original_file(method.receiver(), original_file); + let receiver = find_opt_node_in_file(original_file, method.receiver()); nameref_ctx.kind = Some(NameRefKind::DotAccess(DotAccess { receiver_ty: receiver.as_ref().and_then(|it| sema.type_of_expr(it)), kind: DotAccessKind::Method { has_parens: method.arg_list().map_or(false, |it| it.l_paren_token().is_some()) }, @@ -1189,14 +1186,14 @@ impl<'a> CompletionContext<'a> { None }; - let fetch_ascription = |it: Option| { + let type_location = |it: Option| { let parent = it?; - match_ast! { + let res = match_ast! { match parent { ast::Const(it) => { - let name = find_in_original_file(it.name(), original_file)?; + let name = find_opt_node_in_file(original_file, it.name())?; let original = ast::Const::cast(name.syntax().parent()?)?; - Some(TypeAscriptionTarget::Const(original.body())) + TypeLocation::TypeAscription(TypeAscriptionTarget::Const(original.body())) }, ast::RetType(it) => { if it.thin_arrow_token().is_none() { @@ -1207,8 +1204,8 @@ impl<'a> CompletionContext<'a> { None => ast::ClosureExpr::cast(parent.parent()?)?.param_list(), }; - let parent = find_in_original_file(parent, original_file)?.syntax().parent()?; - Some(TypeAscriptionTarget::RetType(match_ast! { + let parent = find_opt_node_in_file(original_file, parent)?.syntax().parent()?; + TypeLocation::TypeAscription(TypeAscriptionTarget::RetType(match_ast! { match parent { ast::ClosureExpr(it) => { it.body() @@ -1224,17 +1221,25 @@ impl<'a> CompletionContext<'a> { if it.colon_token().is_none() { return None; } - Some(TypeAscriptionTarget::FnParam(find_in_original_file(it.pat(), original_file))) + TypeLocation::TypeAscription(TypeAscriptionTarget::FnParam(find_opt_node_in_file(original_file, it.pat()))) }, ast::LetStmt(it) => { if it.colon_token().is_none() { return None; } - Some(TypeAscriptionTarget::Let(find_in_original_file(it.pat(), original_file))) + TypeLocation::TypeAscription(TypeAscriptionTarget::Let(find_opt_node_in_file(original_file, it.pat()))) }, - _ => None, + ast::TypeBound(_) => TypeLocation::TypeBound, + // is this case needed? + ast::TypeBoundList(_) => TypeLocation::TypeBound, + ast::GenericArg(it) => TypeLocation::GenericArgList(find_opt_node_in_file_compensated(original_file, it.syntax().parent().and_then(ast::GenericArgList::cast))), + // is this case needed? + ast::GenericArgList(it) => TypeLocation::GenericArgList(find_opt_node_in_file_compensated(original_file, Some(it))), + ast::TupleField(_) => TypeLocation::TupleField, + _ => return None, } - } + }; + Some(res) }; // Infer the path kind @@ -1242,10 +1247,9 @@ impl<'a> CompletionContext<'a> { match_ast! { match it { ast::PathType(it) => { - let ascription = fetch_ascription(it.syntax().parent()); + let location = type_location(it.syntax().parent()); Some(PathKind::Type { - in_tuple_struct: it.syntax().parent().map_or(false, |it| ast::TupleField::can_cast(it.kind())), - ascription, + location: location.unwrap_or(TypeLocation::Other), }) }, ast::PathExpr(it) => { @@ -1292,7 +1296,12 @@ impl<'a> CompletionContext<'a> { let parent = it.syntax().parent(); match parent.as_ref().map(|it| it.kind()) { Some(SyntaxKind::MACRO_PAT) => Some(PathKind::Pat), - Some(SyntaxKind::MACRO_TYPE) => Some(PathKind::Type { in_tuple_struct: false, ascription: None }), + Some(SyntaxKind::MACRO_TYPE) => { + let location = type_location(parent.unwrap().parent()); + Some(PathKind::Type { + location: location.unwrap_or(TypeLocation::Other), + }) + }, Some(SyntaxKind::ITEM_LIST) => Some(PathKind::Item { kind: ItemListKind::Module }), Some(SyntaxKind::ASSOC_ITEM_LIST) => Some(PathKind::Item { kind: match parent.and_then(|it| it.parent()) { Some(it) => match_ast! { @@ -1501,15 +1510,14 @@ fn pattern_context_for(original_file: &SyntaxNode, pat: ast::Pat) -> PatternCont } } -fn find_in_original_file(x: Option, original_file: &SyntaxNode) -> Option { - fn find_node_with_range(syntax: &SyntaxNode, range: TextRange) -> Option { - let range = syntax.text_range().intersect(range)?; - syntax.covering_element(range).ancestors().find_map(N::cast) - } - x.map(|e| e.syntax().text_range()).and_then(|r| find_node_with_range(original_file, r)) +/// Attempts to find `node` inside `syntax` via `node`'s text range. +/// If the fake identifier has been inserted after this node or inside of this node use the `_compensated` version instead. +fn find_opt_node_in_file(syntax: &SyntaxNode, node: Option) -> Option { + find_node_in_file(syntax, &node?) } /// Attempts to find `node` inside `syntax` via `node`'s text range. +/// If the fake identifier has been inserted after this node or inside of this node use the `_compensated` version instead. fn find_node_in_file(syntax: &SyntaxNode, node: &N) -> Option { let syntax_range = syntax.text_range(); let range = node.syntax().text_range(); @@ -1528,11 +1536,21 @@ fn find_node_in_file_compensated(syntax: &SyntaxNode, node: &N) -> O return None; } let range = TextRange::new(range.start(), end); - // our inserted ident could cause `range` to be go outside of the original syntax, so cap it + // our inserted ident could cause `range` to go outside of the original syntax, so cap it let intersection = range.intersect(syntax_range)?; syntax.covering_element(intersection).ancestors().find_map(N::cast) } +/// Attempts to find `node` inside `syntax` via `node`'s text range while compensating +/// for the offset introduced by the fake ident.. +/// This is wrong if `node` comes before the insertion point! Use `find_node_in_file` instead. +fn find_opt_node_in_file_compensated( + syntax: &SyntaxNode, + node: Option, +) -> Option { + find_node_in_file_compensated(syntax, &node?) +} + fn path_or_use_tree_qualifier(path: &ast::Path) -> Option<(ast::Path, bool)> { if let Some(qual) = path.qualifier() { return Some((qual, false)); diff --git a/crates/ide-completion/src/patterns.rs b/crates/ide-completion/src/patterns.rs index 88cb486f5d0..9efb42c4de7 100644 --- a/crates/ide-completion/src/patterns.rs +++ b/crates/ide-completion/src/patterns.rs @@ -4,103 +4,16 @@ //! This means we for example expand a NameRef token to its outermost Path node, as semantically these act in the same location //! and the completions usually query for path specific things on the Path context instead. This simplifies some location handling. -use hir::Semantics; -use ide_db::RootDatabase; use syntax::{ ast::{self, HasLoopBody}, match_ast, AstNode, SyntaxElement, SyntaxKind::*, - SyntaxNode, SyntaxToken, TextSize, + SyntaxNode, SyntaxToken, }; #[cfg(test)] use crate::tests::check_pattern_is_applicable; -/// Direct parent "thing" of what we are currently completing. -/// -/// This may contain nodes of the fake file as well as the original, comments on the variants specify -/// from which file the nodes are. -#[derive(Clone, Debug, PartialEq, Eq)] -pub(crate) enum ImmediateLocation { - TypeBound, - // Only set from a type arg - /// Original file ast node - GenericArgList(ast::GenericArgList), -} - -pub(crate) fn determine_location( - sema: &Semantics, - original_file: &SyntaxNode, - offset: TextSize, - name_like: &ast::NameLike, -) -> Option { - let node = match name_like { - ast::NameLike::NameRef(name_ref) => maximize_name_ref(name_ref), - ast::NameLike::Name(name) => name.syntax().clone(), - ast::NameLike::Lifetime(lt) => lt.syntax().clone(), - }; - - match_ast! { - match node { - ast::TypeBoundList(_it) => return Some(ImmediateLocation::TypeBound), - _ => (), - } - }; - - let parent = match node.parent() { - Some(parent) => match ast::MacroCall::cast(parent.clone()) { - // When a path is being typed in an (Assoc)ItemList the parser will always emit a macro_call. - // This is usually fine as the node expansion code above already accounts for that with - // the ancestors call, but there is one exception to this which is that when an attribute - // precedes it the code above will not walk the Path to the parent MacroCall as their ranges differ. - // FIXME path expr and statement have a similar problem - Some(call) - if call.excl_token().is_none() - && call.token_tree().is_none() - && call.semicolon_token().is_none() => - { - call.syntax().parent()? - } - _ => parent, - }, - // SourceFile - None => return None, - }; - - let res = match_ast! { - match parent { - ast::TypeBound(_) => ImmediateLocation::TypeBound, - ast::TypeBoundList(_) => ImmediateLocation::TypeBound, - ast::GenericArgList(_) => sema - .find_node_at_offset_with_macros(original_file, offset) - .map(ImmediateLocation::GenericArgList)?, - _ => return None, - } - }; - Some(res) -} - -/// Maximize a nameref to its enclosing path if its the last segment of said path. -/// That is, when completing a [`NameRef`] we actually handle it as the path it is part of when determining -/// its location. -fn maximize_name_ref(name_ref: &ast::NameRef) -> SyntaxNode { - if let Some(segment) = name_ref.syntax().parent().and_then(ast::PathSegment::cast) { - let p = segment.parent_path(); - if p.parent_path().is_none() { - // Get rid of PathExpr, PathType, etc... - let path = p - .syntax() - .ancestors() - .take_while(|it| it.text_range() == p.syntax().text_range()) - .last(); - if let Some(it) = path { - return it; - } - } - } - name_ref.syntax().clone() -} - pub(crate) fn previous_token(element: SyntaxElement) -> Option { element.into_token().and_then(previous_non_trivia_token) }