Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigurationReader

This class exposes a number of readonly properties which can be used to access configuration options. Each property corresponds to a value in settings.json. See package.json for CMake Tools to see the information on each property. An underscore in a property name corresponds to a dot . in the setting name.

Hierarchy

  • ConfigurationReader

Implements

  • Disposable

Index

Constructors

constructor

Properties

Private _configData

Private Optional _updateSubscription

_updateSubscription: vscode.Disposable

Accessors

autoRestartBuild

  • get autoRestartBuild(): boolean

buildArgs

  • get buildArgs(): string[]

buildBeforeRun

  • get buildBeforeRun(): boolean

buildDirectory

  • get buildDirectory(): string

buildEnvironment

buildToolArgs

  • get buildToolArgs(): string[]

cacheInit

  • get cacheInit(): null | string | string[]

clearOutputBeforeBuild

  • get clearOutputBeforeBuild(): boolean

configData

configureArgs

  • get configureArgs(): string[]

configureEnvironment

  • get configureEnvironment(): HardEnv

configureOnOpen

  • get configureOnOpen(): null | true | false

configureSettings

  • get configureSettings(): any

copyCompileCommands

  • get copyCompileCommands(): string | null

ctestArgs

  • get ctestArgs(): string[]

ctest_parallelJobs

  • get ctest_parallelJobs(): number | null

debugConfig

  • get debugConfig(): any

defaultVariants

  • get defaultVariants(): Object

emscriptenSearchDirs

  • get emscriptenSearchDirs(): string[]

enableOutputParsers

  • get enableOutputParsers(): string[] | null

enableTraceLogging

  • get enableTraceLogging(): boolean

environment

generator

  • get generator(): string | null

installPrefix

  • get installPrefix(): string | null

loggingLevel

mingwSearchDirs

  • get mingwSearchDirs(): string[]

numCTestJobs

  • get numCTestJobs(): number

numJobs

  • get numJobs(): number

outputLogEncoding

  • get outputLogEncoding(): string

parallelJobs

  • get parallelJobs(): number

parseBuildDiagnostics

  • get parseBuildDiagnostics(): boolean

platform

  • get platform(): string | null

preferredGenerators

  • get preferredGenerators(): string[]

raw_cmakePath

  • get raw_cmakePath(): string

raw_ctestPath

  • get raw_ctestPath(): string

saveBeforeBuild

  • get saveBeforeBuild(): boolean

sourceDirectory

  • get sourceDirectory(): string

testEnvironment

toolset

  • get toolset(): string | null

useCMakeServer

  • get useCMakeServer(): boolean

Methods

dispose

  • dispose(): void

onChange

  • onChange<K>(setting: K, cb: function): vscode.Disposable
  • Watch for changes on a particular setting

    Type parameters

    • K: keyof ExtensionConfigurationSettings

    Parameters

    • setting: K

      The name of the setting to watch

    • cb: function

      A callback when the setting changes

        • (value: ExtensionConfigurationSettings[K]): void
        • Parameters

          • value: ExtensionConfigurationSettings[K]

          Returns void

    Returns vscode.Disposable

update

updatePartial

Static createForDirectory

  • Get a configuration object relevant to the given workspace directory. This supports multiple workspaces having differing configs.

    Parameters

    • dirPath: string

    Returns ConfigurationReader

Static loadForPath

Object literals

Private _emitters

_emitters: object

autoRestartBuild

autoRestartBuild: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

buildArgs

buildArgs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

buildBeforeRun

buildBeforeRun: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

buildDirectory

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

buildEnvironment

buildEnvironment: EventEmitter<HardEnv> = new vscode.EventEmitter<HardEnv>()

buildToolArgs

buildToolArgs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

cacheInit

cacheInit: EventEmitter<null | string | string[]> = new vscode.EventEmitter<string|string[]|null>()

clearOutputBeforeBuild

clearOutputBeforeBuild: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

cmakePath

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

configureArgs

configureArgs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

configureEnvironment

configureEnvironment: EventEmitter<HardEnv> = new vscode.EventEmitter<HardEnv>()

configureOnOpen

configureOnOpen: EventEmitter<null | true | false> = new vscode.EventEmitter<boolean|null>()

configureSettings

configureSettings: EventEmitter<object> = new vscode.EventEmitter<{[key: string]: any}>()

copyCompileCommands

copyCompileCommands: EventEmitter<null | string> = new vscode.EventEmitter<string|null>()

ctest

ctest: EventEmitter<object> = new vscode.EventEmitter<{parallelJobs: number;}>()

ctestArgs

ctestArgs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

ctestPath

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

debugConfig

debugConfig: EventEmitter<object> = new vscode.EventEmitter<object>()

defaultVariants

defaultVariants: EventEmitter<object> = new vscode.EventEmitter<object>()

emscriptenSearchDirs

emscriptenSearchDirs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

enableTraceLogging

enableTraceLogging: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

enabledOutputParsers

enabledOutputParsers: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

environment

environment: EventEmitter<HardEnv> = new vscode.EventEmitter<HardEnv>()

generator

generator: EventEmitter<null | string> = new vscode.EventEmitter<string|null>()

installPrefix

installPrefix: EventEmitter<null | string> = new vscode.EventEmitter<string|null>()

loggingLevel

loggingLevel: EventEmitter<"debug" | "info" | "warning" | "error" | "trace" | "note" | "fatal"> = new vscode.EventEmitter<LogLevelKey>()

mingwSearchDirs

mingwSearchDirs: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

outputLogEncoding

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

parallelJobs

parallelJobs: EventEmitter<number> = new vscode.EventEmitter<number>()

parseBuildDiagnostics

parseBuildDiagnostics: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

platform

platform: EventEmitter<null | string> = new vscode.EventEmitter<string|null>()

preferredGenerators

preferredGenerators: EventEmitter<string[]> = new vscode.EventEmitter<string[]>()

saveBeforeBuild

saveBeforeBuild: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

sourceDirectory

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

testEnvironment

testEnvironment: EventEmitter<HardEnv> = new vscode.EventEmitter<HardEnv>()

toolset

toolset: EventEmitter<null | string> = new vscode.EventEmitter<string|null>()

useCMakeServer

useCMakeServer: EventEmitter<boolean> = new vscode.EventEmitter<boolean>()

Generated using TypeDoc