cppcheck/tools
Oliver Stöneberg 5ec0ad6bed
use `ccache` for sanitizer builds / do not use precompiled headers with `ccache` (#4910)
* added CMake option `DISABLE_DMAKE` to disable `run-dmake` dependencies

* tools/CMakeLists.txt: added TODO

* use `ccache` for sanitizer builds

* aligned selfcheck between sanitizer workflows and disabled some currently unnecessary steps

* CI-unixish.yml: do not use precompiled headers with `ccache`
2023-04-01 09:40:10 +02:00
..
bisect bisect.sh: make it possible to detect commits which fix scan time regressions / improved documentation (#4863) 2023-03-08 15:00:10 +01:00
test tools/test: Make scripts executable (#2509) 2020-01-27 06:53:58 +01:00
triage added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
triage_py triage_version.py: extend template for 1.x versions with error ID (#4801) 2023-02-24 07:02:51 +01:00
CMakeLists.txt use `ccache` for sanitizer builds / do not use precompiled headers with `ccache` (#4910) 2023-04-01 09:40:10 +02:00
ci.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
compare.cs added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
compare_ast_symdb.py extended the Python script checks in the CI and adjusted some scripts (#3186) 2021-03-31 22:09:42 +02:00
creduce.py Add creduce.py script to run creduce (#3341) 2021-07-18 07:51:01 +02:00
daca2-download.py daca2: Improve package sorting using natsort (#2505) 2020-01-26 18:39:37 +01:00
daca2-getpackages.py some Python cleanups based on PyCharm inspections (#2999) 2021-01-31 14:27:11 +01:00
dmake.cpp cleaned up includes based on `include-what-you-use` (#4599) 2023-03-02 21:50:14 +01:00
dmake.vcxproj added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
donate-cpu-server.py daca: update old version 2023-01-28 14:53:47 +01:00
donate-cpu.py test-my-pr robustification (#4756) 2023-01-31 22:39:55 +01:00
donate_cpu_lib.py refs #11603 - deprecated `--enable=information` implicitly enabling `missingInclude` (#4865) 2023-03-09 20:04:20 +01:00
extract_and_run_more_tests.sh fixed/excluded some shellcheck warnings and actually fail the build when something is found (#3068) 2021-01-20 18:43:49 +01:00
extracttests.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
generate_and_run_more_tests.sh Fix for 6597: false negative: uninitialized variable usage not detected (ValueFlow , multi variables) (#3535) 2021-10-30 22:13:58 +02:00
git-pre-commit-cppcheck Missing return value in git-pre-commit-cppcheck (#1382) 2018-09-21 04:56:53 +02:00
listErrorsWithoutCWE.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
matchcompiler.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
parse-glibc.py added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
readme.md tools/readme.md: Remove astyle_client description (#3115) 2021-02-07 09:03:37 +01:00
reduce.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
run-coverity.sh run-coverity: updated coverity tool 2022-02-18 19:55:45 +01:00
run_more_tests.sh ValueFlow: Evaluate if statement for function returns (#4908) 2023-03-24 13:31:26 +01:00
test-my-pr.py test-my-pr, mark --c-only and --cpp-only mutually exclusive (#4628) 2022-12-11 19:41:21 +01:00
test_donate_cpu_lib.py donate-cpu: small `LibraryIncludes` regular expression improvements / fixed/improved tests (#4473) 2022-09-16 18:59:53 +02:00
test_donate_cpu_server.py refs #10700 - donate-cpu-server.py: added query parameter `pkgs` to some reports to request a list of affected packages (#3743) 2022-09-29 21:55:44 +02:00
test_matchcompiler.py use python3 on debians too (#3812) 2022-11-03 22:14:30 +01:00
test_reduce.py Typos found by running "codespell" (#4260) 2022-07-10 22:40:05 +02:00
test_showtimetop5.sh CI-unixish.yml: fixed and enabled all `build` steps for macos (#4832) 2023-03-02 20:54:30 +01:00
testrunnerify_code.sh fix a couple of issues in shell scripts found by codacy. 2016-12-25 00:43:47 +01:00
times-tags.sh new default branch is main 2020-06-15 20:04:57 +02:00
times-vs.py added .gitattributes and normalized files (#4668) 2022-12-30 21:33:45 +01:00
times.c tools: allow short SHA1 longer than 7 (#1399) 2018-09-28 19:04:39 +02:00
times.sh Makefile: Add one more flag 'MATCHCOMPILER=yes' 2019-06-23 13:43:09 +02:00
trac-keywords.py extended the Python script checks in the CI and adjusted some scripts (#3186) 2021-03-31 22:09:42 +02:00

readme.md

Cppcheck developer and build tools

* tools/matchcompiler.py

The matchcompiler.py is a build script that performs a few code transformations to .cpp files under the lib directory. These transformations are related to the use of Token::Match() function and are intended to improve code performance. The transformed files are saved on the build directory. This tool is silently used when building the code with SRCDIR=build, that is:

$ cd path/to/cppcheck
$ make MATCHCOMPILER=yes

Here is a simple example of the matchcompiler.py optimization. Suppose there is a file example.cpp under lib/:

// lib/example.cpp
void f1() {
    Token::Match(tok, "abc");
}

void f2() {
    const char *abc = "abc";
    Token::Match(tok, abc);
}

If you manually run matchcompiler.py from the main directory:

$ cd path/to/cppcheck
$ python tools/matchcompiler.py

A file example.cpp will be generated on the build directory:

// build/example.cpp
#include "token.h"
#include "errorlogger.h"
#include <string>
#include <cstring>
static const std::string matchStr1("abc");
// pattern: abc
static bool match1(const Token* tok) {
    if (!tok || !(tok->str()==matchStr1)/* abc */)
        return false;
    return true;
}
void f1() {
    match1(tok);
}

void f2() {
    const char *abc = "abc";
    Token::Match(tok, abc);
}

From this we can see that the usage of Token::Match() in f1() has been optimized, whereas the one in f2() couldn't be optimized (the string wasn't inline on the Token::Match() call). The developer doesn't need to use this tool during development but should be aware of these optimizations. Building with this optimization, cppcheck can get a boost of 2x of speed-up.

* tools/dmake.cpp

Automatically generates the main Makefile for Cppcheck (the main Makefile should not be modified manually). To build and run the dmake tool execute:

$ cd path/to/cppcheck
$ make dmake
$ ./dmake

* tools/reduce.py

Script that reduces code for a hang/false positive.

* tools/times.sh

Script to generate a times.log file that contains timing information of the last 20 revisions.

* tools/donate-cpu.py

Script to donate CPU time to Cppcheck project by checking current Debian packages.

* tools/test-my-pr.py

Script to compare result of working Cppcheck from your branch with main branch.

* tools/triage

This tool lets you comfortably look at Cppcheck analysis results for daca packages. It automatically downloads the package, extracts it and jumps to the corresponding source code for a Cppcheck message.