b089ba4e3b
The YAML setting `toc: true` works for PDF creation but for HTML it simply prints `true` as the table of contents. It looks like a misconception and the only acceptable solution I have found is to use `--toc` on the command line instead of the `toc: true` setting in the YAML header. It is a known issue, here are more details: https://github.com/jgm/pandoc/issues/2872 With this fix I get table of contents not only for PDF but for HTML too. The PDF looks like before for me, the table of contents and the outline are still present as it was before. |
||
|---|---|---|
| Cppcheck.xcodeproj | ||
| addons | ||
| cfg | ||
| cli | ||
| cmake | ||
| cve-test-suite | ||
| democlient | ||
| externals | ||
| gui | ||
| htmlreport | ||
| lib | ||
| man | ||
| oss-fuzz | ||
| platforms | ||
| rules | ||
| samples | ||
| snap | ||
| test | ||
| tools | ||
| win_installer | ||
| .astylerc | ||
| .codacy.yml | ||
| .gitignore | ||
| .mailmap | ||
| .travis.yml | ||
| .travis_llvmcheck_suppressions | ||
| .travis_suppressions | ||
| AUTHORS | ||
| CMakeLists.txt | ||
| COPYING | ||
| Makefile | ||
| appveyor.yml | ||
| benchmarks.txt | ||
| build-pcre.txt | ||
| build.bat | ||
| console_common.pri | ||
| cppcheck-errors.rng | ||
| cppcheck.cbp | ||
| cppcheck.cppcheck | ||
| cppcheck.sln | ||
| createrelease | ||
| doxyfile | ||
| generate_coverage_report | ||
| naming.json | ||
| philosophy.md | ||
| pylintrc_travis | ||
| readme.md | ||
| readme.txt | ||
| readmeja.md | ||
| requirements.txt | ||
| runastyle | ||
| runastyle.bat | ||
| webreport.sh | ||
readme.md
Cppcheck
| Linux Build Status | Windows Build Status | 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:
- Download (and extract) Cppcheck source code
- 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
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:
-
MATCHCOMPILER=yesPython is used to optimise cppcheck. The Token::Match patterns are converted into C++ code at compile time. -
FILESDIR=/usr/share/cppcheckSpecify folder where cppcheck files are installed (addons, cfg, platform) -
HAVE_RULES=yesEnable rules (PCRE is required if this is used) -
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
- Create an empty project file / makefile.
- Add all cpp files in the cppcheck cli and lib folders to the project file / makefile.
- Add all cpp files in the externals folders to the project file / makefile.
- 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