Extract to function (#11467)

* Extract to function.

Author: sean-mcmanus

Extension/package.json

@@ -2,7 +2,7 @@
     "name": "cpptools",
     "displayName": "C/C++",
     "description": "C/C++ IntelliSense, debugging, and code browsing.",
-    "version": "1.17.5-main",
+    "version": "1.18.0-main",
     "publisher": "ms-vscode",
     "icon": "LanguageCCPP_color_128x.png",
     "readme": "README.md",
@@ -3351,6 +3351,15 @@
                     "apply": "first"
                 },
                 "when": "editorLangId =~ /^(c|(cuda-)?cpp)$/ && editorTextFocus && !(config.C_Cpp.intelliSenseEngine =~ /^[dD]isabled$/)"
+            },
+            {
+                "command": "editor.action.codeAction",
+                "key": "ctrl+shift+r ctrl+e",
+                "args": {
+                    "kind": "refactor.extract.function",
+                    "apply": "first"
+                },
+                "when": "editorLangId =~ /^(c|(cuda-)?cpp)$/ && editorTextFocus && !(config.C_Cpp.intelliSenseEngine =~ /^[dD]isabled$/)"
             }
         ],
         "debuggers": [
@@ -6250,13 +6259,25 @@
                 "languages": [
                     "c",
                     "cpp",
-                    "cude-cpp"
+                    "cuda-cpp"
                 ],
                 "actions": {
                     "kind": "refactor.inline.macro",
                     "title": "%c_cpp.codeActions.refactor.inline.macro.title%",
                     "description": "%c_cpp.codeActions.refactor.inline.macro.description%"
                 }
+            },
+            {
+                "languages": [
+                    "c",
+                    "cpp",
+                    "cuda-cpp"
+                ],
+                "actions": {
+                    "kind": "refactor.extract.function",
+                    "title": "%c_cpp.codeActions.refactor.extract.function.title%",
+                    "description": "%c_cpp.codeActions.refactor.extract.function.description%"
+                }
             }
         ]
     },

Extension/package.nls.json

@@ -997,6 +997,8 @@
     "c_cpp.walkthrough.customize.debugging.altText": "Image that shows Add Debug Configuration in the drop-down",
     "c_cpp.codeActions.refactor.inline.macro.title": "Inline macro",
     "c_cpp.codeActions.refactor.inline.macro.description": "Replace the macro invocation with the expanded code.",
+    "c_cpp.codeActions.refactor.extract.function.title": "Extract to function",
+    "c_cpp.codeActions.refactor.extract.function.description": "Extract the selected code to a free or member function.",
     "c_cpp.configuration.refactoring.includeHeader.markdownDescription": "Controls whether to include the header file of a refactored function/symbol to its corresponding source file when doing a refactoring action, such as create declaration/definition.",
     "c_cpp.configuration.refactoring.includeHeader.always.description": "Always include the header file if it is not included explicitly in its source file.",
     "c_cpp.configuration.refactoring.includeHeader.ifNeeded.description": "Only include the header file if it is not included explicitly in its source file or through implicit inclusion.",

Extension/src/LanguageServer/Providers/codeActionProvider.ts

@@ -28,6 +28,7 @@ interface CodeActionCommand {
     edit?: TextEdit;
     uri?: string;
     range?: Range;
+    disabledReason?: string;
 }
 
 interface GetCodeActionsResult {
@@ -44,6 +45,8 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
     }
 
     private static inlineMacroKind: vscode.CodeActionKind = vscode.CodeActionKind.RefactorInline.append("macro");
+    private static extractToFunctionKind: vscode.CodeActionKind = vscode.CodeActionKind.RefactorExtract.append("function");
+    private static expandSelectionKind: vscode.CodeActionKind = CodeActionProvider.extractToFunctionKind.append("expandSelection");
 
     public async provideCodeActions(document: vscode.TextDocument, range: vscode.Range | vscode.Selection,
         context: vscode.CodeActionContext, token: vscode.CancellationToken): Promise<(vscode.Command | vscode.CodeAction)[]> {
@@ -85,6 +88,7 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
             this.client.configuration.CurrentConfiguration?.compilerPathInCppPropertiesJson !== undefined ||
             !!this.client.configuration.CurrentConfiguration?.compileCommandsInCppPropertiesJson ||
             !!this.client.configuration.CurrentConfiguration?.configurationProviderInCppPropertiesJson;
+        const hasExperimentalFeatures: boolean = new CppSettings().experimentalFeatures ?? false;
 
         // Convert to vscode.CodeAction array
         let hasInlineMacro: boolean = false;
@@ -205,6 +209,20 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
                 } else {
                     return;
                 }
+            } else if (command.command === "C_Cpp.ExtractToFunction" ||
+                command.command === "C_Cpp.ExtractToMemberFunction") {
+                if (!hasExperimentalFeatures) {
+                    return;
+                }
+                codeActionKind = CodeActionProvider.extractToFunctionKind;
+            } else if (command.command === "C_Cpp.ExtractToFreeFunction") {
+                // TODO: https://github.com/microsoft/vscode-cpptools/issues/11473 needs to be fixed.
+                return;
+            } else if (command.command === "C_Cpp.ExpandSelection") {
+                if (!hasExperimentalFeatures) {
+                    return;
+                }
+                codeActionKind = CodeActionProvider.expandSelectionKind;
             }
             const vscodeCodeAction: vscode.CodeAction = {
                 title: title,
@@ -214,7 +232,8 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
                     arguments: command.arguments
                 },
                 edit: wsEdit,
-                kind: codeActionKind
+                kind: codeActionKind,
+                disabled: command.disabledReason ? { reason: command.disabledReason } : undefined
             };
             resultCodeActions.push(vscodeCodeAction);
         };
@@ -229,11 +248,11 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
                 if (!editor) {
                     return false;
                 }
-                const result: vscode.Hover[] = <vscode.Hover[]>(await vscode.commands.executeCommand('vscode.executeHoverProvider', document.uri, range.start));
+                const result: vscode.Hover[] = (await vscode.commands.executeCommand('vscode.executeHoverProvider', document.uri, range.start)) as vscode.Hover[];
                 if (result.length === 0) {
                     return false;
                 }
-                const hoverResult: vscode.MarkdownString = <vscode.MarkdownString>result[0].contents[0];
+                const hoverResult: vscode.MarkdownString = result[0].contents[0] as vscode.MarkdownString;
                 if (!hoverResult.value.includes(localize("expands.to", "Expands to:"))) {
                     return false;
                 }

Extension/src/LanguageServer/Providers/documentRangeFormattingEditProvider.ts

@@ -13,7 +13,8 @@ export class DocumentRangeFormattingEditProvider implements vscode.DocumentRange
         this.client = client;
     }
 
-    public async provideDocumentRangeFormattingEdits(document: vscode.TextDocument, range: vscode.Range, options: vscode.FormattingOptions, token: vscode.CancellationToken): Promise<vscode.TextEdit[]> {
+    public async provideDocumentRangeFormattingEdits(document: vscode.TextDocument, range: vscode.Range,
+        options: vscode.FormattingOptions, token: vscode.CancellationToken): Promise<vscode.TextEdit[]> {
         const settings: CppSettings = new CppSettings(vscode.workspace.getWorkspaceFolder(document.uri)?.uri);
         if (settings.formattingEngine === "disabled") {
             return [];
@@ -58,4 +59,12 @@ export class DocumentRangeFormattingEditProvider implements vscode.DocumentRange
             return configCallBack(editorConfigSettings);
         }
     }
+
+    // TODO: This is needed for correct Extract to function formatting.
+    /*
+    public async provideDocumentRangesFormattingEdits(_document: vscode.TextDocument, _ranges: vscode.Range[],
+        _options: vscode.FormattingOptions, _token: vscode.CancellationToken): Promise<vscode.TextEdit[]> {
+        return [];
+    }
+    */
 }

Extension/src/LanguageServer/Providers/renameProvider.ts

@@ -24,6 +24,16 @@ export class RenameProvider implements vscode.RenameProvider {
     }
 
     public async provideRenameEdits(document: vscode.TextDocument, position: vscode.Position, newName: string, _token: vscode.CancellationToken): Promise<vscode.WorkspaceEdit | undefined> {
+        // Bypass the normal rename processing during Extract to function,
+        // since we already know the locations of the required edits.
+        if (this.client.renameDataForExtractToFunction.length > 0) {
+            const workspaceEditResult: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
+            for (const renameData of this.client.renameDataForExtractToFunction) {
+                workspaceEditResult.replace(renameData.uri, renameData.range, newName);
+            }
+            this.client.renameDataForExtractToFunction = [];
+            return workspaceEditResult;
+        }
         await this.client.ready;
         workspaceReferences.cancelCurrentReferenceRequest(CancellationSender.NewRequest);