Function checkVsixCompatibility

Extension/src/main.ts:249–339

()

}

async function checkVsixCompatibility(): Promise<void> {
    const ignoreMismatchedCompatibleVsix: PersistentState<boolean> = new PersistentState<boolean>("CPP." + util.packageJson.version + ".ignoreMismatchedCompatibleVsix", false);
    let resetIgnoreMismatchedCompatibleVsix: boolean = true;

    // Check to ensure the correct platform-specific VSIX was installed.
    const vsixManifestPath: string = path.join(util.extensionPath, ".vsixmanifest");
    // Skip the check if the file does not exist, such as when debugging cpptools.
    if (await util.checkFileExists(vsixManifestPath)) {
        const content: string = await util.readFileText(vsixManifestPath);
        const matches: RegExpMatchArray | null = content.match(/TargetPlatform="(?<platform>[^"]*)"/);
        if (matches && matches.length > 0 && matches.groups) {
            const vsixTargetPlatform: string = matches.groups['platform'];
            const platformInfo: PlatformInformation = await PlatformInformation.GetPlatformInformation();
            let isPlatformCompatible: boolean = true;
            let isPlatformMatching: boolean = true;
            switch (vsixTargetPlatform) {
                case "win32-x64":
                    isPlatformMatching = platformInfo.platform === "win32" && platformInfo.architecture === "x64";
                    // x64 binaries can also be run on arm64 Windows 11.
                    isPlatformCompatible = platformInfo.platform === "win32" && (platformInfo.architecture === "x64" || (platformInfo.architecture === "arm64" && semver.gte(os.release(), "10.0.22000")));
                    break;
                case "win32-ia32":
                    isPlatformMatching = platformInfo.platform === "win32" && platformInfo.architecture === "x86";
                    // x86 binaries can also be run on x64 and arm64 Windows.
                    isPlatformCompatible = platformInfo.platform === "win32" && (platformInfo.architecture === "x86" || platformInfo.architecture === "x64" || platformInfo.architecture === "arm64");
                    break;
                case "win32-arm64":
                    isPlatformMatching = platformInfo.platform === "win32" && platformInfo.architecture === "arm64";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "linux-x64":
                    isPlatformMatching = platformInfo.platform === "linux" && platformInfo.architecture === "x64" && platformInfo.distribution?.name !== "alpine";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "linux-arm64":
                    isPlatformMatching = platformInfo.platform === "linux" && platformInfo.architecture === "arm64" && platformInfo.distribution?.name !== "alpine";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "linux-armhf":
                    isPlatformMatching = platformInfo.platform === "linux" && platformInfo.architecture === "arm" && platformInfo.distribution?.name !== "alpine";
                    // armhf binaries can also be run on aarch64 linux.
                    isPlatformCompatible = platformInfo.platform === "linux" && (platformInfo.architecture === "arm" || platformInfo.architecture === "arm64") && platformInfo.distribution?.name !== "alpine";
                    break;
                case "alpine-x64":
                    isPlatformMatching = platformInfo.platform === "linux" && platformInfo.architecture === "x64" && platformInfo.distribution?.name === "alpine";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "alpine-arm64":
                    isPlatformMatching = platformInfo.platform === "linux" && platformInfo.architecture === "arm64" && platformInfo.distribution?.name === "alpine";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "darwin-x64":
                    isPlatformMatching = platformInfo.platform === "darwin" && platformInfo.architecture === "x64";
                    isPlatformCompatible = isPlatformMatching;
                    break;
                case "darwin-arm64":
                    isPlatformMatching = platformInfo.platform === "darwin" && platformInfo.architecture === "arm64";
                    // x64 binaries can also be run on arm64 macOS.