@specs-feup/clava-misra 1.0.2 → 1.0.3

package/.gitignore

@@ -6,6 +6,11 @@ package-lock.json
 CxxSources
 /misra_config.json
 /src/main.ts
+c-common-standards
+/c90
+/c99
+/example-suite
+/experiment-3
 
 # Extensions
 ltex.dictionary.*
@@ -19,6 +24,9 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
+# Files generated during tests
+__clava_woven_for_file_rebuild/
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

package/README.md

@@ -1,4 +1,4 @@
-# Clava MISRA Tool
+# Clava-MISRA Tool
 
 A Clava-based library to automatically detect and correct parts of C code that violate MISRA-C:2012 coding standard.
 
@@ -15,10 +15,10 @@ npm install @specs-feup/clava-misra
 ## Usage
 
 ### 1. Analysis
-You can use the tool to simply check the violations by executing the following statements in your script:
+You can use the tool to detect violations by executing the following statements in your script:
 
 ```ts
-import MISRATool from "@specs-feup/clava-misra/dist/MISRATool.js";
+import MISRATool from "@specs-feup/clava-misra/MISRATool";
 
 MISRATool.checkCompliance();
 ```
@@ -28,17 +28,17 @@ After analysis, each identified violation will be displayed, including its locat
 Besides analysis, the tool can also correct the provided source code to comply with the coding guidelines, using the following statements:
 
 ```ts
-import MISRATool from "@specs-feup/clava-misra/dist/MISRATool.js";
+import MISRATool from "@specs-feup/clava-misra/MISRATool";
 
-MISRATool.applyCorrections();
+MISRATool.correctViolations();
 ```
 
 After the transformation, any violations that could not be fixed will be displayed along with their justification. The corrected files will be saved in the `woven_code` folder.
 
 You can provide an **optional** JSON config file to assist in correcting specific rules, such as implicit function calls, disallowed functions, and missing return statements. For instance, you can:
 -  Define default values for certain types to address functions with missing return statements.
-- Provide custom implementations for disallowed functions.
 - Specify the path or library for implicit function calls.
+- Provide custom implementations for disallowed functions.
 
 The config file should follow this structure:
 ```json
@@ -49,39 +49,73 @@ The config file should follow this structure:
     "enum Status": "SUCCESS",
     "Color": "RED",
     "my_int_type": "0"
+  }, 
+  "implicitCalls": {
+    "printf": "stdio.h",
+    "foo": "CxxSources/utils/functions.c"
+  },
+  "disallowedFunctions": {
+    "stdlib.h": {
+      "malloc": {
+        "replacement": "custom_malloc",
+        "location": "utils/custom_stdlib.c"
+      },
+      "exit": {
+        "replacement": "custom_exit",
+        "location": "utils/custom_stdlib.c"
+      }
+    }
   }
 }
 ```
-**Note:** Not all fields are required and if the config file is not provided or lacks the necessary information to fix a violation, the violation will remain and be displayed as unresolved. 
+**Note:** Not all fields (`defaultValues`, `implicitCalls`, `disallowedFunctions`) are mandatory. If the config file is not provided or lacks the necessary information to fix a violation, the violation will remain and be displayed as unresolved. 
 
-After preparing the config file, provide its full path to `applyCorrections` method call:
-
-```ts
-import MISRATool from "@specs-feup/clava-misra/dist/MISRATool.js";
-
-MISRATool.applyCorrections("/full/path/to/json/config/file");
-```
 
 ## Execution
 
-To execute a project that uses this tool, you must provide the following information:
+To execute a project that uses this tool, provide the following information:
 
 - The path to your **script file**. 
 - The **C standard** to use (`c90`, `c99`, or `c11`).
 - The path to the **source code** to process.
+- *(Optional)* The full path to a **config file**.
+- *(Optional)* The **analysis type**:
+  - `system`: For rules whose violation detection requires analyzing multiple files together
+  - `single`: For rules whose violation detection is identified within individual translation units independently
+  - `all`: For both system and single translation rules (default)
 
 ```bash
-npx clava classic [path/to/scriptFile.js] -pi -std [c90 | c99 | c11] -p [path/to/source/code]
+npx clava classic <scriptFile.js> -pi -std <c90 | c99 | c11> -p <path/to/source/code> [-av "<options>"]
 ```
 
-**Example:**
+**Note:** Some guidelines are tied to a specific C language standard (e.g., c90, c99, c11). Therefore, they will not be detected when running under other standards. For instance, the rule 17.3 (*"A function shall not be declared implicitly"*) only applies to c90 and is not reported when analyzing c99.
+
+### Examples:
+
+Default use (no config file or analysis type):
+
+```bash
+npx clava classic dist/main.js -pi -std c99 -p CxxSources/
+```
+In this case, analysis type is `all` by default.
+
+With analysis type specified:
+```bash
+npx clava classic dist/main.js -pi -std c99 -p CxxSources/ -av "type=system"
+```
+
+Using a config file:
+```bash
+npx clava classic dist/main.js -pi -std c99 -p CxxSources/ -av "config=misra_config.json"
+```
 
+With both analysis and config file specified:
 ```bash
-npx clava classic main.js -pi -std c99 -p CxxSources/
+npx clava classic dist/main.js -pi -std c99 -p CxxSources/ -av "type=system config=misra_config.json"
 ```
 
 To view other available options, run:
 
 ```bash
-npx clava classic -dummy
+npx clava classic --help
 ```

package/dist/MISRA.d.ts

@@ -1,31 +1,44 @@
 import { If, Joinpoint, Statement, Switch } from "@specs-feup/clava/api/Joinpoints.js";
+type NodeID = string;
+/**
+ * Specifies whether a MISRA rule is applied to a single translation unit
+ * or requires analysis of the entire program.
+ */
+export declare enum AnalysisType {
+    SINGLE_TRANSLATION_UNIT = "single",
+    SYSTEM = "system"
+}
+/**
+ * Types of transformations a rule can apply to a AST node.
+ */
 export declare enum MISRATransformationType {
     NoChange = 0,
     DescendantChange = 1,
     Replacement = 2,
     Removal = 3
 }
+export type MISRATransformationResults = Map<NodeID, MISRATransformationType>;
 /**
- * Represents an error in MISRA compliance, including the rule ID, the joinpoint where the violation occurred, and a descriptive message.
+ * Represents a MISRA-C rule violation.
  */
 export declare class MISRAError {
     /**
-     * Represents the specific MISRA rule that was violated
+     * Represents the specific MISRA-C rule that was violated
      */
-    ruleID: string;
+    readonly ruleID: string;
     /**
      * The joinpoint where the error was detected
      */
-    $jp: Joinpoint;
+    readonly joinpoint: Joinpoint;
     /**
      * Explanation of the violation
      */
-    message: string;
+    readonly message: string;
     /**
      *
-     * @param ruleID - specific MISRA rule that was violated
-     * @param $jp - joinpoint where the error was detected
-     * @param message - description of the error
+     * @param ruleID Identifier of the violated rule
+     * @param $jp Joinpoint where the error was detected
+     * @param message Description of the error
      */
     constructor(ruleID: string, $jp: Joinpoint, message: string);
     /**
@@ -34,6 +47,10 @@ export declare class MISRAError {
      * @returns Returns `true` if the errors are the same, `false` otherwise
      */
     equals(other: MISRAError): boolean;
+    /**
+     * Checks if the associated joinpoint is still present in program's AST
+     */
+    isActiveError(): boolean;
 }
 /**
  * A report of a MISRA transformation, including the transformation type and an optional new joinpoint node.
@@ -44,11 +61,11 @@ export declare class MISRATransformationReport {
     /**
      * The type of the MISRA transformation
      */
-    type: MISRATransformationType;
+    readonly type: MISRATransformationType;
     /**
      * An optional new joinpoint node, provided if the transformation involves a replacement
      */
-    newNode?: Joinpoint;
+    readonly newNode?: Joinpoint;
     /**
      *
      * @param type The type of the MISRA transformation
@@ -126,4 +143,5 @@ export declare class MISRASwitchConverter {
      */
     private static organizeCaseGroups;
 }
+export {};
 //# sourceMappingURL=MISRA.d.ts.map

package/dist/MISRA.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MISRA.d.ts","sourceRoot":"","sources":["../src/MISRA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqC,EAAE,EAAE,SAAS,EAAS,SAAS,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAIjI,oBAAY,uBAAuB;IAC/B,QAAQ,IAAA;IACR,gBAAgB,IAAA;IAChB,WAAW,IAAA;IACX,OAAO,IAAA;CACV;AAED;;GAEG;AACH,qBAAa,UAAU;IACnB;;OAEG;IACI,MAAM,EAAE,MAAM,CAAC;IACtB;;OAEG;IACI,GAAG,EAAE,SAAS,CAAC;IACtB;;OAEG;IACI,OAAO,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;IAM3D;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;CAKrC;AAED;;;;GAIG;AACH,qBAAa,yBAAyB;IAClC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpB;;;;OAIG;gBACS,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,SAAS;CAOjE;AAED;;;;GAIG;AACH,qBAAa,oBAAoB;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAQzD;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IA6B3E;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,EAAE;IAuBpD;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAahC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAgBlC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAK/B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAK1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAiB/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAQpC"}
+{"version":3,"file":"MISRA.d.ts","sourceRoot":"","sources":["../src/MISRA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqC,EAAE,EAAE,SAAS,EAAS,SAAS,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAMjI,KAAK,MAAM,GAAG,MAAM,CAAC;AAErB;;;GAGG;AACH,oBAAY,YAAY;IACpB,uBAAuB,WAAW;IAClC,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,oBAAY,uBAAuB;IAC/B,QAAQ,IAAA;IACR,gBAAgB,IAAA;IAChB,WAAW,IAAA;IACX,OAAO,IAAA;CACV;AAED,MAAM,MAAM,0BAA0B,GAAG,GAAG,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;AAE9E;;GAEG;AACH,qBAAa,UAAU;IACnB;;OAEG;IACH,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;IAM3D;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;IAMlC;;OAEG;IACH,aAAa,IAAI,OAAO;CAG3B;AAED;;;;GAIG;AACH,qBAAa,yBAAyB;IAClC;;OAEG;IACH,SAAgB,IAAI,EAAE,uBAAuB,CAAC;IAC9C;;OAEG;IACH,SAAgB,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpC;;;;OAIG;gBACS,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,SAAS;CAOjE;AAED;;;;GAIG;AACH,qBAAa,oBAAoB;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAQzD;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IA6B3E;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,EAAE;IAuBpD;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAahC;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAgBlC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAK/B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAK1B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAiB/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CASpC"}

package/dist/MISRA.js

@@ -1,6 +1,20 @@
 import { Break, Case } from "@specs-feup/clava/api/Joinpoints.js";
-import { getNumOfSwitchClauses, isCommentStmt } from "./utils/utils.js";
+import { isCommentStmt } from "./utils/CommentUtils.js";
 import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
+import Query from "@specs-feup/lara/api/weaver/Query.js";
+import { countSwitchClauses } from "./utils/SwitchUtils.js";
+/**
+ * Specifies whether a MISRA rule is applied to a single translation unit
+ * or requires analysis of the entire program.
+ */
+export var AnalysisType;
+(function (AnalysisType) {
+    AnalysisType["SINGLE_TRANSLATION_UNIT"] = "single";
+    AnalysisType["SYSTEM"] = "system";
+})(AnalysisType || (AnalysisType = {}));
+/**
+ * Types of transformations a rule can apply to a AST node.
+ */
 export var MISRATransformationType;
 (function (MISRATransformationType) {
     MISRATransformationType[MISRATransformationType["NoChange"] = 0] = "NoChange";
@@ -9,30 +23,30 @@ export var MISRATransformationType;
     MISRATransformationType[MISRATransformationType["Removal"] = 3] = "Removal";
 })(MISRATransformationType || (MISRATransformationType = {}));
 /**
- * Represents an error in MISRA compliance, including the rule ID, the joinpoint where the violation occurred, and a descriptive message.
+ * Represents a MISRA-C rule violation.
  */
 export class MISRAError {
     /**
-     * Represents the specific MISRA rule that was violated
+     * Represents the specific MISRA-C rule that was violated
      */
     ruleID;
     /**
      * The joinpoint where the error was detected
      */
-    $jp;
+    joinpoint;
     /**
      * Explanation of the violation
      */
     message;
     /**
      *
-     * @param ruleID - specific MISRA rule that was violated
-     * @param $jp - joinpoint where the error was detected
-     * @param message - description of the error
+     * @param ruleID Identifier of the violated rule
+     * @param $jp Joinpoint where the error was detected
+     * @param message Description of the error
      */
     constructor(ruleID, $jp, message) {
         this.ruleID = ruleID;
-        this.$jp = $jp;
+        this.joinpoint = $jp;
         this.message = message;
     }
     /**
@@ -42,9 +56,15 @@ export class MISRAError {
      */
     equals(other) {
         return this.ruleID === other.ruleID &&
-            this.$jp.astId === other.$jp.astId &&
+            this.joinpoint.astId === other.joinpoint.astId &&
             this.message === other.message;
     }
+    /**
+     * Checks if the associated joinpoint is still present in program's AST
+     */
+    isActiveError() {
+        return Query.root().contains(this.joinpoint);
+    }
 }
 /**
  * A report of a MISRA transformation, including the transformation type and an optional new joinpoint node.
@@ -86,7 +106,7 @@ export class MISRASwitchConverter {
      * @returns The converted statements or `undefined` if no statements remain
      */
     static convert(switchStmt) {
-        if (switchStmt.hasDefaultCase && getNumOfSwitchClauses(switchStmt) < 2) { // The statements will always be executed 
+        if (switchStmt.hasDefaultCase && countSwitchClauses(switchStmt) < 2) { // The statements will always be executed 
             return this.convertToConsecutiveStmts(switchStmt);
         }
         else {

package/dist/MISRA.js.map

@@ -1 +1 @@
-{"version":3,"file":"MISRA.js","sourceRoot":"","sources":["../src/MISRA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,EAAE,IAAI,EAAuD,MAAM,qCAAqC,CAAC;AACjI,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,eAAe,MAAM,gDAAgD,CAAC;AAE7E,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IAC/B,6EAAQ,CAAA;IACR,6FAAgB,CAAA;IAChB,mFAAW,CAAA;IACX,2EAAO,CAAA;AACX,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAED;;GAEG;AACH,MAAM,OAAO,UAAU;IACnB;;OAEG;IACI,MAAM,CAAS;IACtB;;OAEG;IACI,GAAG,CAAY;IACtB;;OAEG;IACI,OAAO,CAAS;IAEvB;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAc,EAAE,OAAe;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAI,OAAO,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAiB;QACpB,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,CAAC,KAAK;YAClC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IAC1C,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,yBAAyB;IAClC;;OAEG;IACH,IAAI,CAA0B;IAC9B;;OAEG;IACH,OAAO,CAAa;IAEpB;;;;OAIG;IACH,YAAY,IAA6B,EAAE,OAAmB;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,IAAI,KAAK,uBAAuB,CAAC,WAAW,IAAI,CAAC,OAAO,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QACjG,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,UAAkB;QAC7B,IAAI,UAAU,CAAC,cAAc,IAAI,qBAAqB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAE,0CAA0C;YACjH,OAAO,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAkB;QAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAU,CAAC;QAC9C,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAExB,kFAAkF;QAClF,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACnF,UAAU,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,IAAI,SAAS,EAAE,QAAQ,CAAC;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAuB,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,MAAM,EAAE,CAAC;YAEd,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,SAAS,GAAG,IAAI,CAAC;gBACjB,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC;gBAChB,SAAS;YACb,CAAC;YACD,QAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC5B,QAAQ,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,OAAO,SAAsB,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,UAAkB;QAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAU,CAAC;QAC9C,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,MAAU,CAAC;QACf,IAAI,UAA0B,CAAC;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAElC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,mBAAmB;gBACjE,UAAW,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACJ,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;gBAC/E,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACV,MAAM,GAAG,UAAU,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QACD,UAAU,CAAC,WAAW,CAAC,MAAO,CAAC,CAAC;QAChC,OAAO,MAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,iBAAiB,CAAC,SAAqB,EAAE,KAAa,EAAE,KAAa,EAAE,UAA0B;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAChF,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAElE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACd,OAAO,SAAS,CAAC;QACrB,CAAC;aAAM,CAAC;YACJ,UAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC/B,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,mBAAmB,CAAC,SAAqB,EAAE,KAAa;QACnE,IAAI,YAAsB,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAElF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACV,YAAY,GAAG,WAAW,CAAC;gBAC3B,SAAS;YACb,CAAC;YACD,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAa,EAAE,WAAW,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,YAAa,CAAC;IACzB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,gBAAgB,CAAC,KAAY;QACxC,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC;QAC1E,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,WAAW,CAAC,KAAY;QACnC,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC;QACpE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,IAAI,WAAW,GAAW,EAAE,CAAC;QAE7B,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACtC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE3B,IAAI,QAAQ,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC,CAAC,0BAA0B;gBAChE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC7B,WAAW,GAAG,EAAE,CAAC;YACrB,CAAC;QACL,CAAC;QAED,8EAA8E;QAC9E,OAAO,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,kBAAkB,CAAC,UAAoB;QAClD,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACjG,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1F,IAAI,YAAY,EAAE,CAAC;YACf,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ"}
+{"version":3,"file":"MISRA.js","sourceRoot":"","sources":["../src/MISRA.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,EAAE,IAAI,EAAuD,MAAM,qCAAqC,CAAC;AACjI,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,eAAe,MAAM,gDAAgD,CAAC;AAC7E,OAAO,KAAK,MAAM,sCAAsC,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAI5D;;;GAGG;AACH,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,kDAAkC,CAAA;IAClC,iCAAiB,CAAA;AACrB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IAC/B,6EAAQ,CAAA;IACR,6FAAgB,CAAA;IAChB,mFAAW,CAAA;IACX,2EAAO,CAAA;AACX,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAID;;GAEG;AACH,MAAM,OAAO,UAAU;IACnB;;OAEG;IACa,MAAM,CAAS;IAC/B;;OAEG;IACa,SAAS,CAAY;IACrC;;OAEG;IACa,OAAO,CAAS;IAEhC;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAc,EAAE,OAAe;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QACrB,IAAI,CAAC,OAAO,GAAI,OAAO,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAiB;QACpB,OAAO,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,CAAC,KAAK,KAAK,KAAK,CAAC,SAAS,CAAC,KAAK;YAC9C,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,aAAa;QACT,OAAQ,KAAK,CAAC,IAAI,EAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,yBAAyB;IAClC;;OAEG;IACa,IAAI,CAA0B;IAC9C;;OAEG;IACa,OAAO,CAAa;IAEpC;;;;OAIG;IACH,YAAY,IAA6B,EAAE,OAAmB;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,IAAI,KAAK,uBAAuB,CAAC,WAAW,IAAI,CAAC,OAAO,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;QACjG,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAoB;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,UAAkB;QAC7B,IAAI,UAAU,CAAC,cAAc,IAAI,kBAAkB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAE,0CAA0C;YAC9G,OAAO,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAkB;QAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAU,CAAC;QAC9C,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAExB,kFAAkF;QAClF,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACnF,UAAU,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,IAAI,SAAS,EAAE,QAAQ,CAAC;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,QAAuB,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,MAAM,EAAE,CAAC;YAEd,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,SAAS,GAAG,IAAI,CAAC;gBACjB,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAClC,QAAQ,GAAG,IAAI,CAAC;gBAChB,SAAS;YACb,CAAC;YACD,QAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC5B,QAAQ,GAAG,IAAI,CAAC;QACpB,CAAC;QACD,OAAO,SAAsB,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,UAAkB;QAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAU,CAAC;QAC9C,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,MAAU,CAAC;QACf,IAAI,UAA0B,CAAC;QAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAElC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,mBAAmB;gBACjE,UAAW,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;YACtF,CAAC;iBAAM,CAAC;gBACJ,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;gBAC/E,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBACV,MAAM,GAAG,UAAU,CAAC;gBACxB,CAAC;YACL,CAAC;QACL,CAAC;QACD,UAAU,CAAC,WAAW,CAAC,MAAO,CAAC,CAAC;QAChC,OAAO,MAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,iBAAiB,CAAC,SAAqB,EAAE,KAAa,EAAE,KAAa,EAAE,UAA0B;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QAChF,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAElE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACd,OAAO,SAAS,CAAC;QACrB,CAAC;aAAM,CAAC;YACJ,UAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC/B,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,mBAAmB,CAAC,SAAqB,EAAE,KAAa;QACnE,IAAI,YAAsB,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAElF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACV,YAAY,GAAG,WAAW,CAAC;gBAC3B,SAAS;YACb,CAAC;YACD,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAa,EAAE,WAAW,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,YAAa,CAAC;IACzB,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,gBAAgB,CAAC,KAAY;QACxC,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC;QAC1E,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,WAAW,CAAC,KAAY;QACnC,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC;QACpE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAAC,UAAkB;QAC9C,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,IAAI,WAAW,GAAW,EAAE,CAAC;QAE7B,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACtC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE3B,IAAI,QAAQ,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC,CAAC,0BAA0B;gBAChE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC7B,WAAW,GAAG,EAAE,CAAC;YACrB,CAAC;QACL,CAAC;QAED,8EAA8E;QAC9E,OAAO,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,kBAAkB,CAAC,UAAoB;QAClD,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACjG,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAE1F,IAAI,YAAY,EAAE,CAAC;YACf,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ"}

package/dist/MISRAContext.d.ts

@@ -1,21 +1,75 @@
 import { Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
-import { MISRAError } from "./MISRA.js";
+import { MISRAError, MISRATransformationResults, MISRATransformationType } from "./MISRA.js";
+import Context from "./ast-visitor/Context.js";
 /**
- * Tracks MISRA errors and warnings during the analysis and/or transformation of the code.
- * Also generated unique variable and function names.
+ * Tracks MISRA-C violations during the analysis and/or transformation of the code.
+ * Also generates unique variable and function names.
  */
-export default class MISRAContext {
+export default class MISRAContext extends Context<MISRATransformationResults> {
     #private;
+    /**
+     * Returns all violations found in the source code.
+     */
     get errors(): MISRAError[];
-    get warnings(): MISRAError[];
+    /**
+     * Returns violations linked to nodes that are still present in the AST after correction.
+     */
+    get activeErrors(): MISRAError[];
+    /**
+     * Orders errors according to their location
+     */
+    private sortErrors;
+    /**
+     * Returns the user-provided configuration that assists in violation correction, if provided. Otherwise, returns undefined.
+     */
     get config(): Map<string, any> | undefined;
+    /**
+     * 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.
+     */
     set config(configFilePath: string);
-    generateVarName(): string;
-    generateFuncName(): string;
-    generateHeaderFilename(): string;
+    /**
+     * Clears stored information.
+     */
+    resetStorage(): void;
+    /**
+     * Returns the type of transformation applied by the specified rule to the given AST node.
+     * If no transformation was recorded, returns undefined.
+     *
+     * @param ruleID Identifier of the violated rule
+     * @param $jp AST node
+     * @returns The type of transformation applied, or undefined if none was recorded.
+     */
+    getRuleResult(ruleID: string, $jp: Joinpoint): MISRATransformationType | undefined;
+    /**
+     * Registers the type of transformation a rule applied to a AST node
+     * @param ruleID Identifier of the violated rule
+     * @param $jp
+     * @param result Applied transformation
+     */
+    addRuleResult(ruleID: string, $jp: Joinpoint, result: MISRATransformationType): void;
+    /**
+     * Registers a new violation of the standard
+     *
+     * @param ruleID Identifier of the violated rule
+     * @param $jp Joinpoint where the error was detected
+     * @param message Description of the error
+     */
     addMISRAError(ruleID: string, $jp: Joinpoint, message: string): void;
-    addMISRAWarning(ruleID: string, $jp: Joinpoint, message: string): void;
-    printErrors(): void;
-    printWarnings(): void;
+    generateIdentifierName($jp: Joinpoint): string | undefined;
+    /**
+     * Outputs a formatted MISRA-C rule violation message
+     *
+     * @param error - The MISRA error object containing the rule ID, message, and location
+     */
+    private outputError;
+    /**
+     * Displays all violations found in the source code.
+     */
+    outputAllErrors(): void;
+    /**
+     * Displays violations linked to nodes that are still present in the AST after correction.
+     */
+    outputActiveErrors(): void;
 }
 //# sourceMappingURL=MISRAContext.d.ts.map

package/dist/MISRAContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MISRAContext.d.ts","sourceRoot":"","sources":["../src/MISRAContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGxC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;;IAuB7B,IAAI,MAAM,IAAI,UAAU,EAAE,CAEzB;IAED,IAAI,QAAQ,IAAI,UAAU,EAAE,CAE3B;IAED,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAEzC;IAED,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,EAQhC;IAED,eAAe;IAIf,gBAAgB;IAIhB,sBAAsB;IAItB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;IAQ7D,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;IAQ/D,WAAW;IAKX,aAAa;CAIhB"}
+{"version":3,"file":"MISRAContext.d.ts","sourceRoot":"","sources":["../src/MISRAContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,SAAS,EAA6C,MAAM,qCAAqC,CAAC;AACjI,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAE7F,OAAO,OAAO,MAAM,0BAA0B,CAAC;AAG/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,OAAO,CAAC,0BAA0B,CAAC;;IA+BzE;;OAEG;IACH,IAAI,MAAM,IAAI,UAAU,EAAE,CAEzB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,UAAU,EAAE,CAE/B;IAED;;OAEG;IACH,OAAO,CAAC,UAAU;IAKnB;;OAEG;IACF,IAAI,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAEzC;IAED;;;OAGG;IACH,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,EAQhC;IAED;;OAEG;IACH,YAAY;IAQZ;;;;;;;OAOG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,uBAAuB,GAAG,SAAS;IAIlF;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,uBAAuB;IAU7E;;;;;;OAMG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;IAQ7D,sBAAsB,CAAC,GAAG,EAAE,SAAS;IAkBrC;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB;;OAEG;IACH,kBAAkB,IAAI,IAAI;CAK7B"}

package/dist/MISRAContext.js

@@ -1,37 +1,68 @@
+import { EnumDecl, FunctionJp, LabelStmt, RecordJp, TypedefDecl, Vardecl } from "@specs-feup/clava/api/Joinpoints.js";
 import { MISRAError } from "./MISRA.js";
 import * as fs from 'fs';
+import Context from "./ast-visitor/Context.js";
+import { compareLocation, getFileLocation } from "./utils/JoinpointUtils.js";
 /**
- * Tracks MISRA errors and warnings during the analysis and/or transformation of the code.
- * Also generated unique variable and function names.
+ * Tracks MISRA-C violations during the analysis and/or transformation of the code.
+ * Also generates unique variable and function names.
  */
-export default class MISRAContext {
+export default class MISRAContext extends Context {
     /**
-     * List of MISRA errors, that could not be resolved during the transformation process
+     * Stores MISRA-C rule violations.
+     *
+     * When checking compliance, this includes all detected violations.
+     * When performing transformations, it includes only the violations that could not be resolved.
      */
     #misraErrors = [];
+    #misraErrorKeys = new Set();
     /**
-     * List of MISRA warnings generated by transformations that may alter the program's behavior
-     */
-    #misraWarnings = [];
-    /**
-     * Configuration provided by the user to assist in rule corrections
+     * User-provided configuration to assist in violation correction
      */
     #config = undefined;
     #varCounter = 0;
-    #funcCounter = 0;
-    #headerCounter = 0;
-    #varPrefix = "__misra_var_";
-    #funcPrefix = "__misra_func_";
-    #headerPrefix = "misra_hdr_";
+    #functionCounter = 0;
+    #labelCounter = 0;
+    #typeDefCounter = 0;
+    #enumCounter = 0;
+    #structCounter = 0;
+    #unionCounter = 0;
+    #varPrefix = "_misra_var_";
+    #funcPrefix = "_misra_func_";
+    #labelPrefix = "_misra_label_";
+    #typeDefPrefix = "_misra_typedef_";
+    #enumPrefix = "_misra_enum_";
+    #structPrefix = "_misra_struct_";
+    #unionPrefix = "_misra_union_";
+    /**
+     * Returns all violations found in the source code.
+     */
     get errors() {
         return this.#misraErrors;
     }
-    get warnings() {
-        return this.#misraWarnings;
+    /**
+     * Returns violations linked to nodes that are still present in the AST after correction.
+     */
+    get activeErrors() {
+        return this.#misraErrors.filter(error => error.isActiveError());
+    }
+    /**
+     * Orders errors according to their location
+     */
+    sortErrors(errors) {
+        let errorList = errors ? errors : this.#misraErrors;
+        errorList.sort((error1, error2) => compareLocation(error1.joinpoint, error2.joinpoint));
     }
+    /**
+     * Returns the user-provided configuration that assists in violation correction, if provided. Otherwise, returns undefined.
+     */
     get config() {
         return this.#config;
     }
+    /**
+     * 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.
+     */
     set config(configFilePath) {
         if (fs.existsSync(configFilePath)) {
             const data = fs.readFileSync(configFilePath, 'utf-8');
@@ -42,34 +73,99 @@ export default class MISRAContext {
             process.exit(1);
         }
     }
-    generateVarName() {
-        return `${this.#varPrefix}${this.#varCounter++}`;
+    /**
+     * Clears stored information.
+     */
+    resetStorage() {
+        [...this.storage.keys()].forEach(key => {
+            this.storage.set(key, new Map());
+        });
+        this.#misraErrors = [];
+        this.#misraErrorKeys = new Set();
     }
-    generateFuncName() {
-        return `${this.#funcPrefix}${this.#funcCounter++}`;
+    /**
+     * Returns the type of transformation applied by the specified rule to the given AST node.
+     * If no transformation was recorded, returns undefined.
+     *
+     * @param ruleID Identifier of the violated rule
+     * @param $jp AST node
+     * @returns The type of transformation applied, or undefined if none was recorded.
+     */
+    getRuleResult(ruleID, $jp) {
+        return this.get(ruleID)?.get($jp.astId);
     }
-    generateHeaderFilename() {
-        return `${this.#headerPrefix}${this.#headerCounter++}.h`;
+    /**
+     * Registers the type of transformation a rule applied to a AST node
+     * @param ruleID Identifier of the violated rule
+     * @param $jp
+     * @param result Applied transformation
+     */
+    addRuleResult(ruleID, $jp, result) {
+        let transformations = this.get(ruleID);
+        if (transformations === undefined) {
+            transformations = new Map();
+            this.put(ruleID, transformations);
+        }
+        transformations.set($jp.astId, result);
     }
+    /**
+     * Registers a new violation of the standard
+     *
+     * @param ruleID Identifier of the violated rule
+     * @param $jp Joinpoint where the error was detected
+     * @param message Description of the error
+     */
     addMISRAError(ruleID, $jp, message) {
-        const newError = new MISRAError(ruleID, $jp, message);
-        if (!this.#misraErrors.some(error => error.equals(newError))) {
-            this.#misraErrors.push(newError);
+        const key = `${ruleID}-${$jp.astId}-${message}`;
+        if (!this.#misraErrorKeys.has(key)) {
+            this.#misraErrorKeys.add(key);
+            this.#misraErrors.push(new MISRAError(ruleID, $jp, message));
         }
     }
-    addMISRAWarning(ruleID, $jp, message) {
-        const newWarning = new MISRAError(ruleID, $jp, message);
-        if (!this.#misraWarnings.some(warning => warning.equals(newWarning))) {
-            this.#misraWarnings.push(newWarning);
+    generateIdentifierName($jp) {
+        if ($jp instanceof Vardecl) {
+            return `${this.#varPrefix}${this.#varCounter++}`;
+        }
+        else if ($jp instanceof FunctionJp) {
+            return `${this.#funcPrefix}${this.#functionCounter++}`;
+        }
+        else if ($jp instanceof LabelStmt) {
+            return `${this.#labelPrefix}${this.#labelCounter++}`;
+        }
+        else if ($jp instanceof TypedefDecl) {
+            return `${this.#typeDefPrefix}${this.#typeDefCounter++}`;
+        }
+        else if ($jp instanceof EnumDecl) {
+            return `${this.#enumPrefix}${this.#enumCounter++}`;
         }
+        else if ($jp instanceof RecordJp) {
+            return $jp.kind === `struct` ?
+                `${this.#structPrefix}${this.#structCounter++}` :
+                `${this.#unionPrefix}${this.#unionCounter++}`;
+        }
+    }
+    /**
+     * Outputs a formatted MISRA-C rule violation message
+     *
+     * @param error - The MISRA error object containing the rule ID, message, and location
+     */
+    outputError(error) {
+        console.log(`- [Rule ${error.ruleID}] at ${getFileLocation(error.joinpoint)}: ${error.message}\n`);
     }
-    printErrors() {
-        this.#misraErrors.forEach(error => console.log(error.message));
-        console.log('\n');
+    /**
+     * Displays all violations found in the source code.
+     */
+    outputAllErrors() {
+        this.sortErrors();
+        this.#misraErrors.forEach(error => this.outputError(error));
     }
-    printWarnings() {
-        this.#misraWarnings.forEach(warning => console.log(warning.message));
-        console.log('\n');
+    /**
+     * Displays violations linked to nodes that are still present in the AST after correction.
+     */
+    outputActiveErrors() {
+        const errors = this.activeErrors;
+        this.sortErrors(errors);
+        errors.forEach(error => this.outputError(error));
     }
 }
 //# sourceMappingURL=MISRAContext.js.map