Use standard LSP for Folding Ranges (#14783)

Author: Colengms

Extension/src/LanguageServer/Providers/foldingRangeProvider.ts

@@ -13,7 +13,6 @@ import { DocumentFormattingEditProvider } from './Providers/documentFormattingEd
 import { DocumentRangeFormattingEditProvider } from './Providers/documentRangeFormattingEditProvider';
 import { DocumentSymbolProvider } from './Providers/documentSymbolProvider';
 import { FindAllReferencesProvider } from './Providers/findAllReferencesProvider';
-import { FoldingRangeProvider } from './Providers/foldingRangeProvider';
 import { CppInlayHint, InlayHintsProvider } from './Providers/inlayHintProvider';
 import { OnTypeFormattingEditProvider } from './Providers/onTypeFormattingEditProvider';
 import { RenameProvider } from './Providers/renameProvider';
@@ -228,11 +227,6 @@ interface FileChangedParams extends WorkspaceFolderParams {
     uri: string;
 }
 
-interface InputLineRange {
-    startLine: number;
-    endLine: number;
-}
-
 interface InputRegion {
     startLine: number;
     startColumn: number;
@@ -364,26 +358,6 @@ export interface FormatResult {
     edits: TextEdit[];
 }
 
-export interface GetFoldingRangesParams {
-    uri: string;
-}
-
-export enum FoldingRangeKind {
-    None = 0,
-    Comment = 1,
-    Imports = 2,
-    Region = 3
-}
-
-export interface CppFoldingRange {
-    kind: FoldingRangeKind;
-    range: InputLineRange;
-}
-
-export interface GetFoldingRangesResult {
-    ranges: CppFoldingRange[];
-}
-
 export interface IntelliSenseResult {
     uri: string;
     fileVersion: number;
@@ -625,7 +599,6 @@ const SwitchHeaderSourceRequest: RequestType<SwitchHeaderSourceParams, string, v
 const GetTranslationUnitSourceCandidatesRequest: RequestType<TextDocumentIdentifier, GetTranslationUnitSourceCandidatesResult, void> = new RequestType<TextDocumentIdentifier, GetTranslationUnitSourceCandidatesResult, void>('cpptools/getTranslationUnitSourceCandidates');
 const GetDiagnosticsRequest: RequestType<void, GetDiagnosticsResult, void> = new RequestType<void, GetDiagnosticsResult, void>('cpptools/getDiagnostics');
 export const GetDocumentSymbolRequest: RequestType<GetDocumentSymbolRequestParams, GetDocumentSymbolResult, void> = new RequestType<GetDocumentSymbolRequestParams, GetDocumentSymbolResult, void>('cpptools/getDocumentSymbols');
-export const GetFoldingRangesRequest: RequestType<GetFoldingRangesParams, GetFoldingRangesResult, void> = new RequestType<GetFoldingRangesParams, GetFoldingRangesResult, void>('cpptools/getFoldingRanges');
 export const FormatDocumentRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatDocument');
 export const FormatRangeRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatRange');
 export const FormatOnTypeRequest: RequestType<FormatParams, FormatResult, void> = new RequestType<FormatParams, FormatResult, void>('cpptools/formatOnType');
@@ -903,8 +876,6 @@ export class DefaultClient implements Client {
     private documentFormattingProviderDisposable: vscode.Disposable | undefined;
     private formattingRangeProviderDisposable: vscode.Disposable | undefined;
     private onTypeFormattingProviderDisposable: vscode.Disposable | undefined;
-    private codeFoldingProvider: FoldingRangeProvider | undefined;
-    private codeFoldingProviderDisposable: vscode.Disposable | undefined;
     private inlayHintsProvider: InlayHintsProvider | undefined;
     private semanticTokensProvider: SemanticTokensProvider | undefined;
     private semanticTokensProviderDisposable: vscode.Disposable | undefined;
@@ -1431,16 +1402,12 @@ export class DefaultClient implements Client {
                 this.disposables.push(vscode.languages.registerDocumentSymbolProvider(util.documentSelector, instrument(new DocumentSymbolProvider()), undefined));
                 this.disposables.push(vscode.languages.registerCodeActionsProvider(util.documentSelector, instrument(new CodeActionProvider(this)), undefined));
 
-                // Because formatting and codeFolding can vary per folder, we need to register these providers once
-                // and leave them registered. The decision of whether to provide results needs to be made on a per folder basis,
-                // within the providers themselves.
+                // Because formatting can vary per folder, we need to register these providers once and leave them registered.
+                // The decision of whether to provide results needs to be made on a per folder basis, within the providers themselves.
                 this.documentFormattingProviderDisposable = vscode.languages.registerDocumentFormattingEditProvider(util.documentSelector, instrument(new DocumentFormattingEditProvider(this)));
                 this.formattingRangeProviderDisposable = vscode.languages.registerDocumentRangeFormattingEditProvider(util.documentSelector, instrument(new DocumentRangeFormattingEditProvider(this)));
                 this.onTypeFormattingProviderDisposable = vscode.languages.registerOnTypeFormattingEditProvider(util.documentSelector, instrument(new OnTypeFormattingEditProvider(this)), ";", "}", "\n");
 
-                this.codeFoldingProvider = new FoldingRangeProvider(this);
-                this.codeFoldingProviderDisposable = vscode.languages.registerFoldingRangeProvider(util.documentSelector, instrument(this.codeFoldingProvider));
-
                 const settings: CppSettings = new CppSettings();
                 if (settings.isEnhancedColorizationEnabled && semanticTokensLegend) {
                     this.semanticTokensProvider = instrument(new SemanticTokensProvider());
@@ -2648,7 +2615,7 @@ export class DefaultClient implements Client {
             this.inlayHintsProvider.deliverInlayHints(intelliSenseResult.uri, intelliSenseResult.inlayHints, intelliSenseResult.clearExistingInlayHint);
         }
 
-        this.updateInactiveRegions(intelliSenseResult.uri, intelliSenseResult.inactiveRegions, intelliSenseResult.clearExistingInactiveRegions, intelliSenseResult.isCompletePass);
+        this.updateInactiveRegions(intelliSenseResult.uri, intelliSenseResult.inactiveRegions, intelliSenseResult.clearExistingInactiveRegions);
         if (intelliSenseResult.clearExistingDiagnostics || intelliSenseResult.diagnostics.length > 0) {
             this.updateSquiggles(intelliSenseResult.uri, intelliSenseResult.diagnostics, intelliSenseResult.clearExistingDiagnostics);
         }
@@ -2960,11 +2927,7 @@ export class DefaultClient implements Client {
         this.model.isParsingWorkspacePaused.Value = tagParseStatus.isPaused;
     }
 
-    private updateInactiveRegions(uriString: string, inactiveRegions: InputRegion[], startNewSet: boolean, updateFoldingRanges: boolean): void {
-        if (this.codeFoldingProvider && updateFoldingRanges) {
-            this.codeFoldingProvider.refresh();
-        }
-
+    private updateInactiveRegions(uriString: string, inactiveRegions: InputRegion[], startNewSet: boolean): void {
         const client: Client = clients.getClientFor(vscode.Uri.parse(uriString));
         if (!(client instanceof DefaultClient) || (!startNewSet && inactiveRegions.length === 0)) {
             return;
@@ -4291,10 +4254,6 @@ export class DefaultClient implements Client {
             this.onTypeFormattingProviderDisposable.dispose();
             this.onTypeFormattingProviderDisposable = undefined;
         }
-        if (this.codeFoldingProviderDisposable) {
-            this.codeFoldingProviderDisposable.dispose();
-            this.codeFoldingProviderDisposable = undefined;
-        }
         if (this.semanticTokensProviderDisposable) {
             this.semanticTokensProviderDisposable.dispose();
             this.semanticTokensProviderDisposable = undefined;

Extension/src/LanguageServer/client.ts

@@ -15,7 +15,7 @@ import { Client, DefaultClient, SymbolScope, workspaceReferences } from './clien
 import { clients } from './extension';
 import { getLocalizedString, getLocalizedSymbolScope, LocalizeStringParams } from './localization';
 import { CancellationSender } from './references';
-import { hasFileAssociation } from './settings';
+import { CppSettings, hasFileAssociation } from './settings';
 import { shouldChangeFromCToCpp } from './utils';
 
 export const RequestCancelled: number = -32800;
@@ -227,6 +227,10 @@ export function createProtocolFilter(): Middleware {
             logCallHierarchyTelemetry("CallHierarchyCallsFrom", CallHierarchyRequestStatus.Succeeded);
             return result && result.length !== 0 ? result : undefined;
         },
+        provideFoldingRanges: (document, context, token, next) => {
+            const settings: CppSettings = new CppSettings();
+            return settings.codeFolding ? next(document, context, token) : [];
+        },
         provideWorkspaceSymbols: async (query, token, next) => {
             if (!query) {
                 return [];