Class DumpCfg

A tool that dumps the Cfg of the given compilation unit.

Hierarchy (view full)

Tool<DumpCfgOptions>
- DumpCfg

Index

Constructors

Properties

Accessors

defaultOptions id

Methods

getDescription getOptionDescriptions makeOutput run runStandalone runWithCU canRunStandalone

Constructors

constructor

new DumpCfg(ctx, config): DumpCfg
Parameters
- ctx: MistiContext
- config: DumpCfgOptions
Returns DumpCfg
Inherited from Tool.constructor
- Defined in src/tools/tool.ts:17

Properties

`Readonly`ctx

ctx: MistiContext

`Protected` `Readonly`options

options: DumpCfgOptions

User-defined options for the tool merged with the default options.

Accessors

defaultOptions

get defaultOptions(): DumpCfgOptions
The default options for the tool.

Returns DumpCfgOptions
Overrides Tool.defaultOptions
- Defined in src/tools/dumpCfg.ts:19

id

get id(): string
The unique identifier of the tool.

Returns string
Inherited from Tool.id
- Defined in src/tools/tool.ts:27

Methods

getDescription

getDescription(): string
Returns a description of the tool and its options.

Returns string
Overrides Tool.getDescription
- Defined in src/tools/dumpCfg.ts:52

getOptionDescriptions

getOptionDescriptions(): Record<keyof DumpCfgOptions, string>
Returns a map of option names to their descriptions.

Returns Record<keyof DumpCfgOptions, string>
Overrides Tool.getOptionDescriptions
- Defined in src/tools/dumpCfg.ts:56

`Protected`makeOutput

makeOutput(cu, output): ToolOutput
Makes a ToolOutput from the given output.
Parameters
- cu: undefined | CompilationUnit
- output: string
Returns ToolOutput
Inherited from Tool.makeOutput
- Defined in src/tools/tool.ts:78

run

run(cu): ToolOutput
Runs the tool on the given compilation unit.
Parameters
- cu: CompilationUnit
  The compilation unit to run the tool on.
Returns ToolOutput
The result of the tool.
Inherited from Tool.run
- Defined in src/tools/tool.ts:51

runStandalone

runStandalone(): ToolOutput
Runs the tool without any compilation unit.

Returns ToolOutput
The result of the tool.
Inherited from Tool.runStandalone
- Defined in src/tools/tool.ts:59

runWithCU

runWithCU(cu): ToolOutput
Implement this method if your tool needs a compilation unit.
Parameters
- cu: CompilationUnit
  The compilation unit to run the tool on.
Returns ToolOutput
Overrides Tool.runWithCU
- Defined in src/tools/dumpCfg.ts:27

`Static`canRunStandalone

canRunStandalone(tool): boolean
Tests if the Tool could be executed without compilation unit using runStandalone.
Parameters
- tool: Tool<any>
Returns boolean
Inherited from Tool.canRunStandalone
- Defined in src/tools/tool.ts:102