forked from microsoft/vscode-cpptools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.ts
478 lines (403 loc) · 21.4 KB
/
main.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
/* --------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All Rights Reserved.
* See 'LICENSE' in the project root for license information.
* ------------------------------------------------------------------------------------------ */
'use strict';
import * as DebuggerExtension from './Debugger/extension';
import * as fs from 'fs';
import * as LanguageServer from './LanguageServer/extension';
import * as os from 'os';
import * as path from 'path';
import * as Telemetry from './telemetry';
import * as util from './common';
import * as vscode from 'vscode';
import * as nls from 'vscode-nls';
import { PersistentState } from './LanguageServer/persistentState';
import { CppToolsApi, CppToolsExtension } from 'vscode-cpptools';
import { getTemporaryCommandRegistrarInstance, initializeTemporaryCommandRegistrar } from './commands';
import { PlatformInformation, GetOSName } from './platform';
import { PackageManager, PackageManagerError, IPackage, VersionsMatch, ArchitecturesMatch, PlatformsMatch } from './packageManager';
import { getInstallationInformation, InstallationInformation, setInstallationStage, setInstallationType, InstallationType } from './installationInformation';
import { Logger, getOutputChannelLogger, showOutputChannel } from './logger';
import { CppTools1, NullCppTools } from './cppTools1';
import { CppSettings } from './LanguageServer/settings';
import { vsixNameForPlatform, releaseDownloadUrl } from './githubAPI';
nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
const localize: nls.LocalizeFunc = nls.loadMessageBundle();
const cppTools: CppTools1 = new CppTools1();
let languageServiceDisabled: boolean = false;
let reloadMessageShown: boolean = false;
const disposables: vscode.Disposable[] = [];
export async function activate(context: vscode.ExtensionContext): Promise<CppToolsApi & CppToolsExtension> {
await util.checkCuda();
let errMsg: string = "";
const arch: string = PlatformInformation.GetArchitecture();
if (arch !== 'x64' && (process.platform !== 'win32' || (arch !== 'x86' && arch !== 'arm64')) && (process.platform !== 'linux' || (arch !== 'x64' && arch !== 'arm' && arch !== 'arm64')) && (process.platform !== 'darwin' || arch !== 'arm64')) {
errMsg = localize("architecture.not.supported", "Architecture {0} is not supported. ", String(arch));
} else if (process.platform === 'linux' && await util.checkDirectoryExists('/etc/alpine-release')) {
errMsg = localize("apline.containers.not.supported", "Alpine containers are not supported.");
}
if (errMsg) {
vscode.window.showErrorMessage(errMsg);
return new NullCppTools();
}
util.setExtensionContext(context);
initializeTemporaryCommandRegistrar();
Telemetry.activate();
util.setProgress(0);
// Register a protocol handler to serve localized versions of the schema for c_cpp_properties.json
class SchemaProvider implements vscode.TextDocumentContentProvider {
public async provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
console.assert(uri.path[0] === '/', "A preceeding slash is expected on schema uri path");
const fileName: string = uri.path.substr(1);
const locale: string = util.getLocaleId();
let localizedFilePath: string = util.getExtensionFilePath(path.join("dist/schema/", locale, fileName));
const fileExists: boolean = await util.checkFileExists(localizedFilePath);
if (!fileExists) {
localizedFilePath = util.getExtensionFilePath(fileName);
}
return util.readFileText(localizedFilePath);
}
}
vscode.workspace.registerTextDocumentContentProvider('cpptools-schema', new SchemaProvider());
// Initialize the DebuggerExtension and register the related commands and providers.
DebuggerExtension.initialize(context);
await processRuntimeDependencies();
// Read archictures of binaries from install.lock
const fileContents: string = await util.readFileText(util.getInstallLockPath());
// Assume current platform if install.lock is empty.
let installedPlatformAndArchitecture: util.InstallLockContents = {
platform: process.platform,
architecture: arch
};
if (fileContents.length !== 0) {
try {
installedPlatformAndArchitecture = <util.InstallLockContents>JSON.parse(fileContents);
} catch (error) {
// If the contents of install.lock are corrupted, treat as if it's empty.
}
}
// Check the main binaries files to declare if the extension has been installed successfully.
if (process.platform !== installedPlatformAndArchitecture.platform
|| (arch !== installedPlatformAndArchitecture.architecture
&& !(process.platform === "win32"
// On x64 Windows, allow x86 binaries.
&& ((arch === "x64" && installedPlatformAndArchitecture.architecture === "x86")
// On arm64 Windows, allow x86 or x64 binaries.
|| (arch === "arm64" && ((installedPlatformAndArchitecture.architecture === "x86") || (installedPlatformAndArchitecture.architecture === "x64")))))
// On arm64 macOS, allow x64 binaries.
&& !(process.platform === "darwin" && arch === "arm64" && installedPlatformAndArchitecture.architecture === "x64"))) {
// Check if the correct offline/insiders vsix is installed on the correct platform.
const platformInfo: PlatformInformation = await PlatformInformation.GetPlatformInformation();
const vsixName: string = vsixNameForPlatform(platformInfo);
const downloadLink: string = localize("download.button", "Go to Download Page");
errMsg = localize("native.binaries.not.supported", "This {0} {1} version of the extension is incompatible with your OS. Please download and install the \"{2}\" version of the extension.", GetOSName(installedPlatformAndArchitecture.platform), installedPlatformAndArchitecture.architecture, vsixName);
vscode.window.showErrorMessage(errMsg, downloadLink).then(async (selection) => {
if (selection === downloadLink) {
vscode.env.openExternal(vscode.Uri.parse(releaseDownloadUrl));
}
});
} else if (!(await util.checkInstallBinariesExist())) {
errMsg = localize("extension.installation.failed", "The C/C++ extension failed to install successfully. You will need to repair or reinstall the extension for C/C++ language features to function properly.");
const reload: string = localize("remove.extension", "Attempt to Repair");
vscode.window.showErrorMessage(errMsg, reload).then(async (value?: string) => {
if (value === reload) {
await util.removeInstallLockFile();
vscode.commands.executeCommand("workbench.action.reloadWindow");
}
});
} else if (!(await util.checkInstallJsonsExist())) {
// Check the Json files to declare if the extension has been installed successfully.
errMsg = localize("json.files.missing", "The C/C++ extension failed to install successfully. You will need to reinstall the extension for C/C++ language features to function properly.");
const downloadLink: string = localize("download.button", "Go to Download Page");
vscode.window.showErrorMessage(errMsg, downloadLink).then(async (selection) => {
if (selection === downloadLink) {
vscode.env.openExternal(vscode.Uri.parse(releaseDownloadUrl));
}
});
}
return cppTools;
}
export function deactivate(): Thenable<void> {
DebuggerExtension.dispose();
Telemetry.deactivate();
disposables.forEach(d => d.dispose());
if (languageServiceDisabled) {
return Promise.resolve();
}
return LanguageServer.deactivate();
}
async function processRuntimeDependencies(): Promise<void> {
const installLockExists: boolean = await util.checkInstallLockFile();
setInstallationStage('getPlatformInfo');
const info: PlatformInformation = await PlatformInformation.GetPlatformInformation();
let forceOnlineInstall: boolean = false;
if (info.platform === "darwin" && info.version) {
const darwinVersion: PersistentState<string | undefined> = new PersistentState("Cpp.darwinVersion", info.version);
// macOS version has changed
if (darwinVersion.Value !== info.version) {
const highSierraOrLowerRegex: RegExp = new RegExp('10\\.(1[0-3]|[0-9])(\\..*)*$');
const lldbMiFolderPath: string = util.getExtensionFilePath('./debugAdapters/lldb-mi');
// For macOS and if a user has upgraded their OS, check to see if we are on Mojave or later
// and that the debugAdapters/lldb-mi folder exists. This will force a online install to get the correct binaries.
if (!highSierraOrLowerRegex.test(info.version) &&
!await util.checkDirectoryExists(lldbMiFolderPath)) {
forceOnlineInstall = true;
setInstallationStage('cleanUpUnusedBinaries');
await cleanUpUnusedBinaries(info);
}
}
}
const doOfflineInstall: boolean = installLockExists && !forceOnlineInstall;
if (doOfflineInstall) {
// Offline Scenario: Lock file exists but package.json has not had its activationEvents rewritten.
if (util.packageJson.activationEvents && util.packageJson.activationEvents.length === 1) {
try {
await offlineInstallation(info);
} catch (error) {
getOutputChannelLogger().showErrorMessage(localize('initialization.failed', 'The installation of the C/C++ extension failed. Please see the output window for more information.'));
showOutputChannel();
// Send the failure telemetry since postInstall will not be called.
sendTelemetry(info);
}
} else {
// The extension has been installed and activated before.
await finalizeExtensionActivation();
}
} else {
// No lock file, need to download and install dependencies.
try {
await onlineInstallation(info);
} catch (error) {
handleError(error);
// Send the failure telemetry since postInstall will not be called.
sendTelemetry(info);
}
}
}
async function offlineInstallation(info: PlatformInformation): Promise<void> {
setInstallationType(InstallationType.Offline);
setInstallationStage('cleanUpUnusedBinaries');
await cleanUpUnusedBinaries(info);
setInstallationStage('makeBinariesExecutable');
await makeBinariesExecutable();
setInstallationStage('makeOfflineBinariesExecutable');
await makeOfflineBinariesExecutable(info);
setInstallationStage('rewriteManifest');
await rewriteManifest();
setInstallationStage('postInstall');
await postInstall(info);
}
async function onlineInstallation(info: PlatformInformation): Promise<void> {
setInstallationType(InstallationType.Online);
await downloadAndInstallPackages(info);
setInstallationStage('makeBinariesExecutable');
await makeBinariesExecutable();
setInstallationStage('rewriteManifest');
await rewriteManifest();
setInstallationStage('touchInstallLockFile');
await touchInstallLockFile(info);
setInstallationStage('postInstall');
await postInstall(info);
}
async function downloadAndInstallPackages(info: PlatformInformation): Promise<void> {
const outputChannelLogger: Logger = getOutputChannelLogger();
outputChannelLogger.appendLine(localize("updating.dependencies", "Updating C/C++ dependencies..."));
const packageManager: PackageManager = new PackageManager(info, outputChannelLogger);
return vscode.window.withProgress({
location: vscode.ProgressLocation.Notification,
cancellable: false
}, async (progress, token) => {
progress.report({ message: "C/C++ Extension" , increment: 0});
outputChannelLogger.appendLine('');
setInstallationStage('downloadPackages');
await packageManager.DownloadPackages(progress);
outputChannelLogger.appendLine('');
setInstallationStage('installPackages');
await packageManager.InstallPackages(progress);
});
}
function makeBinariesExecutable(): Promise<void> {
return util.allowExecution(util.getDebugAdaptersPath("OpenDebugAD7"));
}
function packageMatchesPlatform(pkg: IPackage, info: PlatformInformation): boolean {
return PlatformsMatch(pkg, info) &&
(pkg.architectures === undefined || ArchitecturesMatch(pkg, info)) &&
VersionsMatch(pkg, info);
}
function invalidPackageVersion(pkg: IPackage, info: PlatformInformation): boolean {
return PlatformsMatch(pkg, info) &&
(pkg.architectures === undefined || ArchitecturesMatch(pkg, info)) &&
!VersionsMatch(pkg, info);
}
async function makeOfflineBinariesExecutable(info: PlatformInformation): Promise<void> {
const promises: Thenable<void>[] = [];
const packages: IPackage[] = util.packageJson["runtimeDependencies"];
packages.forEach(p => {
if (p.binaries && p.binaries.length > 0 &&
packageMatchesPlatform(p, info)) {
p.binaries.forEach(binary => promises.push(util.allowExecution(util.getExtensionFilePath(binary))));
}
});
await Promise.all(promises);
}
async function cleanUpUnusedBinaries(info: PlatformInformation): Promise<void> {
const promises: Thenable<void>[] = [];
const packages: IPackage[] = util.packageJson["runtimeDependencies"];
const logger: Logger = getOutputChannelLogger();
packages.forEach(p => {
if (p.binaries && p.binaries.length > 0 &&
invalidPackageVersion(p, info)) {
p.binaries.forEach(binary => {
const path: string = util.getExtensionFilePath(binary);
if (fs.existsSync(path)) {
logger.appendLine(`deleting: ${path}`);
promises.push(util.deleteFile(path));
}
});
}
});
await Promise.all(promises);
}
function touchInstallLockFile(info: PlatformInformation): Promise<void> {
return util.touchInstallLockFile(info);
}
function handleError(error: any): void {
const installationInformation: InstallationInformation = getInstallationInformation();
installationInformation.hasError = true;
installationInformation.telemetryProperties['stage'] = installationInformation.stage ?? "";
let errorMessage: string;
if (error instanceof PackageManagerError) {
const packageError: PackageManagerError = error;
installationInformation.telemetryProperties['error.methodName'] = packageError.methodName;
installationInformation.telemetryProperties['error.message'] = packageError.message;
if (packageError.innerError) {
errorMessage = packageError.innerError.toString();
installationInformation.telemetryProperties['error.innerError'] = util.removePotentialPII(errorMessage);
} else {
errorMessage = packageError.localizedMessageText;
}
if (packageError.pkg) {
installationInformation.telemetryProperties['error.packageName'] = packageError.pkg.description;
installationInformation.telemetryProperties['error.packageUrl'] = packageError.pkg.url;
}
if (packageError.errorCode) {
installationInformation.telemetryProperties['error.errorCode'] = util.removePotentialPII(packageError.errorCode);
}
} else {
errorMessage = error.toString();
installationInformation.telemetryProperties['error.toString'] = util.removePotentialPII(errorMessage);
}
const outputChannelLogger: Logger = getOutputChannelLogger();
if (installationInformation.stage === 'downloadPackages') {
outputChannelLogger.appendLine("");
}
// Show the actual message and not the sanitized one
outputChannelLogger.appendLine(localize('failed.at.stage', "Failed at stage: {0}", installationInformation.stage));
outputChannelLogger.appendLine(errorMessage);
outputChannelLogger.appendLine("");
outputChannelLogger.appendLine(localize('failed.at.stage2', 'If you work in an offline environment or repeatedly see this error, try downloading a version of the extension with all the dependencies pre-included from {0}, then use the "Install from VSIX" command in VS Code to install it.', releaseDownloadUrl));
showOutputChannel();
}
function sendTelemetry(info: PlatformInformation): boolean {
const installBlob: InstallationInformation = getInstallationInformation();
const success: boolean = !installBlob.hasError;
installBlob.telemetryProperties['success'] = success.toString();
installBlob.telemetryProperties['type'] = installBlob.type === InstallationType.Online ? "online" : "offline";
if (info.distribution) {
installBlob.telemetryProperties['linuxDistroName'] = info.distribution.name;
installBlob.telemetryProperties['linuxDistroVersion'] = info.distribution.version;
}
if (success) {
util.setProgress(util.getProgressInstallSuccess());
}
installBlob.telemetryProperties['osArchitecture'] = os.arch();
installBlob.telemetryProperties['infoArchitecture'] = info.architecture;
Telemetry.logDebuggerEvent("acquisition", installBlob.telemetryProperties);
return success;
}
async function postInstall(info: PlatformInformation): Promise<void> {
const outputChannelLogger: Logger = getOutputChannelLogger();
outputChannelLogger.appendLine("");
outputChannelLogger.appendLine(localize('finished.installing.dependencies', "Finished installing dependencies"));
outputChannelLogger.appendLine("");
const installSuccess: boolean = sendTelemetry(info);
// If there is a download failure, we shouldn't continue activating the extension in some broken state.
if (!installSuccess) {
throw new Error(localize("failed.installing.dependencies", "Failed installing dependencies"));
} else {
// Notify users if debugging may not be supported on their OS.
util.checkDistro(info);
return finalizeExtensionActivation();
}
}
async function finalizeExtensionActivation(): Promise<void> {
const settings: CppSettings = new CppSettings();
if (settings.intelliSenseEngine === "Disabled") {
languageServiceDisabled = true;
getTemporaryCommandRegistrarInstance().disableLanguageServer();
disposables.push(vscode.workspace.onDidChangeConfiguration(() => {
if (!reloadMessageShown && settings.intelliSenseEngine !== "Disabled") {
reloadMessageShown = true;
util.promptForReloadWindowDueToSettingsChange();
}
}));
return;
}
disposables.push(vscode.workspace.onDidChangeConfiguration(() => {
if (!reloadMessageShown && settings.intelliSenseEngine === "Disabled") {
reloadMessageShown = true;
util.promptForReloadWindowDueToSettingsChange();
}
}));
getTemporaryCommandRegistrarInstance().activateLanguageServer();
const packageJson: any = util.getRawPackageJson();
let writePackageJson: boolean = false;
const packageJsonPath: string = util.getExtensionFilePath("package.json");
if (packageJsonPath.includes(".vscode-insiders") || packageJsonPath.includes(".vscode-exploration")) {
if (packageJson.contributes.configuration.properties['C_Cpp.updateChannel'].default === 'Default') {
packageJson.contributes.configuration.properties['C_Cpp.updateChannel'].default = 'Insiders';
writePackageJson = true;
}
}
if (writePackageJson) {
return util.writeFileText(util.getPackageJsonPath(), util.stringifyPackageJson(packageJson));
}
}
function rewriteManifest(): Promise<void> {
// Replace activationEvents with the events that the extension should be activated for subsequent sessions.
const packageJson: any = util.getRawPackageJson();
packageJson.activationEvents = [
"onLanguage:c",
"onLanguage:cpp",
"onLanguage:cuda-cpp",
"onCommand:extension.pickNativeProcess",
"onCommand:extension.pickRemoteNativeProcess",
"onCommand:C_Cpp.BuildAndDebugActiveFile",
"onCommand:C_Cpp.ConfigurationEditJSON",
"onCommand:C_Cpp.ConfigurationEditUI",
"onCommand:C_Cpp.ConfigurationSelect",
"onCommand:C_Cpp.ConfigurationProviderSelect",
"onCommand:C_Cpp.SwitchHeaderSource",
"onCommand:C_Cpp.EnableErrorSquiggles",
"onCommand:C_Cpp.DisableErrorSquiggles",
"onCommand:C_Cpp.ToggleIncludeFallback",
"onCommand:C_Cpp.ToggleDimInactiveRegions",
"onCommand:C_Cpp.ResetDatabase",
"onCommand:C_Cpp.TakeSurvey",
"onCommand:C_Cpp.LogDiagnostics",
"onCommand:C_Cpp.RescanWorkspace",
"onCommand:C_Cpp.VcpkgClipboardInstallSuggested",
"onCommand:C_Cpp.VcpkgOnlineHelpSuggested",
"onCommand:C_Cpp.GenerateEditorConfig",
"onCommand:C_Cpp.GoToNextDirectiveInGroup",
"onCommand:C_Cpp.GoToPrevDirectiveInGroup",
"onCommand:C_Cpp.CheckForCompiler",
"onDebugInitialConfigurations",
"onDebugResolve:cppdbg",
"onDebugResolve:cppvsdbg",
"workspaceContains:/.vscode/c_cpp_properties.json",
"onFileSystem:cpptools-schema"
];
return util.writeFileText(util.getPackageJsonPath(), util.stringifyPackageJson(packageJson));
}