cppcheck/tools
Simon Martin a3d1cac79c Ticket #5373: Keep track whether tokens come from a C or C++ file to properly handle %type% in Token::Match with "delete" 2014-03-08 21:26:06 +01:00
..
argparse.py autopep8 formatting 2013-10-18 17:35:59 +02:00
aws.py ci.py: copy std.cfg to daca2 folder to get better results. 2013-12-12 20:10:46 +01:00
ci.py ci.py: fixed daca2folder() when results is empty 2014-02-23 10:26:01 +01:00
daca2-report.py daca2: count crashes of cppcheck in index table. 2014-01-29 12:54:52 +01:00
daca2.py daca2: remove ../clang/INPUTS/.. files since these take so long time to scan 2014-03-06 20:36:52 +01:00
dmake.cpp dmake: when building cppcheck. do not include "externals" dir, there are no files in there (only the tinyxml dir which is already handled via -Iexternals/tinyxml). 2014-03-03 12:09:21 +01:00
dmake.vcproj Tools: Update VS project file. 2011-08-11 23:40:10 +03:00
extracttests.py man, htdocs, gui, test, tools: bump a few more copyrights to 2014 2014-03-03 11:03:17 +01:00
matchcompiler.py Ticket #5373: Keep track whether tokens come from a C or C++ file to properly handle %type% in Token::Match with "delete" 2014-03-08 21:26:06 +01:00
readme.md Add readme.md for 'tools' directory 2013-12-27 13:58:08 -02:00
reduce.cpp Update copyright 2014-02-15 07:45:39 +01:00
test_matchcompiler.py man, htdocs, gui, test, tools: bump a few more copyrights to 2014 2014-03-03 11:03:17 +01:00
test_showtimetop5.sh travis: rewrite config file. 2014-01-12 22:47:21 +01:00
times-tags.sh make tools/times-tags.sh and tools/times.sh executable (mode 755). 2014-01-05 13:58:59 +01:00
times.c tools/times: modified script to allow longer dataseries 2013-07-21 13:16:34 +02:00
times.sh make tools/times-tags.sh and tools/times.sh executable (mode 755). 2014-01-05 13:58:59 +01:00
tools.pro Add general PRO file for console builds. 2012-06-18 09:28:32 +03: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 intented 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 SRCDIR=build

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

Cppcheck tool that reduces code for a hang/false positive. To build the tool run:

$ cd path/to/cppcheck
$ make reduce

* tools/times.sh

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