Module buildTools/extensionToolchainHelpers

Index

Interfaces

XPMToolVersion

Functions

Functions

checkSettingsPathValidity

checkSettingsPathValidity(path: string | boolean): boolean

- Defined in buildTools/extensionToolchainHelpers.ts:18
Parameters
- path: string | boolean
Returns boolean

checkToolchainPathForTool

checkToolchainPathForTool(toolPath: string | boolean, definition: BuildToolDefinition): string | boolean

- Defined in buildTools/extensionToolchainHelpers.ts:164
Parameters
- toolPath: string | boolean
- definition: BuildToolDefinition
Returns string | boolean

compareVersions

compareVersions(version1: XPMToolVersion | null, version2: XPMToolVersion): XPMToolVersion

- Defined in buildTools/extensionToolchainHelpers.ts:49
Parameters
- version1: XPMToolVersion | null
- version2: XPMToolVersion
Returns XPMToolVersion

getNewestToolchainVersion

getNewestToolchainVersion(tool: BuildToolDefinition, xpmPath: string): Promise<XPMToolVersion | undefined>

- Defined in buildTools/extensionToolchainHelpers.ts:105
Function which returns

Parameters
- tool: BuildToolDefinition
  
  build tool definition
- xpmPath: string
  
  the path to which the xpm install was performed.
Returns Promise<XPMToolVersion | undefined>

getToolBasePath

getToolBasePath(tool: BuildToolDefinition, xpmPath: string): string

- Defined in buildTools/extensionToolchainHelpers.ts:82
return the xpm path for the specified tool e.g ...../bmd.stm32-for-vscode/@xpack-dev-tools/openocd

Parameters
- tool: BuildToolDefinition
  
  The tool for which the paths needs to be found
- xpmPath: string
  
  The path to the xpm install location e.g. context.globalStoragePath
Returns string

getToolVersionFolders

getToolVersionFolders(tool: BuildToolDefinition, xpmPath: string): Promise<[string, vscode.FileType][] | null>

- Defined in buildTools/extensionToolchainHelpers.ts:85
Parameters
- tool: BuildToolDefinition
- xpmPath: string
Returns Promise<[string, vscode.FileType][] | null>

isVersionFile

isVersionFile(version: XPMToolVersion): boolean

- Defined in buildTools/extensionToolchainHelpers.ts:41
Parameters
- version: XPMToolVersion
Returns boolean

parseXPMVersionNumbers

parseXPMVersionNumbers(fileName: string): XPMToolVersion

- Defined in buildTools/extensionToolchainHelpers.ts:26
Parameters
- fileName: string
Returns XPMToolVersion

validateArmToolchainPath

validateArmToolchainPath(armToolChainPath: string | boolean): string | false

- Defined in buildTools/extensionToolchainHelpers.ts:149
Parameters
- armToolChainPath: string | boolean
Returns string | false

validateXPMToolchainPath

validateXPMToolchainPath(tool: BuildToolDefinition, xpmPath: string): Promise<string | boolean>

- Defined in buildTools/extensionToolchainHelpers.ts:126
Parameters
- tool: BuildToolDefinition
- xpmPath: string
Returns Promise<string | boolean>

Generated using TypeDoc