From 8a4a6418553302a2facc92d4908ca67eedd6f829 Mon Sep 17 00:00:00 2001 From: Colen Garoutte-Carson Date: Thu, 7 May 2020 17:09:15 -0700 Subject: [PATCH] Add setting to enable/disable code folding provider --- Extension/package.json | 10 ++ Extension/package.nls.json | 1 + Extension/src/LanguageServer/client.ts | 138 +++++++++++++---------- Extension/src/LanguageServer/settings.ts | 1 + 4 files changed, 89 insertions(+), 61 deletions(-) diff --git a/Extension/package.json b/Extension/package.json index 886cb23af..c2ab2b55a 100644 --- a/Extension/package.json +++ b/Extension/package.json @@ -529,6 +529,16 @@ "default": false, "description": "%c_cpp.configuration.debugger.useBacktickCommandSubstitution.description%", "scope": "window" + }, + "C_Cpp.codeFolding": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "description": "%c_cpp.configuration.codeFolding.description%", + "scope": "resource" } } }, diff --git a/Extension/package.nls.json b/Extension/package.nls.json index f79d7b5c9..d7b17c9a7 100644 --- a/Extension/package.nls.json +++ b/Extension/package.nls.json @@ -64,6 +64,7 @@ "c_cpp.configuration.experimentalFeatures.description": "Controls whether \"experimental\" features are usable.", "c_cpp.configuration.suggestSnippets.description": "If true, snippets are provided by the language server.", "c_cpp.configuration.enhancedColorization.description": "If enabled, code is colorized based on IntelliSense. This setting has no effect if IntelliSense is disabled or if using the Default High Contrast theme.", + "c_cpp.configuration.codeFolding.description": "If enabled, code folding ranges are provided by the language server.", "c_cpp.configuration.vcpkg.enabled.markdownDescription": "Enable integration services for the [vcpkg dependency manager](https://aka.ms/vcpkg/).", "c_cpp.configuration.renameRequiresIdentifier.description": "If true, 'Rename Symbol' will require a valid C/C++ identifier.", "c_cpp.configuration.debugger.useBacktickCommandSubstitution.description": "If true, debugger shell command substitution will use obsolete backtick (`)", diff --git a/Extension/src/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts index 77ddfe626..4a6acacb5 100644 --- a/Extension/src/LanguageServer/client.ts +++ b/Extension/src/LanguageServer/client.ts @@ -537,9 +537,59 @@ export function createNullClient(): Client { return new NullClient(); } +class FoldingRangeProvider implements vscode.FoldingRangeProvider { + private client: DefaultClient; + constructor(client: DefaultClient) { + this.client = client; + } + provideFoldingRanges(document: vscode.TextDocument, context: vscode.FoldingContext, + token: vscode.CancellationToken): Promise { + let id: number = ++abortRequestId; + let params: GetFoldingRangesParams = { + id: id, + uri: document.uri.toString() + }; + return new Promise((resolve, reject) => { + this.client.notifyWhenReady(() => { + this.client.languageClient.sendRequest(GetFoldingRangesRequest, params) + .then((ranges) => { + if (ranges.canceled) { + reject(); + } else { + let result: vscode.FoldingRange[] = []; + ranges.ranges.forEach((r) => { + let foldingRange: vscode.FoldingRange = { + start: r.range.start.line, + end: r.range.end.line + }; + switch (r.kind) { + case FoldingRangeKind.Comment: + foldingRange.kind = vscode.FoldingRangeKind.Comment; + break; + case FoldingRangeKind.Imports: + foldingRange.kind = vscode.FoldingRangeKind.Imports; + break; + case FoldingRangeKind.Region: + foldingRange.kind = vscode.FoldingRangeKind.Region; + break; + default: + break; + } + result.push(foldingRange); + }); + resolve(result); + } + }); + token.onCancellationRequested(e => this.client.abortRequest(id)); + }); + }); + } +} + export class DefaultClient implements Client { private innerLanguageClient?: LanguageClient; // The "client" that launches and communicates with our language "server" process. private disposables: vscode.Disposable[] = []; + private codeFoldingProviderDisposable: vscode.Disposable | undefined; private innerConfiguration?: configs.CppProperties; private rootPathFileWatcher?: vscode.FileSystemWatcher; private rootFolder?: vscode.WorkspaceFolder; @@ -551,6 +601,10 @@ export class DefaultClient implements Client { private visibleRanges = new Map(); private settingsTracker: SettingsTracker; private configurationProvider?: string; + private documentSelector: DocumentFilter[] = [ + { scheme: 'file', language: 'cpp' }, + { scheme: 'file', language: 'c' } + ]; // The "model" that is displayed via the UI (status bar). private model: ClientModel = new ClientModel(); @@ -586,7 +640,7 @@ export class DefaultClient implements Client { return this.model.referencesCommandMode.Value; } - private get languageClient(): LanguageClient { + public get languageClient(): LanguageClient { if (!this.innerLanguageClient) { throw new Error("Attempting to use languageClient before initialized"); } @@ -665,11 +719,6 @@ export class DefaultClient implements Client { telemetry.logLanguageServerEvent("NonDefaultInitialCppSettings", this.settingsTracker.getUserModifiedSettings()); failureMessageShown = false; - let documentSelector: DocumentFilter[] = [ - { scheme: 'file', language: 'cpp' }, - { scheme: 'file', language: 'c' } - ]; - class CodeActionProvider implements vscode.CodeActionProvider { private client: DefaultClient; constructor(client: DefaultClient) { @@ -994,55 +1043,6 @@ export class DefaultClient implements Client { } } - class FoldingRangeProvider implements vscode.FoldingRangeProvider { - private client: DefaultClient; - constructor(client: DefaultClient) { - this.client = client; - } - provideFoldingRanges(document: vscode.TextDocument, context: vscode.FoldingContext, - token: vscode.CancellationToken): Promise { - let id: number = ++abortRequestId; - let params: GetFoldingRangesParams = { - id: id, - uri: document.uri.toString() - }; - return new Promise((resolve, reject) => { - this.client.notifyWhenReady(() => { - this.client.languageClient.sendRequest(GetFoldingRangesRequest, params) - .then((ranges) => { - if (ranges.canceled) { - reject(); - } else { - let result: vscode.FoldingRange[] = []; - ranges.ranges.forEach((r) => { - let foldingRange: vscode.FoldingRange = { - start: r.range.start.line, - end: r.range.end.line - }; - switch (r.kind) { - case FoldingRangeKind.Comment: - foldingRange.kind = vscode.FoldingRangeKind.Comment; - break; - case FoldingRangeKind.Imports: - foldingRange.kind = vscode.FoldingRangeKind.Imports; - break; - case FoldingRangeKind.Region: - foldingRange.kind = vscode.FoldingRangeKind.Region; - break; - default: - break; - } - result.push(foldingRange); - }); - resolve(result); - } - }); - token.onCancellationRequested(e => this.client.abortRequest(id)); - }); - }); - } - } - if (firstClient) { workspaceReferences = new refs.ReferencesManager(this); @@ -1058,12 +1058,15 @@ export class DefaultClient implements Client { this.registerFileWatcher(); - this.disposables.push(vscode.languages.registerRenameProvider(documentSelector, new RenameProvider(this))); - this.disposables.push(vscode.languages.registerReferenceProvider(documentSelector, new FindAllReferencesProvider(this))); + this.disposables.push(vscode.languages.registerRenameProvider(this.documentSelector, new RenameProvider(this))); + this.disposables.push(vscode.languages.registerReferenceProvider(this.documentSelector, new FindAllReferencesProvider(this))); this.disposables.push(vscode.languages.registerWorkspaceSymbolProvider(new WorkspaceSymbolProvider(this))); - this.disposables.push(vscode.languages.registerDocumentSymbolProvider(documentSelector, new DocumentSymbolProvider(this), undefined)); - this.disposables.push(vscode.languages.registerCodeActionsProvider(documentSelector, new CodeActionProvider(this), undefined)); - this.disposables.push(vscode.languages.registerFoldingRangeProvider(documentSelector, new FoldingRangeProvider(this))); + this.disposables.push(vscode.languages.registerDocumentSymbolProvider(this.documentSelector, new DocumentSymbolProvider(this), undefined)); + this.disposables.push(vscode.languages.registerCodeActionsProvider(this.documentSelector, new CodeActionProvider(this), undefined)); + let settings: CppSettings = new CppSettings(); + if (settings.codeFolding) { + this.codeFoldingProviderDisposable = vscode.languages.registerFoldingRangeProvider(this.documentSelector, new FoldingRangeProvider(this)); + } // Listen for messages from the language server. this.registerNotifications(); @@ -1350,6 +1353,15 @@ export class DefaultClient implements Client { if (changedSettings["commentContinuationPatterns"]) { updateLanguageConfigurations(); } + if (changedSettings["codeFolding"]) { + let settings: CppSettings = new CppSettings(); + if (settings.codeFolding) { + this.codeFoldingProviderDisposable = vscode.languages.registerFoldingRangeProvider(this.documentSelector, new FoldingRangeProvider(this)); + } else if (this.codeFoldingProviderDisposable) { + this.codeFoldingProviderDisposable.dispose(); + this.codeFoldingProviderDisposable = undefined; + } + } this.configuration.onDidChangeSettings(); telemetry.logLanguageServerEvent("CppSettingsChange", changedSettings, undefined); } @@ -2540,6 +2552,10 @@ export class DefaultClient implements Client { return promise.then(() => { this.disposables.forEach((d) => d.dispose()); this.disposables = []; + if (this.codeFoldingProviderDisposable) { + this.codeFoldingProviderDisposable.dispose(); + this.codeFoldingProviderDisposable = undefined; + } this.model.dispose(); }); } @@ -2594,7 +2610,7 @@ export class DefaultClient implements Client { this.model.referencesCommandMode.Value = mode; } - private abortRequest(id: number): void { + public abortRequest(id: number): void { let params: AbortRequestParams = { id: id }; diff --git a/Extension/src/LanguageServer/settings.ts b/Extension/src/LanguageServer/settings.ts index 8171e6bfe..5889b6f8b 100644 --- a/Extension/src/LanguageServer/settings.ts +++ b/Extension/src/LanguageServer/settings.ts @@ -156,6 +156,7 @@ export class CppSettings extends Settings { public get defaultSystemIncludePath(): string[] | undefined { return super.Section.get("default.systemIncludePath"); } public get defaultEnableConfigurationSquiggles(): boolean | undefined { return super.Section.get("default.enableConfigurationSquiggles"); } public get useBacktickCommandSubstitution(): boolean | undefined { return super.Section.get("debugger.useBacktickCommandSubstitution"); } + public get codeFolding(): boolean { return super.Section.get("codeFolding") === "Enabled"; } public get enhancedColorization(): boolean { return super.Section.get("enhancedColorization") === "Enabled"