Clava MISRA Tool

A Clava-based library to automatically detect and correct parts of C code that violate MISRA-C:2012 coding standard.

For more details, see the Clava Transpiler repository.

Installation

To get started, ensure the tool's NPM package is installed in your project:

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:

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.

2. Correction

Besides analysis, the tool can also correct the provided source code to comply with the coding guidelines, using the following statements:

import MISRATool from "@specs-feup/clava-misra/dist/MISRATool.js";

MISRATool.applyCorrections();

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.

The config file should follow this structure:

{
  "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:

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.

npx clava classic [path/to/scriptFile.js] -pi -std [c90 | c99 | c11] -p [path/to/source/code]

Example:

npx clava classic main.js -pi -std c99 -p CxxSources/

To view other available options, run:

npx clava classic -dummy