microsoft
/
vscode-cmake-tools
зеркало из https://github.com/microsoft/vscode-cmake-tools.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

before modifying eventEmitter for sourceDirectory

This commit is contained in:
elrashed 2022-08-19 09:36:13 -07:00
Родитель 9dd95930e4
Коммит 88d3575383
8 изменённых файлов: 81 добавлений и 61 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

48
src/cmakeTools.ts
Просмотреть файл

@ -107,20 +107,22 @@ export class CMakeTools implements api.CMakeToolsAPI {
private constructor(readonly extensionContext: vscode.ExtensionContext, readonly workspaceContext: DirectoryContext, folder?: vscode.WorkspaceFolder) {
// Handle the active kit changing. We want to do some updates and teardown
log.debug(localize('constructing.cmaketools', 'Constructing new CMakeTools instance'));
this.folder = folder ? folder : this.workspaceContext.folder;
this.variantManager = new VariantManager(this.folder, this.workspaceContext.state, this.workspaceContext.config);
this._folder = folder ? folder : this.workspaceContext.folder;
this.variantManager = new VariantManager(this._folder, this.workspaceContext.state, this.workspaceContext.config);
}
/**
* The folder associated with this CMakeTools instance
*/
private folder: vscode.WorkspaceFolder;
private _folder: vscode.WorkspaceFolder;
get folder(): vscode.WorkspaceFolder {
return this._folder;
}
/**
* The name of the folder for this CMakeTools instance
*/
get folderName(): string {
return this.folder.name;
return this._folder.name;
}
get workspaceFolder(): vscode.WorkspaceFolder {
@ -201,7 +203,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
if (configurePreset) {
log.debug(localize('resolving.config.preset', 'Resolving the selected configure preset'));
const expandedConfigurePreset = await preset.expandConfigurePreset(this.folder.uri.fsPath,
const expandedConfigurePreset = await preset.expandConfigurePreset(this._folder.uri.fsPath,
configurePreset,
lightNormalizePath(this.workspaceFolder.uri.fsPath || '.'),
this.sourceDir,
@ -269,7 +271,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
async setBuildPreset(buildPreset: string | null) {
if (buildPreset) {
log.debug(localize('resolving.build.preset', 'Resolving the selected build preset'));
const expandedBuildPreset = await preset.expandBuildPreset(this.folder.uri.fsPath,
const expandedBuildPreset = await preset.expandBuildPreset(this._folder.uri.fsPath,
buildPreset,
lightNormalizePath(this.workspaceFolder.uri.fsPath || '.'),
this.sourceDir,
@ -331,7 +333,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
async setTestPreset(testPreset: string | null) {
if (testPreset) {
log.debug(localize('resolving.test.preset', 'Resolving the selected test preset'));
const expandedTestPreset = await preset.expandTestPreset(this.folder.uri.fsPath,
const expandedTestPreset = await preset.expandTestPreset(this._folder.uri.fsPath,
testPreset,
lightNormalizePath(this.workspaceFolder.uri.fsPath || '.'),
this.sourceDir,
@ -582,7 +584,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
const ignoreActivation = localize('ignore.activation', "Don't show again");
let showCMakeLists: boolean = await showCMakeListsExperiment();
const existingCmakeListsFiles: string[] | undefined = await util.getAllCMakeListsPaths(this.folder.uri);
const existingCmakeListsFiles: string[] | undefined = await util.getAllCMakeListsPaths(this._folder.uri);
telemetryProperties["showCMakeListsExperiment"] = (showCMakeLists).toString();
if (existingCmakeListsFiles !== undefined && existingCmakeListsFiles.length > 0) {
@ -634,7 +636,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
} else if (selection.label === browse) {
const openOpts: vscode.OpenDialogOptions = {
canSelectMany: false,
defaultUri: vscode.Uri.file(this.folder.uri.fsPath),
defaultUri: vscode.Uri.file(this._folder.uri.fsPath),
filters: { "CMake files": ["txt"], "All files": ["*"] },
openLabel: "Load"
};
@ -692,7 +694,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
// This CMT folder can go through various changes while executing this function
// that could be relevant to the partial/full feature set view.
// This is a good place for an update.
return updateFullFeatureSetForFolder(this.folder);
return updateFullFeatureSetForFolder(this._folder);
}
/**
@ -754,7 +756,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
this.configurePreset,
this.buildPreset,
this.testPreset,
this.folder.uri.fsPath,
this._folder.uri.fsPath,
preConditionHandler,
preferredGenerators);
break;
@ -766,7 +768,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
this.configurePreset,
this.buildPreset,
this.testPreset,
this.folder.uri.fsPath,
this._folder.uri.fsPath,
preConditionHandler,
preferredGenerators);
break;
@ -778,7 +780,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
this.configurePreset,
this.buildPreset,
this.testPreset,
this.folder.uri.fsPath,
this._folder.uri.fsPath,
preConditionHandler,
preferredGenerators);
}
@ -856,7 +858,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
log.debug(localize('second.phase.init', 'Starting CMakeTools second-phase init'));
this._sourceDir = await util.normalizeAndVerifySourceDir(
await expandString(folder, CMakeDriver.sourceDirExpansionOptions(this.folder.uri.fsPath))
await expandString(folder, CMakeDriver.sourceDirExpansionOptions(this._folder.uri.fsPath))
);
// Start up the variant manager
@ -910,7 +912,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
// Otherwise, fallback to a simple check (does not cover CMake include files)
isCmakeFile = false;
if (str.endsWith("cmakelists.txt")) {
const allcmakelists: string[] | undefined = await util.getAllCMakeListsPaths(this.folder.uri);
const allcmakelists: string[] | undefined = await util.getAllCMakeListsPaths(this._folder.uri);
// Look for the CMakeLists.txt files that are in the workspace or the sourceDirectory root.
isCmakeFile = (str === path.join(sourceDirectory, "cmakelists.txt")) ||
(allcmakelists?.find(file => str === file.toLocaleLowerCase()) !== undefined);
@ -920,7 +922,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
if (isCmakeFile) {
// CMakeLists.txt change event: its creation or deletion are relevant,
// so update full/partial feature set view for this folder.
await updateFullFeatureSetForFolder(this.folder);
await updateFullFeatureSetForFolder(this._folder);
if (drv && !drv.configOrBuildInProgress()) {
if (drv.config.configureOnEdit) {
log.debug(localize('cmakelists.save.trigger.reconfigure', "Detected saving of CMakeLists.txt, attempting automatic reconfigure..."));
@ -939,7 +941,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
// For multi-root, the "onDidSaveTextDocument" will be received once for each project folder.
// To avoid misleading telemetry, consider the notification only for the active folder.
// There is always one active folder in a workspace and never more than one.
if (isActiveFolder(this.folder)) {
if (isActiveFolder(this._folder)) {
// "outside" evaluates whether the modified cmake file belongs to the active folder.
// Currently, we don't differentiate between outside active folder but inside any of the other
// workspace folders versus outside any folder referenced by the current workspace.
@ -967,7 +969,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
// Instead of parsing how and from where a *.cmake file is included or imported
// let's consider one inside the active folder if it's in the workspace folder,
// sourceDirectory or binaryDirectory.
if (str.startsWith(this.folder.uri.fsPath.toLowerCase()) ||
if (str.startsWith(this._folder.uri.fsPath.toLowerCase()) ||
str.startsWith(sourceDirectory) ||
str.startsWith(binaryDirectory)) {
outside = false;
@ -1874,7 +1876,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
}));
let chosen: { label: string; detail: string } | undefined;
if (!name) {
chosen = await vscode.window.showQuickPick(choices, { placeHolder: localize('select.a.launch.target', 'Select a launch target for {0}', this.folder.name) });
chosen = await vscode.window.showQuickPick(choices, { placeHolder: localize('select.a.launch.target', 'Select a launch target for {0}', this._folder.name) });
} else {
chosen = choices.find(choice => choice.label === name);
}
@ -2138,12 +2140,12 @@ export class CMakeTools implements api.CMakeToolsAPI {
const launchEnv = await this.getTargetLaunchEnvironment(drv, debugConfig.environment);
debugConfig.environment = util.makeDebuggerEnvironmentVars(launchEnv);
log.debug(localize('starting.debugger.with', 'Starting debugger with following configuration.'), JSON.stringify({
workspace: this.folder.uri.toString(),
workspace: this._folder.uri.toString(),
config: debugConfig,
environment: debugConfig.environment
}));
const cfg = vscode.workspace.getConfiguration('cmake', this.folder.uri).inspect<object>('debugConfig');
const cfg = vscode.workspace.getConfiguration('cmake', this._folder.uri).inspect<object>('debugConfig');
const customSetting = (cfg?.globalValue !== undefined || cfg?.workspaceValue !== undefined || cfg?.workspaceFolderValue !== undefined);
let dbg = debugConfig.MIMode?.toString();
if (!dbg && debugConfig.type === "cppvsdbg") {
@ -2158,7 +2160,7 @@ export class CMakeTools implements api.CMakeToolsAPI {
telemetry.logEvent('debug', telemetryProperties);
await vscode.debug.startDebugging(this.folder, debugConfig);
await vscode.debug.startDebugging(this._folder, debugConfig);
return vscode.debug.activeDebugSession!;
}

62
src/drivers/cmakeDriver.ts
Просмотреть файл

@ -145,7 +145,8 @@ export abstract class CMakeDriver implements vscode.Disposable {
*/
protected constructor(public readonly cmake: CMakeExecutable,
readonly config: ConfigurationReader,
private readonly __workspaceFolder: string | null,
private readonly _workspaceFolder: string | null,
private readonly _folder: string,
readonly preconditionHandler: CMakePreconditionProblemSolver) {
// We have a cache of file-compilation terminals. Wipe them out when the
// user closes those terminals.
@ -272,6 +273,10 @@ export abstract class CMakeDriver implements vscode.Disposable {
return this._testPreset;
}
get folder() {
return this._folder;
}
/**
* Get the vscode root workspace folder.
*
@ -279,16 +284,28 @@ export abstract class CMakeDriver implements vscode.Disposable {
* `file://` scheme.
*/
protected get workspaceFolder() {
return this.__workspaceFolder;
return this._workspaceFolder;
}
/**
* The source directory, where the root CMakeLists.txt lives.
*
* @note This is distinct from the config values, since we do variable
* substitution.
*/
get sourceDir(): string {
return this._sourceDirectory;
}
private _sourceDirectory = '';
protected variantKeywordSettings: Map<string, string> | null = null;
/**
* The options that will be passed to `expand.expandString` for this driver.
*/
get expansionOptions(): expand.ExpansionOptions {
const ws_root = util.lightNormalizePath(this.workspaceFolder || '.');
const workspaceFolder = util.lightNormalizePath(this.workspaceFolder || '.');
const sourceDirectory = this.folder || '.';
const target: Partial<TargetTriple> = parseTargetTriple(this._kitDetect?.triple ?? '') ?? {};
const version = this._kitDetect?.version ?? '0.0';
@ -297,12 +314,13 @@ export abstract class CMakeDriver implements vscode.Disposable {
buildKit: this._kit ? this._kit.name : '__unknownkit__',
buildType: this.currentBuildType,
generator: this.generatorName || 'null',
workspaceFolder: ws_root,
workspaceFolderBasename: path.basename(ws_root),
workspaceHash: util.makeHashString(ws_root),
workspaceRoot: ws_root,
workspaceRootFolderName: path.basename(ws_root),
workspaceFolder: workspaceFolder,
workspaceFolderBasename: path.basename(workspaceFolder),
workspaceHash: util.makeHashString(workspaceFolder),
workspaceRoot: workspaceFolder,
workspaceRootFolderName: path.basename(workspaceFolder),
userHome: paths.userHome,
sourceDirectory: sourceDirectory,
buildKitVendor: this._kitDetect?.vendor ?? '__unknow_vendor__',
buildKitTriple: this._kitDetect?.triple ?? '__unknow_triple__',
buildKitVersion: version,
@ -326,17 +344,18 @@ export abstract class CMakeDriver implements vscode.Disposable {
}
static sourceDirExpansionOptions(workspaceFolderFspath: string | null): expand.ExpansionOptions {
const ws_root = util.lightNormalizePath(workspaceFolderFspath || '.');
const workspaceFolder = util.lightNormalizePath(workspaceFolderFspath || '.');
// Fill in default replacements
const vars: expand.MinimalPresetContextVars = {
generator: 'generator',
workspaceFolder: ws_root,
workspaceFolderBasename: path.basename(ws_root),
workspaceHash: util.makeHashString(ws_root),
workspaceRoot: ws_root,
workspaceRootFolderName: path.basename(ws_root),
userHome: paths.userHome
workspaceFolder: workspaceFolder,
workspaceFolderBasename: path.basename(workspaceFolder),
workspaceHash: util.makeHashString(workspaceFolder),
workspaceRoot: workspaceFolder,
workspaceRootFolderName: path.basename(workspaceFolder),
userHome: paths.userHome,
sourceDirectory: workspaceFolder
};
return { vars };
@ -601,24 +620,13 @@ export abstract class CMakeDriver implements vscode.Disposable {
await this._refreshExpansions();
}
/**
* The source directory, where the root CMakeLists.txt lives.
*
* @note This is distinct from the config values, since we do variable
* substitution.
*/
get sourceDir(): string {
return this._sourceDirectory;
}
private _sourceDirectory = '';
protected doRefreshExpansions(cb: () => Promise<void>): Promise<void> {
return cb();
}
private async _refreshExpansions() {
return this.doRefreshExpansions(async () => {
this._sourceDirectory = await util.normalizeAndVerifySourceDir(await expand.expandString(this.config.sourceDirectory, CMakeDriver.sourceDirExpansionOptions(this.workspaceFolder)));
this._sourceDirectory = await util.normalizeAndVerifySourceDir(await expand.expandString(this._folder, CMakeDriver.sourceDirExpansionOptions(this.workspaceFolder)));
const opts = this.expansionOptions;
opts.envOverride = await this.getConfigureEnvironment();

6
src/drivers/cmakeFileApiDriver.ts
Просмотреть файл

@ -47,8 +47,9 @@ export class CMakeFileApiDriver extends CMakeDriver {
private constructor(cmake: CMakeExecutable,
readonly config: ConfigurationReader,
workspaceRootPath: string | null,
sourceDirectory: string,
preconditionHandler: CMakePreconditionProblemSolver) {
super(cmake, config, workspaceRootPath, preconditionHandler);
super(cmake, config, workspaceRootPath, sourceDirectory, preconditionHandler);
}
static async create(cmake: CMakeExecutable,
@ -59,10 +60,11 @@ export class CMakeFileApiDriver extends CMakeDriver {
buildPreset: BuildPreset | null,
testPreset: TestPreset | null,
workspaceRootPath: string | null,
sourceDirectory: string,
preconditionHandler: CMakePreconditionProblemSolver,
preferredGenerators: CMakeGenerator[]): Promise<CMakeFileApiDriver> {
log.debug('Creating instance of CMakeFileApiDriver');
return this.createDerived(new CMakeFileApiDriver(cmake, config, workspaceRootPath, preconditionHandler),
return this.createDerived(new CMakeFileApiDriver(cmake, config, workspaceRootPath, sourceDirectory, preconditionHandler),
useCMakePresets,
kit,
configurePreset,

7
src/drivers/cmakeLegacyDriver.ts
Просмотреть файл

@ -38,8 +38,8 @@ export class CMakeLegacyDriver extends CMakeDriver {
throw new Error('Method not implemented.');
}
private constructor(cmake: CMakeExecutable, readonly config: ConfigurationReader, workspaceFolder: string | null, preconditionHandler: CMakePreconditionProblemSolver) {
super(cmake, config, workspaceFolder, preconditionHandler);
private constructor(cmake: CMakeExecutable, readonly config: ConfigurationReader, workspaceFolder: string | null, sourceDirectory: string, preconditionHandler: CMakePreconditionProblemSolver) {
super(cmake, config, workspaceFolder, sourceDirectory, preconditionHandler);
}
private _needsReconfigure = true;
@ -143,10 +143,11 @@ export class CMakeLegacyDriver extends CMakeDriver {
buildPreset: BuildPreset | null,
testPreset: TestPreset | null,
workspaceFolder: string | null,
sourceDirectory: string,
preconditionHandler: CMakePreconditionProblemSolver,
preferredGenerators: CMakeGenerator[]): Promise<CMakeLegacyDriver> {
log.debug(localize('creating.instance.of', 'Creating instance of {0}', "LegacyCMakeDriver"));
return this.createDerived(new CMakeLegacyDriver(cmake, config, workspaceFolder, preconditionHandler),
return this.createDerived(new CMakeLegacyDriver(cmake, config, workspaceFolder, sourceDirectory, preconditionHandler),
useCMakePresets,
kit,
configurePreset,

7
src/drivers/cmakeServerDriver.ts
Просмотреть файл

@ -38,8 +38,8 @@ export class CMakeServerDriver extends CMakeDriver {
throw new Error('Method not implemented.');
}
private constructor(cmake: CMakeExecutable, readonly config: ConfigurationReader, workspaceFolder: string | null, preconditionHandler: CMakePreconditionProblemSolver) {
super(cmake, config, workspaceFolder, preconditionHandler);
private constructor(cmake: CMakeExecutable, readonly config: ConfigurationReader, workspaceFolder: string | null, sourceDirectory: string, preconditionHandler: CMakePreconditionProblemSolver) {
super(cmake, config, workspaceFolder, sourceDirectory, preconditionHandler);
this.config.onChange('environment', () => this._restartClient());
this.config.onChange('configureEnvironment', () => this._restartClient());
}
@ -449,9 +449,10 @@ export class CMakeServerDriver extends CMakeDriver {
buildPreset: BuildPreset | null,
testPreset: TestPreset | null,
workspaceFolder: string | null,
sourceDirectory: string,
preconditionHandler: CMakePreconditionProblemSolver,
preferredGenerators: CMakeGenerator[]): Promise<CMakeServerDriver> {
return this.createDerived(new CMakeServerDriver(cmake, config, workspaceFolder, preconditionHandler),
return this.createDerived(new CMakeServerDriver(cmake, config, workspaceFolder, sourceDirectory, preconditionHandler),
useCMakePresets,
kit,
configurePreset,

4
src/expand.ts
Просмотреть файл

@ -30,6 +30,8 @@ interface RequiredExpansionContextVars {
workspaceRoot: string;
workspaceRootFolderName: string;
userHome: string;
// Path to the project source directory. sourceDirectory can be different from workspaceFolder.
sourceDirectory: string;
}
export interface KitContextVars extends RequiredExpansionContextVars {
@ -48,7 +50,7 @@ export interface KitContextVars extends RequiredExpansionContextVars {
export interface PresetContextVars extends RequiredExpansionContextVars {
[key: string]: string;
sourceDir: string;
sourceDir: string; // Path to the project source directory (i.e. the same as CMAKE_SOURCE_DIR).
sourceParentDir: string;
sourceDirName: string;
presetName: string;

1
src/preset.ts
Просмотреть файл

@ -578,6 +578,7 @@ async function getExpansionOptions(workspaceFolder: string, sourceDir: string, p
workspaceRoot: workspaceFolder,
workspaceRootFolderName: path.dirname(workspaceFolder),
userHome: paths.userHome,
sourceDirectory: sourceDir,
sourceDir,
sourceParentDir: path.dirname(sourceDir),
sourceDirName: path.basename(sourceDir),

7
src/presetsController.ts
Просмотреть файл

@ -41,7 +41,8 @@ export class PresetsController {
static async init(cmakeTools: CMakeTools, kitsController: KitsController): Promise<PresetsController> {
const presetsController = new PresetsController(cmakeTools, kitsController);
const expandSourceDir = async (dir: string) => {
const workspaceFolder = cmakeTools.folder.uri.fsPath;
const workspaceFolder = cmakeTools.workspaceFolder.uri.fsPath;
const sourceDirectory = cmakeTools.folder.uri.fsPath;
const expansionOpts: ExpansionOptions = {
vars: {
workspaceFolder,
@ -50,6 +51,7 @@ export class PresetsController {
workspaceRoot: workspaceFolder,
workspaceRootFolderName: path.dirname(workspaceFolder),
userHome: paths.userHome,
sourceDirectory: sourceDirectory,
// Following fields are not supported for sourceDir expansion
generator: '${generator}',
sourceDir: '${sourceDir}',
@ -61,7 +63,8 @@ export class PresetsController {
return util.normalizeAndVerifySourceDir(await expandString(dir, expansionOpts));
};
presetsController._sourceDir = await expandSourceDir(cmakeTools.workspaceContext.config.sourceDirectory);
//presetsController._sourceDir = await expandSourceDir(cmakeTools.workspaceContext.config.sourceDirectory);
presetsController._sourceDir = await expandSourceDir(cmakeTools.folder.uri.fsPath);
// We explicitly read presets file here, instead of on the initialization of the file watcher. Otherwise
// there might be timing issues, since listeners are invoked async.