Add setting to enable multiline comment customizations (#1583)

* Work in progress.  Wrote framework for comment pattern handling.  Implementation incomplete and some bugs remain.

* address TODOs

* incorrect disposal

* incorrect type decorations

* WIP: update changelog, add a test

* test updates

* rename the setting, update package.json and add more tests

* deal with whitespace continuations

* address PR feedback

Author: bobbrow

Extension/CHANGELOG.md

@@ -1,5 +1,9 @@
 # C/C++ for Visual Studio Code Change Log
 
+## Version 0.15.1: March 2018
+* Support additional multiline comment patterns. [#1100](https://github.com/Microsoft/vscode-cpptools/issues/1100),[#1539](https://github.com/Microsoft/vscode-cpptools/issues/1539)
+  * Added new setting: `C_Cpp.commentContinuationPatterns`
+
 ## Version 0.15.0: February 15, 2018
 * Add colorization for inactive regions. [#1466](https://github.com/Microsoft/vscode-cpptools/issues/1466)
 * Fix 3 highest hitting crashes. [#1137](https://github.com/Microsoft/vscode-cpptools/issues/1137), [#1337](https://github.com/Microsoft/vscode-cpptools/issues/1337), [#1497](https://github.com/Microsoft/vscode-cpptools/issues/1497)

Extension/package.json

@@ -194,6 +194,35 @@
           "default": "checkFolders",
           "description": "Instructs the extension when to use the \"files.exclude\" setting when determining which files should be added to the code navigation database while traversing through the paths in the \"browse.path\" array. \"checkFolders\" means that the exclusion filters will only be evaluated once per folder (individual files are not checked). \"checkFilesAndFolders\" means that the exclusion filters will be evaluated against every file and folder encountered. If your \"files.exclude\" setting only contains folders, then \"checkFolders\" is the best choice and will increase the speed at which the extension can initialize the code navigation database.",
           "scope": "resource"
+        },
+        "C_Cpp.commentContinuationPatterns": {
+          "type": "array",
+          "default": [
+            "/**"
+          ],
+          "items": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The pattern that begins a multiline or single line comment block. The continuation pattern defaults to ' * ' for multiline comment blocks or this string for single line comment blocks."
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "begin": {
+                    "type": "string",
+                    "description": "The pattern that begins a multiline or single line comment block."
+                  },
+                  "continue": {
+                    "type": "string",
+                    "description": "The text that will be inserted on the next line when Enter is pressed inside a multiline or single line comment block."
+                  }
+                }
+              }
+            ]
+          },
+          "description": "Defines the editor behavior for when the Enter key is pressed inside a multiline or single line comment block.",
+          "scope": "resource"
         }
       }
     },
@@ -1072,7 +1101,7 @@
     "test": "gulp allTests",
     "tslint": "gulp tslint",
     "unitTests": "gulp unitTests",
-    "vscode:prepublish": "node ./src/Support/update.js && npm install && tsc -p ./ && node ./out/src/Support/copyDebuggerDependencies.js",
+    "vscode:prepublish": "node ./src/Support/prepublish.js",
     "watch": "tsc -watch -p ./"
   },
   "devDependencies": {

Extension/src/LanguageServer/client.ts

@@ -21,6 +21,7 @@ import { createProtocolFilter } from './protocolFilter';
 import { DataBinding } from './dataBinding';
 import minimatch = require("minimatch");
 import * as logger from '../logger';
+import { updateLanguageConfigurations } from './extension';
 
 let ui: UI;
 
@@ -130,7 +131,7 @@ function collectSettingsForTelemetry(filter: (key: string, val: string, settings
         }
         let val: any = settings.get(key);
         if (val instanceof Object) {
-            continue; // ignore settings that are objects since tostring on those is not useful (e.g. navigation.length)
+            val = JSON.stringify(val, null, 2);
         }
 
         // Skip values that don't match the setting's enum.
@@ -438,9 +439,12 @@ class DefaultClient implements Client {
         let filter: (key: string, val: string) => boolean = (key: string, val: string) => {
             return !(key in previousCppSettings) || val !== previousCppSettings[key];
         };
-        let changedSettings: any = collectSettingsForTelemetry(filter, this.RootUri);
+        let changedSettings: { [key: string] : string} = collectSettingsForTelemetry(filter, this.RootUri);
 
         if (Object.keys(changedSettings).length > 0) {
+            if (changedSettings["commentContinuationPatterns"]) {
+                updateLanguageConfigurations();
+            }
             telemetry.logLanguageServerEvent("CppSettingsChange", changedSettings, null);
         }
     }

Extension/src/LanguageServer/extension.ts

@@ -14,48 +14,20 @@ import { Client } from './client';
 import { ClientCollection } from './clientCollection';
 import { CppSettings } from './settings';
 import { PersistentWorkspaceState } from './persistentState';
+import { getLanguageConfig } from './languageConfig';
 import * as os from 'os';
 
 let prevCrashFile: string;
 let clients: ClientCollection;
 let activeDocument: string;
 let ui: UI;
 let disposables: vscode.Disposable[] = [];
+let languageConfigurations: vscode.Disposable[] = [];
 let intervalTimer: NodeJS.Timer;
 let realActivationOccurred: boolean = false;
 let tempCommands: vscode.Disposable[] = [];
 let activatedPreviously: PersistentWorkspaceState<boolean>;
 
-    // Add ' * ' on new lines after multiline comment with '/**' started
-// Copied from vscode/extensions/typescript/src/typescriptMain.ts
-const multilineCommentRules: any = {
-    onEnterRules: [
-        {
-            // e.g. /** | */
-            beforeText: /^\s*\/\*\*(?!\/)([^\*]|\*(?!\/))*$/,
-            afterText: /^\s*\*\/$/,
-            action: { indentAction: vscode.IndentAction.IndentOutdent, appendText: ' * ' }
-        }, {
-            // e.g. /** ...|
-            beforeText: /^\s*\/\*\*(?!\/)([^\*]|\*(?!\/))*$/,
-            action: { indentAction: vscode.IndentAction.None, appendText: ' * ' }
-        }, {
-            // e.g.  * ...|
-            beforeText: /^(\t|(\ \ ))*\ \*(\ ([^\*]|\*(?!\/))*)?$/,
-            action: { indentAction: vscode.IndentAction.None, appendText: '* ' }
-        }, {
-            // e.g.  */|
-            beforeText: /^(\t|(\ \ ))*\ \*\/\s*$/,
-            action: { indentAction: vscode.IndentAction.None, removeText: 1 }
-        },
-        {
-            // e.g.  *-----*/|
-            beforeText: /^(\t|(\ \ ))*\ \*[^/]*\*\/\s*$/,
-            action: { indentAction: vscode.IndentAction.None, removeText: 1 }
-        }
-    ]
-};
-
 /**
  * activate: set up the extension for language services
  */
@@ -128,14 +100,21 @@ function realActivation(): void {
     disposables.push(vscode.window.onDidChangeTextEditorSelection(onDidChangeTextEditorSelection));
     disposables.push(vscode.window.onDidChangeVisibleTextEditors(onDidChangeVisibleTextEditors));
 
-    disposables.push(vscode.languages.setLanguageConfiguration('c', multilineCommentRules));
-    disposables.push(vscode.languages.setLanguageConfiguration('cpp', multilineCommentRules));
+    updateLanguageConfigurations();
 
     reportMacCrashes();
 
     intervalTimer = setInterval(onInterval, 2500);
 }
 
+export function updateLanguageConfigurations(): void {
+    languageConfigurations.forEach(d => d.dispose());
+    languageConfigurations = [];
+
+    languageConfigurations.push(vscode.languages.setLanguageConfiguration('c', getLanguageConfig('c', clients.ActiveClient.RootUri)));
+    languageConfigurations.push(vscode.languages.setLanguageConfiguration('cpp', getLanguageConfig('cpp', clients.ActiveClient.RootUri)));
+}
+
 /*********************************************
  * workspace events
  *********************************************/
@@ -452,6 +431,7 @@ export function deactivate(): Thenable<void> {
     telemetry.logLanguageServerEvent("LanguageServerShutdown");
     clearInterval(intervalTimer);
     disposables.forEach(d => d.dispose());
+    languageConfigurations.forEach(d => d.dispose());
     ui.dispose();
     return clients.dispose();
 }