cppcheck/addons
Richard A. Smith 2b44fb57bc Loosen restrictions on MISRA rules text structure (#2157)
Version 1.88 changed the parsing of the MISRA rules file adding a
severity setting.  This caused a regression in rule parsing.

In particular the following format used to parse cleanly and produce
rule output that would show the severity as part of the rule text.

    Rule 1.2

    Advisory

    Rule text goes here.

    Rule 1.3

    Required

    More rule text goes here.

As of 1.88 a file structured like above would parse as having no rules.

The problem is the use of blank lines as a rule delimiter.   The
modified rule parser wants to see a rules formatted like below:

    Rule 3.1 Required
    R3.1 text.
    Rule 4.1 Required
    R4.1 text.

or:

    Rule 1.1
    Add this rule and parse to next, skipping empty lines.

    Rule 1.2
    Rule text.

Any rule text that did not fall into one of the above formats would
result in incomplete rule text parsing.

Change the parsing of the rule text file so that blank lines are ignored
instead of treating them as a delimiter between rules. Instead use the
start of the next rule as a delimiter for the end of the previous rule.
This allows both of the newer formats but also supports the behavior of
pre-1.88 versions.

Change units tests that were specifically forbidding the use of blank
lines to ones that allow blank lines.
2019-09-09 21:43:44 +02:00
..
doc Addons: Add README (#2047) 2019-07-28 07:51:03 +02:00
test Loosen restrictions on MISRA rules text structure (#2157) 2019-09-09 21:43:44 +02:00
README.md Addons: Add README (#2047) 2019-07-28 07:51:03 +02:00
ROS_naming.json Feature/ros naming check (#1511) 2019-01-09 18:16:51 +01:00
__init__.py misra.py: Fix up and improve load rules parser. (#1895) 2019-06-17 21:17:29 +02:00
cert.py Typos found by running "codespell" (#2072) 2019-08-08 21:05:28 +02:00
cppcheckdata.doxyfile Fix some typos in comments (found by codespell) 2016-11-27 11:40:42 +01:00
cppcheckdata.py Refactoring: Rename variables. Do not use leading _. Renamed 'col' to 'column' 2019-08-18 12:19:05 +02:00
findcasts.py addons: /reportErrorCli/reportError/ 2019-04-14 08:54:53 +02:00
misc.py make ellipsis ... a single token (#2143) 2019-09-04 08:07:30 +02:00
misra.py Loosen restrictions on MISRA rules text structure (#2157) 2019-09-09 21:43:44 +02:00
naming.json Feature/ros naming check (#1511) 2019-01-09 18:16:51 +01:00
naming.py addons: /reportErrorCli/reportError/ 2019-04-14 08:54:53 +02:00
namingng.py addons/namingng.py: Fixed typos, no functional changes intended. 2019-03-26 15:21:49 +01:00
threadsafety.py addons: /reportErrorCli/reportError/ 2019-04-14 08:54:53 +02:00
y2038.py Update addons structure. Make Y2038 addon works. (#2024) 2019-07-26 06:38:03 +02:00

README.md

Cppcheck addons

Addons are scripts that analyses Cppcheck dump files to check compatibility with secure coding standards and to locate various issues.

Supported addons

  • cert.py Checks for compliance with the safe programming standard CERT.
  • misra.py Used to verify compliance with MISRA C 2012 - a proprietary set of guidelines to avoid such questionable code, developed for embedded systems. Since this standard is proprietary, cppcheck does not display error text by specifying only the number of violated rules (for example, [c2012-21.3]). If you want to display full texts for violated rules, you will need to create a text file containing MISRA rules, which you will have to pass when calling the script with --rule-texts key. Some examples of rule texts files available in tests directory.
  • y2038.py Checks Linux system for year 2038 problem safety. This required modified environment. See complete description here.
  • threadsafety.py Analyse Cppcheck dump files to locate threadsafety issues like static local objects used by multiple threads.

Usage

Command line interface

cppcheck --addon=cert --addon=y2038 src/test.c

It is also possible to call scripts as follows:

cppcheck --dump --quiet src/test.c
python cert.py src/test.c.dump
python misra.py --rules-texts=~/misra_rules.txt src/test.c.dump

This allows you to add additional parameters when calling the script (for example, --rule-tests for misra.py). The full list of available parameters can be found by calling any script with the --help flag.

GUI

When using the graphical interface cppcheck-gui, the selection and configuration of addons is carried out on the tab Addons and tools in the project settings (Edit Project File):