cppcheck の使い方

1-1. Windows

Windows 環境へインストールする手順について記載します。

1. 下記ULRからインストーラーを入手します。

Cppcheck - A tool for static C/C++ code analysis (sourceforge.io)

本ページ記載時のバージョンは 2.12 でした。

2. インストーラーを実行します。

デフォルトで問題ありません。必要に応じて、インストール場所の変更、"Python addons" の追加、等を行います。

以上でインストール完了です。

1-2. Linux

cppcheck は様々なパッケージマネージャーからインストール可能です。使用されている Linux 環境に従って下記コマンドを実行します。

Devian / Ubuntu

sudo apt-get install cppcheck

Fedrea

sudo yum install cppcheck

Mac

brew install cppcheck

2-1. GUI (Windows)

GUI 版の使用方法について記載します。

1. cppcheck を起動します。

最初から日本語で表示してくれました。

2. メニューの [ファイル(F)] → [新規プロジェクト(N)...] でプロジェクトを作成します。

ファイルダイアログが表示されるので、保存するプロジェクトファイルのファイル名を指定します。

その後、プロジェクトの設定画面（下図）が出てくるので、「パス」 に解析を行うソースファイルの場所を設定します。

「インクルードパス」には boost など外部ライブラリーのヘッダー所在を指定します。指定しなくてもチェックできるようですが、指定した方がより良い解析結果を出力してくれるようです。

解析対象から除外するファイルは下記画面中の「除外するソースファイル」へ登録することで行います。

これらのプロジェクトの設定を後から修正したい場合は [プロジェクトの編集(E)] のメニューを選ぶことでと同じダイアログを表示できます。

3. 下記のようなテストプログラムを作成し、これを cppcheck で解析してみます。

[test.cpp]

#include <iostream>

void foo(int x)
{
    int buf[10];
    if (x == 1000){
        buf[x] = 0; // <- ERROR
    }
}

int main()
{
    foo(1000);
    return EXIT_SUCCESS;
}

プロジェクトの新規作成後に [OK] でダイアログを閉じたり、プロジェクトを開くとチェックが始ります。 または「全ファイル再解析(y)」ボタンをクリックすることでも解析を実施してくれます。

解析結果は以下の通りです。ERROR の場所を「Array indel out of bounds.」とちゃんと検出してくれました。

2-2. CUI

CUI 版の使用方法について記載します。

Jenkins や Pipelines などの各種 CI/CD ツールと連携させたい場合などでは CUI(コマンドライン) を使って解析します。

概要

CUI は次の形式で実行します。

$ cppcheck --enable=all ソース [...]

引数としてチェック対象のソースファイルやファイルのあるフォルダーを指定します。フォルダーの場合は再帰的にチェックします。

GUI の結果をみるとわかりやすいと思いますが、 cppcheck の検査項目はカテゴリー分けされています。--enable オプションでそのカテゴリーを指定し、all ですべてのカテゴリーが検査対象となります。--enable を指定していないと検査項目が何もないことになるので、 とりあえず all をつけて使い始め、慣れてきたら必要とする検査項目のみに限定してはいかがでしょうか。

"--enable" オプションで指定できるパラメータは以下の通りです。

パラメータを複数組み合わせて指定する場合、以下のようにカンマ区切りで併記します。

cppcheck --enable=warning,performance file.c

解析してみる

GUI と同じ下記テストコードを解析してみます。

[test.cpp]

#include <iostream>

void foo(int x)
{
    int buf[10];
    if (x == 1000){
        buf[x] = 0; // <- ERROR
    }
}

int main()
{
    foo(1000);
    return EXIT_SUCCESS;
}

下記コマンドで解析します。Windows の場合は事前に path を登録して cppcheck を使えるようにしておいてください。

$ cppcheck --enable=all --suppress=missingIncludeSystem --platform=win64 --std=c++20 test.cpp

実行結果は以下の通りです。

C:\Users\foo\Documents\cpp\cppcheck_test>cppcheck --enable=all --suppress=missingIncludeSystem --platform=win64 --std=c++20 test.cpp
Checking test.cpp ...
test.cpp:7:12: warning: Either the condition 'x==1000' is redundant or the array 'buf[10]' is accessed at index 1000, which is out of bounds. [arrayIndexOutOfBoundsCond]
        buf[x] = 0; // <- ERROR
           ^
test.cpp:6:11: note: Assuming that condition 'x==1000' is not redundant
    if (x == 1000){
          ^
test.cpp:7:12: note: Array index out of bounds
        buf[x] = 0; // <- ERROR
           ^
test.cpp:5:9: style: The scope of the variable 'buf' can be reduced. [variableScope]
    int buf[10];
        ^
test.cpp:7:16: style: Variable 'buf[x]' is assigned a value that is never used. [unreadVariable]
        buf[x] = 0; // <- ERROR
               ^
Active checkers: 163/565

C:\Users\foo\Documents\cpp\cppcheck_test>

GUI 版と同じ解析結果を出力できていることを確認できました。

3-1. 例1

3-2. 例2