cppcheck/readme.md

122 lines
3.4 KiB
Markdown
Raw Normal View History

2015-03-07 08:53:49 +01:00
# Cppcheck [![Linux Build Status](https://img.shields.io/travis/danmar/cppcheck/master.svg?label=Linux%20build)](https://travis-ci.org/danmar/cppcheck) [![Windows Build status](https://img.shields.io/appveyor/ci/danmar/cppcheck/master.svg?label=Windows%20build)](https://ci.appveyor.com/project/danmar/cppcheck/branch/master) [![Coverity Scan Build Status](https://img.shields.io/coverity/scan/512.svg)](https://scan.coverity.com/projects/512)
2012-06-06 16:15:41 +02:00
2013-12-26 19:15:52 +01:00
## Donations
2012-06-06 16:15:41 +02:00
If you find Cppcheck useful for you, feel free to make a donation.
[![Donate](http://pledgie.com/campaigns/4127.png)](http://pledgie.com/campaigns/4127)
2012-12-23 10:56:38 +01:00
## About the name
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
The original name of this program was "C++check", but it was later changed to "Cppcheck".
2012-06-06 16:15:41 +02:00
Despite the name, Cppcheck is designed for both C and C++.
2012-12-23 10:56:38 +01:00
## Manual
2012-06-06 16:15:41 +02:00
2013-07-13 19:23:38 +02:00
A manual is available [online](http://cppcheck.sourceforge.net/manual.pdf).
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
## Compiling
2012-06-06 16:15:41 +02:00
Any C++11 compiler should work. For compilers with partial C++11 support it may work. If your compiler has the C++11 features that are available in Visual Studio 2010 then it will work. If nullptr is not supported by your compiler then this can be emulated using the header lib/cxx11emu.h.
2012-06-06 16:15:41 +02:00
To build the GUI, you need Qt.
When building the command line tool, [PCRE](http://www.pcre.org/) is optional. It is used if you build with rules.
2012-06-06 16:15:41 +02:00
There are multiple compilation choices:
* qmake - cross platform build tool
* Windows: Visual Studio (VS 2010 and above) or Qt Creator or MinGW
2012-06-06 16:15:41 +02:00
* gnu make
* g++ 4.4 (and above)
* clang++ 2.9 (and above)
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
### qmake
2012-06-06 16:15:41 +02:00
You can use the gui/gui.pro file to build the GUI.
2012-06-06 16:28:49 +02:00
```shell
2012-12-23 10:56:38 +01:00
cd gui
qmake
make
```
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
### Visual Studio
2012-06-06 16:15:41 +02:00
Use the cppcheck.sln file. The rules are normally enabled.
2012-12-23 10:56:38 +01:00
To compile with rules (PCRE dependency):
2013-07-13 19:23:38 +02:00
* the PCRE dll is needed. It can be downloaded from [here](http://cppcheck.sourceforge.net/pcre-8.10-vs.zip).
2012-06-06 16:15:41 +02:00
To compile without rules (no dependencies):
2012-12-23 10:56:38 +01:00
* remove the preprocessor define `HAVE_RULES` from the project
2012-06-06 16:15:41 +02:00
* remove the pcre.lib from the project
2012-12-23 10:56:38 +01:00
### Qt Creator + MinGW
2012-06-06 16:15:41 +02:00
The PCRE dll is needed to build the CLI. It can be downloaded here:
http://software-download.name/pcre-library-windows/
2013-12-26 19:15:52 +01:00
### GNU make
2012-06-06 16:15:41 +02:00
Simple build (no dependencies):
2012-06-06 16:27:44 +02:00
```shell
make
2012-12-23 10:56:38 +01:00
```
2012-06-06 16:15:41 +02:00
The recommended release build is:
2012-06-06 16:27:44 +02:00
```shell
make SRCDIR=build CFGDIR=cfg HAVE_RULES=yes
2012-12-23 10:56:38 +01:00
```
2012-06-06 16:15:41 +02:00
Flags:
2013-12-26 19:02:56 +01:00
2015-01-03 12:48:29 +01:00
1. `SRCDIR=build`
2013-12-26 19:02:13 +01:00
Python is used to optimise cppcheck
2013-12-26 18:56:02 +01:00
2015-01-03 12:48:29 +01:00
2. `CFGDIR=cfg`
2013-12-26 19:02:13 +01:00
Specify folder where .cfg files are found
2013-12-26 18:56:02 +01:00
2015-01-03 12:48:29 +01:00
3. `HAVE_RULES=yes`
2013-12-26 19:15:52 +01:00
Enable rules (PCRE is required if this is used)
2012-12-23 10:56:38 +01:00
### g++ (for experts)
2012-06-06 16:15:41 +02:00
If you just want to build Cppcheck without dependencies then you can use this command:
2012-06-06 16:27:44 +02:00
```shell
g++ -o cppcheck -std=c++0x -include lib/cxx11emu.h -Iexternals/tinyxml -Ilib cli/*.cpp lib/*.cpp externals/tinyxml/*.cpp
2012-12-23 10:56:38 +01:00
```
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
If you want to use `--rule` and `--rule-file` then dependencies are needed:
2012-06-06 16:27:44 +02:00
```shell
g++ -o cppcheck -std=c++0x -include lib/cxx11emu.h -lpcre -DHAVE_RULES -Ilib -Iexternals/tinyxml cli/*.cpp lib/*.cpp externals/tinyxml/*.cpp
2012-12-23 10:56:38 +01:00
```
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
### MinGW
2012-06-06 16:15:41 +02:00
```shell
2012-12-23 10:56:38 +01:00
make LDFLAGS=-lshlwapi
```
2012-06-06 16:15:41 +02:00
### Other Compiler/IDE
1. Create a empty project file / makefile.
2. Add all cpp files in the cppcheck cli and lib folders to the project file / makefile.
3. Compile.
2012-12-23 10:56:38 +01:00
### Cross compiling Win32 (CLI) version of Cppcheck in Linux
2012-06-06 16:15:41 +02:00
```shell
2012-12-23 10:56:38 +01:00
sudo apt-get install mingw32
make CXX=i586-mingw32msvc-g++ LDFLAGS="-lshlwapi" RDYNAMIC=""
2012-12-23 10:56:38 +01:00
mv cppcheck cppcheck.exe
```
2012-06-06 16:15:41 +02:00
2012-12-23 10:56:38 +01:00
## Webpage
2012-06-06 16:15:41 +02:00
2012-06-06 16:27:44 +02:00
http://cppcheck.sourceforge.net/