Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CMakeServerClientDriver

Hierarchy

Implements

  • Disposable

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Properties

Private _cacheEntries

_cacheEntries: Map<string, Entry> = new Map<string, cache.Entry>()

Private _clientChangeInProgress

_clientChangeInProgress: Promise<void> = Promise.resolve()

Private _cmakeInputFileSet

_cmakeInputFileSet: InputFileSet = InputFileSet.createEmpty()

Private _cmsClient

_cmsClient: Promise<CMakeServerClient>

Private _codeModel

_codeModel: null | CodeModelContent

Private _codeModelChanged

_codeModelChanged: EventEmitter<null | CodeModelContent> = new vscode.EventEmitter<null|cms.CodeModelContent>()

Private _globalSettings

_globalSettings: GlobalSettingsContent

Private _hadConfigurationChanged

_hadConfigurationChanged: boolean = true

Track if the user changes the settings of the configure via settings.json

Protected _isBusy

_isBusy: boolean = false

Private _onMessageEmitter

_onMessageEmitter: EventEmitter<string> = new vscode.EventEmitter<string>()

Private _prevConfigureEnv

_prevConfigureEnv: string = "null"

The previous configuration environment. Used to detect when we need to restart cmake-server

Private _progressEmitter

_progressEmitter: EventEmitter<ProgressMessage> = new vscode.EventEmitter<cms.ProgressMessage>()

Private _ws

_ws: DirectoryContext

cmake

cmake: CMakeExecutable

ws

ws: DirectoryContext

Accessors

allTargetName

  • get allTargetName(): string

binaryDir

  • get binaryDir(): string

cachePath

  • get cachePath(): string

cmakeCacheEntries

codeModel

compilerID

  • get compilerID(): string | null

copyCompileCommandsPath

  • get copyCompileCommandsPath(): string | null

currentBuildType

  • get currentBuildType(): string

  • 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

expansionOptions

generatorName

  • get generatorName(): string | null

installDir

  • get installDir(): string | null

isBusy

  • get isBusy(): boolean

isMultiConf

  • get isMultiConf(): boolean

linkerID

  • get linkerID(): string | null

mainListFile

  • get mainListFile(): string

onCodeModelChanged

onMessage

  • get onMessage(): Event<string>

onProgress

sourceDir

  • get sourceDir(): string

  • 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

Methods

Protected _cleanPriorConfiguration

  • _cleanPriorConfiguration(): Promise<void>

Private _doRestartClient

_refreshPostConfigure

  • _refreshPostConfigure(): Promise<void>

Private _restartClient

  • _restartClient(): Promise<void>

Private _setKitAndRestart

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

  • Parameters

    • need_clean: boolean
    • cb: function
        • (): Promise<void>

        • Returns Promise<void>

    Returns Promise<void>

Private _startNewClient

asyncDispose

  • asyncDispose(): Promise<void>

build

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

  • Parameters

    • target: string
    • Optional consumer: proc.OutputConsumer

    Returns Promise<number | null>

checkNeedsReconfigure

  • checkNeedsReconfigure(): Promise<boolean>

cleanConfigure

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

configure

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

dispose

  • dispose(): void

  • 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[], consumer?: proc.OutputConsumer): Promise<0 | 1>

Protected doConfigureSettingsChange

  • doConfigureSettingsChange(): void

doInit

  • doInit(): Promise<void>

doPostBuild

  • doPostBuild(): Promise<boolean>

doPreBuild

  • doPreBuild(): Promise<boolean>

doRefreshExpansions

  • doRefreshExpansions(cb: function): Promise<void>

doSetKit

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

executeCommand

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

getBaseConfigureEnvironment

  • getBaseConfigureEnvironment(): Promise<object>

getBestGenerator

getConfigureEnvironment

getEffectiveSubprocessEnvironment

getExpandedEnvironment

  • getExpandedEnvironment(): Promise<object>

getKitEnvironmentVariablesObject

getPreferredGenerators

runCompileCommand

setKit

  • setKit(kit: Kit): Promise<void>

  • Change the current kit. This lets the driver reload, if necessary.

    Parameters

    • kit: Kit

      The new kit

    Returns Promise<void>

setVariantOptions

stopCurrentProcess

  • stopCurrentProcess(): Promise<boolean>

Static create

Static createDerived

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

Generated using TypeDoc