Display a log message when intelliSenseMode is Disabled (#9543)

Colengms · web-flow · commit 6da34e423658 · 2022-07-06T17:50:34.000-07:00
diff --git a/Extension/src/LanguageServer/Providers/codeActionProvider.ts b/Extension/src/LanguageServer/Providers/codeActionProvider.ts
@@ -4,14 +4,12 @@
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
 import {  Position, Range, RequestType, TextEdit } from 'vscode-languageclient';
-import * as util from '../../common';
 import { DefaultClient } from '../client';
 import { CodeActionCodeInfo, CodeActionDiagnosticInfo, codeAnalysisFileToCodeActions, codeAnalysisCodeToFixes,
     codeAnalysisAllFixes } from '../codeAnalysis';
 import { makeVscodeRange } from '../utils';
 import { CppSettings } from '../settings';
-
-type LocalizeStringParams = util.LocalizeStringParams;
+import { getLocalizedString, LocalizeStringParams } from '../localization';
 
 interface GetCodeActionsRequestParams {
     uri: string;
@@ -63,7 +61,7 @@ export class CodeActionProvider implements vscode.CodeActionProvider {
 
             // Convert to vscode.CodeAction array
             commands.forEach((command) => {
-                const title: string = util.getLocalizedString(command.localizeStringParams);
+                const title: string = getLocalizedString(command.localizeStringParams);
                 let wsEdit: vscode.WorkspaceEdit | undefined;
                 let codeActionKind: vscode.CodeActionKind = vscode.CodeActionKind.QuickFix;
                 if (command.edit) {
diff --git a/Extension/src/LanguageServer/Providers/documentSymbolProvider.ts b/Extension/src/LanguageServer/Providers/documentSymbolProvider.ts
@@ -4,9 +4,9 @@
  * ------------------------------------------------------------------------------------------ */
 import * as vscode from 'vscode';
 import { DefaultClient, LocalizeDocumentSymbol, GetDocumentSymbolRequestParams, GetDocumentSymbolRequest, SymbolScope } from '../client';
-import * as util from '../../common';
 import { processDelayedDidOpen } from '../extension';
 import { makeVscodeRange } from '../utils';
+import { getLocalizedString, getLocalizedSymbolScope } from '../localization';
 
 export class DocumentSymbolProvider implements vscode.DocumentSymbolProvider {
     private client: DefaultClient;
@@ -17,18 +17,18 @@ export class DocumentSymbolProvider implements vscode.DocumentSymbolProvider {
         const documentSymbols: vscode.DocumentSymbol[] = [];
         if (symbols) {
             symbols.forEach((symbol) => {
-                let detail: string = util.getLocalizedString(symbol.detail);
+                let detail: string = getLocalizedString(symbol.detail);
                 if (symbol.scope === SymbolScope.Private) {
                     if (detail.length === 0) {
                         detail = "private";
                     } else {
-                        detail = util.getLocalizedSymbolScope("private", detail);
+                        detail = getLocalizedSymbolScope("private", detail);
                     }
                 } else if (symbol.scope === SymbolScope.Protected) {
                     if (detail.length === 0) {
                         detail = "protected";
                     } else {
-                        detail = util.getLocalizedSymbolScope("protected", detail);
+                        detail = getLocalizedSymbolScope("protected", detail);
                     }
                 }
 
diff --git a/Extension/src/LanguageServer/Providers/workspaceSymbolProvider.ts b/Extension/src/LanguageServer/Providers/workspaceSymbolProvider.ts
@@ -5,7 +5,7 @@
 import * as vscode from 'vscode';
 import { DefaultClient, GetSymbolInfoRequest, WorkspaceSymbolParams, LocalizeSymbolInformation, SymbolScope } from '../client';
 import { makeVscodeLocation } from '../utils';
-import * as util from '../../common';
+import { getLocalizedString, getLocalizedSymbolScope } from '../localization';
 
 export class WorkspaceSymbolProvider implements vscode.WorkspaceSymbolProvider {
     private client: DefaultClient;
@@ -23,13 +23,13 @@ export class WorkspaceSymbolProvider implements vscode.WorkspaceSymbolProvider {
 
         // Convert to vscode.Command array
         symbols.forEach((symbol) => {
-            let suffix: string = util.getLocalizedString(symbol.suffix);
+            let suffix: string = getLocalizedString(symbol.suffix);
             let name: string = symbol.name;
             if (suffix.length) {
                 if (symbol.scope === SymbolScope.Private) {
-                    suffix = util.getLocalizedSymbolScope("private", suffix);
+                    suffix = getLocalizedSymbolScope("private", suffix);
                 } else if (symbol.scope === SymbolScope.Protected) {
-                    suffix = util.getLocalizedSymbolScope("protected", suffix);
+                    suffix = getLocalizedSymbolScope("protected", suffix);
                 }
                 name = name + ' (' + suffix + ')';
             } else {
diff --git a/Extension/src/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts
@@ -24,7 +24,7 @@ import { InlayHintsProvider } from './Providers/inlayHintProvider';
 import { LanguageClient, LanguageClientOptions, ServerOptions, NotificationType, TextDocumentIdentifier, RequestType, ErrorAction, CloseAction, DidOpenTextDocumentParams, Range, Position, DocumentFilter } from 'vscode-languageclient';
 import { SourceFileConfigurationItem, WorkspaceBrowseConfiguration, SourceFileConfiguration, Version } from 'vscode-cpptools';
 import { Status, IntelliSenseStatus } from 'vscode-cpptools/out/testApi';
-import { getLocalizedString, LocalizeStringParams } from './localization';
+import { getLocaleId, getLocalizedString, LocalizeStringParams } from './localization';
 import { Location, TextEdit } from './commonTypes';
 import { makeVscodeRange, makeVscodeLocation } from './utils';
 import * as util from '../common';
@@ -37,7 +37,6 @@ import { ClientCollection } from './clientCollection';
 import { createProtocolFilter } from './protocolFilter';
 import { DataBinding } from './dataBinding';
 import minimatch = require("minimatch");
-import * as logger from '../logger';
 import { updateLanguageConfigurations, CppSourceStr } from './extension';
 import { SettingsTracker, getTracker } from './settingsTracker';
 import { getTestHook, TestHook } from '../testHook';
@@ -49,6 +48,7 @@ import * as nls from 'vscode-nls';
 import { lookupString, localizedStringCount } from '../nativeStrings';
 import { CodeAnalysisDiagnosticIdentifiersAndUri, RegisterCodeAnalysisNotifications, removeAllCodeAnalysisProblems,
     removeCodeAnalysisProblems, RemoveCodeAnalysisProblemsParams } from './codeAnalysis';
+import { DebugProtocolParams, getDiagnosticsChannel, getOutputChannelLogger, logDebugProtocol, Logger, logLocalized, showWarning, ShowWarningParams } from '../logger';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -64,10 +64,6 @@ const languageClientCrashTimes: number[] = [];
 let clientCollection: ClientCollection;
 let pendingTask: util.BlockingTask<any> | undefined;
 let compilerDefaults: configs.CompilerDefaults;
-let diagnosticsChannel: vscode.OutputChannel;
-let outputChannel: vscode.OutputChannel;
-let debugChannel: vscode.OutputChannel;
-let warningChannel: vscode.OutputChannel;
 let diagnosticsCollectionIntelliSense: vscode.DiagnosticCollection;
 
 let workspaceDisposables: vscode.Disposable[] = [];
@@ -91,32 +87,10 @@ function logTelemetry(notificationBody: TelemetryPayload): void {
 function setupOutputHandlers(): void {
     console.assert(languageClient !== undefined, "This method must not be called until this.languageClient is set in \"onReady\"");
 
-    languageClient.onNotification(DebugProtocolNotification, (output) => {
-        if (!debugChannel) {
-            debugChannel = vscode.window.createOutputChannel(`${localize("c.cpp.debug.protocol", "C/C++ Debug Protocol")}`);
-            workspaceDisposables.push(debugChannel);
-        }
-        debugChannel.appendLine("");
-        debugChannel.appendLine("************************************************************************************************************************");
-        debugChannel.append(`${output}`);
-    });
-
+    languageClient.onNotification(DebugProtocolNotification, logDebugProtocol);
     languageClient.onNotification(DebugLogNotification, logLocalized);
 }
 
-function log(output: string): void {
-    if (!outputChannel) {
-        outputChannel = logger.getOutputChannel();
-        workspaceDisposables.push(outputChannel);
-    }
-    outputChannel.appendLine(`${output}`);
-}
-
-function logLocalized(params: LocalizeStringParams): void {
-    const output: string = getLocalizedString(params);
-    log(output);
-}
-
 /** Note: We should not await on the following functions,
  * or any funstion that returns a promise acquired from them,
  * vscode.window.showInformationMessage, vscode.window.showWarningMessage, vscode.window.showErrorMessage
@@ -139,21 +113,6 @@ function showMessageWindow(params: ShowMessageWindowParams): void {
     }
 }
 
-function showWarning(params: ShowWarningParams): void {
-    const message: string = getLocalizedString(params.localizeStringParams);
-    let showChannel: boolean = false;
-    if (!warningChannel) {
-        warningChannel = vscode.window.createOutputChannel(`${localize("c.cpp.warnings", "C/C++ Configuration Warnings")}`);
-        workspaceDisposables.push(warningChannel);
-        showChannel = true;
-    }
-    // Append before showing the channel, to avoid a delay.
-    warningChannel.appendLine(`[${new Date().toLocaleString()}] ${message}`);
-    if (showChannel) {
-        warningChannel.show(true);
-    }
-}
-
 function publishIntelliSenseDiagnostics(params: PublishIntelliSenseDiagnosticsParams): void {
     if (!diagnosticsCollectionIntelliSense) {
         diagnosticsCollectionIntelliSense = vscode.languages.createDiagnosticCollection(CppSourceStr);
@@ -192,12 +151,6 @@ interface TelemetryPayload {
     metrics?: { [key: string]: number };
 }
 
-interface DebugProtocolParams {
-    jsonrpc: string;
-    method: string;
-    params?: any;
-}
-
 interface ReportStatusNotificationBody extends WorkspaceFolderParams {
     status: string;
 }
@@ -301,10 +254,6 @@ interface ShowMessageWindowParams {
     localizeStringParams: LocalizeStringParams;
 }
 
-interface ShowWarningParams {
-    localizeStringParams: LocalizeStringParams;
-}
-
 export interface GetDocumentSymbolRequestParams {
     uri: string;
 }
@@ -1378,7 +1327,7 @@ export class DefaultClient implements Client {
                 },
                 vcpkg_root: util.getVcpkgRoot(),
                 experimentalFeatures: workspaceSettings.experimentalFeatures,
-                edgeMessagesDirectory: path.join(util.getExtensionFilePath("bin"), "messages", util.getLocaleId()),
+                edgeMessagesDirectory: path.join(util.getExtensionFilePath("bin"), "messages", getLocaleId()),
                 localizedStrings: localizedStrings,
                 packageVersion: util.packageJson.version,
                 legacyCompilerArgsBehavior: settings_legacyCompilerArgsBehavior
@@ -1518,7 +1467,7 @@ export class DefaultClient implements Client {
                         this.loggingLevel = newLoggingLevel;
                         const newLoggingLevelLogged: boolean = !!newLoggingLevel && newLoggingLevel !== "None" && newLoggingLevel !== "Error";
                         if (oldLoggingLevelLogged || newLoggingLevelLogged) {
-                            const out: logger.Logger = logger.getOutputChannelLogger();
+                            const out: Logger = getOutputChannelLogger();
                             out.appendLine(localize({ key: "loggingLevel.changed", comment: ["{0} is the setting name 'loggingLevel', {1} is a string value such as 'Debug'"] }, "{0} has changed to: {1}", "loggingLevel", changedSettings["loggingLevel"]));
                         }
                     }
@@ -1810,12 +1759,8 @@ export class DefaultClient implements Client {
 
     public async logDiagnostics(): Promise<void> {
         const response: GetDiagnosticsResult = await this.requestWhenReady(() => this.languageClient.sendRequest(GetDiagnosticsRequest, null));
-        if (!diagnosticsChannel) {
-            diagnosticsChannel = vscode.window.createOutputChannel(localize("c.cpp.diagnostics", "C/C++ Diagnostics"));
-            workspaceDisposables.push(diagnosticsChannel);
-        } else {
-            diagnosticsChannel.clear();
-        }
+        const diagnosticsChannel: vscode.OutputChannel = getDiagnosticsChannel();
+        diagnosticsChannel.clear();
 
         const header: string = `-------- Diagnostics - ${new Date().toLocaleString()}\n`;
         const version: string = `Version: ${util.packageJson.version}\n`;
@@ -2352,7 +2297,7 @@ export class DefaultClient implements Client {
         } else if (message.endsWith("IntelliSense done")) {
             const settings: CppSettings = new CppSettings();
             if (settings.loggingLevel === "Debug") {
-                const out: logger.Logger = logger.getOutputChannelLogger();
+                const out: Logger = getOutputChannelLogger();
                 const duration: number = Date.now() - timeStamp;
                 out.appendLine(localize("update.intellisense.time", "Update IntelliSense time (sec): {0}", duration / 1000));
             }
@@ -2425,7 +2370,7 @@ export class DefaultClient implements Client {
     }
 
     private updateTagParseStatus(notificationBody: LocalizeStringParams): void {
-        this.model.parsingWorkspaceStatus.Value = util.getLocalizedString(notificationBody);
+        this.model.parsingWorkspaceStatus.Value = getLocalizedString(notificationBody);
         if (notificationBody.text.startsWith("Workspace parsing paused")) {
             this.model.isParsingWorkspacePausable.Value = true;
             this.model.isParsingWorkspacePaused.Value = true;
@@ -2768,7 +2713,7 @@ export class DefaultClient implements Client {
         }
 
         const settings: CppSettings = new CppSettings();
-        const out: logger.Logger = logger.getOutputChannelLogger();
+        const out: Logger = getOutputChannelLogger();
         if (settings.loggingLevel === "Debug") {
             out.appendLine(localize("configurations.received", "Custom configurations received:"));
         }
@@ -2872,7 +2817,7 @@ export class DefaultClient implements Client {
 
             const settings: CppSettings = new CppSettings();
             if (settings.loggingLevel === "Debug") {
-                const out: logger.Logger = logger.getOutputChannelLogger();
+                const out: Logger = getOutputChannelLogger();
                 out.appendLine(localize("browse.configuration.received", "Custom browse configuration received: {0}", JSON.stringify(sanitized, null, 2)));
             }
 
diff --git a/Extension/src/LanguageServer/clientCollection.ts b/Extension/src/LanguageServer/clientCollection.ts
@@ -295,7 +295,6 @@ export class ClientCollection {
         // this.defaultClient is already in this.languageClients, so do not call dispose() on it.
         this.languageClients.forEach(client => client.dispose());
         this.languageClients.clear();
-        cpptools.disposeWorkspaceData();
         return cpptools.DefaultClient.stopLanguageClient();
     }
 }
diff --git a/Extension/src/LanguageServer/localization.ts b/Extension/src/LanguageServer/localization.ts
@@ -4,7 +4,14 @@
  * ------------------------------------------------------------------------------------------ */
 'use strict';
 
+import { getExtensionFilePath } from '../common';
 import { lookupString } from '../nativeStrings';
+import * as nls from 'vscode-nls';
+import path = require('path');
+import * as fs from 'fs';
+
+nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
+const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
 export interface LocalizeStringParams {
     text: string;
@@ -24,3 +31,45 @@ export function getLocalizedString(params: LocalizeStringParams): string {
     }
     return indent + text;
 }
+
+interface VSCodeNlsConfig {
+    locale: string;
+    availableLanguages: {
+        [pack: string]: string;
+    };
+}
+
+export function getLocaleId(): string {
+    // This replicates the language detection used by initializeSettings() in vscode-nls
+    if (typeof process.env.VSCODE_NLS_CONFIG === 'string') {
+        const vscodeOptions: VSCodeNlsConfig = JSON.parse(process.env.VSCODE_NLS_CONFIG) as VSCodeNlsConfig;
+        if (vscodeOptions.availableLanguages) {
+            const value: any = vscodeOptions.availableLanguages['*'];
+            if (typeof value === 'string') {
+                return value;
+            }
+        }
+        if (typeof vscodeOptions.locale === 'string') {
+            return vscodeOptions.locale.toLowerCase();
+        }
+    }
+    return "en";
+}
+
+export function getLocalizedHtmlPath(originalPath: string): string {
+    const locale: string = getLocaleId();
+    if (!locale.startsWith("en")) {
+        const localizedFilePath: string = getExtensionFilePath(path.join("dist/html/", locale, originalPath));
+        if (fs.existsSync(localizedFilePath)) {
+            return localizedFilePath;
+        }
+    }
+    return getExtensionFilePath(originalPath);
+}
+
+export function getLocalizedSymbolScope(scope: string, detail: string): string {
+    return localize({
+        key: "c.cpp.symbolscope.separator", comment:
+            ["{0} is an untranslated C++ keyword (e.g. \"private\") and {1} is either another keyword (e.g. \"typedef\") or a localized property (e.g. a localized version of \"declaration\""]
+    }, "{0}, {1}", scope, detail);
+}
diff --git a/Extension/src/LanguageServer/settingsPanel.ts b/Extension/src/LanguageServer/settingsPanel.ts
@@ -10,6 +10,7 @@ import * as vscode from 'vscode';
 import * as util from '../common';
 import * as config from './configurations';
 import * as telemetry from '../telemetry';
+import { getLocalizedHtmlPath } from './localization';
 
 // TODO: share ElementId between SettingsPanel and SettingsApp. Investigate why SettingsApp cannot import/export
 const elementId: { [key: string]: string } = {
@@ -373,7 +374,7 @@ export class SettingsPanel {
     private getHtml(): string {
         let content: string | undefined;
 
-        content = fs.readFileSync(util.getLocalizedHtmlPath("ui/settings.html")).toString();
+        content = fs.readFileSync(getLocalizedHtmlPath("ui/settings.html")).toString();
 
         if (this.panel && this.panel.webview) {
             const cppImageUri: vscode.Uri = this.panel.webview.asWebviewUri(vscode.Uri.file(path.join(util.extensionPath, 'LanguageCCPP_color_128x.png')));
diff --git a/Extension/src/common.ts b/Extension/src/common.ts
diff --git a/Extension/src/logger.ts b/Extension/src/logger.ts
diff --git a/Extension/src/main.ts b/Extension/src/main.ts

Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,6 @@ export class ClientCollection {`
`295`	`295`	`// this.defaultClient is already in this.languageClients, so do not call dispose() on it.`
`296`	`296`	`this.languageClients.forEach(client => client.dispose());`
`297`	`297`	`this.languageClients.clear();`
`298`		`- cpptools.disposeWorkspaceData();`
`299`	`298`	`return cpptools.DefaultClient.stopLanguageClient();`
`300`	`299`	`}`
`301`	`300`	`}`