-
Notifications
You must be signed in to change notification settings - Fork 464
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable basic CMake language services (#4204)
* Enable colorization * Colorization matching twxs. Initial in memory support of hover. * initial naive providing of completion items * fix nit with variables and resolveCompletionItem * initial support for modules * add gulp tasks for localizing language service data * make the insertion a better snippet * add slight protections * update changelog
- Loading branch information
1 parent
73cc13f
commit d3f8f05
Showing
8 changed files
with
7,375 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| import * as vscode from "vscode"; | ||
| import * as path from "path"; | ||
| import { fs } from "@cmt/pr"; | ||
| import { thisExtensionPath } from "@cmt/util"; | ||
| import * as util from "@cmt/util"; | ||
|
|
||
| interface Commands { | ||
| [key: string]: Command; | ||
| } | ||
|
|
||
| interface Command { | ||
| name: string; | ||
| description: string; | ||
| syntax_examples: string[]; | ||
| } | ||
|
|
||
| // Same as variables right now. If we modify, create individual interfaces. | ||
| interface Modules extends Variables { | ||
|
|
||
| } | ||
|
|
||
| interface Variables { | ||
| [key: string]: Variable; | ||
| } | ||
|
|
||
| interface Variable { | ||
| name: string; | ||
| description: string; | ||
| } | ||
|
|
||
| enum LanguageType { | ||
| Variable, | ||
| Command, | ||
| Module | ||
| } | ||
|
|
||
| export class LanguageServiceData implements vscode.HoverProvider, vscode.CompletionItemProvider { | ||
| private commands: Commands = {}; | ||
| private variables: Variables = {}; // variables and properties | ||
| private modules: Modules = {}; | ||
|
|
||
| private constructor() { | ||
| } | ||
|
|
||
| private async getFile(fileEnding: string, locale: string): Promise<string> { | ||
| let filePath: string = path.join(thisExtensionPath(), "dist/languageServices", locale, "assets", fileEnding); | ||
| const fileExists: boolean = await util.checkFileExists(filePath); | ||
| if (!fileExists) { | ||
| filePath = path.join(thisExtensionPath(), "assets", fileEnding); | ||
| } | ||
| return fs.readFile(filePath); | ||
| } | ||
|
|
||
| private async load(): Promise<void> { | ||
| const locale: string = util.getLocaleId(); | ||
| this.commands = JSON.parse(await this.getFile("commands.json", locale)); | ||
| this.variables = JSON.parse(await this.getFile("variables.json", locale)); | ||
| this.modules = JSON.parse(await this.getFile("modules.json", locale)); | ||
| } | ||
|
|
||
| private getCompletionSuggestionsHelper(currentWord: string, data: Commands | Modules | Variables, type: LanguageType): vscode.CompletionItem[] { | ||
| function moduleInsertText(module: string): vscode.SnippetString { | ||
| if (module.indexOf("Find") === 0) { | ||
| return new vscode.SnippetString(`find_package(${module.replace("Find", "")}\${1: REQUIRED})`); | ||
| } else { | ||
| return new vscode.SnippetString(`include(${module})`); | ||
| } | ||
| } | ||
|
|
||
| function variableInsertText(variable: string): vscode.SnippetString { | ||
| return new vscode.SnippetString(variable.replace(/<(.*)>/g, "${1:<$1>}")); | ||
| } | ||
|
|
||
| function commandInsertText(func: string): vscode.SnippetString { | ||
| const scopedFunctions = ["if", "function", "while", "macro", "foreach"]; | ||
| const is_scoped = scopedFunctions.includes(func); | ||
| if (is_scoped) { | ||
| return new vscode.SnippetString(`${func}(\${1})\n\t\nend${func}(\${1})\n`); | ||
| } else { | ||
| return new vscode.SnippetString(`${func}(\${1})`); | ||
| } | ||
| } | ||
|
|
||
| return Object.keys(data).map((key) => { | ||
| if (data[key].name.includes(currentWord)) { | ||
| const completionItem = new vscode.CompletionItem(data[key].name); | ||
| completionItem.insertText = type === LanguageType.Command ? commandInsertText(data[key].name) : type === LanguageType.Variable ? variableInsertText(data[key].name) : moduleInsertText(data[key].name); | ||
| completionItem.kind = type === LanguageType.Command ? vscode.CompletionItemKind.Function : type === LanguageType.Variable ? vscode.CompletionItemKind.Variable : vscode.CompletionItemKind.Module; | ||
| return completionItem; | ||
| } | ||
| return null; | ||
| }).filter((value) => value !== null) as vscode.CompletionItem[]; | ||
| } | ||
|
|
||
| private getCompletionSuggestions(currentWord: string): vscode.CompletionItem[] { | ||
| return this.getCompletionSuggestionsHelper(currentWord, this.commands, LanguageType.Command) | ||
| .concat(this.getCompletionSuggestionsHelper(currentWord, this.variables, LanguageType.Variable)) | ||
| .concat(this.getCompletionSuggestionsHelper(currentWord, this.modules, LanguageType.Module)); | ||
| } | ||
|
|
||
| public static async create(): Promise<LanguageServiceData> { | ||
| const data = new LanguageServiceData(); | ||
| await data.load(); | ||
| return data; | ||
| } | ||
|
|
||
| provideCompletionItems(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, _context: vscode.CompletionContext): vscode.ProviderResult<vscode.CompletionItem[] | vscode.CompletionList> { | ||
| const wordAtPosition = document.getWordRangeAtPosition(position); | ||
|
|
||
| let currentWord = ""; | ||
| if (wordAtPosition && wordAtPosition.start.character < position.character) { | ||
| const word = document.getText(wordAtPosition); | ||
| currentWord = word.substr(0, position.character - wordAtPosition.start.character); | ||
| } | ||
|
|
||
| if (token.isCancellationRequested) { | ||
| return null; | ||
| } | ||
|
|
||
| return this.getCompletionSuggestions(currentWord); | ||
| } | ||
|
|
||
| resolveCompletionItem?(item: vscode.CompletionItem, _token: vscode.CancellationToken): vscode.ProviderResult<vscode.CompletionItem> { | ||
| return item; | ||
| } | ||
|
|
||
| provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken): vscode.ProviderResult<vscode.Hover> { | ||
| const range = document.getWordRangeAtPosition(position); | ||
| const value = document.getText(range); | ||
|
|
||
| if (token.isCancellationRequested) { | ||
| return null; | ||
| } | ||
|
|
||
| const hoverSuggestions = this.commands[value] || this.variables[value] || this.modules[value]; | ||
|
|
||
| const markdown: vscode.MarkdownString = new vscode.MarkdownString(); | ||
| markdown.appendMarkdown(hoverSuggestions.description); | ||
| hoverSuggestions.syntax_examples?.forEach((example) => { | ||
| markdown.appendCodeblock(`\t${example}`, "cmake"); | ||
| }); | ||
|
|
||
| if (hoverSuggestions) { | ||
| return new vscode.Hover(markdown); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } |