crates/ide_completion/src/render/pattern.rs

   1 //! Renderer for patterns.
   2
   3 use hir::{db::HirDatabase, HasAttrs, HasVisibility, Name, StructKind};
   4 use ide_db::helpers::SnippetCap;
   5 use itertools::Itertools;
   6 use syntax::SmolStr;
   7
   8 use crate::{
   9     context::{ParamKind, PatternContext},
  10     render::RenderContext,
  11     CompletionItem, CompletionItemKind,
  12 };
  13
  14 pub(crate) fn render_struct_pat(
  15     ctx: RenderContext<'_>,
  16     strukt: hir::Struct,
  17     local_name: Option<Name>,
  18 ) -> Option<CompletionItem> {
  19     let _p = profile::span("render_struct_pat");
  20
  21     let fields = strukt.fields(ctx.db());
  22     let (visible_fields, fields_omitted) = visible_fields(&ctx, &fields, strukt)?;
  23
  24     if visible_fields.is_empty() {
  25         // Matching a struct without matching its fields is pointless, unlike matching a Variant without its fields
  26         return None;
  27     }
  28
  29     let name = local_name.unwrap_or_else(|| strukt.name(ctx.db())).to_smol_str();
  30     let pat = render_pat(&ctx, &name, strukt.kind(ctx.db()), &visible_fields, fields_omitted)?;
  31
  32     Some(build_completion(ctx, name, pat, strukt))
  33 }
  34
  35 pub(crate) fn render_variant_pat(
  36     ctx: RenderContext<'_>,
  37     variant: hir::Variant,
  38     local_name: Option<Name>,
  39     path: Option<hir::ModPath>,
  40 ) -> Option<CompletionItem> {
  41     let _p = profile::span("render_variant_pat");
  42
  43     let fields = variant.fields(ctx.db());
  44     let (visible_fields, fields_omitted) = visible_fields(&ctx, &fields, variant)?;
  45
  46     let name = match &path {
  47         Some(path) => path.to_string().into(),
  48         None => local_name.unwrap_or_else(|| variant.name(ctx.db())).to_smol_str(),
  49     };
  50     let pat = render_pat(&ctx, &name, variant.kind(ctx.db()), &visible_fields, fields_omitted)?;
  51
  52     Some(build_completion(ctx, name, pat, variant))
  53 }
  54
  55 fn build_completion(
  56     ctx: RenderContext<'_>,
  57     name: SmolStr,
  58     pat: String,
  59     def: impl HasAttrs + Copy,
  60 ) -> CompletionItem {
  61     let mut item = CompletionItem::new(CompletionItemKind::Binding, ctx.source_range(), name);
  62     item.set_documentation(ctx.docs(def)).set_deprecated(ctx.is_deprecated(def)).detail(&pat);
  63     match ctx.snippet_cap() {
  64         Some(snippet_cap) => item.insert_snippet(snippet_cap, pat),
  65         None => item.insert_text(pat),
  66     };
  67     item.build()
  68 }
  69
  70 fn render_pat(
  71     ctx: &RenderContext<'_>,
  72     name: &str,
  73     kind: StructKind,
  74     fields: &[hir::Field],
  75     fields_omitted: bool,
  76 ) -> Option<String> {
  77     let mut pat = match kind {
  78         StructKind::Tuple if ctx.snippet_cap().is_some() => {
  79             render_tuple_as_pat(fields, name, fields_omitted)
  80         }
  81         StructKind::Record => {
  82             render_record_as_pat(ctx.db(), ctx.snippet_cap(), fields, name, fields_omitted)
  83         }
  84         _ => return None,
  85     };
  86
  87     if matches!(
  88         ctx.completion.pattern_ctx,
  89         Some(PatternContext { is_param: Some(ParamKind::Function), .. })
  90     ) {
  91         pat.push(':');
  92         pat.push(' ');
  93         pat.push_str(name);
  94     }
  95     if ctx.snippet_cap().is_some() {
  96         pat.push_str("$0");
  97     }
  98     Some(pat)
  99 }
 100
 101 fn render_record_as_pat(
 102     db: &dyn HirDatabase,
 103     snippet_cap: Option<SnippetCap>,
 104     fields: &[hir::Field],
 105     name: &str,
 106     fields_omitted: bool,
 107 ) -> String {
 108     let fields = fields.iter();
 109     if snippet_cap.is_some() {
 110         format!(
 111             "{name} {{ {}{} }}",
 112             fields
 113                 .enumerate()
 114                 .map(|(idx, field)| format!("{}${}", field.name(db), idx + 1))
 115                 .format(", "),
 116             if fields_omitted { ", .." } else { "" },
 117             name = name
 118         )
 119     } else {
 120         format!(
 121             "{name} {{ {}{} }}",
 122             fields.map(|field| field.name(db)).format(", "),
 123             if fields_omitted { ", .." } else { "" },
 124             name = name
 125         )
 126     }
 127 }
 128
 129 fn render_tuple_as_pat(fields: &[hir::Field], name: &str, fields_omitted: bool) -> String {
 130     format!(
 131         "{name}({}{})",
 132         fields.iter().enumerate().map(|(idx, _)| format!("${}", idx + 1)).format(", "),
 133         if fields_omitted { ", .." } else { "" },
 134         name = name
 135     )
 136 }
 137
 138 fn visible_fields(
 139     ctx: &RenderContext<'_>,
 140     fields: &[hir::Field],
 141     item: impl HasAttrs,
 142 ) -> Option<(Vec<hir::Field>, bool)> {
 143     let module = ctx.completion.scope.module()?;
 144     let n_fields = fields.len();
 145     let fields = fields
 146         .iter()
 147         .filter(|field| field.is_visible_from(ctx.db(), module))
 148         .copied()
 149         .collect::<Vec<_>>();
 150
 151     let fields_omitted =
 152         n_fields - fields.len() > 0 || item.attrs(ctx.db()).by_key("non_exhaustive").exists();
 153     Some((fields, fields_omitted))
 154 }