static analysis of C/C++ code
Go to file
Oliver Stöneberg 2cd8bb94e4
some small `CmdLineParser` cleanups and improvements (#4654)
2022-12-19 22:28:36 +01:00
.github/workflows improved `MathLib::to{ULong|Long|Double}Number()` and increased test coverage / added CMake option `USE_LIBCXX` / fixed #10695 (#4611) 2022-12-07 09:20:09 +01:00
addons Missing rule-text-file to not stop the analysis (#4458) 2022-09-12 12:55:07 +02:00
cfg Add cfg for std::scoped_lock, handle template arguments in checkMisusedScopedObject() (#4615) 2022-12-07 09:10:48 +01:00
cli some small `CmdLineParser` cleanups and improvements (#4654) 2022-12-19 22:28:36 +01:00
cmake improved `MathLib::to{ULong|Long|Double}Number()` and increased test coverage / added CMake option `USE_LIBCXX` / fixed #10695 (#4611) 2022-12-07 09:20:09 +01:00
democlient Remove bug hunting. This feature will be provided in Cppcheck premium. 2022-04-11 07:31:33 +02:00
externals bump simplecpp (#4618) 2022-12-09 07:18:13 +01:00
gui add/preserve `const` in `dynamic_cast` (#4655) 2022-12-19 20:01:12 +01:00
htmlreport removed unused test files (#4648) 2022-12-18 19:36:37 +01:00
lib add/preserve `const` in `dynamic_cast` (#4655) 2022-12-19 20:01:12 +01:00
man added missing version bumps to 2.10 (#4420) 2022-09-09 21:02:04 +02:00
oss-fuzz enabled and fixed `readability-named-parameter` clang-tidy warnings (#4487) 2022-09-27 20:03:25 +02:00
platforms Running astyle [ci skip] 2020-11-21 00:02:44 +01:00
rules Activated 'make validateRules' and improved rule XML file parsing. Now, it optionally accepts '<rules>...</rules>' tags to make xmllint happy. 2022-06-22 00:03:18 +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 some small `CmdLineParser` cleanups and improvements (#4654) 2022-12-19 22:28:36 +01:00
tools donate-cpu: fixed interrupted `main` branch compilation (#4643) 2022-12-18 19:50:22 +01:00
valgrind Add Valgrind CI action (#2921) 2020-12-07 08:41:25 +01:00
win_installer win_installer: copy openssl from Qt tools folder 2022-11-02 12:11:13 +01:00
.clang-tidy include all (internal non-generated) headers in clang-tidy checks (#4100) 2022-10-16 13:51:17 +02:00
.codacy.yml removed unused test files (#4648) 2022-12-18 19:36:37 +01:00
.gitignore selfcheck : cleaned up some suppressions, fixed warnings and some cleanups (#4436) 2022-09-06 23:11:39 +02:00
.mailmap Revert "Revert "Add a .mailmap file."" 2013-10-04 18:03:18 +02:00
.selfcheck_suppressions selfcheck : cleaned up some suppressions, fixed warnings and some cleanups (#4436) 2022-09-06 23:11:39 +02:00
.selfcheck_unused_suppressions added unusedFunction self check to CI / cleanups (#3526) 2022-01-18 22:02:25 +01:00
.travis.yml Moved some stuff from Travis to GitHub Actions / Cleanups (#3715) 2022-05-31 19:53:50 +02:00
.uncrustify.cfg Format with uncrustify (#3388) 2021-08-07 20:51:18 +02:00
AUTHORS AUTHORS: Add gerboengels 2022-10-11 22:02:56 +02:00
CMakeLists.txt handle precompiled headers with `ccache` / fixed caching in some docker builds (#4505) 2022-09-26 18:21:43 +02:00
COPYING
Makefile removed unused test files (#4648) 2022-12-18 19:36:37 +01:00
build-pcre.txt Add how to install pcre by using homebrew (#3087) 2021-01-27 19:06:58 +01:00
clang-tidy.md disabled all clang-tidy checks for Qt generated files (#4525) 2022-09-30 07:27:03 +02: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: small tweaks 2022-08-28 17:21:32 +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 bumped minimum supported GCC version to 4.8 (#3768) 2022-02-05 17:57:32 +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 Denote 'python xxx/donate-cpu.py' line as code (#4456) 2022-09-09 23:07:58 +02:00
readme.txt Remove bug hunting. This feature will be provided in Cppcheck premium. 2022-04-11 07:31:33 +02:00
readmeja.md added MinGW to CI and fixed local MinGW build (#3826) 2022-02-16 07:06:04 +01:00
releasenotes.txt some small `CmdLineParser` cleanups and improvements (#4654) 2022-12-19 22:28:36 +01: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 OSS-Fuzz Coverity Scan Build Status License
Github Action 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.8 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.8 (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.

Visual Studio (from command line)

If you do not wish to use the Visual Studio IDE, you can compile cppcheck from the command line the following command.

msbuild cppcheck.sln

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

If you encounter the following error with MATCHCOMPILER=yes you need to specify your Python interpreter via PYTHON_INTERPRETER.

process_begin: CreateProcess(NULL, which python3, ...) failed.
makefile:24: pipe: No error
process_begin: CreateProcess(NULL, which python, ...) failed.
makefile:27: pipe: No error
makefile:30: *** Did not find a Python interpreter.  Stop.

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/