1 //! Renderer for `struct` literal.
3 use hir::{db::HirDatabase, HasAttrs, HasVisibility, Name, StructKind};
4 use ide_db::helpers::SnippetCap;
5 use itertools::Itertools;
7 use crate::{item::CompletionKind, render::RenderContext, CompletionItem, CompletionItemKind};
9 pub(crate) fn render_struct_literal(
10 ctx: RenderContext<'_>,
12 local_name: Option<Name>,
13 ) -> Option<CompletionItem> {
14 let _p = profile::span("render_struct_literal");
16 let fields = strukt.fields(ctx.db());
17 let (visible_fields, fields_omitted) = visible_fields(&ctx, &fields, strukt)?;
20 // If some fields are private you can't make `struct` literal.
24 let name = local_name.unwrap_or_else(|| strukt.name(ctx.db())).to_string();
25 let literal = render_literal(&ctx, &name, strukt.kind(ctx.db()), &visible_fields)?;
27 Some(build_completion(ctx, name, literal, strukt))
31 ctx: RenderContext<'_>,
34 def: impl HasAttrs + Copy,
36 let mut item = CompletionItem::new(CompletionKind::Snippet, ctx.source_range(), name + " {…}");
37 item.kind(CompletionItemKind::Snippet)
38 .set_documentation(ctx.docs(def))
39 .set_deprecated(ctx.is_deprecated(def))
41 if let Some(snippet_cap) = ctx.snippet_cap() {
42 item.insert_snippet(snippet_cap, literal);
44 item.insert_text(literal);
50 ctx: &RenderContext<'_>,
53 fields: &[hir::Field],
55 let mut literal = match kind {
56 StructKind::Tuple if ctx.snippet_cap().is_some() => render_tuple_as_literal(fields, name),
57 StructKind::Record => render_record_as_literal(ctx.db(), ctx.snippet_cap(), fields, name),
61 if ctx.snippet_cap().is_some() {
62 literal.push_str("$0");
67 fn render_record_as_literal(
69 snippet_cap: Option<SnippetCap>,
70 fields: &[hir::Field],
73 let fields = fields.iter();
74 if snippet_cap.is_some() {
79 .map(|(idx, field)| format!("{}: ${{{}:()}}", field.name(db), idx + 1))
86 fields.map(|field| format!("{}: ()", field.name(db))).format(", "),
92 fn render_tuple_as_literal(fields: &[hir::Field], name: &str) -> String {
95 fields.iter().enumerate().map(|(idx, _)| format!("${}", idx + 1)).format(", "),
101 ctx: &RenderContext<'_>,
102 fields: &[hir::Field],
104 ) -> Option<(Vec<hir::Field>, bool)> {
105 let module = ctx.completion.scope.module()?;
106 let n_fields = fields.len();
109 .filter(|field| field.is_visible_from(ctx.db(), module))
111 .collect::<Vec<_>>();
114 n_fields - fields.len() > 0 || item.attrs(ctx.db()).by_key("non_exhaustive").exists();
115 Some((fields, fields_omitted))