@mirascript/monaco 0.1.87 → 0.1.88

package/src/lsp/providers/completion-item-provider.ts

@@ -1,536 +0,0 @@
-import {
-    getVmFunctionInfo,
-    type VmValue,
-    isVmExtern,
-    isVmModule,
-    type VmFunctionInfo,
-    type VmExtern,
-    type VmModule,
-    isVmWrapper,
-    serialize,
-} from '@mirascript/mirascript';
-import { DiagnosticCode } from '@mirascript/mirascript/subtle';
-import { KEYWORDS as HELP_KEYWORDS } from '@mirascript/help';
-import {
-    type editor,
-    languages,
-    type CancellationToken,
-    type IPosition,
-    type IRange,
-    type Position,
-    Range,
-} from '../../monaco-api.js';
-import { Provider, type MonacoContext } from './base.js';
-import { strictContainsPosition, wordAt } from '../monaco-utils.js';
-import { codeblock, getDeep, valueDoc, paramsList, getField, listFields, isDeprecatedGlobal } from '../utils.js';
-import { KEYWORDS, RESERVED_KEYWORDS, REG_IDENTIFIER_FULL, REG_ORDINAL_FULL, isKeyword } from '../../constants.js';
-import type { LocalDefinition } from '../compile-result.js';
-
-const DESC_GLOBAL = '(global)';
-const DESC_LOCAL = '(local)';
-const DESC_FIELD = '(field)';
-
-const SUGGEST_KEYWORDS: string[] = [];
-
-const loadSuggestKeywords = () => {
-    if (SUGGEST_KEYWORDS.length > 0) return SUGGEST_KEYWORDS; // 已加载过
-    for (const kw of KEYWORDS) {
-        if (RESERVED_KEYWORDS.includes(kw as never)) continue; // 跳过保留关键字
-        SUGGEST_KEYWORDS.push(kw);
-    }
-    return SUGGEST_KEYWORDS;
-};
-
-const COMMON_GLOBAL_SUGGESTIONS = (
-    range: languages.CompletionItemRanges,
-    extension: boolean,
-): languages.CompletionItem[] => {
-    const suggestions: languages.CompletionItem[] = [
-        {
-            label: 'type',
-            kind: languages.CompletionItemKind.Keyword,
-            insertText: 'type',
-            commitCharacters: ['('],
-            documentation: { value: HELP_KEYWORDS.type },
-            range,
-        },
-        {
-            label: 'global',
-            kind: languages.CompletionItemKind.Keyword,
-            insertText: 'global',
-            commitCharacters: ['.', '['],
-            documentation: { value: HELP_KEYWORDS.global },
-            range,
-        },
-    ];
-    if (!extension) {
-        suggestions.push(
-            {
-                label: { label: 'if', description: 'If 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'if ${1:condition} {\n\t$0\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`if\` 表达式进行条件判断。${codeblock('if condition {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'ifelse', description: 'If-Else 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'if ${1:condition} {\n\t$0\n} else {\n\t\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`ifelse\` 表达式进行条件判断。${codeblock('if condition {\n\t// code\n} else {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'match', description: 'Match 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText:
-                    'match ${1:value} {\n\tcase ${2:case1} {\n\t\t$0\n\t}\n\tcase ${3:case2} {\n\t\t\n\t}\n\tcase _ {\n\t\t\n\t}\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`match\` 表达式进行模式匹配。${codeblock('match value {\n\tcase case1 {\n\t\t// code\n\t}\n\tcase case2 {\n\t\t// code\n\t}\n\tcase _ {\n\t\t// code\n\t}\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'loop', description: 'Loop 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'loop {\n\t$0\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`loop\` 表达式进行无限循环。${codeblock('loop {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'while', description: 'While 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'while ${1:condition} {\n\t$0\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`while\` 表达式进行条件循环。${codeblock('while condition {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'whileelse', description: 'While-Else 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'while ${1:condition} {\n\t$0\n} else {\n\t\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`whileelse\` 表达式进行条件循环。${codeblock('while condition {\n\t// code\n} else {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'for', description: 'For 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'for ${1:item} in ${2:collection} {\n\t$0\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`for\` 表达式进行迭代循环。${codeblock('for item in collection {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'forelse', description: 'For-Else 表达式' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'for ${1:item} in ${2:collection} {\n\t$0\n} else {\n\t\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`forelse\` 表达式进行迭代循环。${codeblock('for item in collection {\n\t// code\n} else {\n\t// code\n}')}`,
-                },
-                range,
-            },
-            {
-                label: { label: 'fn', description: 'Fn 语句' },
-                kind: languages.CompletionItemKind.Snippet,
-                insertText: 'fn ${1:name}(${2:params}) {\n\t$0\n}',
-                insertTextRules: languages.CompletionItemInsertTextRule.InsertAsSnippet,
-                documentation: {
-                    value: `使用 \`fn\` 语句进行函数声明。${codeblock('fn name(params) {\n\t// code\n}')}`,
-                },
-                range,
-            },
-        );
-
-        for (const kw of loadSuggestKeywords()) {
-            const exist = suggestions.some(
-                (item) => item.label === kw && item.kind === languages.CompletionItemKind.Keyword,
-            );
-            if (exist) continue;
-            suggestions.push(kwSuggestion(kw, range));
-        }
-    }
-    return suggestions;
-};
-
-/** 构造关键字选项 */
-function kwSuggestion(kw: string, range: languages.CompletionItemRanges): languages.CompletionItem {
-    const doc = (HELP_KEYWORDS as Record<string, string | undefined>)[kw];
-    return {
-        label: kw,
-        kind: languages.CompletionItemKind.Keyword,
-        insertText: kw,
-        documentation: doc ? { value: doc } : undefined,
-        range,
-    };
-}
-
-/** 扩展完成项 */
-interface CustomCompletionItem extends languages.CompletionItem {
-    /** 是否为字段 */
-    isField: boolean;
-    /** 对应的父值 */
-    vmParent?: MonacoContext | VmExtern | VmModule;
-    /** 对应的变量值 */
-    vmValue?: VmValue;
-}
-
-/** 构造 filterText */
-function filterText(key: string, char: string | undefined): string {
-    if (char == null || key.startsWith(char)) return key;
-    if (key.startsWith('@')) return key.replace(/^@+/, '');
-    if (key.startsWith('$')) return key.replace(/^\$+/, '');
-    return key;
-}
-
-/** 构造选项 */
-function completion(
-    model: editor.ITextModel,
-    description: string,
-    key: string,
-    value: VmValue | undefined,
-    fn: VmFunctionInfo | LocalDefinition['fn'] | undefined,
-    field: boolean,
-): Pick<CustomCompletionItem, 'label' | 'kind' | 'commitCharacters' | 'vmValue' | 'isField'> {
-    let detail = '';
-    let kind: languages.CompletionItemKind;
-    if (fn == null && typeof value == 'function') {
-        fn = getVmFunctionInfo(value);
-    }
-    if (fn != null) {
-        detail = paramsList(model, fn);
-        kind = field ? languages.CompletionItemKind.Function : languages.CompletionItemKind.Method;
-    } else if (isVmModule(value)) {
-        kind = languages.CompletionItemKind.Module;
-    } else if (isVmExtern(value) && typeof value.value == 'function') {
-        if (value.value.prototype != null && (key[0] ?? '').toUpperCase() === key[0]) {
-            kind = languages.CompletionItemKind.Class;
-        } else {
-            detail = '(..)';
-            kind = value.thisArg ? languages.CompletionItemKind.Method : languages.CompletionItemKind.Function;
-        }
-    } else if (!field && key.startsWith('@')) {
-        kind = languages.CompletionItemKind.Constant;
-    } else {
-        kind = field ? languages.CompletionItemKind.Field : languages.CompletionItemKind.Variable;
-    }
-    return {
-        label: { label: key, description, detail },
-        kind,
-        commitCharacters: fn ? ['!', '('] : ['!', '.', '[', '('],
-        vmValue: value,
-        isField: field,
-    };
-}
-
-/**
- * 自动完成
- */
-export class CompletionItemProvider extends Provider implements languages.CompletionItemProvider {
-    readonly triggerCharacters: string[] = ['.', ':'];
-    /** 查找全局变量 */
-    private async completeGlobal(
-        model: editor.ITextModel,
-        char: string | undefined,
-        locals: readonly CustomCompletionItem[],
-        range: languages.CompletionItemRanges,
-        hasGlobalPrefix: boolean,
-    ): Promise<CustomCompletionItem[]> {
-        const global = await this.getContext(model);
-        const suggestions: CustomCompletionItem[] = [];
-        const localKeys = new Set(locals.map((item) => item.insertText));
-        for (const key of new Set(global.keys())) {
-            if (!global.has(key)) continue;
-            const element = global.get(key);
-
-            let prefix = key;
-            const edits: editor.ISingleEditOperation[] = [];
-            if (!REG_IDENTIFIER_FULL.test(key)) {
-                const kStr = serialize(key);
-                if (hasGlobalPrefix) {
-                    prefix = `[${kStr}]`;
-                    // 删除多余的 . 前缀
-                    edits.push({
-                        range: {
-                            startLineNumber: range.replace.startLineNumber,
-                            startColumn: range.replace.startColumn - 1,
-                            endLineNumber: range.replace.endLineNumber,
-                            endColumn: range.replace.endColumn,
-                        },
-                        text: '',
-                    });
-                } else {
-                    prefix = `global[${serialize(key)}]`;
-                }
-            } else if (!hasGlobalPrefix && (localKeys.has(key) || isKeyword(key))) {
-                prefix = `global.${key}`;
-            }
-
-            if (isVmModule(element)) {
-                for (const f of element.keys()) {
-                    if (char && !f.toLowerCase().includes(char)) {
-                        continue;
-                    }
-                    const field = element.get(f);
-                    if (field === undefined) continue;
-
-                    suggestions.push({
-                        insertText: `${prefix}.${f}`,
-                        filterText: filterText(f, char),
-                        range,
-                        additionalTextEdits: edits,
-                        vmParent: element,
-                        ...completion(model, DESC_GLOBAL, `${key}.${f}`, field, undefined, true),
-                    });
-                }
-            }
-
-            if (char && !key.toLowerCase().includes(char)) {
-                continue;
-            }
-
-            if (isDeprecatedGlobal(global, key)) {
-                // skip deprecated globals in completion
-                continue;
-            }
-            suggestions.push({
-                insertText: prefix,
-                filterText: filterText(key, char),
-                range,
-                additionalTextEdits: edits,
-                vmParent: global,
-                ...completion(model, DESC_GLOBAL, key, element, undefined, false),
-            });
-        }
-        return suggestions;
-    }
-    /** 查找局部变量 */
-    private async completeLocal(
-        model: editor.ITextModel,
-        position: IPosition,
-        char: string | undefined,
-        range: languages.CompletionItemRanges,
-    ): Promise<CustomCompletionItem[]> {
-        const compiled = await this.getCompileResult(model);
-        if (!compiled) return [];
-        const suggestions: CustomCompletionItem[] = [];
-
-        let scope = compiled.scopeAt(model, position);
-        const locals = new Set<string>();
-        while (scope) {
-            for (const { definition, fn } of scope.locals) {
-                const name =
-                    definition.code === DiagnosticCode.ParameterIt ? 'it' : model.getValueInRange(definition.range);
-                if (char && !name.toLowerCase().includes(char)) continue;
-                if (locals.has(name)) continue; // 子作用域可能会覆盖父作用域的变量
-
-                locals.add(name);
-                const suggestion = {
-                    insertText: name,
-                    filterText: filterText(name, char),
-                    range,
-                    ...completion(model, DESC_LOCAL, name, undefined, fn, false),
-                };
-                if (definition.code === DiagnosticCode.LocalModule) {
-                    suggestion.kind = languages.CompletionItemKind.Module;
-                } else if (definition.code === DiagnosticCode.LocalFunction) {
-                    suggestion.kind = languages.CompletionItemKind.Function;
-                }
-                suggestions.push(suggestion);
-            }
-            if (!scope.parent) break;
-            scope = scope.parent;
-        }
-        return suggestions;
-    }
-
-    /** 查找变量字段 */
-    private async completeFields(
-        model: editor.ITextModel,
-        position: Position,
-        char: string | undefined,
-        range: languages.CompletionItemRanges,
-    ): Promise<CustomCompletionItem[]> {
-        const compiled = await this.getCompileResult(model);
-        if (!compiled) return [];
-        const access = compiled.fieldAccessAt(model, position);
-        if (!access || access.fields.length === 0) return [];
-        const { def, fields } = access;
-        if ('definition' in def.def) {
-            // TODO: suggests local item fields
-            return [];
-        }
-        const vmGlobal = await this.getContext(model);
-        fields.pop(); // 移除最后一个部分，因为它是当前输入位置的字段名
-        const [, value] = getDeep(vmGlobal, def.def.name, fields);
-        if (value == null || typeof value != 'object') {
-            return [];
-        }
-        const keys = listFields(value, true);
-        const result: CustomCompletionItem[] = [];
-        for (const k of keys) {
-            const key = String(k);
-            if (char && !String(key).toLowerCase().includes(char)) {
-                continue;
-            }
-            if (!REG_IDENTIFIER_FULL.test(key) && !REG_ORDINAL_FULL.test(key)) {
-                continue;
-            }
-            const field = getField(value, key);
-            result.push({
-                insertText: key,
-                range,
-                vmParent: isVmWrapper(value) ? value : undefined,
-                ...completion(model, DESC_FIELD, key, field, undefined, true),
-            });
-        }
-        return result;
-    }
-
-    /** 获取完成范围 */
-    private toCompletionItemRanges(position: IPosition, range: IRange): languages.CompletionItemRanges {
-        return {
-            replace: range,
-            insert: Range.fromPositions(Range.getStartPosition(range), position),
-        };
-    }
-
-    /** @inheritdoc */
-    async provideCompletionItems(
-        model: editor.ITextModel,
-        position: Position,
-        context: languages.CompletionContext,
-        token: CancellationToken,
-    ): Promise<languages.CompletionList | undefined> {
-        const compiled = await this.getCompileResult(model);
-        if (!compiled) return undefined;
-
-        if (context.triggerCharacter === '.') {
-            const prevWord = model.getWordAtPosition({
-                lineNumber: position.lineNumber,
-                column: position.column - 1,
-            });
-            if (prevWord?.word === 'global') {
-                const globals = await this.completeGlobal(
-                    model,
-                    undefined,
-                    [],
-                    this.toCompletionItemRanges(position, {
-                        startLineNumber: position.lineNumber,
-                        startColumn: position.column,
-                        endLineNumber: position.lineNumber,
-                        endColumn: position.column,
-                    }),
-                    true,
-                );
-                return { suggestions: globals };
-            }
-        }
-
-        const word = wordAt(model, position);
-        const prev = model.getValueInRange({
-            startLineNumber: position.lineNumber,
-            startColumn: (word?.range.startColumn ?? position.column) - 2,
-            endLineNumber: position.lineNumber,
-            endColumn: word?.range.startColumn ?? position.column,
-        });
-
-        if (prev !== '::' && context.triggerCharacter === ':') {
-            return undefined; // 不是 :: 触发的
-        }
-
-        // suggest variables
-        let char: string | undefined;
-        let range: IRange;
-        const def = compiled.variableAccessAt(model, position);
-        if (def) {
-            if (def.ref == null) {
-                // 输入位置是变量定义
-                const suggestions: languages.CompletionItem[] = [];
-                if (
-                    word &&
-                    compiled.tags.some(
-                        (t) => strictContainsPosition(t.range, position) && t.code === DiagnosticCode.MatchExpression,
-                    )
-                ) {
-                    suggestions.push(
-                        kwSuggestion('case', this.toCompletionItemRanges(position, word.range)),
-                        kwSuggestion('if', this.toCompletionItemRanges(position, word.range)),
-                    );
-                }
-                return { suggestions };
-            }
-            const d = def.def;
-            range = d.references[def.ref]!.range;
-            char = model.getValueInRange({
-                startLineNumber: range.startLineNumber,
-                startColumn: range.startColumn,
-                endLineNumber: range.startLineNumber,
-                endColumn: range.startColumn + 1,
-            });
-        } else if (word) {
-            range = word.range;
-            char = word.word[0];
-        } else {
-            range = {
-                startLineNumber: position.lineNumber,
-                startColumn: position.column,
-                endLineNumber: position.lineNumber,
-                endColumn: position.column,
-            };
-        }
-        char = char?.toLowerCase();
-
-        const completionRange = this.toCompletionItemRanges(position, range);
-
-        if (/[^.]\.$/u.test(prev)) {
-            const suggestions = await this.completeFields(model, position, char, completionRange);
-            return { suggestions };
-        }
-
-        const suggestions = COMMON_GLOBAL_SUGGESTIONS(completionRange, prev === '::');
-        const locals = await this.completeLocal(model, position, char, completionRange);
-        const globals = await this.completeGlobal(model, char, locals, completionRange, false);
-        suggestions.push(...locals, ...globals);
-
-        return { suggestions };
-    }
-
-    /** @inheritdoc */
-    resolveCompletionItem(
-        item: languages.CompletionItem,
-        token: CancellationToken,
-    ): languages.CompletionItem | undefined {
-        if (typeof item.label == 'string') {
-            // not a dynamic completion item
-            return item;
-        }
-        const { vmValue, isField, vmParent } = item as CustomCompletionItem;
-        const { label } = item.label;
-        if (vmValue !== undefined || vmParent) {
-            if (item.documentation) return item;
-            const last = label.split('.').pop()!;
-            const def = valueDoc(last, vmValue, isField ? 'field' : 'hint', vmParent ?? null);
-            item.documentation = {
-                value: `${codeblock('\0' + def.script)}\n${def.doc.join('\n')}`,
-            };
-        }
-        return item;
-    }
-}