typst_ide/

complete.rs

use std::cmp::Reverse;
use std::collections::BTreeMap;

use ecow::{EcoString, eco_format};
use rustc_hash::FxHashSet;
use serde::{Deserialize, Serialize};
use typst::foundations::{
    AsOutput, AutoValue, CastInfo, Func, Label, NativeElement, NoneValue, Output,
    ParamInfo, Repr, StyleChain, Styles, Type, Value, fields_on, repr,
};
use typst::layout::{Alignment, Dir};
use typst::syntax::ast::AstNode;
use typst::syntax::{
    FileId, LinkedNode, Side, Source, SyntaxKind, SyntaxMode, ast, is_id_continue,
    is_id_start, is_ident,
};
use typst::text::{FontFlags, RawElem};
use typst::visualize::Color;
use unscanny::Scanner;

use crate::analyze::analyze_expr_with_fallback;
use crate::docs::{find_param_docs, find_value_docs};
use crate::utils::{check_value_recursively, globals, summarize_font_family};
use crate::{IdeWorld, analyze_expr, analyze_import, analyze_labels, named_items};

/// 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.
///
/// Passing an `output` (from a previous compilation) is optional, but enhances
/// the autocompletions. Label completions, for instance, are only generated
/// when the document is available.
pub fn autocomplete(
    world: &dyn IdeWorld,
    output: Option<impl AsOutput>,
    source: &Source,
    cursor: usize,
    explicit: bool,
) -> Option<(usize, Vec<Completion>)> {
    let leaf = LinkedNode::new(source.root()).leaf_at(cursor, Side::Before)?;
    let mut ctx = CompletionContext::new(
        world,
        output.as_ref().map(|v| v.as_output()),
        source,
        &leaf,
        cursor,
        explicit,
    );

    // Getting the syntax mode also ensures we are not in a comment.
    let mode = ctx.leaf.mode_after()?;

    _ = complete_field_accesses(&mut ctx)
        || complete_open_labels(&mut ctx)
        || complete_imports(&mut ctx)
        || complete_rules(&mut ctx)
        || complete_params(&mut ctx)
        // Only attempt the general completions after the more specific ones.
        || match mode {
            SyntaxMode::Markup => complete_markup(&mut ctx),
            SyntaxMode::Math => complete_math(&mut ctx),
            SyntaxMode::Code => 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<EcoString>,
    /// An optional short description, at most one sentence.
    pub detail: Option<EcoString>,
}

/// A kind of item that can be completed.
#[derive(Debug, Clone, PartialEq, 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 file path.
    Path,
    /// A package.
    Package,
    /// A label.
    Label,
    /// A font family.
    Font,
    /// A symbol.
    Symbol(EcoString),
}

/// Complete field accesses.
fn complete_field_accesses(ctx: &mut CompletionContext) -> bool {
    let (after_dot, textual_dot) = match ctx.leaf.kind() {
        SyntaxKind::Dot => (true, false),
        SyntaxKind::Text | SyntaxKind::MathText if ctx.leaf.leaf_text() == "." => {
            (true, true)
        }
        _ => (false, false),
    };

    // After an expression plus a dot: "emoji.|".
    if after_dot
        && let Some(prev) = ctx.leaf.prev_sibling()
        // We don't complete when we had trivia between the previous node
        // and a textual dot: `[#x .|]`
        && (!textual_dot || prev.range().end == ctx.leaf.range().start)
        && prev.is::<ast::Expr>() // The dot must comes after an expression.
        // And that expression must allow field access
        && (prev.parent_kind() != Some(SyntaxKind::Markup)
            || prev.prev_sibling_kind() == Some(SyntaxKind::Hash))
        && let Some((value, styles)) = analyze_expr(ctx.world, &prev).into_iter().next()
    {
        ctx.from = ctx.cursor;
        field_access_completions(ctx, &value, &styles);
        return true;
    }

    // After a started field access: "emoji.fa|".
    if matches!(ctx.leaf.kind(), SyntaxKind::Ident | SyntaxKind::MathIdent)
        && let Some(prev) = ctx.leaf.prev_sibling()
        && prev.kind() == SyntaxKind::Dot
        && let Some(prev_prev) = prev.prev_sibling()
        && prev_prev.is::<ast::Expr>()
        && let Some((value, styles)) =
            analyze_expr(ctx.world, &prev_prev).into_iter().next()
    {
        debug_assert!(matches!(
            ctx.leaf.parent_kind(),
            Some(SyntaxKind::FieldAccess | SyntaxKind::MathFieldAccess),
        ));
        ctx.from = ctx.leaf.offset();
        field_access_completions(ctx, &value, &styles);
        return true;
    }

    false
}

/// Add completions for all fields on a value.
fn field_access_completions(
    ctx: &mut CompletionContext,
    value: &Value,
    styles: &Option<Styles>,
) {
    let scopes = {
        let ty = value.ty().scope();
        let elem = match value {
            Value::Content(content) => Some(content.elem().scope()),
            _ => None,
        };
        elem.into_iter().chain(Some(ty))
    };

    // Autocomplete methods from the element's or type's scope. We only complete
    // those which have a `self` parameter.
    for (name, binding) in scopes.flat_map(|scope| scope.iter()) {
        let Ok(func) = binding.read().clone().cast::<Func>() else { continue };
        if let Some(param) = func.params().next()
            && param.name() == Some("self")
        {
            ctx.call_completion(name.clone(), binding.read());
        }
    }

    if let Some(scope) = value.scope() {
        for (name, binding) in scope.iter() {
            ctx.call_completion(name.clone(), binding.read());
        }
    }

    for &field in 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(field, &value.field(field, ()).unwrap());
    }

    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().into()),
                        label: modifier.into(),
                        apply: None,
                        detail: None,
                    });
                }
            }
        }
        Value::Content(content) => {
            for (name, value) in content.fields() {
                ctx.value_completion(name, &value);
            }
        }
        Value::Dict(dict) => {
            for (name, value) in dict.iter() {
                ctx.value_completion(name.clone(), value);
            }
        }
        Value::Args(args) => {
            for (name, value) in args.to_named().iter() {
                ctx.value_completion(name.clone(), value);
            }
        }
        Value::Func(func) => {
            // Autocomplete get rules.
            if let Some((elem, styles)) = func.to_element().zip(styles.as_ref()) {
                for param in elem.params().iter().filter(|param| !param.required) {
                    if let Some(value) = elem.field_id(param.name).and_then(|id| {
                        elem.field_from_styles(id, StyleChain::new(styles)).ok()
                    }) {
                        ctx.value_completion(param.name, &value);
                    }
                }
            }
        }
        _ => {}
    }
}

/// Complete half-finished labels.
fn complete_open_labels(ctx: &mut CompletionContext) -> bool {
    // A label anywhere in code: "(<la|".
    if ctx.leaf.kind().is_error() && ctx.leaf.leaf_text().starts_with('<') {
        ctx.from = ctx.leaf.offset() + 1;
        ctx.label_completions();
        return true;
    }

    false
}

/// Complete imports.
fn complete_imports(ctx: &mut CompletionContext) -> bool {
    // In an import path for a file or package:
    // "#import "|",
    if let Some(SyntaxKind::ModuleImport | SyntaxKind::ModuleInclude) =
        ctx.leaf.parent_kind()
        && let Some(ast::Expr::Str(str)) = ctx.leaf.cast()
    {
        let value = str.get();
        ctx.from = ctx.leaf.offset();
        if value.starts_with('@') {
            let all_versions = value.contains(':');
            ctx.package_completions(all_versions);
        } else {
            ctx.file_completions_with_extensions(&["typ"]);
        }
        return true;
    }

    // Behind an import list:
    // "#import "path.typ": |",
    // "#import "path.typ": a, b, |".
    if let Some(prev) = ctx.leaf.prev_sibling()
        && let Some(ast::Expr::ModuleImport(import)) = prev.get().cast()
        && let Some(ast::Imports::Items(items)) = import.imports()
        && let Some(source) = prev.children().find(|child| child.is::<ast::Expr>())
    {
        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 ctx.leaf.kind() == SyntaxKind::Ident
        && let Some(parent) = ctx.leaf.parent()
        && parent.kind() == SyntaxKind::ImportItemPath
        && let Some(grand) = parent.parent()
        && grand.kind() == SyntaxKind::ImportItems
        && let Some(great) = grand.parent()
        && let Some(ast::Expr::ModuleImport(import)) = great.get().cast()
        && let Some(ast::Imports::Items(items)) = import.imports()
        && let Some(source) = great.children().find(|child| child.is::<ast::Expr>())
    {
        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, binding) in scope.iter() {
        if existing.iter().all(|item| item.original_name().as_str() != name) {
            ctx.value_completion(name.clone(), binding.read());
        }
    }
}

/// 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 let Some(prev) = ctx.leaf.prev_leaf()
        && matches!(prev.kind(), SyntaxKind::Colon)
        && matches!(prev.parent_kind(), Some(SyntaxKind::ShowRule))
    {
        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().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.to_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.
///
/// FUTURE: Make this work for math functions. This will require a much deeper
/// refactoring of `param_completions` below, including handling 2d arguments
/// correctly and ensuring we add a hash in math when suggesting to insert
/// values that aren't strings.
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, args_linked) = if let Some(parent) = ctx.leaf.parent()
        && let Some(parent) = match parent.kind() {
            SyntaxKind::Named => parent.parent(),
            _ => Some(parent),
        }
        && let Some(args) = parent.get().cast::<ast::Args>()
        && let Some(grand) = parent.parent()
        && let Some(expr) = grand.get().cast::<ast::Expr>()
        && let set = matches!(expr, ast::Expr::SetRule(_))
        && let Some(callee) = match expr {
            ast::Expr::FuncCall(call) => Some(call.callee()),
            ast::Expr::SetRule(set) => Some(set.target()),
            _ => None,
        }
        && let Some(callee) = grand.find(callee.span())
    {
        (callee, set, args, parent)
    } 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::RightParen
            | SyntaxKind::Comma
            | SyntaxKind::Colon
    ) {
        let Some(prev) = deciding.prev_leaf() else { break };
        deciding = prev;
    }

    // Parameter values: "func(param:|)", "func(param: |)".
    if let SyntaxKind::Colon = deciding.kind()
        && let Some(prev) = deciding.prev_leaf()
        && let Some(param) = prev.get().cast::<ast::Ident>()
    {
        if let Some(next) = deciding.next_leaf() {
            ctx.from = ctx.cursor.min(next.offset());
        }

        named_param_value_completions(ctx, &callee, &param);
        return true;
    }

    // Parameters: "func(|)", "func(hi|)", "func(12, |)", "func(12,|)" [explicit mode only]
    if let SyntaxKind::LeftParen | SyntaxKind::Comma = deciding.kind()
        && (deciding.kind() != SyntaxKind::Comma
            || deciding.range().end < ctx.cursor
            || ctx.explicit)
    {
        if let Some(next) = deciding.next_leaf() {
            ctx.from = ctx.cursor.min(next.offset());
        }

        param_completions(ctx, &callee, set, args, args_linked);
        return true;
    }

    false
}

/// Add completions for the parameters of a function.
fn param_completions<'a>(
    ctx: &mut CompletionContext<'a>,
    callee: &LinkedNode<'a>,
    set: bool,
    args: ast::Args<'a>,
    args_linked: &LinkedNode<'a>,
) {
    let Some(value) = analyze_expr_with_fallback(ctx.world, callee) else { return };
    let Ok(func) = value.cast::<Func>() else { return };

    // Determine which arguments are already present.
    let mut existing_positional = 0;
    let mut existing_named = FxHashSet::default();
    for arg in args.items() {
        match arg {
            ast::Arg::Pos(_) => {
                let Some(node) = args_linked.find(arg.span()) else { continue };
                if node.range().end < ctx.cursor {
                    existing_positional += 1;
                }
            }
            ast::Arg::Named(named) => {
                existing_named.insert(named.name().as_str());
            }
            _ => {}
        }
    }

    let mut skipped_positional = 0;
    for param in func.params() {
        if set && !param.settable() {
            continue;
        }

        if param.positional() {
            if skipped_positional < existing_positional && !param.variadic() {
                skipped_positional += 1;
                continue;
            }

            param_value_completions(ctx, &func, &param);
        }

        if let Some(name) = param.name()
            && param.named()
        {
            if existing_named.contains(name) {
                continue;
            }

            let apply = if param.name() == Some("caption") {
                eco_format!("{name}: [${{}}]")
            } else {
                eco_format!("{name}: ${{}}")
            };

            ctx.completions.push(Completion {
                kind: CompletionKind::Param,
                label: name.into(),
                apply: Some(apply),
                detail: find_param_docs(ctx.world, &param).map(|docs| docs.summary()),
            });
        }
    }

    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: &LinkedNode,
    name: &str,
) {
    let Some(value) = analyze_expr_with_fallback(ctx.world, callee) else { return };
    let Ok(func) = value.cast::<Func>() else { return };

    let Some(param) = func.param(name) else { return };
    if !param.named() {
        return;
    }

    param_value_completions(ctx, &func, &param);

    if ctx.before.ends_with(':') {
        ctx.enrich(" ", "");
    }
}

/// Add completions for the values of a parameter.
fn param_value_completions<'a>(
    ctx: &mut CompletionContext<'a>,
    func: &Func,
    param: &ParamInfo,
) {
    if param.name() == Some("font") {
        ctx.font_completions();
    } else if let Some(extensions) = path_completion(func, param) {
        ctx.file_completions_with_extensions(extensions);
    } else if func.name() == Some("figure") && param.name() == Some("body") {
        ctx.snippet_completion("image", "image(\"${}\"),", "An image in a figure.");
        ctx.snippet_completion("table", "table(\n  ${}\n),", "A table in a figure.");
    }

    if let ParamInfo::Native(param) = param {
        ctx.cast_completions(&param.input);
    }
}

/// Returns which file extensions to complete for the given parameter if any.
fn path_completion(func: &Func, param: &ParamInfo) -> Option<&'static [&'static str]> {
    Some(match (func.name(), param.name().unwrap_or_default()) {
        (Some("image"), "source") => {
            &["png", "jpg", "jpeg", "gif", "svg", "svgz", "webp", "pdf"]
        }
        (Some("csv"), "source") => &["csv"],
        (Some("plugin"), "source") => &["wasm"],
        (Some("cbor"), "source") => &["cbor"],
        (Some("json"), "source") => &["json"],
        (Some("toml"), "source") => &["toml"],
        (Some("xml"), "source") => &["xml"],
        (Some("yaml"), "source") => &["yml", "yaml"],
        (Some("bibliography"), "sources") => &["bib", "yml", "yaml"],
        (Some("bibliography"), "style") => &["csl"],
        (Some("cite"), "style") => &["csl"],
        (Some("raw"), "syntaxes") => &["sublime-syntax"],
        (Some("raw"), "theme") => &["tmtheme"],
        (Some("attach"), "path") if *func == typst::pdf::AttachElem::ELEM => &[],
        (None, "path") => &[],
        _ => return None,
    })
}

/// Complete in markup mode.
fn complete_markup(ctx: &mut CompletionContext) -> bool {
    debug_assert_eq!(ctx.leaf.mode_after(), Some(SyntaxMode::Markup));

    // Start of a reference: "@|".
    if ctx.leaf.kind() == SyntaxKind::Text && ctx.before.ends_with("@") {
        ctx.from = ctx.cursor;
        ctx.label_completions();
        return true;
    }

    // An existing reference: "@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 let Some(prev) = ctx.leaf.prev_leaf()
        && prev.kind() == SyntaxKind::Eq
        && prev.parent_kind() == Some(SyntaxKind::LetBinding)
    {
        ctx.from = ctx.cursor;
        code_completions(ctx, false);
        return true;
    }

    // Behind a half-completed context block: "#context |".
    if let Some(prev) = ctx.leaf.prev_leaf()
        && prev.kind() == SyntaxKind::Context
    {
        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 {
    debug_assert_eq!(ctx.leaf.mode_after(), Some(SyntaxMode::Math));

    // Behind existing atom or identifier: "$a|$" or "$abc|$".
    if matches!(ctx.leaf.kind(), SyntaxKind::MathText | 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 in code mode.
fn complete_code(ctx: &mut CompletionContext) -> bool {
    debug_assert_eq!(ctx.leaf.mode_after(), Some(SyntaxMode::Code));

    // Start of embedded code in markup or math: "[#|]", "$#|$".
    // (if not in markup or math, the kind would be an `Error`).
    if ctx.leaf.kind() == SyntaxKind::Hash {
        ctx.from = ctx.cursor;
        code_completions(ctx, true);
        return true;
    }

    // An existing identifier: "{ pa| }".
    // Ignores named pair keys as they are not variables (as in "(pa|: 23)").
    if ctx.leaf.kind() == SyntaxKind::Ident
        && (ctx.leaf.index() > 0 || ctx.leaf.parent_kind() != Some(SyntaxKind::Named))
    {
        ctx.from = ctx.leaf.offset();
        code_completions(ctx, false);
        return true;
    }

    // Anywhere: "{ | }", "(|)", "(1,|)", "(a:|)".
    // But not within or after an expression, and also not part of a dictionary
    // key (as in "(pa: |,)")
    if ctx.explicit
        && ctx.leaf.parent_kind() != Some(SyntaxKind::Dict)
        && (ctx.leaf.kind().is_trivia()
            || matches!(
                ctx.leaf.kind(),
                SyntaxKind::LeftParen
                    | SyntaxKind::LeftBrace
                    | SyntaxKind::Comma
                    | SyntaxKind::Colon
            ))
    {
        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) {
    if hash {
        ctx.scope_completions(true, |value| {
            // If we are in markup, ignore colors, directions, and alignments.
            // They are useless and bloat the autocomplete results.
            let ty = value.ty();
            ty != Type::of::<Color>()
                && ty != Type::of::<Dir>()
                && ty != Type::of::<Alignment>()
        });
    } else {
        ctx.scope_completions(true, |_| true);
    }

    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(
        "context expression",
        "context ${}",
        "Provides contextual data.",
    );

    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 \"${}\": ${}",
        "Imports variables from another file.",
    );

    ctx.snippet_completion(
        "import (package)",
        "import \"@${}\": ${}",
        "Imports variables from a package.",
    );

    ctx.snippet_completion(
        "include (file)",
        "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.",
        );
    }
}

/// See if the AST node is somewhere within a show rule applying to equations
fn is_in_equation_show_rule(leaf: &LinkedNode<'_>) -> bool {
    let mut node = leaf;
    while let Some(parent) = node.parent() {
        if let Some(expr) = parent.get().cast::<ast::Expr>()
            && let ast::Expr::ShowRule(show) = expr
            && let Some(ast::Expr::FieldAccess(field)) = show.selector()
            && field.field().as_str() == "equation"
        {
            return true;
        }
        node = parent;
    }
    false
}

/// Context for autocompletion.
struct CompletionContext<'a> {
    world: &'a (dyn IdeWorld + 'a),
    output: Option<&'a dyn Output>,
    text: &'a str,
    before: &'a str,
    after: &'a str,
    leaf: &'a LinkedNode<'a>,
    cursor: usize,
    explicit: bool,
    from: usize,
    completions: Vec<Completion>,
    seen_casts: FxHashSet<u128>,
}

impl<'a> CompletionContext<'a> {
    /// Create a new autocompletion context.
    fn new(
        world: &'a (dyn IdeWorld + 'a),
        output: Option<&'a dyn Output>,
        source: &'a Source,
        leaf: &'a LinkedNode<'a>,
        cursor: usize,
        explicit: bool,
    ) -> Self {
        let text = source.text();
        Self {
            world,
            output,
            text,
            before: &text[..cursor],
            after: &text[cursor..],
            leaf,
            cursor,
            explicit,
            from: cursor,
            completions: vec![],
            seen_casts: FxHashSet::default(),
        }
    }

    /// A small window of context before the cursor.
    fn before_window(&self, size: usize) -> &str {
        Scanner::new(self.before).get(self.cursor.saturating_sub(size)..self.cursor)
    }

    /// 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 book = self.world.book();
        let equation = is_in_equation_show_rule(self.leaf);
        for (family, iter) in book.families() {
            let variants: Vec<_> = iter.filter_map(|id| book.info(id)).collect();
            let is_math = variants.iter().any(|f| f.flags.contains(FontFlags::MATH));
            let detail = summarize_font_family(variants);
            if !equation || is_math {
                self.str_completion(
                    family,
                    Some(CompletionKind::Font),
                    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.namespace, &spec.name, Reverse(spec.version))
        });
        if !all_versions {
            packages.dedup_by_key(|(spec, _)| (&spec.namespace, &spec.name));
        }
        for (package, description) in packages {
            self.str_completion(
                eco_format!("{package}"),
                Some(CompletionKind::Package),
                description.as_deref(),
            );
        }
    }

    /// Add completions for all available files.
    fn file_completions(&mut self, mut filter: impl FnMut(FileId) -> bool) {
        let Some(current_id) = self.leaf.span().id() else { return };
        let Some(current_dir) = current_id.vpath().parent() else { return };

        let mut paths: Vec<EcoString> = self
            .world
            .files()
            .iter()
            .filter(|&&id| id != current_id && filter(id))
            .map(|id| id.vpath().relative_from(&current_dir))
            .collect();

        paths.sort();

        for path in paths {
            self.str_completion(path, Some(CompletionKind::Path), None);
        }
    }

    /// Add completions for all files with any of the given extensions.
    ///
    /// If the array is empty, all extensions are allowed.
    fn file_completions_with_extensions(&mut self, extensions: &[&str]) {
        if extensions.is_empty() {
            self.file_completions(|_| true);
        }
        self.file_completions(|id| {
            let ext = id
                .vpath()
                .extension()
                .map(EcoString::from)
                .unwrap_or_default()
                .to_lowercase();
            extensions.contains(&ext.as_str())
        });
    }

    /// Add completions for raw block tags.
    fn raw_completions(&mut self) {
        for (name, mut tags) in RawElem::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(repr::separated_list(&tags, " or ").into()),
            });
        }
    }

    /// Add completions for labels and references.
    fn label_completions(&mut self) {
        let Some(output) = self.output else { return };
        let (labels, split) = analyze_labels(output);

        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::Label,
                apply: (open || close).then(|| {
                    eco_format!(
                        "{}{}{}",
                        if open { "<" } else { "" },
                        label.resolve(),
                        if close { ">" } else { "" }
                    )
                }),
                label: label.resolve().as_str().into(),
                detail,
            });
        }
    }

    /// Add a completion for an arbitrary value.
    fn value_completion(&mut self, label: impl Into<EcoString>, value: &Value) {
        self.value_completion_full(Some(label.into()), value, false, None, None);
    }

    /// Add a completion for an arbitrary value, adding parentheses if it's a function.
    fn call_completion(&mut self, label: impl Into<EcoString>, value: &Value) {
        self.value_completion_full(Some(label.into()), value, true, None, None);
    }

    /// Add a completion for a specific string literal.
    fn str_completion(
        &mut self,
        string: impl Into<EcoString>,
        kind: Option<CompletionKind>,
        detail: Option<&str>,
    ) {
        let string = string.into();
        self.value_completion_full(None, &Value::Str(string.into()), false, kind, detail);
    }

    /// Add a completion for a specific value.
    fn value_completion_full(
        &mut self,
        label: Option<EcoString>,
        value: &Value,
        parens: bool,
        kind: Option<CompletionKind>,
        detail: Option<&str>,
    ) {
        let at = label.as_deref().is_some_and(|field| !is_ident(field));
        let label = label.unwrap_or_else(|| value.repr());

        let detail = detail.map(Into::into).or_else(|| match value {
            Value::Symbol(_) => None,
            Value::Func(_) | Value::Type(_) => {
                find_value_docs(self.world, value).map(|docs| docs.summary())
            }
            v => {
                let repr = v.repr();
                (repr.as_str() != label).then_some(repr)
            }
        });

        let mut apply = None;
        if parens
            && matches!(value, Value::Func(_))
            && !self.after.starts_with(['(', '['])
        {
            if let Value::Func(func) = value {
                let bracket_mode = if self.leaf.mode_after() == Some(SyntaxMode::Math) {
                    BracketMode::RoundWithin
                } else {
                    BracketMode::of(func)
                };
                apply = Some(match bracket_mode {
                    BracketMode::RoundAfter => eco_format!("{label}()${{}}"),
                    BracketMode::RoundWithin => eco_format!("{label}(${{}})"),
                    BracketMode::RoundNewline => eco_format!("{label}(\n  ${{}}\n)"),
                    BracketMode::SquareWithin => eco_format!("{label}[${{}}]"),
                });
            }
        } else if at {
            apply = Some(eco_format!("at(\"{label}\")"));
        } else if label.starts_with('"')
            && self.after.starts_with('"')
            && let Some(trimmed) = label.strip_suffix('"')
        {
            apply = Some(trimmed.into());
        }

        self.completions.push(Completion {
            kind: kind.unwrap_or_else(|| match value {
                Value::Func(_) => CompletionKind::Func,
                Value::Type(_) => CompletionKind::Type,
                Value::Symbol(s) => CompletionKind::Symbol(s.get().into()),
                _ => CompletionKind::Constant,
            }),
            label,
            apply,
            detail,
        });
    }

    /// Add completions for a castable.
    fn cast_completions(&mut self, cast: &CastInfo) {
        // Prevent duplicate completions from appearing.
        if !self.seen_casts.insert(typst::utils::hash128(cast)) {
            return;
        }

        match cast {
            CastInfo::Any => {}
            CastInfo::Value(value, docs) => {
                self.value_completion_full(None, value, false, None, Some(docs));
            }
            CastInfo::Type(ty) => {
                if *ty == Type::of::<NoneValue>() {
                    self.snippet_completion("none", "none", "Nothing.")
                } else if *ty == Type::of::<AutoValue>() {
                    self.snippet_completion("auto", "auto", "A smart default.");
                } else if *ty == Type::of::<bool>() {
                    self.snippet_completion("false", "false", "No / Disabled.");
                    self.snippet_completion("true", "true", "Yes / Enabled.");
                } else if *ty == Type::of::<Color>() {
                    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::<Label>() {
                    self.label_completions()
                } else if *ty == Type::of::<Func>() {
                    self.snippet_completion(
                        "function",
                        "(${params}) => ${output}",
                        "A custom function.",
                    );
                } else {
                    self.completions.push(Completion {
                        kind: CompletionKind::Syntax,
                        label: ty.long_name().into(),
                        apply: Some(eco_format!("${{{ty}}}")),
                        detail: Some(eco_format!("A value of type {ty}.")),
                    });
                    self.scope_completions(false, |value| value.ty() == *ty);
                }
            }
            CastInfo::Union(union) => {
                for info in union {
                    self.cast_completions(info);
                }
            }
        }
    }

    /// Add completions for definitions that are available at the cursor.
    ///
    /// Filters the global/math scope with the given filter.
    fn scope_completions(&mut self, parens: bool, filter: impl Fn(&Value) -> bool) {
        // When any of the constituent parts of the value matches the filter,
        // that's ok as well. For example, when autocompleting `#rect(fill: |)`,
        // we propose colors, but also dictionaries and modules that contain
        // colors.
        let filter = |value: &Value| check_value_recursively(value, &filter);

        let mut defined = BTreeMap::<EcoString, Option<Value>>::new();
        named_items(self.world, self.leaf.clone(), |item| {
            let name = item.name();
            if !name.is_empty() && item.value().as_ref().is_none_or(filter) {
                defined.insert(name.clone(), item.value());
            }

            None::<()>
        });

        for (name, value) in &defined {
            if let Some(value) = value {
                self.value_completion(name.clone(), value);
            } else {
                self.completions.push(Completion {
                    kind: CompletionKind::Constant,
                    label: name.clone(),
                    apply: None,
                    detail: None,
                });
            }
        }

        for (name, binding) in globals(self.world, self.leaf).iter() {
            let value = binding.read();
            if filter(value) && !defined.contains_key(name) {
                self.value_completion_full(Some(name.clone()), value, parens, None, None);
            }
        }
    }
}

/// What kind of parentheses to autocomplete for a function.
enum BracketMode {
    /// Round parenthesis, with the cursor within: `(|)`.
    RoundWithin,
    /// Round parenthesis, with the cursor after them: `()|`.
    RoundAfter,
    /// Round parenthesis, with newlines and indent.
    RoundNewline,
    /// Square brackets, with the cursor within: `[|]`.
    SquareWithin,
}

impl BracketMode {
    fn of(func: &Func) -> Self {
        // If we have no parameters or only the self one, it's friendlier to put
        // the cursor after the method call.
        if func.params().all(|param| param.name() == Some("self")) {
            return Self::RoundAfter;
        }

        match func.name() {
            Some(
                "emph" | "footnote" | "quote" | "strong" | "highlight" | "overline"
                | "underline" | "smallcaps" | "strike" | "sub" | "super",
            ) => Self::SquareWithin,
            Some("colbreak" | "parbreak" | "linebreak" | "pagebreak") => Self::RoundAfter,
            Some("figure" | "table" | "grid" | "stack") => Self::RoundNewline,
            _ => Self::RoundWithin,
        }
    }
}

#[cfg(test)]
mod tests {
    use std::borrow::Borrow;
    use std::collections::BTreeSet;

    use typst::foundations::AsOutput;
    use typst_layout::PagedDocument;

    use super::{Completion, CompletionKind, autocomplete};
    use crate::tests::{FilePos, TestWorld, WorldLike};

    /// Quote a string.
    macro_rules! q {
        ($s:literal) => {
            concat!("\"", $s, "\"")
        };
    }

    type Response = Option<(usize, Vec<Completion>)>;

    trait ResponseExt {
        fn completions(&self) -> &[Completion];
        fn labels(&self) -> BTreeSet<&str>;
        fn must_be_empty(&self) -> &Self;
        fn must_include<'a>(&self, includes: impl IntoIterator<Item = &'a str>) -> &Self;
        fn must_exclude<'a>(&self, excludes: impl IntoIterator<Item = &'a str>) -> &Self;
        fn at(&self, label: &str) -> &Completion;
    }

    impl ResponseExt for Response {
        fn completions(&self) -> &[Completion] {
            match self {
                Some((_, completions)) => completions.as_slice(),
                None => &[],
            }
        }

        fn labels(&self) -> BTreeSet<&str> {
            self.completions().iter().map(|c| c.label.as_str()).collect()
        }

        #[track_caller]
        fn must_be_empty(&self) -> &Self {
            let labels = self.labels();
            assert!(
                labels.is_empty(),
                "expected no suggestions (got {labels:?} instead)"
            );
            self
        }

        #[track_caller]
        fn must_include<'a>(&self, includes: impl IntoIterator<Item = &'a str>) -> &Self {
            let labels = self.labels();
            for item in includes {
                assert!(
                    labels.contains(item),
                    "{item:?} was not contained in {labels:?}",
                );
            }
            self
        }

        #[track_caller]
        fn must_exclude<'a>(&self, excludes: impl IntoIterator<Item = &'a str>) -> &Self {
            let labels = self.labels();
            for item in excludes {
                assert!(
                    !labels.contains(item),
                    "{item:?} was wrongly contained in {labels:?}",
                );
            }
            self
        }

        #[track_caller]
        fn at(&self, label: &str) -> &Completion {
            self.completions()
                .iter()
                .find(|c| c.label == label)
                .unwrap_or_else(|| panic!("found no completion for {label:?}"))
        }
    }

    trait CompletionExt {
        fn must_apply_as<'a>(&self, apply: impl Into<Option<&'a str>>) -> &Self;
        fn must_have_detail<'a>(&self, detail: impl Into<Option<&'a str>>) -> &Self;
    }

    impl CompletionExt for Completion {
        #[track_caller]
        fn must_apply_as<'a>(&self, apply: impl Into<Option<&'a str>>) -> &Self {
            assert_eq!(self.apply.as_deref(), apply.into());
            self
        }

        #[track_caller]
        fn must_have_detail<'a>(&self, detail: impl Into<Option<&'a str>>) -> &Self {
            assert_eq!(self.detail.as_deref(), detail.into());
            self
        }
    }

    #[track_caller]
    fn test(world: impl WorldLike, pos: impl FilePos) -> Response {
        let world = world.acquire();
        let world = world.borrow();
        let doc = typst::compile::<PagedDocument>(world).output.ok();
        test_with_doc(world, pos, doc.as_ref(), true)
    }

    #[track_caller]
    fn test_implicit(world: impl WorldLike, pos: impl FilePos) -> Response {
        let world = world.acquire();
        let world = world.borrow();
        let doc = typst::compile::<PagedDocument>(world).output.ok();
        test_with_doc(world, pos, doc.as_ref(), false)
    }

    #[track_caller]
    fn test_with_addition(
        initial_text: &str,
        addition: &str,
        pos: impl FilePos,
    ) -> Response {
        let mut world = TestWorld::new(initial_text);
        let doc = typst::compile::<PagedDocument>(&world).output.ok();
        let end = world.main.text().len();
        world.main.edit(end..end, addition);
        test_with_doc(&world, pos, doc.as_ref(), true)
    }

    #[track_caller]
    fn test_with_doc(
        world: impl WorldLike,
        pos: impl FilePos,
        output: Option<impl AsOutput>,
        explicit: bool,
    ) -> Response {
        let world = world.acquire();
        let world = world.borrow();
        let (source, cursor) = pos.resolve(world);
        autocomplete(world, output, &source, cursor, explicit)
    }

    #[test]
    fn test_autocomplete_hash_expr() {
        test("#", -1).must_include(["int", "if conditional"]);
        test("#i", -1).must_include(["int", "if conditional"]);
        test("$#$", -2).must_include(["int", "if conditional"]);
        test("$#i$", -2).must_include(["int", "if conditional"]);
    }

    #[test]
    fn test_autocomplete_array_method() {
        test("#().", -1).must_include(["insert", "remove", "len", "all"]);
        test("#{ let x = (1, 2, 3); x. }", -3).must_include(["at", "push", "pop"]);
    }

    /// Test that extra spaces before a '.' don't cause autocompletion in markup
    /// or math.
    #[test]
    fn test_autocomplete_dot_whitespace() {
        test("#() .", -1).must_exclude(["insert", "remove", "len", "all"]);
        test("#{() .}", -2).must_include(["insert", "remove", "len", "all"]);
        test("$#() .$", -2).must_exclude(["insert", "remove", "len", "all"]);
        test("$std.array .$", -2).must_exclude(["insert", "remove", "len", "all"]);
        test("#() .a", -1).must_exclude(["insert", "remove", "len", "all"]);
        test("#{() .a}", -2).must_include(["at", "any", "all"]);
        test("$std.array .a$", -2).must_exclude(["insert", "remove", "len", "all"]);
    }

    /// Test that autocomplete in math uses the correct global scope.
    #[test]
    fn test_autocomplete_math_scope() {
        test("$#col$", -2).must_include(["colbreak"]).must_exclude(["colon"]);
        test("$col$", -2).must_include(["colon"]).must_exclude(["colbreak"]);
        test("$(col)$", -3).must_include(["colon"]).must_exclude(["colbreak"]);
        test("$1/col$", -2).must_include(["colon"]).must_exclude(["colbreak"]);
    }

    /// Basic tests for field access autocompletion in code and math.
    #[test]
    fn test_autocomplete_field_access() {
        test("#assert.", -1).must_include(["eq", "ne"]);
        test("$#assert.$", -2).must_include(["eq", "ne"]);
        // Note that we still include `ne` even though we've started typing.
        test("#assert.e", -1).must_include(["eq", "ne"]);
        test("#(assert.e)", -2).must_include(["eq", "ne"]);
        test("$#assert.e$", -2).must_include(["eq", "ne"]);
        test("$#std.assert.e$", -2)
            .must_include(["eq", "ne"])
            .must_exclude(["lt"]);
        test("$std.assert.e$", -2)
            .must_include(["eq", "ne"])
            .must_exclude(["lt"]);
    }

    /// Test autocomplete inside math function call arguments.
    #[test]
    fn test_autocomplete_math_func_call() {
        test("$f(#pi)$", -3).must_include(["box"]).must_exclude(["pi"]);
        test("$f(pi)$", -3).must_include(["pi"]).must_exclude(["box"]);
        test("$pi()$", -4).must_include(["pi"]).must_exclude(["box"]);
        test("$pi(pi)$", -3).must_include(["pi"]).must_exclude(["box"]);
        test("$vec(pi)$", -3).must_include(["pi"]).must_exclude(["box"]);
        test("$vec(size:pi)$", -3).must_include(["pi"]).must_exclude(["box"]);
        test("$vec(..pi)$", -3).must_include(["pi"]).must_exclude(["box"]);
    }

    /// Test dict field autocompletion in code and math.
    #[test]
    fn test_autocomplete_dict_fields() {
        let with = |text| &*format!("#let dict = (a: (c: 1), b: 2); {text}").leak();
        test(with("#dict."), -1)
            .must_include(["a", "b", "keys"])
            .must_exclude(["c"]);
        test(with("$dict.$"), -2)
            .must_include(["a", "b", "keys"])
            .must_exclude(["c"]);
        test(with("#dict.b."), -1)
            .must_include(["bit-or"])
            .must_exclude(["c"]);
        test(with("$dict.b.$"), -2)
            .must_include(["bit-or"])
            .must_exclude(["c"]);
        test(with("#dict.a."), -1)
            .must_include(["c", "keys"])
            .must_exclude(["b"]);
        test(with("$dict.a.$"), -2)
            .must_include(["c", "keys"])
            .must_exclude(["b"]);
        test(with("#dict.a.c."), -1).must_include(["bit-or"]);
        test(with("$dict.a.c.$"), -2).must_include(["bit-or"]);
    }

    /// Test argument field autocompletion in code and math.
    #[test]
    fn test_autocomplete_argument_fields() {
        let with = |text| {
            &*format!("#let args = arguments(0, a: arguments(c: 1), b: 2); {text}").leak()
        };
        test(with("#args."), -1)
            .must_include(["a", "b", "pos", "named"])
            .must_exclude(["c"]);
        test(with("$args.$"), -2)
            .must_include(["a", "b", "pos", "named"])
            .must_exclude(["c"]);
        test(with("#args.b."), -1)
            .must_include(["bit-or"])
            .must_exclude(["c"]);
        test(with("$args.b.$"), -2)
            .must_include(["bit-or"])
            .must_exclude(["c"]);
        test(with("#args.at(0)."), -1).must_include(["bit-or"]);
        test(with("#args.a."), -1)
            .must_include(["c", "pos", "named"])
            .must_exclude(["b"]);
        test(with("$args.a.$"), -2)
            .must_include(["c", "pos", "named"])
            .must_exclude(["b"]);
        test(with("#args.a.c."), -1).must_include(["bit-or"]);
        test(with("$args.a.c.$"), -2).must_include(["bit-or"]);
    }

    /// Test that the `before_window` doesn't slice into invalid byte
    /// boundaries.
    #[test]
    fn test_autocomplete_before_window_char_boundary() {
        test("😀😀     #text(font: \"\")", -3);
    }

    /// Ensure that autocompletion for `#cite(|)` completes bibligraphy labels,
    /// but no other labels.
    #[test]
    fn test_autocomplete_cite_function() {
        // First compile a working file to get a document.
        let mut world =
            TestWorld::new("#bibliography(\"works.bib\") <bib>").with_asset("works.bib");
        let doc = typst::compile::<PagedDocument>(&world).output.ok();

        // Then, add the invalid `#cite` call. Had the document been invalid
        // initially, we would have no populated document to autocomplete with.
        let end = world.main.text().len();
        world.main.edit(end..end, " #cite()");

        test_with_doc(&world, -2, doc.as_ref(), true)
            .must_include(["netwok", "glacier-melt", "supplement"])
            .must_exclude(["bib"]);
    }

    #[test]
    fn test_autocomplete_ref_function() {
        test_with_addition("x<test>", " #ref(<)", -2).must_include(["test"]);
    }

    #[test]
    fn test_autocomplete_ref_shorthand() {
        test_with_addition("x<test>", " @", -1).must_include(["test"]);
    }

    #[test]
    fn test_autocomplete_ref_shorthand_with_partial_identifier() {
        test_with_addition("x<test>", " @te", -1).must_include(["test"]);
    }

    #[test]
    fn test_autocomplete_ref_identical_labels_returns_single_completion() {
        let result = test_with_addition("x<test> y<test>", " @t", -1);
        let completions = result.completions();
        let label_count =
            completions.iter().filter(|c| c.kind == CompletionKind::Label).count();
        assert_eq!(label_count, 1);
    }

    /// Test what kind of brackets we autocomplete for function calls depending
    /// on the function and existing parens.
    #[test]
    fn test_autocomplete_bracket_mode() {
        test("#", 1).at("list").must_apply_as("list(${})");
        test("#", 1).at("linebreak").must_apply_as("linebreak()${}");
        test("#", 1).at("strong").must_apply_as("strong[${}]");
        test("#", 1).at("footnote").must_apply_as("footnote[${}]");
        test("#", 1).at("figure").must_apply_as("figure(\n  ${}\n)");
        test("#", 1).at("table").must_apply_as("table(\n  ${}\n)");
        test("#()", 1).at("list").must_apply_as(None);
        test("#[]", 1).at("strong").must_apply_as(None);
        test("$$", 1).at("overline").must_apply_as("overline(${})");
    }

    /// Test that we only complete positional parameters if they aren't
    /// already present.
    #[test]
    fn test_autocomplete_positional_param() {
        // No string given yet.
        test("#numbering()", -2).must_include(["string", "integer"]);
        // String is already given.
        test("#numbering(\"foo\", )", -2)
            .must_include(["integer"])
            .must_exclude(["string"]);
        // Integer is already given, but numbering is variadic.
        test("#numbering(\"foo\", 1, )", -2)
            .must_include(["integer"])
            .must_exclude(["string"]);
        // After argument list no completions.
        test("#numbering()", -1).must_exclude(["string"]);
    }

    /// Test that autocompletion for values of known type picks up nested
    /// values.
    #[test]
    fn test_autocomplete_value_filter() {
        let world = TestWorld::new("#import \"design.typ\": clrs; #rect(fill: )")
            .with_source(
                "design.typ",
                "#let clrs = (a: red, b: blue); #let nums = (a: 1, b: 2)",
            );

        test(&world, -2)
            .must_include(["clrs", "aqua"])
            .must_exclude(["nums", "a", "b"]);
    }

    #[test]
    fn test_autocomplete_packages() {
        test("#import \"@\"", -2).must_include([q!("@preview/example:0.1.0")]);
    }

    #[test]
    fn test_autocomplete_file_path() {
        let world = TestWorld::new("#include \"\"")
            .with_source("utils.typ", "")
            .with_source("content/a.typ", "#image()")
            .with_source("content/b.typ", "#csv(\"\")")
            .with_source("content/c.typ", "#include \"\"")
            .with_source("content/d.typ", "#pdf.attach(\"\")")
            .with_source("content/e.typ", "#math.attach(\"\")")
            .with_asset_at("assets/tiger.jpg", "tiger.jpg")
            .with_asset_at("assets/rhino.png", "rhino.png")
            .with_asset_at("data/example.csv", "example.csv");

        test(&world, -2)
            .must_include([q!("content/a.typ"), q!("content/b.typ"), q!("utils.typ")])
            .must_exclude([q!("assets/tiger.jpg")]);

        test(&world, ("content/a.typ", -2))
            .must_include([q!("../assets/tiger.jpg"), q!("../assets/rhino.png")])
            .must_exclude([q!("../data/example.csv"), q!("b.typ")]);

        test(&world, ("content/b.typ", -3)).must_include([q!("../data/example.csv")]);

        test(&world, ("content/c.typ", -2))
            .must_include([q!("../main.typ"), q!("a.typ"), q!("b.typ")])
            .must_exclude([q!("c.typ")]);

        test(&world, ("content/d.typ", -2))
            .must_include([q!("../assets/tiger.jpg"), q!("../data/example.csv")]);

        test(&world, ("content/e.typ", -2)).must_exclude([q!("data/example.csv")]);
    }

    #[test]
    fn test_autocomplete_figure_snippets() {
        let res = test("#figure()", -2);
        res.at("image").must_apply_as("image(\"${}\"),");
        res.at("table").must_apply_as("table(\n  ${}\n),");

        test("#figure(cap)", -2).at("caption").must_apply_as("caption: [${}]");
    }

    #[test]
    fn test_autocomplete_import_items() {
        let world = TestWorld::new("#import \"other.typ\": ")
            .with_source("second.typ", "#import \"other.typ\": th")
            .with_source("other.typ", "#let this = 1; #let that = 2");

        test(&world, ("main.typ", 21))
            .must_include(["*", "this", "that"])
            .must_exclude(["figure"]);
        test(&world, ("second.typ", 23))
            .must_include(["this", "that"])
            .must_exclude(["*", "figure"]);
    }

    #[test]
    fn test_autocomplete_type_methods() {
        test("#\"hello\".", -1).must_include(["len", "contains"]);
        test("#table().", -1).must_exclude(["cell"]);
    }

    #[test]
    fn test_autocomplete_content_methods() {
        test("#show outline.entry: it => it.\n#outline()\n= Hi", 30)
            .must_include(["indented", "body", "page"]);
    }

    #[test]
    fn test_autocomplete_symbol_variants() {
        test("#sym.arrow.", -1)
            .must_include(["r", "dashed"])
            .must_exclude(["cases"]);
        test("$ arrow. $", -3)
            .must_include(["r", "dashed"])
            .must_exclude(["cases"]);
    }

    #[test]
    fn test_autocomplete_fonts() {
        test("#text(font:)", -2)
            .must_include([q!("Libertinus Serif"), q!("New Computer Modern Math")]);

        test("#show link: set text(font: )", -2)
            .must_include([q!("Libertinus Serif"), q!("New Computer Modern Math")]);

        test("#show math.equation: set text(font: )", -2)
            .must_include([q!("New Computer Modern Math")])
            .must_exclude([q!("Libertinus Serif")]);

        test("#show math.equation: it => { set text(font: )\nit }", -7)
            .must_include([q!("New Computer Modern Math")])
            .must_exclude([q!("Libertinus Serif")]);
    }

    #[test]
    fn test_autocomplete_typed_html() {
        test("#html.div(translate: )", -2)
            .must_include(["true", "false"])
            .must_exclude([q!("yes"), q!("no")]);
        test("#html.input(value: )", -2).must_include(["float", "string", "red", "blue"]);
        test("#html.div(role: )", -2).must_include([q!("alertdialog")]);
    }

    #[test]
    fn test_autocomplete_in_function_params_after_comma_and_colon() {
        let document = "#text(size: 12pt, [])";

        // After colon
        test(document, 11).must_include(["length"]);
        test_implicit(document, 11).must_include(["length"]);

        test(document, 12).must_include(["length"]);
        test_implicit(document, 12).must_include(["length"]);

        // After comma
        test(document, 17).must_include(["font"]);
        test_implicit(document, 17).must_be_empty();

        test(document, 18).must_include(["font"]);
        test_implicit(document, 18).must_include(["font"]);
    }

    #[test]
    fn test_autocomplete_in_list_literal() {
        let document = "#let val = 0\n#(1, \"one\")";

        // After opening paren
        test(document, 15).must_include(["color", "val"]);
        test_implicit(document, 15).must_be_empty();

        // After first element
        test(document, 16).must_be_empty();
        test_implicit(document, 16).must_be_empty();

        // After comma
        test(document, 17).must_include(["color", "val"]);
        test_implicit(document, 17).must_be_empty();

        test(document, 18).must_include(["color", "val"]);
        test_implicit(document, 18).must_be_empty();
    }

    #[test]
    fn test_autocomplete_in_dict_literal() {
        let document = "#let first = 0\n#(first: 1, second: one)";

        // After opening paren
        test(document, 17).must_be_empty();
        test_implicit(document, 17).must_be_empty();

        // After first key
        test(document, 22).must_be_empty();
        test_implicit(document, 22).must_be_empty();

        // After colon
        test(document, 23).must_include(["align", "first"]);
        test_implicit(document, 23).must_be_empty();

        test(document, 24).must_include(["align", "first"]);
        test_implicit(document, 24).must_be_empty();

        // After first value
        test(document, 25).must_be_empty();
        test_implicit(document, 25).must_be_empty();

        // After comma
        test(document, 26).must_be_empty();
        test_implicit(document, 26).must_be_empty();

        test(document, 27).must_be_empty();
        test_implicit(document, 27).must_be_empty();
    }

    #[test]
    fn test_autocomplete_in_destructuring() {
        let document = "#let value = 20\n#let (va: value) = (va: 10)";

        // At destructuring rename pattern source
        test(document, 24).must_be_empty();
        test_implicit(document, 24).must_be_empty();
    }

    #[test]
    fn test_autocomplete_user_function() {
        let world = TestWorld::new("#import \"lib.typ\"\n#lib.")
            .with_source("lib.typ", crate::tests::EXAMPLE_CLOSURE);
        let res = test(&world, -1);
        res.must_include(["foo"]);
        res.at("foo").must_have_detail("A useful function.");
    }

    #[test]
    fn test_autocomplete_user_function_params() {
        let world = TestWorld::new("#import \"lib.typ\": *\n#foo()")
            .with_source("lib.typ", crate::tests::EXAMPLE_CLOSURE);
        let res = test(&world, -2);
        res.must_include(["forest", "tree"]);
        res.at("forest").must_have_detail("More trees.");
        res.at("tree").must_have_detail("Tree with three slashes.");
    }
}