static analysis of C/C++ code
Go to file
orbitcowboy efd3aa47c5 Code formatting 2021-12-19 17:45:04 +01:00
.github/workflows Fix #9162 (Invalid --project files do not give any error) (#3177) 2021-12-19 12:36:11 +01:00
addons misra; fix typo 2021-12-14 17:32:05 +01:00
cfg wxwidgets.cfg: Cleanup wrong arg config 2021-12-16 11:27:07 +01:00
cli Fix #9162 (Invalid --project files do not give any error) (#3177) 2021-12-19 12:36:11 +01:00
cmake added building of GUI tests to CMake (#3619) 2021-12-17 21:49:32 +01:00
cve-test-suite fixed/excluded some shellcheck warnings and actually fail the build when something is found (#3068) 2021-01-20 18:43:49 +01:00
democlient democlient: fix compiler error 2021-10-02 13:03:51 +02:00
externals bump simplecpp 2021-12-16 21:18:27 +01:00
gui Code formatting 2021-12-19 17:45:04 +01:00
htmlreport Various changes (#3622) 2021-12-15 20:57:06 +01:00
lib dump; add 'noreturn' attribute for function calls 2021-12-19 15:32:33 +01:00
man Add support for string_view (#3480) 2021-10-05 08:28:19 +02:00
oss-fuzz Format with uncrustify (#3388) 2021-08-07 20:51:18 +02:00
platforms Running astyle [ci skip] 2020-11-21 00:02:44 +01:00
rules Format rules files as well 2019-09-26 19:58:39 +02:00
samples samples; Fixed missing return in non-void functions 2021-07-04 16:59:09 +02:00
snap Fix permissions of certain non-executable files (#1083) 2018-02-09 19:46:38 +01:00
test Ticket #8640: Added regression test 2021-12-19 17:43:32 +01:00
tools test-my-pr: Allow to specify packages to process (#3605) 2021-12-05 20:25:38 +01:00
valgrind Add Valgrind CI action (#2921) 2020-12-07 08:41:25 +01:00
win_installer win_installer: update building. all files needed are collected in a single folder. the 'deploy' artifact will contain all the files. 2021-10-16 13:59:39 +02:00
.clang-tidy updated latest ubuntu version to 21.10 / updated to clang-tidy-13 (#3494) 2021-10-24 11:07:45 +02:00
.codacy.yml Codacy: Try to exclude all addon test files 2018-10-18 09:29:38 +02:00
.gitignore Fix #9162 (Invalid --project files do not give any error) (#3177) 2021-12-19 12:36:11 +01:00
.mailmap
.travis.yml moved bug hunting in CI from defunct Travis job to (disabled) GitHub action (#3164) 2021-10-13 14:47:59 +02:00
.travis_llvmcheck_suppressions Travis: updated the .travis_llvmcheck_suppressions file, * is not allowed 2018-11-19 15:42:40 +01:00
.travis_suppressions Fix #9162 (Invalid --project files do not give any error) (#3177) 2021-12-19 12:36:11 +01:00
.uncrustify.cfg Format with uncrustify (#3388) 2021-08-07 20:51:18 +02:00
AUTHORS AUTHORS: Added afestini 2021-12-15 20:57:53 +01:00
CMakeLists.txt Dont require __main__ for an addon (#3363) 2021-08-12 20:17:51 +02:00
COPYING
Makefile cleaned up includes based on include-what-you-use (#3627) 2021-12-15 19:47:27 +01:00
appveyor.yml Add colors to CLI reporting (#3304) 2021-07-08 21:21:35 +02:00
benchmarks.txt benchmarks: Added CImg. Removed old stuff. 2019-03-04 07:05:40 +01:00
build-pcre.txt Add how to install pcre by using homebrew (#3087) 2021-01-27 19:06:58 +01:00
console_common.pri
cppcheck-errors.rng Readd cppcheck-errors.rng 2021-06-19 19:44:36 +02:00
cppcheck.cppcheck Add cppcheck.cppcheck build dir 2018-02-23 22:16:49 +01:00
cppcheck.sln Updated to Visual Studio 2019 2019-07-06 12:11:19 +02:00
createrelease createrelease: copy output from github actions 2021-10-02 15:19:59 +02:00
doxyfile Fix typos (#1568) 2019-01-06 17:15:57 +01:00
generate_coverage_report rename externals/tinyxml to externals/tinyxml2 2020-11-16 09:11:53 +01:00
naming.json Check for JSON error when parsing addon .json files + fixes (#2374) 2019-11-20 15:37:09 +01:00
philosophy.md philosophy.md : Describe inconclusive messages (#2841) 2021-01-18 19:58:06 +01:00
pylintrc_travis pylintrc_travis: Add check for bad-indentation, fix issues in misra.py (#2349) 2019-11-11 13:53:19 +01:00
readme.md Switch from http to https on our sourceforge webpage 2021-08-28 12:46:54 +02:00
readme.txt Switch from http to https on our sourceforge webpage 2021-08-28 12:46:54 +02:00
readmeja.md Switch from http to https on our sourceforge webpage 2021-08-28 12:46:54 +02:00
releasenotes.txt Add support for string_view (#3480) 2021-10-05 08:28:19 +02:00
requirements.txt Install pcre from github since the ftp.pcre.org site is no longer available (#3546) 2021-11-06 19:05:16 +01:00
runformat runformat: simple build instruction 2021-08-08 14:34:52 +02:00
webreport.sh fixed/excluded some shellcheck warnings and actually fail the build when something is found (#3068) 2021-01-20 18:43:49 +01:00

readme.md

Cppcheck

GitHub Actions Linux Build Status Windows Build Status OSS-Fuzz Coverity Scan Build Status License
Github Action Status Linux Build Status Windows Build Status OSS-Fuzz Coverity Scan Build Status License

About the name

The original name of this program was "C++check", but it was later changed to "Cppcheck".

Despite the name, Cppcheck is designed for both C and C++.

Manual

A manual is available online.

Donate CPU

Cppcheck is a hobby project with limited resources. You can help us by donating CPU (1 core or as many as you like). It is simple:

  1. Download (and extract) Cppcheck source code.
  2. Run script: python cppcheck/tools/donate-cpu.py.

The script will analyse debian source code and upload the results to a cppcheck server. We need these results both to improve Cppcheck and to detect regressions.

You can stop the script whenever you like with Ctrl C.

Compiling

Any C++11 compiler should work. For compilers with partial C++11 support it may work. If your compiler has the C++11 features that are available in Visual Studio 2013 / GCC 4.6 then it will work.

To build the GUI, you need Qt.

When building the command line tool, PCRE is optional. It is used if you build with rules.

There are multiple compilation choices:

  • qmake - cross platform build tool
  • cmake - cross platform build tool
  • Windows: Visual Studio (VS 2013 and above)
  • Windows: Qt Creator + mingw
  • gnu make
  • g++ 4.6 (or later)
  • clang++

cmake

Example, compiling Cppcheck with cmake:

mkdir build
cd build
cmake ..
cmake --build .

If you want to compile the GUI you can use the flag. -DBUILD_GUI=ON

For rules support (requires pcre) use the flag. -DHAVE_RULES=ON

For release builds it is recommended that you use: -DUSE_MATCHCOMPILER=ON

Using cmake you can generate project files for Visual Studio,XCode,etc.

qmake

You can use the gui/gui.pro file to build the GUI.

cd gui
qmake
make

Visual Studio

Use the cppcheck.sln file. The file is configured for Visual Studio 2019, but the platform toolset can be changed easily to older or newer versions. The solution contains platform targets for both x86 and x64.

To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration. pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /externals then. A current version of PCRE for Visual Studio can be obtained using vcpkg.

VS Code (on Windows)

Install MSYS2 to get GNU toolchain with g++ and gdb (https://www.msys2.org/). Create a settings.json file in the .vscode folder with the following content (adjust path as necessary):

{
    "terminal.integrated.shell.windows": "C:\\msys64\\usr\\bin\\bash.exe",
    "terminal.integrated.shellArgs.windows": [
        "--login",
    ],
    "terminal.integrated.env.windows": {
        "CHERE_INVOKING": "1",
        "MSYSTEM": "MINGW64",
    }
}

Run "make" in the terminal to build cppcheck.

For debugging create a launch.json file in the .vscode folder with the following content, which covers configuration for debugging cppcheck and misra.py:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "cppcheck",
            "type": "cppdbg",
            "request": "launch",
            "program": "${workspaceFolder}/cppcheck.exe",
            "args": [
                "--dump",
                "${workspaceFolder}/addons/test/misra/misra-test.c"
            ],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "externalConsole": true,
            "MIMode": "gdb",
            "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ]
        },
        {
            "name": "misra.py",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/addons/misra.py",
            "console": "integratedTerminal",
            "args": [
                "${workspaceFolder}/addons/test/misra/misra-test.c.dump"
            ]
        }
    ]
}

Qt Creator + MinGW

The PCRE dll is needed to build the CLI. It can be downloaded here: http://software-download.name/pcre-library-windows/

GNU make

Simple, unoptimized build (no dependencies):

make

The recommended release build is:

make MATCHCOMPILER=yes FILESDIR=/usr/share/cppcheck HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function"

Flags:

  1. MATCHCOMPILER=yes Python is used to optimise cppcheck. The Token::Match patterns are converted into C++ code at compile time.

  2. FILESDIR=/usr/share/cppcheck Specify folder where cppcheck files are installed (addons, cfg, platform)

  3. HAVE_RULES=yes Enable rules (PCRE is required if this is used)

  4. CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function" Enables most compiler optimizations, disables cppcheck-internal debugging code and enables basic compiler warnings.

g++ (for experts)

If you just want to build Cppcheck without dependencies then you can use this command:

g++ -o cppcheck -std=c++11 -Iexternals -Iexternals/simplecpp -Iexternals/tinyxml2 -Iexternals/picojson -Ilib cli/*.cpp lib/*.cpp externals/simplecpp/simplecpp.cpp externals/tinyxml2/*.cpp

If you want to use --rule and --rule-file then dependencies are needed:

g++ -o cppcheck -std=c++11 -lpcre -DHAVE_RULES -Ilib -Iexternals -Iexternals/simplecpp -Iexternals/tinyxml2 cli/*.cpp lib/*.cpp externals/simplecpp/simplecpp.cpp externals/tinyxml2/*.cpp

MinGW

mingw32-make LDFLAGS=-lshlwapi

Other Compiler/IDE

  1. Create an empty project file / makefile.
  2. Add all cpp files in the cppcheck cli and lib folders to the project file / makefile.
  3. Add all cpp files in the externals folders to the project file / makefile.
  4. Compile.

Cross compiling Win32 (CLI) version of Cppcheck in Linux

sudo apt-get install mingw32
make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi" RDYNAMIC=""
mv cppcheck cppcheck.exe

Packages

You can install Cppcheck with yum/apt/brew/etc.

The official rpms are built with these files: https://src.fedoraproject.org/rpms/cppcheck/tree/master

Webpage

https://cppcheck.sourceforge.io/