use std::cmp::Reverse; use std::collections::{BTreeSet, HashSet}; use ecow::{eco_format, EcoString}; use if_chain::if_chain; use serde::{Deserialize, Serialize}; use typst::doc::Frame; use typst::eval::repr::separated_list; use typst::eval::{ format_str, AutoValue, CastInfo, Func, Library, NoneValue, Repr, Scope, Type, Value, }; use typst::geom::Color; use typst::model::Label; use typst::syntax::{ ast, is_id_continue, is_id_start, is_ident, LinkedNode, Source, SyntaxKind, }; use typst::World; use unscanny::Scanner; use super::analyze::analyze_labels; use super::{analyze_expr, analyze_import, plain_docs_sentence, summarize_font_family}; /// Autocomplete a cursor position in a source file. /// /// Returns the position from which the completions apply and a list of /// completions. /// /// When `explicit` is `true`, the user requested the completion by pressing /// control and space or something similar. pub fn autocomplete( world: &dyn World, frames: &[Frame], source: &Source, cursor: usize, explicit: bool, ) -> Option<(usize, Vec)> { let mut ctx = CompletionContext::new(world, frames, source, cursor, explicit)?; let _ = complete_comments(&mut ctx) || complete_field_accesses(&mut ctx) || complete_open_labels(&mut ctx) || complete_imports(&mut ctx) || complete_rules(&mut ctx) || complete_params(&mut ctx) || complete_markup(&mut ctx) || complete_math(&mut ctx) || complete_code(&mut ctx); Some((ctx.from, ctx.completions)) } /// An autocompletion option. #[derive(Debug, Clone, Serialize, Deserialize)] pub struct Completion { /// The kind of item this completes to. pub kind: CompletionKind, /// The label the completion is shown with. pub label: EcoString, /// The completed version of the input, possibly described with snippet /// syntax like `${lhs} + ${rhs}`. /// /// Should default to the `label` if `None`. pub apply: Option, /// An optional short description, at most one sentence. pub detail: Option, } /// A kind of item that can be completed. #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] pub enum CompletionKind { /// A syntactical structure. Syntax, /// A function. Func, /// A type. Type, /// A function parameter. Param, /// A constant. Constant, /// A symbol. Symbol(char), } /// Complete in comments. Or rather, don't! fn complete_comments(ctx: &mut CompletionContext) -> bool { matches!(ctx.leaf.kind(), SyntaxKind::LineComment | SyntaxKind::BlockComment) } /// Complete in markup mode. fn complete_markup(ctx: &mut CompletionContext) -> bool { // Bail if we aren't even in markup. if !matches!( ctx.leaf.parent_kind(), None | Some(SyntaxKind::Markup) | Some(SyntaxKind::Ref) ) { return false; } // Start of an interpolated identifier: "#|". if ctx.leaf.kind() == SyntaxKind::Hash { ctx.from = ctx.cursor; code_completions(ctx, true); return true; } // An existing identifier: "#pa|". if ctx.leaf.kind() == SyntaxKind::Ident { ctx.from = ctx.leaf.offset(); code_completions(ctx, true); return true; } // Start of a reference: "@|" or "@he|". if ctx.leaf.kind() == SyntaxKind::RefMarker { ctx.from = ctx.leaf.offset() + 1; ctx.label_completions(); return true; } // Behind a half-completed binding: "#let x = |". if_chain! { if let Some(prev) = ctx.leaf.prev_leaf(); if prev.kind() == SyntaxKind::Eq; if prev.parent_kind() == Some(SyntaxKind::LetBinding); then { ctx.from = ctx.cursor; code_completions(ctx, false); return true; } } // Directly after a raw block. let mut s = Scanner::new(ctx.text); s.jump(ctx.leaf.offset()); if s.eat_if("```") { s.eat_while('`'); let start = s.cursor(); if s.eat_if(is_id_start) { s.eat_while(is_id_continue); } if s.cursor() == ctx.cursor { ctx.from = start; ctx.raw_completions(); } return true; } // Anywhere: "|". if ctx.explicit { ctx.from = ctx.cursor; markup_completions(ctx); return true; } false } /// Add completions for markup snippets. #[rustfmt::skip] fn markup_completions(ctx: &mut CompletionContext) { ctx.snippet_completion( "expression", "#${}", "Variables, function calls, blocks, and more.", ); ctx.snippet_completion( "linebreak", "\\\n${}", "Inserts a forced linebreak.", ); ctx.snippet_completion( "strong text", "*${strong}*", "Strongly emphasizes content by increasing the font weight.", ); ctx.snippet_completion( "emphasized text", "_${emphasized}_", "Emphasizes content by setting it in italic font style.", ); ctx.snippet_completion( "raw text", "`${text}`", "Displays text verbatim, in monospace.", ); ctx.snippet_completion( "code listing", "```${lang}\n${code}\n```", "Inserts computer code with syntax highlighting.", ); ctx.snippet_completion( "hyperlink", "https://${example.com}", "Links to a URL.", ); ctx.snippet_completion( "label", "<${name}>", "Makes the preceding element referenceable.", ); ctx.snippet_completion( "reference", "@${name}", "Inserts a reference to a label.", ); ctx.snippet_completion( "heading", "= ${title}", "Inserts a section heading.", ); ctx.snippet_completion( "list item", "- ${item}", "Inserts an item of a bullet list.", ); ctx.snippet_completion( "enumeration item", "+ ${item}", "Inserts an item of a numbered list.", ); ctx.snippet_completion( "enumeration item (numbered)", "${number}. ${item}", "Inserts an explicitly numbered list item.", ); ctx.snippet_completion( "term list item", "/ ${term}: ${description}", "Inserts an item of a term list.", ); ctx.snippet_completion( "math (inline)", "$${x}$", "Inserts an inline-level mathematical equation.", ); ctx.snippet_completion( "math (block)", "$ ${sum_x^2} $", "Inserts a block-level mathematical equation.", ); } /// Complete in math mode. fn complete_math(ctx: &mut CompletionContext) -> bool { if !matches!( ctx.leaf.parent_kind(), Some(SyntaxKind::Equation) | Some(SyntaxKind::Math) | Some(SyntaxKind::MathFrac) | Some(SyntaxKind::MathAttach) ) { return false; } // Start of an interpolated identifier: "#|". if ctx.leaf.kind() == SyntaxKind::Hash { ctx.from = ctx.cursor; code_completions(ctx, true); return true; } // Behind existing atom or identifier: "$a|$" or "$abc|$". if matches!(ctx.leaf.kind(), SyntaxKind::Text | SyntaxKind::MathIdent) { ctx.from = ctx.leaf.offset(); math_completions(ctx); return true; } // Anywhere: "$|$". if ctx.explicit { ctx.from = ctx.cursor; math_completions(ctx); return true; } false } /// Add completions for math snippets. #[rustfmt::skip] fn math_completions(ctx: &mut CompletionContext) { ctx.scope_completions(true, |_| true); ctx.snippet_completion( "subscript", "${x}_${2:2}", "Sets something in subscript.", ); ctx.snippet_completion( "superscript", "${x}^${2:2}", "Sets something in superscript.", ); ctx.snippet_completion( "fraction", "${x}/${y}", "Inserts a fraction.", ); } /// Complete field accesses. fn complete_field_accesses(ctx: &mut CompletionContext) -> bool { // Behind an expression plus dot: "emoji.|". if_chain! { if ctx.leaf.kind() == SyntaxKind::Dot || (ctx.leaf.kind() == SyntaxKind::Text && ctx.leaf.text() == "."); if ctx.leaf.range().end == ctx.cursor; if let Some(prev) = ctx.leaf.prev_sibling(); if prev.is::(); if prev.parent_kind() != Some(SyntaxKind::Markup) || prev.prev_sibling_kind() == Some(SyntaxKind::Hash); if let Some(value) = analyze_expr(ctx.world, &prev).into_iter().next(); then { ctx.from = ctx.cursor; field_access_completions(ctx, &value); return true; } } // Behind a started field access: "emoji.fa|". if_chain! { if ctx.leaf.kind() == SyntaxKind::Ident; if let Some(prev) = ctx.leaf.prev_sibling(); if prev.kind() == SyntaxKind::Dot; if let Some(prev_prev) = prev.prev_sibling(); if prev_prev.is::(); if let Some(value) = analyze_expr(ctx.world, &prev_prev).into_iter().next(); then { ctx.from = ctx.leaf.offset(); field_access_completions(ctx, &value); return true; } } false } /// Add completions for all fields on a value. fn field_access_completions(ctx: &mut CompletionContext, value: &Value) { for (name, value) in value.ty().scope().iter() { ctx.value_completion(Some(name.clone()), value, true, None); } if let Some(scope) = value.scope() { for (name, value) in scope.iter() { ctx.value_completion(Some(name.clone()), value, true, None); } } for &(method, args) in typst::eval::mutable_methods_on(value.ty()) { ctx.completions.push(Completion { kind: CompletionKind::Func, label: method.into(), apply: Some(if args { eco_format!("{method}(${{}})") } else { eco_format!("{method}()${{}}") }), detail: None, }) } for &field in typst::eval::fields_on(value.ty()) { // Complete the field name along with its value. Notes: // 1. No parentheses since function fields cannot currently be called // with method syntax; // 2. We can unwrap the field's value since it's a field belonging to // this value's type, so accessing it should not fail. ctx.value_completion( Some(field.into()), &value.field(field).unwrap(), false, None, ); } match value { Value::Symbol(symbol) => { for modifier in symbol.modifiers() { if let Ok(modified) = symbol.clone().modified(modifier) { ctx.completions.push(Completion { kind: CompletionKind::Symbol(modified.get()), label: modifier.into(), apply: None, detail: None, }); } } } Value::Content(content) => { for (name, value) in content.fields() { ctx.value_completion(Some(name.into()), &value, false, None); } } Value::Dict(dict) => { for (name, value) in dict.iter() { ctx.value_completion(Some(name.clone().into()), value, false, None); } } Value::Plugin(plugin) => { for name in plugin.iter() { ctx.completions.push(Completion { kind: CompletionKind::Func, label: name.clone(), apply: None, detail: None, }) } } _ => {} } } /// Complete half-finished labels. fn complete_open_labels(ctx: &mut CompletionContext) -> bool { // A label anywhere in code: "( bool { // In an import path for a package: // "#import "@|", if_chain! { if matches!( ctx.leaf.parent_kind(), Some(SyntaxKind::ModuleImport | SyntaxKind::ModuleInclude) ); if let Some(ast::Expr::Str(str)) = ctx.leaf.cast(); let value = str.get(); if value.starts_with('@'); then { let all_versions = value.contains(':'); ctx.from = ctx.leaf.offset(); ctx.package_completions(all_versions); return true; } } // Behind an import list: // "#import "path.typ": |", // "#import "path.typ": a, b, |". if_chain! { if let Some(prev) = ctx.leaf.prev_sibling(); if let Some(ast::Expr::Import(import)) = prev.get().cast(); if let Some(ast::Imports::Items(items)) = import.imports(); if let Some(source) = prev.children().find(|child| child.is::()); then { ctx.from = ctx.cursor; import_item_completions(ctx, items, &source); return true; } } // Behind a half-started identifier in an import list: // "#import "path.typ": thi|", if_chain! { if ctx.leaf.kind() == SyntaxKind::Ident; if let Some(parent) = ctx.leaf.parent(); if parent.kind() == SyntaxKind::ImportItems; if let Some(grand) = parent.parent(); if let Some(ast::Expr::Import(import)) = grand.get().cast(); if let Some(ast::Imports::Items(items)) = import.imports(); if let Some(source) = grand.children().find(|child| child.is::()); then { ctx.from = ctx.leaf.offset(); import_item_completions(ctx, items, &source); return true; } } false } /// Add completions for all exports of a module. fn import_item_completions<'a>( ctx: &mut CompletionContext<'a>, existing: ast::ImportItems<'a>, source: &LinkedNode, ) { let Some(value) = analyze_import(ctx.world, source) else { return }; let Some(scope) = value.scope() else { return }; if existing.iter().next().is_none() { ctx.snippet_completion("*", "*", "Import everything."); } for (name, value) in scope.iter() { if existing.iter().all(|item| item.original_name().as_str() != name) { ctx.value_completion(Some(name.clone()), value, false, None); } } } /// Complete set and show rules. fn complete_rules(ctx: &mut CompletionContext) -> bool { // We don't want to complete directly behind the keyword. if !ctx.leaf.kind().is_trivia() { return false; } let Some(prev) = ctx.leaf.prev_leaf() else { return false }; // Behind the set keyword: "set |". if matches!(prev.kind(), SyntaxKind::Set) { ctx.from = ctx.cursor; set_rule_completions(ctx); return true; } // Behind the show keyword: "show |". if matches!(prev.kind(), SyntaxKind::Show) { ctx.from = ctx.cursor; show_rule_selector_completions(ctx); return true; } // Behind a half-completed show rule: "show strong: |". if_chain! { if let Some(prev) = ctx.leaf.prev_leaf(); if matches!(prev.kind(), SyntaxKind::Colon); if matches!(prev.parent_kind(), Some(SyntaxKind::ShowRule)); then { ctx.from = ctx.cursor; show_rule_recipe_completions(ctx); return true; } } false } /// Add completions for all functions from the global scope. fn set_rule_completions(ctx: &mut CompletionContext) { ctx.scope_completions(true, |value| { matches!( value, Value::Func(func) if func.params() .unwrap_or_default() .iter() .any(|param| param.settable), ) }); } /// Add completions for selectors. fn show_rule_selector_completions(ctx: &mut CompletionContext) { ctx.scope_completions( false, |value| matches!(value, Value::Func(func) if func.element().is_some()), ); ctx.enrich("", ": "); ctx.snippet_completion( "text selector", "\"${text}\": ${}", "Replace occurrences of specific text.", ); ctx.snippet_completion( "regex selector", "regex(\"${regex}\"): ${}", "Replace matches of a regular expression.", ); } /// Add completions for recipes. fn show_rule_recipe_completions(ctx: &mut CompletionContext) { ctx.snippet_completion( "replacement", "[${content}]", "Replace the selected element with content.", ); ctx.snippet_completion( "replacement (string)", "\"${text}\"", "Replace the selected element with a string of text.", ); ctx.snippet_completion( "transformation", "element => [${content}]", "Transform the element with a function.", ); ctx.scope_completions(false, |value| matches!(value, Value::Func(_))); } /// Complete call and set rule parameters. fn complete_params(ctx: &mut CompletionContext) -> bool { // Ensure that we are in a function call or set rule's argument list. let (callee, set, args) = if_chain! { if let Some(parent) = ctx.leaf.parent(); if let Some(parent) = match parent.kind() { SyntaxKind::Named => parent.parent(), _ => Some(parent), }; if let Some(args) = parent.get().cast::(); if let Some(grand) = parent.parent(); if let Some(expr) = grand.get().cast::(); let set = matches!(expr, ast::Expr::Set(_)); if let Some(callee) = match expr { ast::Expr::FuncCall(call) => Some(call.callee()), ast::Expr::Set(set) => Some(set.target()), _ => None, }; then { (callee, set, args) } else { return false; } }; // Find the piece of syntax that decides what we're completing. let mut deciding = ctx.leaf.clone(); while !matches!( deciding.kind(), SyntaxKind::LeftParen | SyntaxKind::Comma | SyntaxKind::Colon ) { let Some(prev) = deciding.prev_leaf() else { break }; deciding = prev; } // Parameter values: "func(param:|)", "func(param: |)". if_chain! { if deciding.kind() == SyntaxKind::Colon; if let Some(prev) = deciding.prev_leaf(); if let Some(param) = prev.get().cast::(); then { if let Some(next) = deciding.next_leaf() { ctx.from = ctx.cursor.min(next.offset()); } named_param_value_completions(ctx, callee, ¶m); return true; } } // Parameters: "func(|)", "func(hi|)", "func(12,|)". if_chain! { if matches!(deciding.kind(), SyntaxKind::LeftParen | SyntaxKind::Comma); if deciding.kind() != SyntaxKind::Comma || deciding.range().end < ctx.cursor; then { if let Some(next) = deciding.next_leaf() { ctx.from = ctx.cursor.min(next.offset()); } param_completions(ctx, callee, set, args); return true; } } false } /// Add completions for the parameters of a function. fn param_completions<'a>( ctx: &mut CompletionContext<'a>, callee: ast::Expr<'a>, set: bool, args: ast::Args<'a>, ) { let Some(func) = resolve_global_callee(ctx, callee) else { return }; let Some(params) = func.params() else { return }; // Exclude named arguments which are already present. let exclude: Vec<_> = args .items() .filter_map(|arg| match arg { ast::Arg::Named(named) => Some(named.name()), _ => None, }) .collect(); for param in params { if exclude.iter().any(|ident| ident.as_str() == param.name) { continue; } if set && !param.settable { continue; } if param.named { ctx.completions.push(Completion { kind: CompletionKind::Param, label: param.name.into(), apply: Some(eco_format!("{}: ${{}}", param.name)), detail: Some(plain_docs_sentence(param.docs)), }); } if param.positional { ctx.cast_completions(¶m.input); } } if ctx.before.ends_with(',') { ctx.enrich(" ", ""); } } /// Add completions for the values of a named function parameter. fn named_param_value_completions<'a>( ctx: &mut CompletionContext<'a>, callee: ast::Expr<'a>, name: &str, ) { let Some(func) = resolve_global_callee(ctx, callee) else { return }; let Some(param) = func.param(name) else { return }; if !param.named { return; } ctx.cast_completions(¶m.input); if name == "font" { ctx.font_completions(); } if ctx.before.ends_with(':') { ctx.enrich(" ", ""); } } /// Resolve a callee expression to a global function. fn resolve_global_callee<'a>( ctx: &CompletionContext<'a>, callee: ast::Expr<'a>, ) -> Option<&'a Func> { let value = match callee { ast::Expr::Ident(ident) => ctx.global.get(&ident)?, ast::Expr::FieldAccess(access) => match access.target() { ast::Expr::Ident(target) => match ctx.global.get(&target)? { Value::Module(module) => module.field(&access.field()).ok()?, Value::Func(func) => func.field(&access.field()).ok()?, _ => return None, }, _ => return None, }, _ => return None, }; match value { Value::Func(func) => Some(func), _ => None, } } /// Complete in code mode. fn complete_code(ctx: &mut CompletionContext) -> bool { if matches!( ctx.leaf.parent_kind(), None | Some(SyntaxKind::Markup) | Some(SyntaxKind::Math) | Some(SyntaxKind::MathFrac) | Some(SyntaxKind::MathAttach) | Some(SyntaxKind::MathRoot) ) { return false; } // An existing identifier: "{ pa| }". if ctx.leaf.kind() == SyntaxKind::Ident { ctx.from = ctx.leaf.offset(); code_completions(ctx, false); return true; } // A potential label (only at the start of an argument list): "(<|". if ctx.before.ends_with("(<") { ctx.from = ctx.cursor; ctx.label_completions(); return true; } // Anywhere: "{ | }". // But not within or after an expression. if ctx.explicit && (ctx.leaf.kind().is_trivia() || matches!(ctx.leaf.kind(), SyntaxKind::LeftParen | SyntaxKind::LeftBrace)) { ctx.from = ctx.cursor; code_completions(ctx, false); return true; } false } /// Add completions for expression snippets. #[rustfmt::skip] fn code_completions(ctx: &mut CompletionContext, hash: bool) { ctx.scope_completions(true, |value| !hash || { matches!(value, Value::Symbol(_) | Value::Func(_) | Value::Type(_) | Value::Module(_)) }); ctx.snippet_completion( "function call", "${function}(${arguments})[${body}]", "Evaluates a function.", ); ctx.snippet_completion( "code block", "{ ${} }", "Inserts a nested code block.", ); ctx.snippet_completion( "content block", "[${content}]", "Switches into markup mode.", ); ctx.snippet_completion( "set rule", "set ${}", "Sets style properties on an element.", ); ctx.snippet_completion( "show rule", "show ${}", "Redefines the look of an element.", ); ctx.snippet_completion( "show rule (everything)", "show: ${}", "Transforms everything that follows.", ); ctx.snippet_completion( "let binding", "let ${name} = ${value}", "Saves a value in a variable.", ); ctx.snippet_completion( "let binding (function)", "let ${name}(${params}) = ${output}", "Defines a function.", ); ctx.snippet_completion( "if conditional", "if ${1 < 2} {\n\t${}\n}", "Computes or inserts something conditionally.", ); ctx.snippet_completion( "if-else conditional", "if ${1 < 2} {\n\t${}\n} else {\n\t${}\n}", "Computes or inserts different things based on a condition.", ); ctx.snippet_completion( "while loop", "while ${1 < 2} {\n\t${}\n}", "Computes or inserts something while a condition is met.", ); ctx.snippet_completion( "for loop", "for ${value} in ${(1, 2, 3)} {\n\t${}\n}", "Computes or inserts something for each value in a collection.", ); ctx.snippet_completion( "for loop (with key)", "for (${key}, ${value}) in ${(a: 1, b: 2)} {\n\t${}\n}", "Computes or inserts something for each key and value in a collection.", ); ctx.snippet_completion( "break", "break", "Exits early from a loop.", ); ctx.snippet_completion( "continue", "continue", "Continues with the next iteration of a loop.", ); ctx.snippet_completion( "return", "return ${output}", "Returns early from a function.", ); ctx.snippet_completion( "import (file)", "import \"${file}.typ\": ${items}", "Imports variables from another file.", ); ctx.snippet_completion( "import (package)", "import \"@${}\": ${items}", "Imports variables from another file.", ); ctx.snippet_completion( "include (file)", "include \"${file}.typ\"", "Includes content from another file.", ); ctx.snippet_completion( "include (package)", "include \"@${}\"", "Includes content from another file.", ); ctx.snippet_completion( "array literal", "(${1, 2, 3})", "Creates a sequence of values.", ); ctx.snippet_completion( "dictionary literal", "(${a: 1, b: 2})", "Creates a mapping from names to value.", ); if !hash { ctx.snippet_completion( "function", "(${params}) => ${output}", "Creates an unnamed function.", ); } } /// Context for autocompletion. struct CompletionContext<'a> { world: &'a (dyn World + 'a), frames: &'a [Frame], library: &'a Library, global: &'a Scope, math: &'a Scope, text: &'a str, before: &'a str, after: &'a str, leaf: LinkedNode<'a>, cursor: usize, explicit: bool, from: usize, completions: Vec, seen_casts: HashSet, } impl<'a> CompletionContext<'a> { /// Create a new autocompletion context. fn new( world: &'a (dyn World + 'a), frames: &'a [Frame], source: &'a Source, cursor: usize, explicit: bool, ) -> Option { let text = source.text(); let library = world.library(); let leaf = LinkedNode::new(source.root()).leaf_at(cursor)?; Some(Self { world, frames, library, global: library.global.scope(), math: library.math.scope(), text, before: &text[..cursor], after: &text[cursor..], leaf, cursor, explicit, from: cursor, completions: vec![], seen_casts: HashSet::new(), }) } /// A small window of context before the cursor. fn before_window(&self, size: usize) -> &str { &self.before[self.cursor.saturating_sub(size)..] } /// Add a prefix and suffix to all applications. fn enrich(&mut self, prefix: &str, suffix: &str) { for Completion { label, apply, .. } in &mut self.completions { let current = apply.as_ref().unwrap_or(label); *apply = Some(eco_format!("{prefix}{current}{suffix}")); } } /// Add a snippet completion. fn snippet_completion( &mut self, label: &'static str, snippet: &'static str, docs: &'static str, ) { self.completions.push(Completion { kind: CompletionKind::Syntax, label: label.into(), apply: Some(snippet.into()), detail: Some(docs.into()), }); } /// Add completions for all font families. fn font_completions(&mut self) { let equation = self.before_window(25).contains("equation"); for (family, iter) in self.world.book().families() { let detail = summarize_font_family(iter); if !equation || family.contains("Math") { self.value_completion( None, &Value::Str(family.into()), false, Some(detail.as_str()), ); } } } /// Add completions for all available packages. fn package_completions(&mut self, all_versions: bool) { let mut packages: Vec<_> = self.world.packages().iter().collect(); packages.sort_by_key(|(spec, _)| (&spec.name, Reverse(spec.version))); if !all_versions { packages.dedup_by_key(|(spec, _)| &spec.name); } for (package, description) in packages { self.value_completion( None, &Value::Str(format_str!("{package}")), false, description.as_deref(), ); } } /// Add completions for raw block tags. fn raw_completions(&mut self) { for (name, mut tags) in (self.library.items.raw_languages)() { let lower = name.to_lowercase(); if !tags.contains(&lower.as_str()) { tags.push(lower.as_str()); } tags.retain(|tag| is_ident(tag)); if tags.is_empty() { continue; } self.completions.push(Completion { kind: CompletionKind::Constant, label: name.into(), apply: Some(tags[0].into()), detail: Some(separated_list(&tags, " or ").into()), }); } } /// Add completions for labels and references. fn label_completions(&mut self) { let (labels, split) = analyze_labels(self.world, self.frames); let head = &self.text[..self.from]; let at = head.ends_with('@'); let open = !at && !head.ends_with('<'); let close = !at && !self.after.starts_with('>'); let citation = !at && self.before_window(15).contains("cite"); let (skip, take) = if at { (0, usize::MAX) } else if citation { (split, usize::MAX) } else { (0, split) }; for (label, detail) in labels.into_iter().skip(skip).take(take) { self.completions.push(Completion { kind: CompletionKind::Constant, apply: (open || close).then(|| { eco_format!( "{}{}{}", if open { "<" } else { "" }, label.as_str(), if close { ">" } else { "" } ) }), label: label.as_str().into(), detail, }); } } /// Add a completion for a specific value. fn value_completion( &mut self, label: Option, value: &Value, parens: bool, docs: Option<&str>, ) { let at = label.as_deref().map_or(false, |field| !is_ident(field)); let label = label.unwrap_or_else(|| value.repr()); let detail = docs.map(Into::into).or_else(|| match value { Value::Symbol(_) => None, Value::Func(func) => func.docs().map(plain_docs_sentence), v => { let repr = v.repr(); (repr.as_str() != label).then_some(repr) } }); let mut apply = None; if parens && matches!(value, Value::Func(_)) { if let Value::Func(func) = value { if func .params() .is_some_and(|params| params.iter().all(|param| param.name == "self")) { apply = Some(eco_format!("{label}()${{}}")); } else { apply = Some(eco_format!("{label}(${{}})")); } } } else if at { apply = Some(eco_format!("at(\"{label}\")")); } else if label.starts_with('"') && self.after.starts_with('"') { if let Some(trimmed) = label.strip_suffix('"') { apply = Some(trimmed.into()); } } self.completions.push(Completion { kind: match value { Value::Func(_) => CompletionKind::Func, Value::Type(_) => CompletionKind::Type, Value::Symbol(s) => CompletionKind::Symbol(s.get()), _ => CompletionKind::Constant, }, label, apply, detail, }); } /// Add completions for a castable. fn cast_completions(&mut self, cast: &'a CastInfo) { // Prevent duplicate completions from appearing. if !self.seen_casts.insert(typst::util::hash128(cast)) { return; } match cast { CastInfo::Any => {} CastInfo::Value(value, docs) => { self.value_completion(None, value, true, Some(docs)); } CastInfo::Type(ty) => { if *ty == Type::of::() { self.snippet_completion("none", "none", "Nothing.") } else if *ty == Type::of::() { self.snippet_completion("auto", "auto", "A smart default."); } else if *ty == Type::of::() { self.snippet_completion("false", "false", "No / Disabled."); self.snippet_completion("true", "true", "Yes / Enabled."); } else if *ty == Type::of::() { self.snippet_completion( "luma()", "luma(${v})", "A custom grayscale color.", ); self.snippet_completion( "rgb()", "rgb(${r}, ${g}, ${b}, ${a})", "A custom RGBA color.", ); self.snippet_completion( "cmyk()", "cmyk(${c}, ${m}, ${y}, ${k})", "A custom CMYK color.", ); self.snippet_completion( "oklab()", "oklab(${l}, ${a}, ${b}, ${alpha})", "A custom Oklab color.", ); self.snippet_completion( "oklch()", "oklch(${l}, ${chroma}, ${hue}, ${alpha})", "A custom Oklch color.", ); self.snippet_completion( "color.linear-rgb()", "color.linear-rgb(${r}, ${g}, ${b}, ${a})", "A custom linear RGBA color.", ); self.snippet_completion( "color.hsv()", "color.hsv(${h}, ${s}, ${v}, ${a})", "A custom HSVA color.", ); self.snippet_completion( "color.hsl()", "color.hsl(${h}, ${s}, ${l}, ${a})", "A custom HSLA color.", ); self.scope_completions(false, |value| value.ty() == *ty); } else if *ty == Type::of::