@specs-feup/clava-misra 1.0.0 → 1.0.2

package/.gitignore

@@ -0,0 +1,117 @@
+##### User-added #####
+woven_code/
+/dist
+/docs
+package-lock.json
+CxxSources
+/misra_config.json
+/src/main.ts
+
+# Extensions
+ltex.dictionary.*
+######################
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

package/README.md

@@ -1,32 +1,87 @@
-# clava-project-template
+# Clava MISRA Tool
 
-A template for developing projects for Clava in Typescript
+A Clava-based library to automatically detect and correct parts of C code that violate MISRA-C:2012 coding standard.
 
-## Installing dev environment
+For more details, see the [Clava Transpiler repository](https://github.com/specs-feup/clava).
 
-Execute the following commands to download all the required code:
+## Installation
+
+To get started, ensure the tool's NPM package is installed in your project:
 
 ```bash
-npm install
+npm install @specs-feup/clava-misra
 ```
 
-## Executing Clava-JS
+## Usage
 
-You can execute your project in Clava by running the following on your terminal
+### 1. Analysis
+You can use the tool to simply check the violations by executing the following statements in your script:
 
-```bash
-npm run run
+```ts
+import MISRATool from "@specs-feup/clava-misra/dist/MISRATool.js";
+
+MISRATool.checkCompliance();
 ```
+After analysis, each identified violation will be displayed, including its location and description.
 
-Take a look inside the `scripts` field in the `package.json` file for more information.
+### 2. Correction
+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";
+
+MISRATool.applyCorrections();
+```
 
-You can also run tests, get test coverage information and generate documentation for your project.
+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.
 
-## Debugging
+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.
 
-You can get debugging information using a `DEBUG` environment variable.
-This variable is used by the [debug](https://www.npmjs.com/package/debug) module to determine what to expose.
+The config file should follow this structure:
+```json
+{
+  "defaultValues": {
+    "unsigned int": 0,  
+    "float": 0.0,
+    "enum Status": "SUCCESS",
+    "Color": "RED",
+    "my_int_type": "0"
+  }
+}
+```
+**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. 
+
+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:
+
+- The path to your **script file**. 
+- The **C standard** to use (`c90`, `c99`, or `c11`).
+- The path to the **source code** to process.
+
+```bash
+npx clava classic [path/to/scriptFile.js] -pi -std [c90 | c99 | c11] -p [path/to/source/code]
+```
+
+**Example:**
 
 ```bash
-DEBUG="*" npm run run
+npx clava classic main.js -pi -std c99 -p CxxSources/
 ```
+
+To view other available options, run:
+
+```bash
+npx clava classic -dummy
+```

package/dist/MISRA.d.ts

@@ -0,0 +1,129 @@
+import { If, Joinpoint, Statement, Switch } from "@specs-feup/clava/api/Joinpoints.js";
+export declare enum MISRATransformationType {
+    NoChange = 0,
+    DescendantChange = 1,
+    Replacement = 2,
+    Removal = 3
+}
+/**
+ * Represents an error in MISRA compliance, including the rule ID, the joinpoint where the violation occurred, and a descriptive message.
+ */
+export declare class MISRAError {
+    /**
+     * Represents the specific MISRA rule that was violated
+     */
+    ruleID: string;
+    /**
+     * The joinpoint where the error was detected
+     */
+    $jp: Joinpoint;
+    /**
+     * Explanation of the violation
+     */
+    message: string;
+    /**
+     *
+     * @param ruleID - specific MISRA rule that was violated
+     * @param $jp - joinpoint where the error was detected
+     * @param message - description of the error
+     */
+    constructor(ruleID: string, $jp: Joinpoint, message: string);
+    /**
+     * Checks if two instances of MISRAError are equal based on all properties
+     * @param other
+     * @returns Returns `true` if the errors are the same, `false` otherwise
+     */
+    equals(other: MISRAError): boolean;
+}
+/**
+ * A report of a MISRA transformation, including the transformation type and an optional new joinpoint node.
+ *
+ * If the transformation type is `Replacement`, the `newNode` must be provided to indicate the new joinpoint.
+ */
+export declare class MISRATransformationReport {
+    /**
+     * The type of the MISRA transformation
+     */
+    type: MISRATransformationType;
+    /**
+     * An optional new joinpoint node, provided if the transformation involves a replacement
+     */
+    newNode?: Joinpoint;
+    /**
+     *
+     * @param type The type of the MISRA transformation
+     * @param newNode The new joinpoint node resulting from the transformation. Required if the transformation type is `Replacement`.
+     */
+    constructor(type: MISRATransformationType, newNode?: Joinpoint);
+}
+/**
+ * Converts a switch statement into either consecutive statements or if statements
+ * - If the switch has only one clause and a default case, it is converted to consecutive statements
+ * - Otherwise, it is converted to if statements
+ */
+export declare class MISRASwitchConverter {
+    /**
+     * Converts a switch statement to consecutive statements or if statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @returns The converted statements or `undefined` if no statements remain
+     */
+    static convert(switchStmt: Switch): Statement | undefined;
+    /**
+     * Converts a switch with only one clause and a default case into consecutive statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @returns The first statement or `undefined` if no statements remain
+     */
+    static convertToConsecutiveStmts(switchStmt: Switch): Statement | undefined;
+    /**
+     * Converts a switch statement into a series of if statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @returns The first if statement created
+     */
+    static convertToIfStatements(switchStmt: Switch): If;
+    /**
+     * Creates an if statement for the given consecutive cases
+     *
+     * @param condition - The switch condition
+     * @param cases - A list of consecutive cases
+     * @param index - The index of the current case group
+     * @param lastIfStmt - The last if statement, used to chain else
+     * @returns The new if statement
+     */
+    private static createIfStatement;
+    /**
+     * Creates the equivalent condition for an if statement based on the case values
+     *
+     * @param condition - The switch condition
+     * @param cases - A list of case` statements
+     * @returns The combined condition
+     */
+    private static equivalentCondition;
+    /**
+     * Removes all break statements from the given scope
+     * @param scope - The scope from which the break statements will be removed
+     */
+    private static removeBreakStmts;
+    /**
+     * Removes all case statements from the given scope
+     * @param scope - The scope from which the case statements will be removed
+     */
+    private static removeCases;
+    /**
+     * Groups case statements into consecutive blocks, ensuring the block with the default case is last
+     *
+     * @param switchStmt - The switch statement
+     * @returns The grouped case statements
+     */
+    private static consecutiveCases;
+    /**
+     * Organizes case groups such that the group with default case is placed last.
+     *
+     * @param caseGroups - The groups of case statements
+     * @returns The organized case groups
+     */
+    private static organizeCaseGroups;
+}
+//# sourceMappingURL=MISRA.d.ts.map

package/dist/MISRA.d.ts.map

@@ -0,0 +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"}

package/dist/MISRA.js

@@ -0,0 +1,245 @@
+import { Break, Case } from "@specs-feup/clava/api/Joinpoints.js";
+import { getNumOfSwitchClauses, isCommentStmt } from "./utils/utils.js";
+import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
+export var MISRATransformationType;
+(function (MISRATransformationType) {
+    MISRATransformationType[MISRATransformationType["NoChange"] = 0] = "NoChange";
+    MISRATransformationType[MISRATransformationType["DescendantChange"] = 1] = "DescendantChange";
+    MISRATransformationType[MISRATransformationType["Replacement"] = 2] = "Replacement";
+    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.
+ */
+export class MISRAError {
+    /**
+     * Represents the specific MISRA rule that was violated
+     */
+    ruleID;
+    /**
+     * The joinpoint where the error was detected
+     */
+    $jp;
+    /**
+     * 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
+     */
+    constructor(ruleID, $jp, message) {
+        this.ruleID = ruleID;
+        this.$jp = $jp;
+        this.message = message;
+    }
+    /**
+     * Checks if two instances of MISRAError are equal based on all properties
+     * @param other
+     * @returns Returns `true` if the errors are the same, `false` otherwise
+     */
+    equals(other) {
+        return this.ruleID === other.ruleID &&
+            this.$jp.astId === other.$jp.astId &&
+            this.message === other.message;
+    }
+}
+/**
+ * A report of a MISRA transformation, including the transformation type and an optional new joinpoint node.
+ *
+ * If the transformation type is `Replacement`, the `newNode` must be provided to indicate the new joinpoint.
+ */
+export class MISRATransformationReport {
+    /**
+     * The type of the MISRA transformation
+     */
+    type;
+    /**
+     * An optional new joinpoint node, provided if the transformation involves a replacement
+     */
+    newNode;
+    /**
+     *
+     * @param type The type of the MISRA transformation
+     * @param newNode The new joinpoint node resulting from the transformation. Required if the transformation type is `Replacement`.
+     */
+    constructor(type, newNode) {
+        this.type = type;
+        if (type === MISRATransformationType.Replacement && !newNode) {
+            throw new Error("newNode must be provided when a 'Replacement' transformation is performed");
+        }
+        this.newNode = newNode;
+    }
+}
+/**
+ * Converts a switch statement into either consecutive statements or if statements
+ * - If the switch has only one clause and a default case, it is converted to consecutive statements
+ * - Otherwise, it is converted to if statements
+ */
+export class MISRASwitchConverter {
+    /**
+     * Converts a switch statement to consecutive statements or if statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @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 
+            return this.convertToConsecutiveStmts(switchStmt);
+        }
+        else {
+            return this.convertToIfStatements(switchStmt);
+        }
+    }
+    /**
+     * Converts a switch with only one clause and a default case into consecutive statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @returns The first statement or `undefined` if no statements remain
+     */
+    static convertToConsecutiveStmts(switchStmt) {
+        const scope = switchStmt.children[1];
+        this.removeBreakStmts(scope);
+        this.removeCases(scope);
+        // If there are no statements except break and comments, the switch can be removed
+        if (scope.children.length === 0 || scope.children.every(stmt => isCommentStmt(stmt))) {
+            switchStmt.detach();
+            return undefined;
+        }
+        let firstStmt, lastStmt;
+        const stmts = scope.children;
+        for (let i = 0; i < stmts.length; i++) {
+            const stmt = stmts[i];
+            stmt.detach();
+            if (!firstStmt) {
+                firstStmt = stmt;
+                switchStmt.replaceWith(firstStmt);
+                lastStmt = stmt;
+                continue;
+            }
+            lastStmt.insertAfter(stmt);
+            lastStmt = stmt;
+        }
+        return firstStmt;
+    }
+    /**
+     * Converts a switch statement into a series of if statements
+     *
+     * @param switchStmt - The switch statement to convert
+     * @returns The first if statement created
+     */
+    static convertToIfStatements(switchStmt) {
+        const scope = switchStmt.children[1];
+        const consecutiveCases = this.consecutiveCases(switchStmt);
+        this.removeBreakStmts(scope);
+        let ifStmt;
+        let lastIfStmt;
+        for (let i = 0; i < consecutiveCases.length; i++) {
+            const cases = consecutiveCases[i];
+            if (cases.some(caseStmt => caseStmt.isDefault)) { // Has default case
+                lastIfStmt.setElse(ClavaJoinPoints.scope(...cases[cases.length - 1].instructions));
+            }
+            else {
+                lastIfStmt = this.createIfStatement(switchStmt.condition, cases, i, lastIfStmt);
+                if (i === 0) {
+                    ifStmt = lastIfStmt;
+                }
+            }
+        }
+        switchStmt.replaceWith(ifStmt);
+        return ifStmt;
+    }
+    /**
+     * Creates an if statement for the given consecutive cases
+     *
+     * @param condition - The switch condition
+     * @param cases - A list of consecutive cases
+     * @param index - The index of the current case group
+     * @param lastIfStmt - The last if statement, used to chain else
+     * @returns The new if statement
+     */
+    static createIfStatement(condition, cases, index, lastIfStmt) {
+        const conditionExpr = this.equivalentCondition(condition, cases);
+        const thenBody = ClavaJoinPoints.scope(...cases[cases.length - 1].instructions);
+        const newIfStmt = ClavaJoinPoints.ifStmt(conditionExpr, thenBody);
+        if (index === 0) {
+            return newIfStmt;
+        }
+        else {
+            lastIfStmt.setElse(newIfStmt);
+            return newIfStmt;
+        }
+    }
+    /**
+     * Creates the equivalent condition for an if statement based on the case values
+     *
+     * @param condition - The switch condition
+     * @param cases - A list of case` statements
+     * @returns The combined condition
+     */
+    static equivalentCondition(condition, cases) {
+        let lastBinaryOp;
+        for (let i = 0; i < cases.length; i++) {
+            const caseStmt = cases[i];
+            const newBinaryOp = ClavaJoinPoints.binaryOp("==", condition, caseStmt.values[0]);
+            if (i === 0) {
+                lastBinaryOp = newBinaryOp;
+                continue;
+            }
+            lastBinaryOp = ClavaJoinPoints.binaryOp("||", lastBinaryOp, newBinaryOp);
+        }
+        return lastBinaryOp;
+    }
+    /**
+     * Removes all break statements from the given scope
+     * @param scope - The scope from which the break statements will be removed
+     */
+    static removeBreakStmts(scope) {
+        const breakStmts = scope.children.filter(child => child instanceof Break);
+        breakStmts.forEach(stmt => stmt.detach());
+    }
+    /**
+     * Removes all case statements from the given scope
+     * @param scope - The scope from which the case statements will be removed
+     */
+    static removeCases(scope) {
+        const cases = scope.children.filter(child => child instanceof Case);
+        cases.forEach(caseStmt => caseStmt.detach());
+    }
+    /**
+     * Groups case statements into consecutive blocks, ensuring the block with the default case is last
+     *
+     * @param switchStmt - The switch statement
+     * @returns The grouped case statements
+     */
+    static consecutiveCases(switchStmt) {
+        let caseGroups = [];
+        let currentList = [];
+        for (const caseStmt of switchStmt.cases) {
+            currentList.push(caseStmt);
+            if (caseStmt.instructions.length !== 0) { // Has no consecutive case
+                caseGroups.push(currentList);
+                currentList = [];
+            }
+        }
+        // Ensure the block containing the default case is placed at the last position
+        return this.organizeCaseGroups(caseGroups);
+    }
+    /**
+     * Organizes case groups such that the group with default case is placed last.
+     *
+     * @param caseGroups - The groups of case statements
+     * @returns The organized case groups
+     */
+    static organizeCaseGroups(caseGroups) {
+        const nonDefaultGroups = caseGroups.filter(block => !block.some(caseStmt => caseStmt.isDefault));
+        const defaultBlock = caseGroups.find(block => block.some(caseStmt => caseStmt.isDefault));
+        if (defaultBlock) {
+            nonDefaultGroups.push(defaultBlock);
+        }
+        return nonDefaultGroups;
+    }
+}
+//# sourceMappingURL=MISRA.js.map

package/dist/MISRA.js.map

@@ -0,0 +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"}

package/dist/MISRAContext.d.ts

@@ -0,0 +1,21 @@
+import { Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
+import { MISRAError } from "./MISRA.js";
+/**
+ * Tracks MISRA errors and warnings during the analysis and/or transformation of the code.
+ * Also generated unique variable and function names.
+ */
+export default class MISRAContext {
+    #private;
+    get errors(): MISRAError[];
+    get warnings(): MISRAError[];
+    get config(): Map<string, any> | undefined;
+    set config(configFilePath: string);
+    generateVarName(): string;
+    generateFuncName(): string;
+    generateHeaderFilename(): string;
+    addMISRAError(ruleID: string, $jp: Joinpoint, message: string): void;
+    addMISRAWarning(ruleID: string, $jp: Joinpoint, message: string): void;
+    printErrors(): void;
+    printWarnings(): void;
+}
+//# sourceMappingURL=MISRAContext.d.ts.map

package/dist/MISRAContext.d.ts.map

@@ -0,0 +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"}