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