cppcheck/addons
thingsconnected 24133d4a59
addons/namingng.py: Fix commandline use. (#5793)
namingng.py was only usable in standalone mode, but now supports CLI
mode, i.e. with cppcheck --addon=namingng. It uses the generic reporting
provided by cppcheckdata.reportError(). All output other than reported
errors is suppressed.

A local function reportNamingError() is implemented to call through to
cppcheckdata.reportError(), filling in common defaults.

The collection of errors and the --verify feature are removed, including
related workflow and a test file. These are replaced by a unit test.
2023-12-30 20:54:03 +01:00
..
doc Addons: Add README (#2047) 2019-07-28 07:51:03 +02:00
test addons/namingng.py: Fix commandline use. (#5793) 2023-12-30 20:54:03 +01:00
README.md addons/namingng.py: Fix commandline use. (#5793) 2023-12-30 20:54:03 +01: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
cppcheck.py Typos found by running "codespell" (#3463) 2021-09-20 19:51:38 +02:00
cppcheckdata.doxyfile Fix some typos in comments (found by codespell) 2016-11-27 11:40:42 +01:00
cppcheckdata.py fix casing in variable name (#5778) 2023-12-18 18:57:08 +01:00
findcasts.py test/cli/test-other.py: improved addon tests (#5469) 2023-09-25 13:39:17 +02:00
misc.py Addons: Reuse cppcheckdata.simpleMatch 2020-11-11 14:24:55 +01:00
misra.py Fixed #12267 (Misra.py: crashes in 17.7 checker when there is macro in variable declaration) (#5768) 2023-12-15 22:53:19 +01:00
misra_9.py Fix #12298: false positive: misra-c2012-9.3 (#5812) 2023-12-30 13:05:25 +01:00
naming.py Ignore copy/move constructors for function naming checks (#4134) 2022-06-01 06:54:31 +02:00
namingng.config.json addons/namingng.py: Fix commandline use. (#5793) 2023-12-30 20:54:03 +01:00
namingng.json addons/namingng.py: Fix commandline use. (#5793) 2023-12-30 20:54:03 +01:00
namingng.py addons/namingng.py: Fix commandline use. (#5793) 2023-12-30 20:54:03 +01:00
runaddon.py Dont require __main__ for an addon (#3363) 2021-08-12 20:17:51 +02:00
threadsafety.py threadsafety.py: cleanup (#5132) 2023-06-08 19:58:11 +02:00
y2038.py test/cli/test-other.py: improved addon tests (#5469) 2023-09-25 13:39:17 +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

  • 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.
  • naming.py Enforces naming conventions across the code.
  • namingng.py Enforces naming conventions across the code. Enhanced version with support for type prefixes in variable and function names.
  • findcasts.py Locates casts in the code.
  • misc.py Performs miscellaneous checks.

Other files

  • doc Additional files for documentation generation.
  • tests Contains various unit tests for the addons.
  • cppcheck.py Internal helper used by Cppcheck binary to run the addons.
  • cppcheckdata.doxyfile Configuration file for documentation generation.
  • cppcheckdata.py Helper class for reading Cppcheck dump files within an addon.
  • misra_9.py Implementation of the MISRA 9.x rules used by misra addon.
  • namingng.config.json Example configuration for namingng addon.
  • namingng.json Example JSON file that can be used using --addon=namingng.json, referring to namingng.py and namingng.config.json
  • ROS_naming.json Example configuration for the namingng addon enforcing the ROS naming convention for C++ .
  • runaddon.py Internal helper used by Cppcheck binary to run the addons.

Usage

Command line interface

cppcheck --addon=misc src/test.c

It is also possible to call scripts as follows:

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

This allows you to add additional parameters when calling the script (for example, --rule-texts 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):

Screenshot