Class LegacyCMakeDriver

The legacy driver.

Hierarchy

CMakeDriver
- LegacyCMakeDriver

Implements

Disposable

Index

Constructors

constructor

Properties

Accessors

Constructors

Private constructor

new LegacyCMakeDriver(cmake: CMakeExecutable, ws: DirectoryContext): LegacyCMakeDriver

Overrides CMakeDriver.constructor
- Defined in legacy-driver.ts:26
Parameters
- cmake: CMakeExecutable
- ws: DirectoryContext
Returns LegacyCMakeDriver

Properties

Private _cacheWatcher

_cacheWatcher: FileSystemWatcher = vscode.workspace.createFileSystemWatcher(this.cachePath)

Watcher for the CMake cache file on disk.

Private _cmakeCache

_cmakeCache: CMakeCache | null = null

Protected _isBusy

_isBusy: boolean = false

Private _needsReconfigure

_needsReconfigure: boolean = true

cmake

cmake: CMakeExecutable

ws

ws: DirectoryContext

Accessors

allTargetName

get allTargetName(): string

Inherited from CMakeDriver.allTargetName
- Defined in driver.ts:429
Returns string

binaryDir

get binaryDir(): string

Inherited from CMakeDriver.binaryDir
- Defined in driver.ts:390
Directory where build output is stored.

Returns string

cachePath

get cachePath(): string

Inherited from CMakeDriver.cachePath
- Defined in driver.ts:408
brief

Get the path to the CMakeCache file in the build directory

Returns string

cmakeCache

get cmakeCache(): null | CMakeCache

- Defined in legacy-driver.ts:106
Returns null | CMakeCache

cmakeCacheEntries

get cmakeCacheEntries(): Map<string, CacheEntryProperties>

Overrides CMakeDriver.cmakeCacheEntries
- Defined in legacy-driver.ts:115
Returns Map<string, CacheEntryProperties>

compilerID

get compilerID(): string | null

Inherited from CMakeDriver.compilerID
- Defined in driver.ts:441
The ID of the current compiler, as best we can tell

Returns string | null

copyCompileCommandsPath

get copyCompileCommandsPath(): string | null

Inherited from CMakeDriver.copyCompileCommandsPath
- Defined in driver.ts:402
Path to copy compile_commands.json to

Returns string | null

currentBuildType

get currentBuildType(): string

Inherited from CMakeDriver.currentBuildType
- Defined in driver.ts:419
Get the current build type, according to the current selected variant.

This is the value passed to CMAKE_BUILD_TYPE or --config for multiconf

Returns string

executableTargets

get executableTargets(): never[]

Overrides CMakeDriver.executableTargets
- Defined in legacy-driver.ts:99
Returns never[]

expansionOptions

get expansionOptions(): ExpansionOptions

Inherited from CMakeDriver.expansionOptions
- Defined in driver.ts:188
The options that will be passed to expand.expandString for this driver.

Returns ExpansionOptions

generatorName

get generatorName(): string | null

Overrides CMakeDriver.generatorName
- Defined in legacy-driver.ts:123
Returns string | null

installDir

get installDir(): string | null

Inherited from CMakeDriver.installDir
- Defined in driver.ts:396
Directory where the targets will be installed.

Returns string | null

isBusy

get isBusy(): boolean

Inherited from CMakeDriver.isBusy
- Defined in driver.ts:345
Is the driver busy? ie. running a configure/build/test

Returns boolean

isMultiConf

get isMultiConf(): boolean

Inherited from CMakeDriver.isMultiConf
- Defined in driver.ts:421
Returns boolean

linkerID

get linkerID(): string | null

Inherited from CMakeDriver.linkerID
- Defined in driver.ts:461
Returns string | null

mainListFile

get mainListFile(): string

Inherited from CMakeDriver.mainListFile
- Defined in driver.ts:382
Path to where the root CMakeLists.txt file should be

Returns string

onProgress

get onProgress(): vscode.Event<ProgressMessage>

Inherited from CMakeDriver.onProgress
- Defined in driver.ts:134
Returns vscode.Event<ProgressMessage>

sourceDir

get sourceDir(): string

Inherited from CMakeDriver.sourceDir
- Defined in driver.ts:354
The source directory, where the root CMakeLists.txt lives.

note

This is distinct from the config values, since we do variable substitution.

Returns string

targets

get targets(): never[]

Overrides CMakeDriver.targets
- Defined in legacy-driver.ts:98
Returns never[]

Methods

Protected _cleanPriorConfiguration

_cleanPriorConfiguration(): Promise<void>

Inherited from CMakeDriver._cleanPriorConfiguration
- Defined in driver.ts:272
Remove the prior CMake configuration files.

Returns Promise<void>

Private _reloadPostConfigure

_reloadPostConfigure(): Promise<void>

- Defined in legacy-driver.ts:109
Returns Promise<void>

asyncDispose

asyncDispose(): Promise<void>

Overrides CMakeDriver.asyncDispose
- Defined in legacy-driver.ts:42
Returns Promise<void>

build

build(target: string, consumer?: proc.OutputConsumer): Promise<number | null>

Inherited from CMakeDriver.build
- Defined in driver.ts:647
Parameters
- target: string
- Optional consumer: proc.OutputConsumer
Returns Promise<number | null>

checkNeedsReconfigure

checkNeedsReconfigure(): Promise<boolean>

Overrides CMakeDriver.checkNeedsReconfigure
- Defined in legacy-driver.ts:31
Returns Promise<boolean>

cleanConfigure

cleanConfigure(consumer?: proc.OutputConsumer): Promise<number>

Overrides CMakeDriver.cleanConfigure
- Defined in legacy-driver.ts:73
Parameters
- Optional consumer: proc.OutputConsumer
Returns Promise<number>

configure

configure(extra_args: string[], consumer?: proc.OutputConsumer): Promise<number>

Inherited from CMakeDriver.configure
- Defined in driver.ts:553
Parameters
- extra_args: string[]
- Optional consumer: proc.OutputConsumer
Returns Promise<number>

dispose

dispose(): void

Inherited from CMakeDriver.dispose
- Defined in driver.ts:101
Dispose the driver. This disposes some things synchronously, but also calls the asyncDispose() method to start any asynchronous shutdown.

Returns void

doConfigure

doConfigure(args_: string[], outputConsumer?: proc.OutputConsumer): Promise<number>

Overrides CMakeDriver.doConfigure
- Defined in legacy-driver.ts:44
Parameters
- args_: string[]
- Optional outputConsumer: proc.OutputConsumer
Returns Promise<number>

doConfigureSettingsChange

doConfigureSettingsChange(): void

Overrides CMakeDriver.doConfigureSettingsChange
- Defined in legacy-driver.ts:30
Returns void

doInit

doInit(): Promise<void>

Overrides CMakeDriver.doInit
- Defined in legacy-driver.ts:83
Returns Promise<void>

doPostBuild

doPostBuild(): Promise<boolean>

Overrides CMakeDriver.doPostBuild
- Defined in legacy-driver.ts:78
Returns Promise<boolean>

Protected doPreBuild

doPreBuild(): Promise<boolean>

Inherited from CMakeDriver.doPreBuild
- Defined in driver.ts:51
Returns Promise<boolean>

Protected doRefreshExpansions

doRefreshExpansions(cb: function): Promise<void>

Inherited from CMakeDriver.doRefreshExpansions
- Defined in driver.ts:357
Parameters
- cb: function
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

doSetKit

doSetKit(need_clean: boolean, cb: function): Promise<void>

Overrides CMakeDriver.doSetKit
- Defined in legacy-driver.ts:33
Parameters
- need_clean: boolean
- cb: function
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

executeCommand

executeCommand(command: string, args: string[], consumer?: proc.OutputConsumer, options?: proc.ExecutionOptions): Subprocess

Inherited from CMakeDriver.executeCommand
- Defined in driver.ts:221
Parameters
- command: string
- args: string[]
- Optional consumer: proc.OutputConsumer
- Optional options: proc.ExecutionOptions
Returns Subprocess

getBaseConfigureEnvironment

getBaseConfigureEnvironment(): Promise<object>

Inherited from CMakeDriver.getBaseConfigureEnvironment
- Defined in driver.ts:163
Get the configure environment and apply any needed substitutions before returning it.

Returns Promise<object>

getBestGenerator

getBestGenerator(): Promise<CMakeGenerator | null>

Inherited from CMakeDriver.getBestGenerator
- Defined in driver.ts:502
Picks the best generator to use on the current system

Returns Promise<CMakeGenerator | null>

getConfigureEnvironment

getConfigureEnvironment(): Promise<EnvironmentVariables>

Inherited from CMakeDriver.getConfigureEnvironment
- Defined in driver.ts:127
Get the environment variables that should be set at CMake-configure time.

Returns Promise<EnvironmentVariables>

getEffectiveSubprocessEnvironment

getEffectiveSubprocessEnvironment(opts?: proc.ExecutionOptions): EnvironmentVariables

Inherited from CMakeDriver.getEffectiveSubprocessEnvironment
- Defined in driver.ts:214
Parameters
- Optional opts: proc.ExecutionOptions
Returns EnvironmentVariables

getExpandedEnvironment

getExpandedEnvironment(): Promise<object>

Inherited from CMakeDriver.getExpandedEnvironment
- Defined in driver.ts:151
Get the environment and apply any needed substitutions before returning it.

Returns Promise<object>

getKitEnvironmentVariablesObject

getKitEnvironmentVariablesObject(): EnvironmentVariables

Inherited from CMakeDriver.getKitEnvironmentVariablesObject
- Defined in driver.ts:120
Get the environment variables required by the current Kit

Returns EnvironmentVariables

getPreferredGenerators

getPreferredGenerators(): CMakeGenerator[]

Inherited from CMakeDriver.getPreferredGenerators
- Defined in driver.ts:490
Returns CMakeGenerator[]

runCompileCommand

runCompileCommand(cmd: CompileCommand): vscode.Terminal

Inherited from CMakeDriver.runCompileCommand
- Defined in driver.ts:244
Launch the given compilation command in an embedded terminal.

Parameters
- cmd: CompileCommand
  
  The compilation command from a compilation database to run
Returns vscode.Terminal

setKit

setKit(kit: Kit): Promise<void>

Inherited from CMakeDriver.setKit
- Defined in driver.ts:290
Change the current kit. This lets the driver reload, if necessary.

Parameters
- kit: Kit
  
  The new kit
Returns Promise<void>

setVariantOptions

setVariantOptions(opts: VariantOption): Promise<void>

Inherited from CMakeDriver.setVariantOptions
- Defined in driver.ts:333
Change the current options from the variant.

Parameters
- opts: VariantOption
  
  The new options
Returns Promise<void>

stopCurrentProcess

stopCurrentProcess(): Promise<boolean>

Inherited from CMakeDriver.stopCurrentProcess
- Defined in driver.ts:775
Stops the currently running process at user request

Returns Promise<boolean>

Static create

create(cmake: CMakeExecutable, ws: DirectoryContext, kit: Kit | null): Promise<LegacyCMakeDriver>

- Defined in legacy-driver.ts:93
Parameters
- cmake: CMakeExecutable
- ws: DirectoryContext
- kit: Kit | null
Returns Promise<LegacyCMakeDriver>

Static createDerived

createDerived<T>(inst: T, kit: Kit | null): Promise<T>

Inherited from CMakeDriver.createDerived
- Defined in driver.ts:805
Asynchronous initialization. Should be called by base classes during their initialization.

Type parameters
- T: CMakeDriver
Parameters
- inst: T
- kit: Kit | null
Returns Promise<T>

Generated using TypeDoc