cppcheck/tools
Daniel Marjamäki c7cbe7f2d3 rename externals/tinyxml to externals/tinyxml2 2020-11-16 09:11:53 +01:00
..
test
triage triage: fix version match for 2.1 2020-09-14 15:43:24 +02:00
CMakeLists.txt made check.h less heavy (#2633) 2020-05-23 07:16:49 +02:00
ci.py
compare.cs
compare_ast_symdb.py compare_ast_symdb.py: small fix and refactorings 2020-10-31 17:37:23 +01:00
daca2-download.py
daca2-getpackages.py
daca2-logs2git.sh
dmake.cpp rename externals/tinyxml to externals/tinyxml2 2020-11-16 09:11:53 +01:00
dmake.sln
dmake.vcxproj
donate-cpu-server.py donate-cpu-server: OLD_VERSION=2.2 2020-10-03 12:55:55 +02:00
donate-cpu.py test-my-pr: Retry if failed to get package (#2515) 2020-02-02 18:00:36 +01:00
donate_cpu_lib.py donate_cpu_lib.py: Formatted Qt list, there are no functional changes 2020-10-04 18:42:59 +02:00
extract_and_run_more_tests.sh
extracttests.py
generate_and_run_more_tests.sh
generate_cfg_tests.cpp
git-pre-commit-cppcheck
listErrorsWithoutCWE.py
matchcompiler.py Update matchcompiler after change in Token::Match (#2653) 2020-05-20 21:33:29 +02:00
parse-glibc.py
pr.py
readme.md new default branch is main 2020-06-15 20:04:57 +02:00
reduce.py
run-coverity.sh
run_more_tests.sh
test-my-pr.py new default branch is main 2020-06-15 20:04:57 +02:00
test_matchcompiler.py
test_showtimetop5.sh
testrunnerify_code.sh
times-tags.sh new default branch is main 2020-06-15 20:04:57 +02:00
times-vs.py
times.c
times.sh
trac-keywords.py

readme.md

Cppcheck developer and build tools

* tools/astyle-client.py

With this tool you can astyle-format arbitrary cpp/header files even if you do not have astyle on your computer.

astyle on a server is used.

Example usage:

python tools/astyle-client.py lib/token.cpp

The file is reformatted and a status message is written that says if there were any changes or not.

This script is a lot slower than running astyle locally on your computer.

* 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.