Add command to log language service diagnostics (#3489)

* Add support for showing diagnostics
microsoft · Apr 19, 2019 · 0e3fea9 · 0e3fea9
1 parent a39b1a5
commit 0e3fea9
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 4 deletions.
diff --git a/Extension/package.json b/Extension/package.json
@@ -593,6 +593,11 @@
         "command": "C_Cpp.BuildAndDebugActiveFile",
         "title": "%c_cpp.command.buildAndDebugActiveFile.title%",
         "category": "C/C++"
+      },
+      {
+        "command": "C_Cpp.LogDiagnostics",
+        "title": "%c_cpp.command.logDiagnostics.title%",
+        "category": "C/C++"
       }
     ],
     "keybindings": [

diff --git a/Extension/package.nls.it.json b/Extension/package.nls.it.json
@@ -17,5 +17,6 @@
     "c_cpp.command.resumeParsing.title": "Riprendi l'analisi del codice",
     "c_cpp.command.showParsingCommands.title": "Mostra comandi per l'analisi del codice",
     "c_cpp.command.takeSurvey.title": "Partecipa al Sondaggio",
-    "c_cpp.command.buildAndDebugActiveFile.title": "Compila ed Esegui il debug del file attivo"
+    "c_cpp.command.buildAndDebugActiveFile.title": "Compila ed Esegui il debug del file attivo",
+    "c_cpp.command.logDiagnostics.title": "Registra Diagnostica"
 }
diff --git a/Extension/package.nls.json b/Extension/package.nls.json
@@ -17,5 +17,6 @@
     "c_cpp.command.resumeParsing.title": "Resume parsing",
     "c_cpp.command.showParsingCommands.title": "Show parsing commands",
     "c_cpp.command.takeSurvey.title": "Take survey",
-    "c_cpp.command.buildAndDebugActiveFile.title": "Build and Debug Active File"
+    "c_cpp.command.buildAndDebugActiveFile.title": "Build and Debug Active File",
+    "c_cpp.command.logDiagnostics.title": "Log Diagnostics"
 }
diff --git a/Extension/package.nls.zh-cn.json b/Extension/package.nls.zh-cn.json
@@ -17,5 +17,6 @@
     "c_cpp.command.resumeParsing.title": "继续解析",
     "c_cpp.command.showParsingCommands.title": "查看解析命令",
     "c_cpp.command.takeSurvey.title": "调查问卷",
-    "c_cpp.command.buildAndDebugActiveFile.title": "生成和调试当前文件"
+    "c_cpp.command.buildAndDebugActiveFile.title": "生成和调试当前文件",
+    "c_cpp.command.logDiagnostics.title": "记录诊断"
 }
diff --git a/Extension/src/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts
@@ -140,12 +140,17 @@ interface QueryTranslationUnitSourceResult {
     configDisposition: QueryTranslationUnitSourceConfigDisposition;
 }
 
+interface GetDiagnosticsResult {
+    diagnostics: string;
+}
+
 // Requests
 const NavigationListRequest: RequestType<TextDocumentIdentifier, string, void, void> = new RequestType<TextDocumentIdentifier, string, void, void>('cpptools/requestNavigationList');
 const GoToDeclarationRequest: RequestType<void, void, void, void> = new RequestType<void, void, void, void>('cpptools/goToDeclaration');
 const QueryCompilerDefaultsRequest: RequestType<QueryCompilerDefaultsParams, configs.CompilerDefaults, void, void> = new RequestType<QueryCompilerDefaultsParams, configs.CompilerDefaults, void, void>('cpptools/queryCompilerDefaults');
 const QueryTranslationUnitSourceRequest: RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void, void> = new RequestType<QueryTranslationUnitSourceParams, QueryTranslationUnitSourceResult, void, void>('cpptools/queryTranslationUnitSource');
 const SwitchHeaderSourceRequest: RequestType<SwitchHeaderSourceParams, string, void, void> = new RequestType<SwitchHeaderSourceParams, string, void, void>('cpptools/didSwitchHeaderSource');
+const GetDiagnosticsRequest: RequestType<void, GetDiagnosticsResult, void, void> = new RequestType<void, GetDiagnosticsResult, void, void>('cpptools/getDiagnostics');
 
 // Notifications to the server
 const DidOpenNotification: NotificationType<DidOpenTextDocumentParams, void> = new NotificationType<DidOpenTextDocumentParams, void>('textDocument/didOpen');
@@ -231,6 +236,7 @@ export interface Client {
     updateCustomConfigurations(requestingProvider?: CustomConfigurationProvider1): Thenable<void>;
     updateCustomBrowseConfiguration(requestingProvider?: CustomConfigurationProvider1): Thenable<void>;
     provideCustomConfiguration(document: vscode.TextDocument): Promise<void>;
+    logDiagnostics(): Promise<void>;
     getCurrentConfigName(): Thenable<string>;
     getCompilerPath(): Thenable<string>;
     getKnownCompilers(): Thenable<configs.KnownCompiler[]>;
@@ -276,6 +282,7 @@ class DefaultClient implements Client {
     private trackedDocuments = new Set<vscode.TextDocument>();
     private outputChannel: vscode.OutputChannel;
     private debugChannel: vscode.OutputChannel;
+    private diagnosticsChannel: vscode.OutputChannel;
     private crashTimes: number[] = [];
     private isSupported: boolean = true;
     private inactiveRegionsDecorations = new Map<string, DecorationRangesPair>();
@@ -638,6 +645,17 @@ class DefaultClient implements Client {
         });
     }
 
+    public async logDiagnostics(): Promise<void> {
+        let response: GetDiagnosticsResult = await this.requestWhenReady(() => this.languageClient.sendRequest(GetDiagnosticsRequest, null));
+        if (!this.diagnosticsChannel) {
+            this.diagnosticsChannel = vscode.window.createOutputChannel("C/C++ Diagnostics");
+            this.disposables.push(this.diagnosticsChannel);
+        }
+        let header: string = `-------- Diagnostics - ${new Date().toLocaleString()}\n`;
+        let version: string = `Version: ${util.packageJson.version}\n`;
+        this.diagnosticsChannel.appendLine(`${header}${version}${response.diagnostics}`);
+    }
+
     public async provideCustomConfiguration(document: vscode.TextDocument): Promise<void> {
         let tokenSource: CancellationTokenSource = new CancellationTokenSource();
         let providers: CustomConfigurationProviderCollection = getCustomConfigProviders();
@@ -1446,6 +1464,7 @@ class NullClient implements Client {
     updateCustomConfigurations(requestingProvider?: CustomConfigurationProvider1): Thenable<void> { return Promise.resolve(); }
     updateCustomBrowseConfiguration(requestingProvider?: CustomConfigurationProvider1): Thenable<void> { return Promise.resolve(); }
     provideCustomConfiguration(document: vscode.TextDocument): Promise<void> { return Promise.resolve(); }
+    logDiagnostics(): Promise<void> { return Promise.resolve(); }
     getCurrentConfigName(): Thenable<string> { return Promise.resolve(""); }
     getCompilerPath(): Thenable<string> { return Promise.resolve(""); }
     getKnownCompilers(): Thenable<configs.KnownCompiler[]> { return Promise.resolve([]); }

diff --git a/Extension/src/LanguageServer/extension.ts b/Extension/src/LanguageServer/extension.ts
@@ -676,6 +676,7 @@ export function registerCommands(): void {
     disposables.push(vscode.commands.registerCommand('C_Cpp.ResumeParsing', onResumeParsing));
     disposables.push(vscode.commands.registerCommand('C_Cpp.ShowParsingCommands', onShowParsingCommands));
     disposables.push(vscode.commands.registerCommand('C_Cpp.TakeSurvey', onTakeSurvey));
+    disposables.push(vscode.commands.registerCommand('C_Cpp.LogDiagnostics', onLogDiagnostics));
     disposables.push(vscode.commands.registerCommand('cpptools.activeConfigName', onGetActiveConfigName));
     getTemporaryCommandRegistrarInstance().executeDelayedCommands();
 }
@@ -880,6 +881,11 @@ function onGetActiveConfigName(): Thenable<string> {
     return clients.ActiveClient.getCurrentConfigName();
 }
 
+function onLogDiagnostics(): void {
+    onActivationEvent();
+    clients.ActiveClient.logDiagnostics();
+}
+
 function reportMacCrashes(): void {
     if (process.platform === "darwin") {
         prevCrashFile = "";

diff --git a/Extension/src/commands.ts b/Extension/src/commands.ts
@@ -32,7 +32,8 @@ class TemporaryCommandRegistrar {
         "C_Cpp.PauseParsing",
         "C_Cpp.ResumeParsing",
         "C_Cpp.ShowParsingCommands",
-        "C_Cpp.TakeSurvey"
+        "C_Cpp.TakeSurvey",
+        "C_Cpp.LogDiagnostics"
     ];
 
     constructor() {

diff --git a/Extension/src/main.ts b/Extension/src/main.ts
@@ -348,6 +348,7 @@ function rewriteManifest(): Promise<void> {
         "onCommand:C_Cpp.ResumeParsing",
         "onCommand:C_Cpp.ShowParsingCommands",
         "onCommand:C_Cpp.TakeSurvey",
+        "onCommand:C_Cpp.LogDiagnostics",
         "onDebug",
         "workspaceContains:/.vscode/c_cpp_properties.json"
     ];