Sources were built with Clang but with increased verbosity of error detection. A number of syntax and semantic warnings were encountered. Commit adds changes to correct these warnings. Some changes involve removing extra, and unncessary, semi-colons at EOL (e.g. at end of switch clause). Project astyle settings are not currently setup to detect if a file is to have an extra carriage return after the last line of data. Two files were altered to ensure an extra carriage return. An advisory to enhance code was encountered in triage code. Clang advisory on a for-loop interation value suggested that: `use reference type 'const QString &' to prevent copying` |
||
---|---|---|
.. | ||
test | ||
triage | ||
astyle_client.py | ||
astyle_server.py | ||
ci.py | ||
clang-ast.cpp | ||
compare-ast-clang-and-cppcheck.py | ||
compare.cs | ||
daca-test-patch.sh | ||
daca2-download.py | ||
daca2-getpackages.py | ||
daca2-logs2git.sh | ||
dmake.cpp | ||
dmake.sln | ||
dmake.vcxproj | ||
donate-cpu-server.py | ||
donate-cpu.py | ||
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 | ||
parse-glibc.py | ||
pr.py | ||
readme.md | ||
reduce.py | ||
run-coverity.sh | ||
run_more_tests.sh | ||
test_matchcompiler.py | ||
test_showtimetop5.sh | ||
testrunnerify_code.sh | ||
times-tags.sh | ||
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.