rust/crates/ide-completion/src/render.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

1729 lines
47 KiB
Rust
Raw Normal View History

2020-11-01 03:35:04 -06:00
//! `render` module provides utilities for rendering completion suggestions
//! into code pieces that will be presented to user.
pub(crate) mod macro_;
pub(crate) mod function;
pub(crate) mod const_;
2020-12-20 11:19:23 -06:00
pub(crate) mod pattern;
pub(crate) mod type_alias;
pub(crate) mod variant;
pub(crate) mod union_literal;
pub(crate) mod literal;
2021-12-21 07:07:48 -06:00
use hir::{AsAssocItem, HasAttrs, HirDisplay, ScopeDef};
2022-04-01 18:42:21 -05:00
use ide_db::{
helpers::item_name, imports::import_assets::LocatedImport, RootDatabase, SnippetCap, SymbolKind,
};
use syntax::{AstNode, SmolStr, SyntaxKind, TextRange};
2020-11-01 03:35:04 -06:00
use crate::{
context::{DotAccess, PathCompletionCtx, PathKind, PatternContext},
2022-04-11 11:48:27 -05:00
item::{Builder, CompletionRelevanceTypeMatch},
2022-06-20 13:16:40 -05:00
render::{
function::render_fn,
literal::render_variant_lit,
macro_::{render_macro, render_macro_pat},
},
CompletionContext, CompletionItem, CompletionItemKind, CompletionRelevance,
};
2020-11-01 04:48:42 -06:00
/// Interface for data and methods required for items rendering.
#[derive(Debug, Clone)]
2020-11-01 03:35:04 -06:00
pub(crate) struct RenderContext<'a> {
completion: &'a CompletionContext<'a>,
is_private_editable: bool,
2022-04-01 18:42:21 -05:00
import_to_add: Option<LocatedImport>,
2020-11-01 03:35:04 -06:00
}
impl<'a> RenderContext<'a> {
pub(crate) fn new(completion: &'a CompletionContext<'a>) -> RenderContext<'a> {
RenderContext { completion, is_private_editable: false, import_to_add: None }
}
pub(crate) fn private_editable(mut self, private_editable: bool) -> Self {
self.is_private_editable = private_editable;
self
}
2022-04-01 18:42:21 -05:00
pub(crate) fn import_to_add(mut self, import_to_add: Option<LocatedImport>) -> Self {
self.import_to_add = import_to_add;
self
2020-11-01 03:35:04 -06:00
}
fn snippet_cap(&self) -> Option<SnippetCap> {
self.completion.config.snippet_cap
2020-11-01 03:35:04 -06:00
}
fn db(&self) -> &'a RootDatabase {
2021-06-12 22:54:16 -05:00
self.completion.db
2020-11-01 03:35:04 -06:00
}
fn source_range(&self) -> TextRange {
2020-11-01 03:35:04 -06:00
self.completion.source_range()
}
fn completion_relevance(&self) -> CompletionRelevance {
CompletionRelevance {
is_private_editable: self.is_private_editable,
requires_import: self.import_to_add.is_some(),
..Default::default()
}
}
2022-05-10 07:31:28 -05:00
fn is_immediately_after_macro_bang(&self) -> bool {
self.completion.token.kind() == SyntaxKind::BANG
&& self
.completion
.token
.parent()
.map_or(false, |it| it.kind() == SyntaxKind::MACRO_CALL)
}
fn is_deprecated(&self, def: impl HasAttrs) -> bool {
let attrs = def.attrs(self.db());
attrs.by_key("deprecated").exists()
2020-11-01 03:35:04 -06:00
}
2020-11-01 03:59:43 -06:00
fn is_deprecated_assoc_item(&self, as_assoc_item: impl AsAssocItem) -> bool {
let db = self.db();
let assoc = match as_assoc_item.as_assoc_item(db) {
Some(assoc) => assoc,
None => return false,
};
let is_assoc_deprecated = match assoc {
hir::AssocItem::Function(it) => self.is_deprecated(it),
hir::AssocItem::Const(it) => self.is_deprecated(it),
hir::AssocItem::TypeAlias(it) => self.is_deprecated(it),
};
is_assoc_deprecated
|| assoc
.containing_trait_or_trait_impl(db)
.map(|trait_| self.is_deprecated(trait_))
.unwrap_or(false)
}
// FIXME: remove this
fn docs(&self, def: impl HasAttrs) -> Option<hir::Documentation> {
def.docs(self.db())
2020-11-01 03:59:43 -06:00
}
2020-11-01 03:35:04 -06:00
}
2021-06-16 08:46:58 -05:00
pub(crate) fn render_field(
2021-06-09 16:43:22 -05:00
ctx: RenderContext<'_>,
dot_access: &DotAccess,
2021-06-09 16:43:22 -05:00
receiver: Option<hir::Name>,
field: hir::Field,
ty: &hir::Type,
) -> CompletionItem {
let is_deprecated = ctx.is_deprecated(field);
let name = field.name(ctx.db()).to_smol_str();
2021-06-09 16:43:22 -05:00
let mut item = CompletionItem::new(
SymbolKind::Field,
2021-06-09 16:43:22 -05:00
ctx.source_range(),
receiver.map_or_else(|| name.clone(), |receiver| format!("{}.{}", receiver, name).into()),
2021-06-09 16:43:22 -05:00
);
item.set_relevance(CompletionRelevance {
type_match: compute_type_match(ctx.completion, ty),
2021-09-04 18:28:59 -05:00
exact_name_match: compute_exact_name_match(ctx.completion, name.as_str()),
2021-06-09 16:43:22 -05:00
..CompletionRelevance::default()
});
item.detail(ty.display(ctx.db()).to_string())
.set_documentation(field.docs(ctx.db()))
.set_deprecated(is_deprecated)
.lookup_by(name.clone());
2021-09-04 18:28:59 -05:00
let is_keyword = SyntaxKind::from_keyword(name.as_str()).is_some();
if is_keyword && !matches!(name.as_str(), "self" | "crate" | "super" | "Self") {
item.insert_text(format!("r#{}", name));
2021-09-04 18:28:59 -05:00
}
if let Some(receiver) = &dot_access.receiver {
if let Some(ref_match) = compute_ref_match(ctx.completion, ty) {
item.ref_match(ref_match, receiver.syntax().text_range().start());
}
}
2021-06-09 16:43:22 -05:00
item.build()
}
2021-06-16 08:46:58 -05:00
pub(crate) fn render_tuple_field(
2021-06-09 16:43:22 -05:00
ctx: RenderContext<'_>,
receiver: Option<hir::Name>,
field: usize,
ty: &hir::Type,
) -> CompletionItem {
let mut item = CompletionItem::new(
SymbolKind::Field,
2021-06-09 16:43:22 -05:00
ctx.source_range(),
receiver.map_or_else(|| field.to_string(), |receiver| format!("{}.{}", receiver, field)),
);
item.detail(ty.display(ctx.db()).to_string()).lookup_by(field.to_string());
2021-06-09 16:43:22 -05:00
item.build()
}
2022-06-20 13:16:40 -05:00
pub(crate) fn render_type_inference(ty_string: String, ctx: &CompletionContext) -> CompletionItem {
let mut builder =
CompletionItem::new(CompletionItemKind::InferredType, ctx.source_range(), ty_string);
builder.set_relevance(CompletionRelevance { is_definite: true, ..Default::default() });
builder.build()
}
pub(crate) fn render_path_resolution(
2021-06-16 08:46:58 -05:00
ctx: RenderContext<'_>,
path_ctx: &PathCompletionCtx,
2021-06-16 08:46:58 -05:00
local_name: hir::Name,
2021-12-21 07:07:48 -06:00
resolution: ScopeDef,
2022-04-11 11:48:27 -05:00
) -> Builder {
2022-06-20 13:16:40 -05:00
render_resolution_path(ctx, path_ctx, local_name, None, resolution)
2021-06-16 08:46:58 -05:00
}
2022-06-20 13:16:40 -05:00
pub(crate) fn render_pattern_resolution(
ctx: RenderContext<'_>,
2022-06-20 13:16:40 -05:00
pattern_ctx: &PatternContext,
local_name: hir::Name,
resolution: ScopeDef,
2022-04-11 11:48:27 -05:00
) -> Builder {
2022-06-20 13:16:40 -05:00
render_resolution_pat(ctx, pattern_ctx, local_name, None, resolution)
}
2021-06-16 08:46:58 -05:00
pub(crate) fn render_resolution_with_import(
ctx: RenderContext<'_>,
path_ctx: &PathCompletionCtx,
2022-04-01 18:42:21 -05:00
import_edit: LocatedImport,
2022-04-11 11:48:27 -05:00
) -> Option<Builder> {
2022-04-01 18:42:21 -05:00
let resolution = ScopeDef::from(import_edit.original_item);
2022-06-20 13:16:40 -05:00
let local_name = scope_def_to_name(resolution, &ctx, &import_edit)?;
Some(render_resolution_path(ctx, path_ctx, local_name, Some(import_edit), resolution))
}
pub(crate) fn render_resolution_with_import_pat(
ctx: RenderContext<'_>,
pattern_ctx: &PatternContext,
import_edit: LocatedImport,
) -> Option<Builder> {
let resolution = ScopeDef::from(import_edit.original_item);
let local_name = scope_def_to_name(resolution, &ctx, &import_edit)?;
Some(render_resolution_pat(ctx, pattern_ctx, local_name, Some(import_edit), resolution))
}
fn scope_def_to_name(
resolution: ScopeDef,
ctx: &RenderContext,
import_edit: &LocatedImport,
) -> Option<hir::Name> {
Some(match resolution {
2021-12-21 07:07:48 -06:00
ScopeDef::ModuleDef(hir::ModuleDef::Function(f)) => f.name(ctx.completion.db),
ScopeDef::ModuleDef(hir::ModuleDef::Const(c)) => c.name(ctx.completion.db)?,
ScopeDef::ModuleDef(hir::ModuleDef::TypeAlias(t)) => t.name(ctx.completion.db),
2022-04-01 18:42:21 -05:00
_ => item_name(ctx.db(), import_edit.original_item)?,
2022-06-20 13:16:40 -05:00
})
2021-06-16 08:46:58 -05:00
}
2022-06-20 13:16:40 -05:00
fn render_resolution_pat(
ctx: RenderContext<'_>,
pattern_ctx: &PatternContext,
local_name: hir::Name,
import_to_add: Option<LocatedImport>,
resolution: ScopeDef,
) -> Builder {
let _p = profile::span("render_resolution");
use hir::ModuleDef::*;
match resolution {
ScopeDef::ModuleDef(Macro(mac)) => {
let ctx = ctx.import_to_add(import_to_add);
return render_macro_pat(ctx, pattern_ctx, local_name, mac);
}
_ => (),
}
render_resolution_simple_(ctx, local_name, import_to_add, resolution)
2022-04-02 06:49:36 -05:00
}
2022-06-20 13:16:40 -05:00
fn render_resolution_path(
2021-06-09 16:43:22 -05:00
ctx: RenderContext<'_>,
path_ctx: &PathCompletionCtx,
2021-06-09 16:43:22 -05:00
local_name: hir::Name,
2022-04-01 18:42:21 -05:00
import_to_add: Option<LocatedImport>,
2021-12-21 07:07:48 -06:00
resolution: ScopeDef,
2022-04-11 11:48:27 -05:00
) -> Builder {
2021-06-09 16:43:22 -05:00
let _p = profile::span("render_resolution");
use hir::ModuleDef::*;
2022-03-16 10:32:36 -05:00
match resolution {
ScopeDef::ModuleDef(Macro(mac)) => {
let ctx = ctx.import_to_add(import_to_add);
return render_macro(ctx, path_ctx, local_name, mac);
2022-03-16 10:32:36 -05:00
}
2021-12-21 07:07:48 -06:00
ScopeDef::ModuleDef(Function(func)) => {
2022-03-16 10:32:36 -05:00
let ctx = ctx.import_to_add(import_to_add);
return render_fn(ctx, path_ctx, Some(local_name), func);
2021-06-09 16:43:22 -05:00
}
ScopeDef::ModuleDef(Variant(var)) => {
2022-03-16 10:32:36 -05:00
let ctx = ctx.clone().import_to_add(import_to_add.clone());
if let Some(item) =
render_variant_lit(ctx, path_ctx, Some(local_name.clone()), var, None)
{
return item;
}
}
2022-03-16 10:32:36 -05:00
_ => (),
}
2022-06-20 13:16:40 -05:00
let completion = ctx.completion;
let cap = ctx.snippet_cap();
2022-06-20 13:16:40 -05:00
let db = completion.db;
let config = completion.config;
let name = local_name.to_smol_str();
2022-06-20 13:16:40 -05:00
let mut item = render_resolution_simple_(ctx, local_name, import_to_add, resolution);
// Add `<>` for generic types
let type_path_no_ty_args = matches!(
path_ctx,
PathCompletionCtx { kind: PathKind::Type { .. }, has_type_args: false, .. }
) && config.callable.is_some();
if type_path_no_ty_args {
if let Some(cap) = cap {
let has_non_default_type_params = match resolution {
ScopeDef::ModuleDef(hir::ModuleDef::Adt(it)) => it.has_non_default_type_params(db),
ScopeDef::ModuleDef(hir::ModuleDef::TypeAlias(it)) => {
it.has_non_default_type_params(db)
}
_ => false,
};
2022-06-20 13:16:40 -05:00
if has_non_default_type_params {
cov_mark::hit!(inserts_angle_brackets_for_generics);
item.lookup_by(name.clone())
.label(SmolStr::from_iter([&name, "<…>"]))
.trigger_call_info()
.insert_snippet(cap, format!("{}<$0>", name));
}
}
}
2022-06-20 13:16:40 -05:00
if let ScopeDef::Local(local) = resolution {
let ty = local.ty(db);
if !ty.is_unknown() {
item.detail(ty.display(db).to_string());
}
item.set_relevance(CompletionRelevance {
type_match: compute_type_match(completion, &ty),
exact_name_match: compute_exact_name_match(completion, &name),
is_local: true,
..CompletionRelevance::default()
});
if let Some(ref_match) = compute_ref_match(completion, &ty) {
item.ref_match(ref_match, path_ctx.path.syntax().text_range().start());
}
};
item
}
fn render_resolution_simple_(
ctx: RenderContext<'_>,
local_name: hir::Name,
2022-04-01 18:42:21 -05:00
import_to_add: Option<LocatedImport>,
resolution: ScopeDef,
2022-04-11 11:48:27 -05:00
) -> Builder {
let _p = profile::span("render_resolution");
let db = ctx.db();
let ctx = ctx.import_to_add(import_to_add);
2022-06-20 13:16:40 -05:00
let kind = res_to_kind(resolution);
let mut item = CompletionItem::new(kind, ctx.source_range(), local_name.to_smol_str());
item.set_relevance(ctx.completion_relevance())
.set_documentation(scope_def_docs(db, resolution))
.set_deprecated(scope_def_is_deprecated(&ctx, resolution));
if let Some(import_to_add) = ctx.import_to_add {
item.add_import(import_to_add);
}
item
}
fn res_to_kind(resolution: ScopeDef) -> CompletionItemKind {
use hir::ModuleDef::*;
match resolution {
ScopeDef::Unknown => CompletionItemKind::UnresolvedReference,
ScopeDef::ModuleDef(Function(_)) => CompletionItemKind::SymbolKind(SymbolKind::Function),
ScopeDef::ModuleDef(Variant(_)) => CompletionItemKind::SymbolKind(SymbolKind::Variant),
ScopeDef::ModuleDef(Macro(_)) => CompletionItemKind::SymbolKind(SymbolKind::Macro),
ScopeDef::ModuleDef(Module(..)) => CompletionItemKind::SymbolKind(SymbolKind::Module),
ScopeDef::ModuleDef(Adt(adt)) => CompletionItemKind::SymbolKind(match adt {
hir::Adt::Struct(_) => SymbolKind::Struct,
hir::Adt::Union(_) => SymbolKind::Union,
hir::Adt::Enum(_) => SymbolKind::Enum,
}),
ScopeDef::ModuleDef(Const(..)) => CompletionItemKind::SymbolKind(SymbolKind::Const),
ScopeDef::ModuleDef(Static(..)) => CompletionItemKind::SymbolKind(SymbolKind::Static),
ScopeDef::ModuleDef(Trait(..)) => CompletionItemKind::SymbolKind(SymbolKind::Trait),
ScopeDef::ModuleDef(TypeAlias(..)) => CompletionItemKind::SymbolKind(SymbolKind::TypeAlias),
ScopeDef::ModuleDef(BuiltinType(..)) => CompletionItemKind::BuiltinType,
ScopeDef::GenericParam(param) => CompletionItemKind::SymbolKind(match param {
hir::GenericParam::TypeParam(_) => SymbolKind::TypeParam,
hir::GenericParam::ConstParam(_) => SymbolKind::ConstParam,
hir::GenericParam::LifetimeParam(_) => SymbolKind::LifetimeParam,
}),
ScopeDef::Local(..) => CompletionItemKind::SymbolKind(SymbolKind::Local),
ScopeDef::Label(..) => CompletionItemKind::SymbolKind(SymbolKind::Label),
ScopeDef::AdtSelfType(..) | ScopeDef::ImplSelfType(..) => {
CompletionItemKind::SymbolKind(SymbolKind::SelfParam)
}
}
2021-06-09 16:43:22 -05:00
}
2021-12-21 07:07:48 -06:00
fn scope_def_docs(db: &RootDatabase, resolution: ScopeDef) -> Option<hir::Documentation> {
2021-06-09 16:43:22 -05:00
use hir::ModuleDef::*;
match resolution {
2021-12-21 07:07:48 -06:00
ScopeDef::ModuleDef(Module(it)) => it.docs(db),
ScopeDef::ModuleDef(Adt(it)) => it.docs(db),
ScopeDef::ModuleDef(Variant(it)) => it.docs(db),
ScopeDef::ModuleDef(Const(it)) => it.docs(db),
ScopeDef::ModuleDef(Static(it)) => it.docs(db),
ScopeDef::ModuleDef(Trait(it)) => it.docs(db),
ScopeDef::ModuleDef(TypeAlias(it)) => it.docs(db),
2021-06-09 16:43:22 -05:00
_ => None,
}
2021-06-09 16:43:22 -05:00
}
2021-12-21 07:07:48 -06:00
fn scope_def_is_deprecated(ctx: &RenderContext<'_>, resolution: ScopeDef) -> bool {
2021-06-09 16:43:22 -05:00
match resolution {
2021-12-21 07:07:48 -06:00
ScopeDef::ModuleDef(it) => ctx.is_deprecated_assoc_item(it),
ScopeDef::GenericParam(it) => ctx.is_deprecated(it),
ScopeDef::AdtSelfType(it) => ctx.is_deprecated(it),
2021-06-09 16:43:22 -05:00
_ => false,
}
}
fn compute_type_match(
ctx: &CompletionContext,
completion_ty: &hir::Type,
) -> Option<CompletionRelevanceTypeMatch> {
let expected_type = ctx.expected_type.as_ref()?;
// We don't ever consider unit type to be an exact type match, since
// nearly always this is not meaningful to the user.
if expected_type.is_unit() {
return None;
}
if completion_ty == expected_type {
Some(CompletionRelevanceTypeMatch::Exact)
2021-05-15 13:18:54 -05:00
} else if expected_type.could_unify_with(ctx.db, completion_ty) {
Some(CompletionRelevanceTypeMatch::CouldUnify)
} else {
None
}
}
fn compute_exact_name_match(ctx: &CompletionContext, completion_name: &str) -> bool {
ctx.expected_name.as_ref().map_or(false, |name| name.text() == completion_name)
}
fn compute_ref_match(
ctx: &CompletionContext,
completion_ty: &hir::Type,
) -> Option<hir::Mutability> {
let expected_type = ctx.expected_type.as_ref()?;
if completion_ty != expected_type {
let expected_type_without_ref = expected_type.remove_ref()?;
if completion_ty.autoderef(ctx.db).any(|deref_ty| deref_ty == expected_type_without_ref) {
cov_mark::hit!(suggest_ref);
let mutability = if expected_type.is_mutable_reference() {
hir::Mutability::Mut
} else {
hir::Mutability::Shared
};
return Some(mutability);
};
}
None
}
#[cfg(test)]
mod tests {
use std::cmp;
use expect_test::{expect, Expect};
use ide_db::SymbolKind;
use itertools::Itertools;
use crate::{
item::CompletionRelevanceTypeMatch,
2021-06-16 14:45:02 -05:00
tests::{check_edit, do_completion, get_all_items, TEST_CONFIG},
2022-04-01 12:50:27 -05:00
CompletionItem, CompletionItemKind, CompletionRelevance, CompletionRelevancePostfixMatch,
};
#[track_caller]
fn check(ra_fixture: &str, kind: impl Into<CompletionItemKind>, expect: Expect) {
let actual = do_completion(ra_fixture, kind.into());
expect.assert_debug_eq(&actual);
}
#[track_caller]
fn check_kinds(ra_fixture: &str, kinds: &[CompletionItemKind], expect: Expect) {
let actual: Vec<_> =
kinds.iter().flat_map(|&kind| do_completion(ra_fixture, kind)).collect();
expect.assert_debug_eq(&actual);
}
#[track_caller]
fn check_relevance_for_kinds(ra_fixture: &str, kinds: &[CompletionItemKind], expect: Expect) {
2022-05-29 10:06:48 -05:00
let mut actual = get_all_items(TEST_CONFIG, ra_fixture, None);
actual.retain(|it| kinds.contains(&it.kind()));
actual.sort_by_key(|it| cmp::Reverse(it.relevance().score()));
check_relevance_(actual, expect);
}
#[track_caller]
fn check_relevance(ra_fixture: &str, expect: Expect) {
2022-05-29 10:06:48 -05:00
let mut actual = get_all_items(TEST_CONFIG, ra_fixture, None);
actual.retain(|it| it.kind() != CompletionItemKind::Snippet);
actual.retain(|it| it.kind() != CompletionItemKind::Keyword);
actual.retain(|it| it.kind() != CompletionItemKind::BuiltinType);
actual.sort_by_key(|it| cmp::Reverse(it.relevance().score()));
check_relevance_(actual, expect);
}
#[track_caller]
fn check_relevance_(actual: Vec<CompletionItem>, expect: Expect) {
let actual = actual
.into_iter()
.flat_map(|it| {
let mut items = vec![];
let tag = it.kind().tag();
let relevance = display_relevance(it.relevance());
items.push(format!("{} {} {}\n", tag, it.label(), relevance));
if let Some((mutability, _offset, relevance)) = it.ref_match() {
let label = format!("&{}{}", mutability.as_keyword_for_ref(), it.label());
let relevance = display_relevance(relevance);
items.push(format!("{} {} {}\n", tag, label, relevance));
}
items
})
.collect::<String>();
expect.assert_eq(&actual);
fn display_relevance(relevance: CompletionRelevance) -> String {
let relevance_factors = vec![
(relevance.type_match == Some(CompletionRelevanceTypeMatch::Exact), "type"),
(
relevance.type_match == Some(CompletionRelevanceTypeMatch::CouldUnify),
"type_could_unify",
),
(relevance.exact_name_match, "name"),
(relevance.is_local, "local"),
2022-04-01 12:50:27 -05:00
(
relevance.postfix_match == Some(CompletionRelevancePostfixMatch::Exact),
"snippet",
),
(relevance.is_op_method, "op_method"),
(relevance.requires_import, "requires_import"),
]
.into_iter()
.filter_map(|(cond, desc)| if cond { Some(desc) } else { None })
.join("+");
format!("[{}]", relevance_factors)
}
}
#[test]
fn enum_detail_includes_record_fields() {
check(
r#"
enum Foo { Foo { x: i32, y: i32 } }
2021-01-06 14:15:48 -06:00
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo {…}",
source_range: 54..56,
delete: 54..56,
insert: "Foo { x: ${1:()}, y: ${2:()} }$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
detail: "Foo { x: i32, y: i32 }",
},
]
"#]],
);
}
#[test]
fn enum_detail_includes_tuple_fields() {
check(
r#"
enum Foo { Foo (i32, i32) }
2021-01-06 14:15:48 -06:00
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo(…)",
source_range: 46..48,
delete: 46..48,
insert: "Foo(${1:()}, ${2:()})$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
detail: "Foo(i32, i32)",
},
]
"#]],
);
}
#[test]
fn fn_detail_includes_args_and_return_type() {
check(
r#"
fn foo<T>(a: u32, b: u32, t: T) -> (u32, T) { (a, t) }
fn main() { fo$0 }
"#,
SymbolKind::Function,
expect![[r#"
[
CompletionItem {
label: "foo(…)",
source_range: 68..70,
delete: 68..70,
insert: "foo(${1:a}, ${2:b}, ${3:t})$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "fn(u32, u32, T) -> (u32, T)",
trigger_call_info: true,
},
CompletionItem {
label: "main()",
source_range: 68..70,
delete: 68..70,
insert: "main()$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
]
"#]],
);
}
#[test]
fn enum_detail_just_name_for_unit() {
check(
r#"
enum Foo { Foo }
2021-01-06 14:15:48 -06:00
fn main() { Foo::Fo$0 }
"#,
SymbolKind::Variant,
expect![[r#"
[
CompletionItem {
label: "Foo",
source_range: 35..37,
delete: 35..37,
insert: "Foo$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
detail: "Foo",
},
]
"#]],
);
}
#[test]
fn lookup_enums_by_two_qualifiers() {
check_kinds(
r#"
mod m {
pub enum Spam { Foo, Bar(i32) }
}
2021-01-06 14:15:48 -06:00
fn main() { let _: m::Spam = S$0 }
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Function),
CompletionItemKind::SymbolKind(SymbolKind::Module),
CompletionItemKind::SymbolKind(SymbolKind::Variant),
],
expect![[r#"
[
CompletionItem {
label: "main()",
source_range: 75..76,
delete: 75..76,
insert: "main()$0",
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
CompletionItem {
label: "m",
source_range: 75..76,
delete: 75..76,
insert: "m",
kind: SymbolKind(
Module,
),
},
CompletionItem {
label: "m::Spam::Bar(…)",
source_range: 75..76,
delete: 75..76,
insert: "m::Spam::Bar(${1:()})$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
lookup: "Spam::Bar(…)",
detail: "m::Spam::Bar(i32)",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_item_from_trait: false,
2022-04-11 11:48:27 -05:00
is_name_already_imported: false,
requires_import: false,
2022-01-06 06:36:43 -06:00
is_op_method: false,
is_private_editable: false,
2022-04-01 12:50:27 -05:00
postfix_match: None,
2022-04-02 06:49:36 -05:00
is_definite: false,
},
},
CompletionItem {
label: "m::Spam::Foo",
source_range: 75..76,
delete: 75..76,
insert: "m::Spam::Foo$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
lookup: "Spam::Foo",
detail: "m::Spam::Foo",
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
Exact,
),
is_local: false,
is_item_from_trait: false,
2022-04-11 11:48:27 -05:00
is_name_already_imported: false,
requires_import: false,
2022-01-06 06:36:43 -06:00
is_op_method: false,
is_private_editable: false,
2022-04-01 12:50:27 -05:00
postfix_match: None,
2022-04-02 06:49:36 -05:00
is_definite: false,
},
},
]
"#]],
)
}
#[test]
fn sets_deprecated_flag_in_items() {
check(
r#"
#[deprecated]
fn something_deprecated() {}
2021-01-06 14:15:48 -06:00
fn main() { som$0 }
"#,
SymbolKind::Function,
expect![[r#"
[
CompletionItem {
label: "main()",
source_range: 56..59,
delete: 56..59,
insert: "main()$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Function,
),
lookup: "main",
detail: "fn()",
},
CompletionItem {
label: "something_deprecated()",
source_range: 56..59,
delete: 56..59,
insert: "something_deprecated()$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Function,
),
lookup: "something_deprecated",
detail: "fn()",
deprecated: true,
},
]
"#]],
);
check(
r#"
struct A { #[deprecated] the_field: u32 }
2021-01-06 14:15:48 -06:00
fn foo() { A { the$0 } }
"#,
SymbolKind::Field,
expect![[r#"
[
CompletionItem {
label: "the_field",
source_range: 57..60,
delete: 57..60,
insert: "the_field",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Field,
),
detail: "u32",
deprecated: true,
relevance: CompletionRelevance {
exact_name_match: false,
type_match: Some(
CouldUnify,
),
is_local: false,
is_item_from_trait: false,
2022-04-11 11:48:27 -05:00
is_name_already_imported: false,
requires_import: false,
2022-01-06 06:36:43 -06:00
is_op_method: false,
is_private_editable: false,
2022-04-01 12:50:27 -05:00
postfix_match: None,
2022-04-02 06:49:36 -05:00
is_definite: false,
},
},
]
"#]],
);
}
#[test]
fn renders_docs() {
check_kinds(
r#"
struct S {
/// Field docs
foo:
}
impl S {
/// Method docs
2021-01-06 14:15:48 -06:00
fn bar(self) { self.$0 }
}"#,
&[CompletionItemKind::Method, CompletionItemKind::SymbolKind(SymbolKind::Field)],
expect![[r#"
[
CompletionItem {
label: "bar()",
source_range: 94..94,
delete: 94..94,
insert: "bar()$0",
kind: Method,
lookup: "bar",
detail: "fn(self)",
documentation: Documentation(
"Method docs",
),
},
CompletionItem {
label: "foo",
source_range: 94..94,
delete: 94..94,
insert: "foo",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Field,
),
detail: "{unknown}",
documentation: Documentation(
"Field docs",
),
},
]
"#]],
);
check_kinds(
r#"
2021-01-06 14:15:48 -06:00
use self::my$0;
/// mod docs
mod my { }
/// enum docs
enum E {
/// variant docs
V
}
use self::E::*;
"#,
&[
CompletionItemKind::SymbolKind(SymbolKind::Module),
CompletionItemKind::SymbolKind(SymbolKind::Variant),
CompletionItemKind::SymbolKind(SymbolKind::Enum),
],
expect![[r#"
[
CompletionItem {
label: "my",
source_range: 10..12,
delete: 10..12,
insert: "my",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Module,
2021-01-20 11:46:14 -06:00
),
documentation: Documentation(
"mod docs",
),
},
CompletionItem {
label: "V",
source_range: 10..12,
delete: 10..12,
insert: "V$0",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Variant,
),
detail: "V",
documentation: Documentation(
"variant docs",
),
},
CompletionItem {
label: "E",
source_range: 10..12,
delete: 10..12,
insert: "E",
2021-01-20 11:46:14 -06:00
kind: SymbolKind(
Enum,
2021-01-20 11:46:14 -06:00
),
documentation: Documentation(
"enum docs",
),
},
]
"#]],
)
}
#[test]
fn dont_render_attrs() {
check(
r#"
struct S;
impl S {
#[inline]
fn the_method(&self) { }
}
2021-01-06 14:15:48 -06:00
fn foo(s: S) { s.$0 }
"#,
CompletionItemKind::Method,
expect![[r#"
[
CompletionItem {
label: "the_method()",
source_range: 81..81,
delete: 81..81,
insert: "the_method()$0",
kind: Method,
lookup: "the_method",
detail: "fn(&self)",
},
]
"#]],
)
}
#[test]
fn no_call_parens_if_fn_ptr_needed() {
2021-03-08 14:19:44 -06:00
cov_mark::check!(no_call_parens_if_fn_ptr_needed);
check_edit(
"foo",
r#"
fn foo(foo: u8, bar: u8) {}
struct ManualVtable { f: fn(u8, u8) }
fn main() -> ManualVtable {
2021-01-06 14:15:48 -06:00
ManualVtable { f: f$0 }
}
"#,
r#"
fn foo(foo: u8, bar: u8) {}
struct ManualVtable { f: fn(u8, u8) }
fn main() -> ManualVtable {
ManualVtable { f: foo }
}
2021-09-04 18:28:59 -05:00
"#,
);
check_edit(
"type",
r#"
struct RawIdentTable { r#type: u32 }
fn main() -> RawIdentTable {
RawIdentTable { t$0: 42 }
}
"#,
r#"
struct RawIdentTable { r#type: u32 }
fn main() -> RawIdentTable {
RawIdentTable { r#type: 42 }
}
"#,
);
}
#[test]
fn no_parens_in_use_item() {
check_edit(
"foo",
r#"
mod m { pub fn foo() {} }
2021-01-06 14:15:48 -06:00
use crate::m::f$0;
"#,
r#"
mod m { pub fn foo() {} }
use crate::m::foo;
"#,
);
}
#[test]
fn no_parens_in_call() {
check_edit(
"foo",
r#"
fn foo(x: i32) {}
2021-01-06 14:15:48 -06:00
fn main() { f$0(); }
"#,
r#"
fn foo(x: i32) {}
fn main() { foo(); }
"#,
);
check_edit(
"foo",
r#"
struct Foo;
impl Foo { fn foo(&self){} }
2021-01-06 14:15:48 -06:00
fn f(foo: &Foo) { foo.f$0(); }
"#,
r#"
struct Foo;
impl Foo { fn foo(&self){} }
fn f(foo: &Foo) { foo.foo(); }
"#,
);
}
#[test]
fn inserts_angle_brackets_for_generics() {
2021-03-08 14:19:44 -06:00
cov_mark::check!(inserts_angle_brackets_for_generics);
check_edit(
"Vec",
r#"
struct Vec<T> {}
2021-01-06 14:15:48 -06:00
fn foo(xs: Ve$0)
"#,
r#"
struct Vec<T> {}
fn foo(xs: Vec<$0>)
"#,
);
check_edit(
"Vec",
r#"
type Vec<T> = (T,);
2021-01-06 14:15:48 -06:00
fn foo(xs: Ve$0)
"#,
r#"
type Vec<T> = (T,);
fn foo(xs: Vec<$0>)
"#,
);
check_edit(
"Vec",
r#"
struct Vec<T = i128> {}
2021-01-06 14:15:48 -06:00
fn foo(xs: Ve$0)
"#,
r#"
struct Vec<T = i128> {}
fn foo(xs: Vec)
"#,
);
check_edit(
"Vec",
r#"
struct Vec<T> {}
2021-01-06 14:15:48 -06:00
fn foo(xs: Ve$0<i128>)
"#,
r#"
struct Vec<T> {}
fn foo(xs: Vec<i128>)
"#,
);
}
#[test]
2021-03-09 11:24:09 -06:00
fn active_param_relevance() {
check_relevance(
r#"
struct S { foo: i64, bar: u32, baz: u32 }
fn test(bar: u32) { }
2021-01-06 14:15:48 -06:00
fn foo(s: S) { test(s.$0) }
"#,
expect![[r#"
fd bar [type+name]
fd baz [type]
fd foo []
"#]],
);
}
#[test]
2021-03-09 11:24:09 -06:00
fn record_field_relevances() {
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
2021-01-06 14:15:48 -06:00
fn foo(a: A) { B { bar: a.$0 }; }
"#,
expect![[r#"
fd bar [type+name]
fd baz [type]
fd foo []
"#]],
)
}
#[test]
2021-03-09 11:24:09 -06:00
fn record_field_and_call_relevances() {
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
fn f(foo: i64) { }
2021-01-06 14:15:48 -06:00
fn foo(a: A) { B { bar: f(a.$0) }; }
"#,
expect![[r#"
fd foo [type+name]
fd bar []
fd baz []
"#]],
);
2021-03-09 11:24:09 -06:00
check_relevance(
r#"
struct A { foo: i64, bar: u32, baz: u32 }
struct B { x: (), y: f32, bar: u32 }
fn f(foo: i64) { }
2021-01-06 14:15:48 -06:00
fn foo(a: A) { f(B { bar: a.$0 }); }
"#,
expect![[r#"
fd bar [type+name]
fd baz [type]
fd foo []
"#]],
);
}
#[test]
fn prioritize_exact_ref_match() {
2021-03-09 11:24:09 -06:00
check_relevance(
r#"
struct WorldSnapshot { _f: () };
2021-01-06 14:15:48 -06:00
fn go(world: &WorldSnapshot) { go(w$0) }
"#,
expect![[r#"
lc world [type+name+local]
st WorldSnapshot {} []
st &WorldSnapshot {} [type]
st WorldSnapshot []
fn go() []
"#]],
);
}
#[test]
fn too_many_arguments() {
cov_mark::check!(too_many_arguments);
2021-03-09 11:24:09 -06:00
check_relevance(
r#"
struct Foo;
2021-01-06 14:15:48 -06:00
fn f(foo: &Foo) { f(foo, w$0) }
"#,
expect![[r#"
lc foo [local]
st Foo []
fn f() []
"#]],
);
}
2021-03-09 09:06:08 -06:00
2021-03-12 17:06:17 -06:00
#[test]
fn score_fn_type_and_name_match() {
check_relevance(
r#"
struct A { bar: u8 }
fn baz() -> u8 { 0 }
fn bar() -> u8 { 0 }
fn f() { A { bar: b$0 }; }
"#,
expect![[r#"
fn bar() [type+name]
2021-03-12 17:06:17 -06:00
fn baz() [type]
st A []
fn f() []
"#]],
);
}
#[test]
fn score_method_type_and_name_match() {
check_relevance(
r#"
fn baz(aaa: u32){}
struct Foo;
impl Foo {
fn aaa(&self) -> u32 { 0 }
fn bbb(&self) -> u32 { 0 }
fn ccc(&self) -> u64 { 0 }
}
fn f() {
baz(Foo.$0
}
"#,
expect![[r#"
me aaa() [type+name]
me bbb() [type]
me ccc() []
"#]],
);
}
#[test]
fn score_method_name_match_only() {
check_relevance(
r#"
fn baz(aaa: u32){}
struct Foo;
impl Foo {
fn aaa(&self) -> u64 { 0 }
}
fn f() {
baz(Foo.$0
}
"#,
expect![[r#"
me aaa() [name]
"#]],
);
}
2021-03-09 09:06:08 -06:00
#[test]
fn suggest_ref_mut() {
cov_mark::check!(suggest_ref);
check_relevance(
2021-03-09 09:06:08 -06:00
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut s = S;
foo($0);
}
"#,
expect![[r#"
lc s [name+local]
lc &mut s [type+name+local]
st S []
st &mut S [type]
st S []
fn main() []
fn foo() []
2021-03-09 09:06:08 -06:00
"#]],
);
check_relevance(
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut s = S;
foo(&mut $0);
}
"#,
expect![[r#"
lc s [type+name+local]
st S [type]
st S []
fn main() []
fn foo() []
"#]],
);
2022-01-06 13:45:09 -06:00
check_relevance(
r#"
struct S;
fn foo(s: &mut S) {}
fn main() {
let mut ssss = S;
foo(&mut s$0);
}
"#,
expect![[r#"
lc ssss [type+local]
st S [type]
2022-01-06 13:45:09 -06:00
st S []
fn main() []
fn foo() []
"#]],
);
2021-03-09 09:06:08 -06:00
}
#[test]
fn suggest_deref() {
check_relevance(
r#"
//- minicore: deref
struct S;
struct T(S);
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
fn foo(s: &S) {}
fn main() {
let t = T(S);
let m = 123;
foo($0);
}
"#,
expect![[r#"
lc m [local]
lc t [local]
lc &t [type+local]
st S []
st &S [type]
st T []
st S []
fn main() []
fn foo() []
md core []
tt Sized []
"#]],
)
}
#[test]
fn suggest_deref_mut() {
check_relevance(
r#"
2021-06-16 02:30:29 -05:00
//- minicore: deref_mut
struct S;
struct T(S);
2021-06-16 02:30:29 -05:00
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
2021-06-16 02:30:29 -05:00
impl core::ops::DerefMut for T {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
fn foo(s: &mut S) {}
fn main() {
let t = T(S);
let m = 123;
foo($0);
}
"#,
expect![[r#"
lc m [local]
lc t [local]
lc &mut t [type+local]
st S []
st &mut S [type]
st T []
st S []
fn main() []
2021-06-16 02:30:29 -05:00
fn foo() []
md core []
tt Sized []
"#]],
)
}
#[test]
fn locals() {
check_relevance(
r#"
fn foo(bar: u32) {
let baz = 0;
f$0
}
"#,
expect![[r#"
lc baz [local]
lc bar [local]
fn foo() []
"#]],
);
}
#[test]
fn enum_owned() {
check_relevance(
r#"
enum Foo { A, B }
fn foo() {
bar($0);
}
fn bar(t: Foo) {}
"#,
expect![[r#"
ev Foo::A [type]
ev Foo::B [type]
en Foo []
fn bar() []
fn foo() []
"#]],
);
}
#[test]
fn enum_ref() {
check_relevance(
r#"
enum Foo { A, B }
fn foo() {
bar($0);
}
fn bar(t: &Foo) {}
"#,
expect![[r#"
ev Foo::A []
ev &Foo::A [type]
ev Foo::B []
ev &Foo::B [type]
en Foo []
fn bar() []
fn foo() []
"#]],
);
}
#[test]
fn suggest_deref_fn_ret() {
check_relevance(
r#"
2021-06-18 14:47:02 -05:00
//- minicore: deref
struct S;
struct T(S);
2021-06-18 14:47:02 -05:00
impl core::ops::Deref for T {
type Target = S;
fn deref(&self) -> &Self::Target {
&self.0
}
}
fn foo(s: &S) {}
fn bar() -> T {}
fn main() {
foo($0);
}
2021-06-18 14:47:02 -05:00
"#,
expect![[r#"
st S []
st &S [type]
st T []
st S []
fn main() []
2021-06-18 14:47:02 -05:00
fn bar() []
fn &bar() [type]
fn foo() []
md core []
tt Sized []
"#]],
)
}
#[test]
fn op_function_relevances() {
check_relevance(
r#"
#[lang = "sub"]
trait Sub {
fn sub(self, other: Self) -> Self { self }
}
impl Sub for u32 {}
fn foo(a: u32) { a.$0 }
"#,
expect![[r#"
me sub() (as Sub) [op_method]
"#]],
);
check_relevance(
r#"
struct Foo;
impl Foo {
fn new() -> Self {}
}
#[lang = "eq"]
pub trait PartialEq<Rhs: ?Sized = Self> {
fn eq(&self, other: &Rhs) -> bool;
fn ne(&self, other: &Rhs) -> bool;
}
impl PartialEq for Foo {}
fn main() {
Foo::$0
}
"#,
expect![[r#"
fn new() []
me eq() (as PartialEq) [op_method]
me ne() (as PartialEq) [op_method]
"#]],
);
}
#[test]
fn struct_field_method_ref() {
check_kinds(
r#"
struct Foo { bar: u32 }
impl Foo { fn baz(&self) -> u32 { 0 } }
fn foo(f: Foo) { let _: &u32 = f.b$0 }
"#,
&[CompletionItemKind::Method, CompletionItemKind::SymbolKind(SymbolKind::Field)],
expect![[r#"
[
CompletionItem {
label: "baz()",
source_range: 98..99,
delete: 98..99,
insert: "baz()$0",
kind: Method,
lookup: "baz",
detail: "fn(&self) -> u32",
ref_match: "&@96",
},
CompletionItem {
label: "bar",
source_range: 98..99,
delete: 98..99,
insert: "bar",
kind: SymbolKind(
Field,
),
detail: "u32",
ref_match: "&@96",
},
]
"#]],
);
}
#[test]
fn qualified_path_ref() {
check_kinds(
r#"
struct S;
struct T;
impl T {
fn foo() -> S {}
}
fn bar(s: &S) {}
fn main() {
bar(T::$0);
}
"#,
&[CompletionItemKind::SymbolKind(SymbolKind::Function)],
expect![[r#"
[
CompletionItem {
label: "foo()",
source_range: 95..95,
delete: 95..95,
insert: "foo()$0",
kind: SymbolKind(
Function,
),
lookup: "foo",
detail: "fn() -> S",
ref_match: "&@92",
},
]
"#]],
);
}
#[test]
fn generic_enum() {
check_relevance(
r#"
enum Foo<T> { A(T), B }
// bar() should not be an exact type match
// because the generic parameters are different
fn bar() -> Foo<u8> { Foo::B }
// FIXME baz() should be an exact type match
// because the types could unify, but it currently
// is not. This is due to the T here being
// TyKind::Placeholder rather than TyKind::Missing.
fn baz<T>() -> Foo<T> { Foo::B }
fn foo() {
let foo: Foo<u32> = Foo::B;
let _: Foo<u32> = f$0;
}
"#,
expect![[r#"
lc foo [type+local]
ev Foo::A() [type_could_unify]
ev Foo::B [type_could_unify]
fn foo() []
en Foo []
fn baz() []
fn bar() []
"#]],
);
}
#[test]
fn postfix_exact_match_is_high_priority() {
cov_mark::check!(postfix_exact_match_is_high_priority);
check_relevance_for_kinds(
r#"
mod ops {
pub trait Not {
type Output;
fn not(self) -> Self::Output;
}
impl Not for bool {
type Output = bool;
fn not(self) -> bool { if self { false } else { true }}
}
}
fn main() {
let _: bool = (9 > 2).not$0;
}
"#,
&[CompletionItemKind::Snippet, CompletionItemKind::Method],
expect![[r#"
sn not [snippet]
me not() (use ops::Not) [type_could_unify+requires_import]
sn if []
sn while []
sn ref []
sn refm []
sn match []
sn box []
sn dbg []
sn dbgr []
sn call []
"#]],
);
}
#[test]
fn postfix_inexact_match_is_low_priority() {
cov_mark::check!(postfix_inexact_match_is_low_priority);
check_relevance_for_kinds(
r#"
struct S;
impl S {
fn f(&self) {}
}
fn main() {
S.$0
}
"#,
&[CompletionItemKind::Snippet, CompletionItemKind::Method],
expect![[r#"
me f() []
sn ref []
sn refm []
sn match []
sn box []
sn dbg []
sn dbgr []
sn call []
sn let []
sn letm []
"#]],
);
}
#[test]
fn flyimport_reduced_relevance() {
check_relevance(
r#"
mod std {
pub mod io {
pub trait BufRead {}
pub struct BufReader;
pub struct BufWriter;
}
}
struct Buffer;
fn f() {
Buf$0
}
"#,
expect![[r#"
md std []
st Buffer []
fn f() []
tt BufRead (use std::io::BufRead) [requires_import]
st BufReader (use std::io::BufReader) [requires_import]
st BufWriter (use std::io::BufWriter) [requires_import]
"#]],
);
}
}