static analysis of C/C++ code
Go to file
Oliver Stöneberg 9280b5d7a5
CI-unixish.yml: removed `macos-11` builds and no longer build with qmake on MacOS (#5614)
Removed all `macos-11` builds as `brew` no longer supports it and we use
it in most steps:
```
Warning: You are using macOS 11.
We (and Apple) do not provide support for this old version.
It is expected behaviour that some formulae will fail to build in this old version.
It is expected behaviour that Homebrew will be buggy and slow.
Do not create any issues about this on Homebrew's GitHub repositories.
Do not create any issues even if you think this message is unrelated.
Any opened issues will be immediately closed without response.
Do not ask for help from Homebrew or its maintainers on social media.
You may ask for help in Homebrew's discussions but are unlikely to receive a response.
Try to figure out the problem yourself and submit a fix as a pull request.
We will review it but may or may not accept it.
```

Also `brew` might no longer provide pre-built Qt5 packages which will
cause the step to run for hours as it will compile it on demand - see
https://github.com/danmar/cppcheck/actions/runs/6735637341/job/18314354679
for such an instance.
2023-11-02 23:31:59 +01:00
.github/workflows CI-unixish.yml: removed `macos-11` builds and no longer build with qmake on MacOS (#5614) 2023-11-02 23:31:59 +01:00
addons Fix #9488: MISRA addon: False positive for rule 10.6 in test for rule 10.1 (#5598) 2023-10-30 17:24:19 +01:00
cfg Fix #12134 false negative: passedByValue (#5607) 2023-10-31 19:08:08 +01:00
cli extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
cmake fixed #12042 - deprecated building with Qt5 / build with Qt6 in CI / updated latest Qt in CI to 6.5.3 (#4957) 2023-10-26 14:55:59 +02:00
democlient CI-unixish.yml: added step to compile democlient (#4997) 2023-04-21 18:58:04 +02:00
externals added simplecpp source to selfcheck (#5432) 2023-10-26 10:52:44 +02:00
gui extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
htmlreport removed unused test files (#4648) 2022-12-18 19:36:37 +01:00
lib extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
man Fixed #3537 (Allow inline suppression comments for macros) (#5559) 2023-10-16 19:43:15 +02:00
oss-fuzz removed unnecessary OSS-Fuzz related builds from CI (#4827) 2023-02-25 15:40:12 +01:00
platforms made platforms file validation stricter / added missing `bool` elements (#4747) 2023-01-27 08:34:12 +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 extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
tools extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
valgrind Add Valgrind CI action (#2921) 2020-12-07 08:41:25 +01:00
win_installer installer: added missing library configurations and removed unneeded Qt DLLs / refs #10771 - added initial portable package (#4669) 2023-10-11 13:26:12 +02:00
.clang-tidy fixed #12042 - deprecated building with Qt5 / build with Qt6 in CI / updated latest Qt in CI to 6.5.3 (#4957) 2023-10-26 14:55:59 +02:00
.codacy.yml renamed some files in the `test` folder (#4705) 2023-01-27 08:18:32 +01:00
.gitattributes added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
.gitignore Don't ignore build*, accidently it ignored all files starts with buil… (#5051) 2023-05-12 16:08:58 +02:00
.mailmap Revert "Revert "Add a .mailmap file."" 2013-10-04 18:03:18 +02:00
.selfcheck_suppressions added simplecpp source to selfcheck (#5432) 2023-10-26 10:52:44 +02:00
.selfcheck_unused_suppressions fixed #11483 (FN unusedFunction for method with inline implementation) (#5457) 2023-09-20 14:45:44 +02: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 JohanBertrand [ci skip] (#5549) 2023-10-13 12:48:50 +02:00
CMakeLists.txt fixed #7099 - added optional `man` target to CMake / build manpage in CI (#5536) 2023-10-09 22:20:36 +02:00
COPYING Licensing: Using the GPL 3 license 2008-10-26 07:55:15 +00:00
Makefile extracted `FileSettings` from `ImportProject` to `filesettings.h` (#5604) 2023-11-02 17:42:41 +01:00
build-pcre.txt added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
clang-tidy.md fixed #12042 - deprecated building with Qt5 / build with Qt6 in CI / updated latest Qt in CI to 6.5.3 (#4957) 2023-10-26 14:55:59 +02:00
codecov.yml disabled codecov comments and actions for now (#4896) 2023-03-16 19:24:33 +01:00
console_common.pri pro and pri files: remove unneeded empty lines, use spaces for consistency 2012-10-12 17:46:57 +02:00
cppcheck-errors.rng Readd cppcheck-errors.rng 2021-06-19 19:44:36 +02:00
cppcheck.cppcheck renamed some files in the `test` folder (#4705) 2023-01-27 08:18:32 +01:00
cppcheck.sln fixed #11910 - removed Visual Studio x86 targets from project files and builds from CI (#5397) 2023-09-04 19:40:13 +02:00
createrelease createrelease: Updated release procedure 2023-09-10 17:18:02 +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 philosphy.md: Remove section about bughunting it has been moved to Cppcheck Premium 2023-06-09 09:40:58 +02: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 deprecated qmake build system / removed Qt5 fallback when using `USE_QT6=On` (#5271) 2023-08-09 22:40:15 +02:00
readme.txt header file path required for picojson (#5040) 2023-05-07 08:29:38 +02:00
readmeja.md added MinGW to CI and fixed local MinGW build (#3826) 2022-02-16 07:06:04 +01:00
releasenotes.txt fixed #12042 - deprecated building with Qt5 / build with Qt6 in CI / updated latest Qt in CI to 6.5.3 (#4957) 2023-10-26 14:55:59 +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

OSS-Fuzz Coverity Scan Build Status License
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.

Building a specific configuration

For single-configuration generators (like "Unix Makefiles") you can generate and build a specific configuration (e.g. "RelWithDebInfo") using:

mkdir build_RelWithDebInfo
cd build_RelWithDebInfo
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
cmake --build . --config RelWithDebInfo

For multi-configuration generators (like "Visual Studio 17 2022") the same is achieved using:

mkdir build
cd build
cmake ..
cmake --build . --config RelWithDebInfo

qmake

NOTE: This has been deprecated and will be removed in a future version. Please use CMake instead.

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

Besides building yourself on the platform of your choice there are also several ways to obtain pre-built packages.
Note: The non-Windows packages are not maintained by the Cppcheck team but by the respective packagers instead.

  • (Windows) An official Windows installer is available via the official Cppcheck SourceForge page: https://cppcheck.sourceforge.io/.
  • (Linux/Unix) Many major distros offer Cppcheck packages via their integrated package managers (yum, apt, pacman, etc.). See https://pkgs.org/search/?q=cppcheck for an overview.
  • (Linux/Unix) Unless you are using a "rolling" distro, it is likely that they are not carrying the latest version. There are several external (mainly unsupported) repositories like AUR (ArchLinux), PPA (ubuntu), EPEL (CentOS/Fedora) etc. which provide up-to-date packages.
  • (Linux/Unix) The Canonical Snapcraft package is unmaintained and contains a very old version. Please refrain from using it! See https://trac.cppcheck.net/ticket/11641 for more details.
  • (MacOS) A package is available via Homebrew (brew). See https://formulae.brew.sh/formula/cppcheck#default.

Webpage

https://cppcheck.sourceforge.io/