CppcheckRule

This module generates a report from result of cppcheck static analysis.

Prerequisites

cppcheck

Static C++ code analyzer tool. Available from ubuntu packages or from source at http://cppcheck.sourceforge.net/

xsltproc

XSL Template rendering tool. Available from ubuntu packages or from source at http://xmlsoft.org/

Functions

add_cppcheck(module,
  [INTPUT        <dir>     [ <dir>     ... ]],
  [FILE_PATTERNS <pattern> [ <pattern> ... ]]
)

This function generates cmake targets that produce cppcheck reports for a given module. Generated targets are added as dependency of the global cppcheck and cppcheck-clean targets.

Parameters

module

Name of the module. It determines the name of the generated cmake targets and the directory where targets generate the report.

INPUT

List of directories where target should search source files process. Default value is given by CppcheckRule_DEFAULT_INPUT

FILE_PATTERNS

List of wildcards search files in given input directories. Default value is given by CppcheckRule_DEFAULT_FILE_PATTERNS

Global variables

CppcheckRule_DEFAULT_INPUT

"${CMAKE_CURRENT_SOURCE_DIR}/src"

CppcheckRule_DEFAULT_FILE_PATTERNS

"*.cc;*.hh;*.hxx"

Generated targets

cppcheck

generate cppcheck reports for all modules

cppcheck-clean

removes cppcheck reports for all modules

<module>-cppcheck

generate cppcheck report for module <module>

<module>-cppcheck-clean

removes cppcheck report for module <module>

Dependencies

Warning

The dependency of cmake build system to the modification time of INPUT directories doesn’t work with cmake versions prior to 3.0. This mean you must re-run cmake after adding new sources files in order to properly update the rule files dependencies

Generated reports

HTML : reports/cppcheck/<module>/index.html

Bellow an example of generated html report :

XML : reports/cppcheck/<module>/cppcheck.xml

<?xml version="1.0" encoding="UTF-8"?>
<results version="2">
  <cppcheck version="1.72"/>
  <errors>
    <error id="duplicateExpression" severity="style" msg="Same expression on both sides of '<='." verbose="Finding the same expression on both sides of an operator is suspicious and might indicate a cut and paste or logic error. Please examine this code carefully to determine if it is correct.">
      <location file="functions.hh" line="12"/>
      <location file="functions.hh" line="12"/>
    </error>
    <error id="bitwiseOnBoolean" severity="style" msg="Boolean variable 'test1' is used in bitwise operation. Did you mean '&&'?" verbose="Boolean variable 'test1' is used in bitwise operation. Did you mean '&&'?" inconclusive="true">
      <location file="functions.hh" line="22"/>
    </error>
  </errors>
</results>

JSON : reports/cppcheck/<module>/status.json

{
  "status": "success",
  "graphs": [
    {
      "data": {
        "labels": [],
        "datasets": [
          {
            "borderColor": "rgba(179, 0, 0, 0.5)",
            "pointBorderColor": "rgba(102, 0, 0, 1)",
            "yAxisID": "absolute",
            "label": "cppcheck error count",
            "backgroundColor": "rgba(179, 0, 0, 0.5)",
            "pointBackgroundColor": "rgba(102, 0, 0, 1)",
            "data": "%(total)d"
          }
        ]
      },
      "type": "line",
      "options": {
        "scales": {
          "xAxes": [
            {
              "ticks": {
                "fontSize": 12,
                "minRotation": 80
              }
            }
          ],
          "yAxes": [
            {
              "position": "left",
              "ticks": {
                "fontSize": 24,
                "beginAtZero": true
              },
              "type": "linear",
              "id": "absolute",
              "display": true
            }
          ]
        },
        "title": {
          "text": "%(module)s : cppcheck",
          "display": true
        }
      }
    }
  ],
  "data": {
    "total": 0
  },
  "label": "0"
}