1 //! Renderer for patterns.
3 use hir::{db::HirDatabase, HasAttrs, HasVisibility, Name, StructKind};
4 use ide_db::helpers::SnippetCap;
5 use itertools::Itertools;
8 context::{ParamKind, PatternContext},
10 render::RenderContext,
11 CompletionItem, CompletionItemKind,
14 pub(crate) fn render_struct_pat(
15 ctx: RenderContext<'_>,
17 local_name: Option<Name>,
18 ) -> Option<CompletionItem> {
19 let _p = profile::span("render_struct_pat");
21 let fields = strukt.fields(ctx.db());
22 let (visible_fields, fields_omitted) = visible_fields(&ctx, &fields, strukt)?;
24 if visible_fields.is_empty() {
25 // Matching a struct without matching its fields is pointless, unlike matching a Variant without its fields
29 let name = local_name.unwrap_or_else(|| strukt.name(ctx.db())).to_string();
30 let pat = render_pat(&ctx, &name, strukt.kind(ctx.db()), &visible_fields, fields_omitted)?;
32 Some(build_completion(ctx, name, pat, strukt))
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");
43 let fields = variant.fields(ctx.db());
44 let (visible_fields, fields_omitted) = visible_fields(&ctx, &fields, variant)?;
46 let name = match &path {
47 Some(path) => path.to_string(),
48 None => local_name.unwrap_or_else(|| variant.name(ctx.db())).to_string(),
50 let pat = render_pat(&ctx, &name, variant.kind(ctx.db()), &visible_fields, fields_omitted)?;
52 Some(build_completion(ctx, name, pat, variant))
56 ctx: RenderContext<'_>,
59 def: impl HasAttrs + Copy,
61 let mut item = CompletionItem::new(CompletionKind::Snippet, ctx.source_range(), name);
62 item.kind(CompletionItemKind::Binding)
63 .set_documentation(ctx.docs(def))
64 .set_deprecated(ctx.is_deprecated(def))
66 match ctx.snippet_cap() {
67 Some(snippet_cap) => item.insert_snippet(snippet_cap, pat),
68 None => item.insert_text(pat),
74 ctx: &RenderContext<'_>,
77 fields: &[hir::Field],
80 let mut pat = match kind {
81 StructKind::Tuple if ctx.snippet_cap().is_some() => {
82 render_tuple_as_pat(fields, name, fields_omitted)
84 StructKind::Record => {
85 render_record_as_pat(ctx.db(), ctx.snippet_cap(), fields, name, fields_omitted)
91 ctx.completion.pattern_ctx,
92 Some(PatternContext { is_param: Some(ParamKind::Function), .. })
98 if ctx.snippet_cap().is_some() {
104 fn render_record_as_pat(
105 db: &dyn HirDatabase,
106 snippet_cap: Option<SnippetCap>,
107 fields: &[hir::Field],
109 fields_omitted: bool,
111 let fields = fields.iter();
112 if snippet_cap.is_some() {
117 .map(|(idx, field)| format!("{}${}", field.name(db), idx + 1))
119 if fields_omitted { ", .." } else { "" },
125 fields.map(|field| field.name(db)).format(", "),
126 if fields_omitted { ", .." } else { "" },
132 fn render_tuple_as_pat(fields: &[hir::Field], name: &str, fields_omitted: bool) -> String {
135 fields.iter().enumerate().map(|(idx, _)| format!("${}", idx + 1)).format(", "),
136 if fields_omitted { ", .." } else { "" },
142 ctx: &RenderContext<'_>,
143 fields: &[hir::Field],
145 ) -> Option<(Vec<hir::Field>, bool)> {
146 let module = ctx.completion.scope.module()?;
147 let n_fields = fields.len();
150 .filter(|field| field.is_visible_from(ctx.db(), module))
152 .collect::<Vec<_>>();
155 n_fields - fields.len() > 0 || item.attrs(ctx.db()).by_key("non_exhaustive").exists();
156 Some((fields, fields_omitted))