Class MISRAContext

Tracks MISRA-C violations during the analysis and/or transformation of the code. Also generates unique variable and function names.

Hierarchy (View Summary)

Context<MISRATransformationResults>
- MISRAContext

Index

Constructors

Properties

Accessors

activeErrors config errors

Methods

addMISRAError addRuleResult generateIdentifierName get getRuleResult outputActiveErrors outputAllErrors put resetStorage

Constructors

constructor

new MISRAContext(): MISRAContext
Returns MISRAContext
Inherited from Context.constructor

Properties

`Protected`storage

storage: Map<string, MISRATransformationResults> = ...

Accessors

activeErrors

get activeErrors(): MISRAError[]
Returns violations linked to nodes that are still present in the AST after correction.

Returns MISRAError[]
- Defined in MISRAContext.ts:52

config

get config(): Map<string, any> | undefined
Returns the user-provided configuration that assists in violation correction, if provided. Otherwise, returns undefined.

Returns Map<string, any> | undefined
- Defined in MISRAContext.ts:67
set config(configFilePath: string): void
Loads the JSON config file and transforms it into an internal Map representation. If the file does not exist, logs an error and exits the process.
Parameters
- configFilePath: string
Returns void
- Defined in MISRAContext.ts:75

errors

get errors(): MISRAError[]
Returns all violations found in the source code.

Returns MISRAError[]
- Defined in MISRAContext.ts:45

Methods

addMISRAError

addMISRAError(ruleID: string, $jp: Joinpoint, message: string): void
Registers a new violation of the standard
Parameters
- ruleID: string
  Identifier of the violated rule
- $jp: Joinpoint
  Joinpoint where the error was detected
- message: string
  Description of the error
Returns void
- Defined in MISRAContext.ts:131

addRuleResult

addRuleResult(
    ruleID: string,
    $jp: Joinpoint,
    result: MISRATransformationType,
): void
Registers the type of transformation a rule applied to a AST node
Parameters
- ruleID: string
  Identifier of the violated rule
- $jp: Joinpoint
- result: MISRATransformationType
  Applied transformation
Returns void
- Defined in MISRAContext.ts:114

generateIdentifierName

generateIdentifierName($jp: Joinpoint): string | undefined
Parameters
- $jp: Joinpoint
Returns string | undefined
- Defined in MISRAContext.ts:139

get

get(key: string): MISRATransformationResults | undefined
Parameters
- key: string
Returns MISRATransformationResults | undefined
Inherited from Context.get
- Defined in ast-visitor/Context.ts:13

getRuleResult

getRuleResult(
ruleID: string,
$jp: Joinpoint,
): MISRATransformationType | undefined
Returns the type of transformation applied by the specified rule to the given AST node. If no transformation was recorded, returns undefined.
Parameters
- ruleID: string
  Identifier of the violated rule
- $jp: Joinpoint
  AST node
Returns MISRATransformationType | undefined
The type of transformation applied, or undefined if none was recorded.
- Defined in MISRAContext.ts:104

outputActiveErrors

outputActiveErrors(): void
Displays violations linked to nodes that are still present in the AST after correction.

Returns void
- Defined in MISRAContext.ts:177

outputAllErrors

outputAllErrors(): void
Displays all violations found in the source code.

Returns void
- Defined in MISRAContext.ts:169

put

put(key: string, value: MISRATransformationResults): void
Parameters
- key: string
- value: MISRATransformationResults
Returns void
Inherited from Context.put
- Defined in ast-visitor/Context.ts:9

resetStorage

resetStorage(): void
Clears stored information.

Returns void
- Defined in MISRAContext.ts:88