static analysis of C/C++ code
Go to file
Daniel Marjamäki b36c85d8fd Rename VerifyException to BugHuntingException 2020-06-15 22:07:32 +02:00
.github/workflows
addons
cfg wxwidgets.cfg: Added support for more interfaces 2020-06-15 20:03:20 +02:00
cli Tweked --help output 2020-06-14 17:23:29 +02:00
cmake Set version to 2.1.99 / 2.2 dev 2020-06-14 07:16:14 +02:00
cve-test-suite
democlient
externals
gui AboutDialog: Updated copyright year so we don't have to manually tweak it. Thank you Z3 library. 2020-06-14 07:36:19 +02:00
htmlreport htmlreport: Fix source view with leading empty lines 2020-01-21 09:13:55 +01:00
lib Rename VerifyException to BugHuntingException 2020-06-15 22:07:32 +02:00
man Integrated PR #2679 into main 2020-06-15 20:11:20 +02:00
oss-fuzz some CMake cleanups and additions (#2639) 2020-05-27 05:15:46 +02:00
platforms
rules
samples
snap Fix permissions of certain non-executable files (#1083) 2018-02-09 19:46:38 +01:00
test 9768: Fix ast with throw in the middle of return (#2678) 2020-06-15 10:36:02 +02:00
tools new default branch is main 2020-06-15 20:04:57 +02:00
win_installer
.astylerc
.clang-tidy
.codacy.yml
.gitignore
.mailmap
.travis.yml
.travis_llvmcheck_suppressions
.travis_suppressions
AUTHORS
CMakeLists.txt
COPYING
Makefile Set debug mode 2020-06-13 18:09:27 +02:00
appveyor.yml
benchmarks.txt
build-pcre.txt
build.bat
console_common.pri
cppcheck-errors.rng
cppcheck.cppcheck
cppcheck.sln
createrelease
doxyfile
generate_coverage_report
naming.json
philosophy.md
pylintrc_travis
readme.md new default branch is main 2020-06-15 20:04:57 +02:00
readme.txt compiling; you can put z3 files in externals/z3 2020-02-11 17:42:40 +01:00
readmeja.md
requirements.txt
runastyle
runastyle.bat
webreport.sh

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.

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/tinyxml -Ilib cli/*.cpp lib/*.cpp externals/simplecpp/simplecpp.cpp externals/tinyxml/*.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/tinyxml cli/*.cpp lib/*.cpp externals/simplecpp/simplecpp.cpp externals/tinyxml/*.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

Webpage

http://cppcheck.sourceforge.net/