1 //! Completion for derives
2 use hir::{HasAttrs, MacroDef, MacroKind};
3 use ide_db::helpers::{import_assets::ImportAssets, insert_use::ImportScope, FamousDefs};
4 use itertools::Itertools;
5 use rustc_hash::FxHashSet;
6 use syntax::{ast, SmolStr, SyntaxKind};
9 completions::flyimport::compute_fuzzy_completion_order_key,
10 context::CompletionContext,
11 item::{CompletionItem, CompletionItemKind},
12 Completions, ImportEdit,
15 pub(super) fn complete_derive(
16 acc: &mut Completions,
17 ctx: &CompletionContext,
18 existing_derives: &[ast::Path],
20 let core = FamousDefs(&ctx.sema, ctx.krate).core();
21 let existing_derives: FxHashSet<_> = existing_derives
23 .filter_map(|path| ctx.scope.speculative_resolve_as_mac(&path))
24 .filter(|mac| mac.kind() == MacroKind::Derive)
27 for (name, mac) in get_derives_in_scope(ctx) {
28 if existing_derives.contains(&mac) {
32 let name = name.to_smol_str();
33 let (label, lookup) = match core.zip(mac.module(ctx.db).map(|it| it.krate())) {
34 // show derive dependencies for `core`/`std` derives
35 Some((core, mac_krate)) if core == mac_krate => {
36 if let Some(derive_completion) = DEFAULT_DERIVE_DEPENDENCIES
38 .find(|derive_completion| derive_completion.label == name)
40 let mut components = vec![derive_completion.label];
41 components.extend(derive_completion.dependencies.iter().filter(
45 .filter_map(|it| it.name(ctx.db))
46 .any(|it| it.to_smol_str() == dependency)
49 let lookup = components.join(", ");
50 let label = Itertools::intersperse(components.into_iter().rev(), ", ");
51 (SmolStr::from_iter(label), Some(lookup))
60 CompletionItem::new(CompletionItemKind::Attribute, ctx.source_range(), label);
61 if let Some(docs) = mac.docs(ctx.db) {
62 item.documentation(docs);
64 if let Some(lookup) = lookup {
65 item.lookup_by(lookup);
70 flyimport_attribute(acc, ctx);
73 fn get_derives_in_scope(ctx: &CompletionContext) -> Vec<(hir::Name, MacroDef)> {
74 let mut result = Vec::default();
75 ctx.process_all_names(&mut |name, scope_def| {
76 if let hir::ScopeDef::MacroDef(mac) = scope_def {
77 if mac.kind() == hir::MacroKind::Derive {
78 result.push((name, mac));
85 fn flyimport_attribute(acc: &mut Completions, ctx: &CompletionContext) -> Option<()> {
86 if ctx.token.kind() != SyntaxKind::IDENT {
89 let potential_import_name = ctx.token.to_string();
90 let module = ctx.scope.module()?;
91 let parent = ctx.token.parent()?;
92 let user_input_lowercased = potential_import_name.to_lowercase();
93 let import_assets = ImportAssets::for_fuzzy_path(
96 potential_import_name,
100 let import_scope = ImportScope::find_insert_use_container(&parent, &ctx.sema)?;
103 .search_for_imports(&ctx.sema, ctx.config.insert_use.prefix_kind)
105 .filter_map(|import| match import.original_item {
106 hir::ItemInNs::Macros(mac) => Some((import, mac)),
109 .filter(|&(_, mac)| !ctx.is_item_hidden(&hir::ItemInNs::Macros(mac)))
110 .sorted_by_key(|(import, _)| {
111 compute_fuzzy_completion_order_key(&import.import_path, &user_input_lowercased)
113 .filter_map(|(import, mac)| {
114 let mut item = CompletionItem::new(
115 CompletionItemKind::Attribute,
117 mac.name(ctx.db)?.to_smol_str(),
119 item.add_import(ImportEdit { import, scope: import_scope.clone() });
120 if let Some(docs) = mac.docs(ctx.db) {
121 item.documentation(docs);
129 struct DeriveDependencies {
131 dependencies: &'static [&'static str],
134 /// Standard Rust derives that have dependencies
135 /// (the dependencies are needed so that the main derive don't break the compilation when added)
136 const DEFAULT_DERIVE_DEPENDENCIES: &[DeriveDependencies] = &[
137 DeriveDependencies { label: "Copy", dependencies: &["Clone"] },
138 DeriveDependencies { label: "Eq", dependencies: &["PartialEq"] },
139 DeriveDependencies { label: "Ord", dependencies: &["PartialOrd", "Eq", "PartialEq"] },
140 DeriveDependencies { label: "PartialOrd", dependencies: &["PartialEq"] },