Clangツールを活用したC/C++コードフォーマッターの自作方法

このチュートリアルでは、Clangツールを活用してC/C++のコードフォーマットツール（フォーマッター）を作成する方法を解説します。プロジェクト全体のソースコードを一括で整形できるため、チーム開発におけるコードスタイルの統一に役立ちます。

環境構築

まず、必要なパッケージをインストールします。以下のコマンドを実行してください。

sudo apt install python
sudo apt install clang-format-3.5

次に、現在のユーザーが読み書き権限を持っている場所にPythonスクリプトファイルを作成します。

スクリプトの例

以下は、カレントディレクトリ以下を再帰的に走査し、C/C++関連の拡張子を持つファイルを自動的にフォーマットするPythonスクリプトです。

import os
cpp_extensions = (".cxx",".cpp",".c", ".hxx", ".hh", ".cc", ".hpp")
for root, dirs, files in os.walk(os.getcwd()):
    for file in files:
        if file.endswith(cpp_extensions):
            os.system("clang-format-3.5 -i -style=file " + root + "/" + file)

スクリプトのポイント

• os.walk(): カレントディレクトリ以下のすべてのサブディレクトリを再帰的に探索します。
• cpp_extensions: .cpp や .c、.hpp など、主要なC/C++ソースファイル・ヘッダーファイルの拡張子を網羅しています。
• -style=file: プロジェクト直下の .clang-format ファイルに記述されたスタイル設定を読み込んで適用します。
• -i オプション: ファイルを直接上書きして整形結果を反映します。

.clang-format設定ファイルの作成

次に、コードスタイルを定義するフォーマット設定ファイルを、ユーザーのホームディレクトリ（最上位ディレクトリ）に作成します。以下のコマンドでGoogleスタイルの設定を出力できます。

clang-format-3.5 -style=google -dump-config > .clang-format

生成された .clang-format ファイルを、対象プロジェクトのトップディレクトリにコピーしてください。

使い方

これで準備は完了です。作成したPythonスクリプトを実行するだけで、プロジェクト内のすべてのC/C++ファイルが指定したスタイルに従って自動整形されます。

python format_code.py

.clang-format ファイルを編集すれば、インデント幅や括弧の改行位置など、細かいスタイル設定も自由にカスタマイズ可能です。ぜひ自分好みのコードフォーマットツールとして活用してみてください。