cppcheck/tools
Oliver Stöneberg 4f7d162555
matchcompiler.py: only add additional includes if necessary (#2636)
2020-05-12 21:49:39 +02:00
..
test tools/test: Make scripts executable (#2509) 2020-01-27 06:53:58 +01:00
triage cleaned up setting of compiler options and a few more things in CMake (#2599) 2020-04-22 11:04:19 +02:00
CMakeLists.txt added dmake targets to CMake (#2634) 2020-05-10 16:41:50 +02:00
ci.py Improve Python code 2017-06-04 22:51:48 +02:00
clang-ast.cpp clang-ast: print constructors and destructors 2018-04-30 15:42:40 +02:00
compare-ast-clang-and-cppcheck.py some small *.py script cleanup (#1328) 2018-08-05 20:36:21 +02:00
compare.cs tools/compare.cs: changed format for error message 2018-02-15 15:17:04 +01:00
daca2-download.py daca2: Improve package sorting using natsort (#2505) 2020-01-26 18:39:37 +01:00
daca2-getpackages.py daca2: Improve package sorting using natsort (#2505) 2020-01-26 18:39:37 +01:00
daca2-logs2git.sh daca2: add script which crawls the daca logs and feeds them into a git repository. 2017-09-03 22:31:36 +02:00
dmake.cpp Sync dmake and Makefile (change missing from 3a71eb834d) 2019-12-04 20:27:48 +01:00
dmake.sln dmake: Update Visual Studio solution and project (#2385) 2019-11-21 19:39:19 +01:00
dmake.vcxproj dmake: Update Visual Studio solution and project (#2385) 2019-11-21 19:39:19 +01:00
donate-cpu-server.py daca@home: update OLD_VERSION 2020-05-10 14:30:53 +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: Fix that timed out analyses are handled as crashes (#2561) 2020-02-28 08:12:10 +01:00
extract_and_run_more_tests.sh Testing: extract testcases, edit comparisons, run cppcheck, compare results 2015-07-22 09:52:24 +02:00
extracttests.py Update Copyright year 2019-12-21 11:23:01 +01:00
generate_and_run_more_tests.sh generate_and_run_more_tests: Add testuninitvar 2015-07-26 11:29:02 +02:00
generate_cfg_tests.cpp generate_cfg_tests: fix argument count 2018-03-19 20:46:55 +01:00
git-pre-commit-cppcheck Missing return value in git-pre-commit-cppcheck (#1382) 2018-09-21 04:56:53 +02:00
listErrorsWithoutCWE.py Improve Python code 2017-07-22 11:05:50 +02:00
matchcompiler.py matchcompiler.py: only add additional includes if necessary (#2636) 2020-05-12 21:49:39 +02:00
parse-glibc.py Improve Python code 2017-06-05 13:23:00 +02:00
pr.py Use library to track container lifetimes 2019-08-15 20:36:25 +02:00
readme.md Update tools/readme.md (#2300) 2019-10-29 20:05:16 +01:00
reduce.py reduce.py: Allow reducing error messages, print output in case of error (#2179) 2019-10-04 21:22:59 +02:00
run-coverity.sh fix run-coverity.sh script. It will run in the cppcheck-devinfo folder from now on. 2019-09-04 17:12:03 +02:00
run_more_tests.sh Make generate_and_run_more_tests happy 2019-08-18 15:13:00 +02:00
test-my-pr.py test-my-pr: Retry if failed to get package (#2515) 2020-02-02 18:00:36 +01:00
test_matchcompiler.py Updated copyright year 2018-01-14 15:37:52 +01:00
test_showtimetop5.sh Correct script 2017-05-03 21:09:20 +02: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 fix a couple of issues in shell scripts found by codacy. 2016-12-25 00:43:47 +01:00
times-vs.py Improve Python code 2017-06-04 22:51:48 +02: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 python formatting. Run autopep8 and replace tabs with spaces. 2018-02-13 09:26:11 +01:00

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