CMake ビルド実例

この記事では、完全な C++ プロジェクトの例を通じて、CMake を使用して実行ファイルとライブラリファイルを含むプロジェクトをゼロからビルドする方法を説明します。

サンプルプロジェクトにはメインプログラムとカスタムライブラリが含まれており、CMake ビルドの完全なライフサイクルをカバーしています。


プロジェクトの準備

ビルドを開始する前に、プロジェクトファイルを作成し、プロジェクト構造を把握します。

プロジェクト構造

サンプルプロジェクトには、メインプログラムのソースファイル、ライブラリのソースファイル、ライブラリのヘッダーファイルが含まれており、ディレクトリ構造は次のとおりです:

MyProject/
├── CMakeLists.txt          # CMake 配置文件
├── src/
│   ├── main.cpp            # 主程序源文件
│   └── mylib.cpp           # 库源文件
└── include/
    └── mylib.h             # 库头文件
ファイル 役割 説明
CMakeLists.txt CMake 設定ファイル プロジェクトのビルドルール、ターゲット、依存関係を定義します
src/main.cpp メインプログラムのソースファイル main() 関数を含み、プログラムのエントリーポイントです
src/mylib.cpp ライブラリのソースファイル カスタムライブラリの機能実装
include/mylib.h ライブラリのヘッダーファイル ライブラリの公開インターフェース宣言であり、メインプログラムがインクルードして使用します

CMakeLists.txt 設定ファイル

MyProject のルートディレクトリに CMakeLists.txt ファイルを作成し、以下の内容を記述します:

実例

# ファイルパス:MyProject/CMakeLists.txt

# CMake の最低バージョンを指定(ファイルの先頭行に置く必要があります)
cmake_minimum_required(VERSION 3.10)

# プロジェクト名とバージョン番号を定義
project(MyProject VERSION 1.0)

# C++ 標準を C++11 に設定し、コンパイラに強制適用させる
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# グローバルなヘッダーファイル検索パスを追加
include_directories(${PROJECT_SOURCE_DIR}/include)

# ライブラリターゲット MyLib を作成(ソースファイルは src/mylib.cpp)
add_library(MyLib src/mylib.cpp)

# 実行ファイルターゲット MyExecutable を作成(ソースファイルは src/main.cpp)
add_executable(MyExecutable src/main.cpp)

# MyLib ライブラリを MyExecutable 実行ファイルにリンク
target_link_libraries(MyExecutable MyLib)

設定ファイル内の各指令の役割は次のとおりです:

指令 役割 重要ポイント
cmake_minimum_required(VERSION 3.10) CMake の最低バージョンを指定 ファイルの最上部に置く必要があり、このバージョンより低いとエラーになります
project(MyProject VERSION 1.0) プロジェクト名とバージョンを定義 バージョン番号により PROJECT_VERSION などの変数が設定されます
set(CMAKE_CXX_STANDARD 11) C++ 標準を指定 CMAKE_CXX_STANDARD_REQUIRED と組み合わせることで、C++ 標準が強制的に適用されます
include_directories(...) ヘッダーファイル検索パスを追加 コンパイラが include/ 配下のヘッダーファイルを見つけられるようにします
add_library(MyLib ...) ライブラリターゲットを作成 タイプを指定しない場合、BUILD_SHARED_LIBS によって静的または動的ライブラリが決まります
add_executable(MyExecutable ...) 実行ファイルターゲットを作成 ターゲット名は最終的に生成される実行ファイル名になります
target_link_libraries(...) ライブラリを実行ファイルにリンク MyExecutable のコンパイル時に MyLib が自動的にリンクされます

各 add_executable と add_library は、1つのビルドターゲット(Target)を定義します。ターゲットの概念は CMake の中核であり、以降の target_include_directories、target_link_libraries などの指令はすべてターゲットを中心に構成されています。


ビルド手順の詳細

CMakeLists.txt を用意したら、以下の6つの手順でプロジェクトのビルドと実行を行います。

全体のフローの概要:

手順 操作 コマンド
1 CMakeLists.txt を作成 設定ファイルを手動で記述
2 ビルドディレクトリを作成 mkdir build && cd build
3 プロジェクトを設定 cmake ..
4 プロジェクトをコンパイル make 或 cmake --build .
5 実行ファイルを実行 ./MyExecutable
6 ビルドファイルをクリーンアップ make clean

CMakeLists.txt ファイルの作成

MyProject のルートディレクトリに CMakeLists.txt ファイルを作成します。内容は前のセクションの設定説明で示したとおりです。

これは CMake ビルド全体の起点であり、すべてのビルドルールがこのファイルに定義されています。

ビルドディレクトリの作成

ソースコードディレクトリを整理した状態に保つために、Out-of-sourceプロジェクトのルートディレクトリに独立したビルドディレクトリを作成するビルド方式を推奨します。

ターミナルを開き、MyProject ディレクトリに移動します:

# 创建构建目录
mkdir build

# 进入构建目录(后续所有操作都在此目录执行)
cd build

build ディレクトリを .gitignore ファイルに追加して、コンパイル成果物をバージョン管理システムにコミットしないようにします。

プロジェクトの設定

ビルドディレクトリ内で CMake を実行し、現在のプラットフォームに適したビルドシステムファイル(Makefile など)を生成します。

..CMakeLists.txt を含むソースコードディレクトリを指定します。

# 在 build 目录中运行 CMake 配置
cmake ..

CMake は設定結果を出力し、検出されたコンパイラと設定状態を表示します。すべてが正常であれば、次のような出力が表示されます:

-- The CXX compiler identification is GNU 11.4.0
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: /path/to/MyProject/build

設定中にエラーが発生した場合(コンパイラの欠落や CMake のバージョンが低すぎる場合など)、CMake は中断し、具体的なエラー原因を出力します。対応する問題を解決してから、cmake ..再実行するだけで大丈夫です。

プロジェクトのコンパイル

ビルドファイルが生成されたら、対応するビルドコマンドを使用してプロジェクトをコンパイルします。

デフォルトでは、CMake は Unix 系システム上で Makefile を生成するため、make コマンドを直接使用できます。

# 在 build 目录中编译项目
make

コンパイルが完了すると、build ディレクトリに実行ファイル MyExecutable とライブラリファイル libMyLib.a が生成されます。

クロスプラットフォームの汎用ビルドコマンドを使用することもできます:

# cmake --build . 会自动调用正确的底层构建工具
cmake --build .

実行ファイルの実行

コンパイルが成功したら、ビルドディレクトリ内で生成された実行ファイルを直接実行します。

# 运行编译生成的可执行文件
./MyExecutable

# 预期输出示例
Hello from サンプル! This is MyLib speaking.

ビルドファイルのクリーンアップ

クリーンアップ操作により、コンパイル中に生成された中間ファイル(.o ファイルなど)とターゲットファイルが削除され、ディスク容量が解放されます。

make clean コマンドを使用します:

# 删除编译产生的中间文件和目标文件
make clean

ビルドディレクトリを手動で削除します:

クリーンアップルールが定義されていない場合は、ビルドディレクトリ全体を直接削除できます。

# 回到项目根目录,删除 build 目录
cd ..
rm -rf build

build ディレクトリ全体を削除するのが最も徹底したクリーンアップ方法です。次回のビルド時は、mkdir build && cd build && cmake .. && make を再実行するだけで最初からやり直せます。


注意事項

ソースファイルのパスが正しいことを確認してください。add_executable と add_library 内のソースファイルパスは、CMakeLists.txt があるディレクトリからの相対パスです。パスを誤って記述しても CMake の設定段階ではエラーになりませんが、コンパイル時にファイルが見つからないというエラーが発生します。

ターゲット名は大文字と小文字を区別します。MyLib と mylib は別のターゲットです。target_link_libraries で参照するターゲット名は、add_library で定義したターゲット名と完全に一致している必要があります。

CMakeLists.txt を変更した後は、再設定が必要です。ソースファイルのみを変更した場合は、直接 make を実行すれば十分です。ただし、CMakeLists.txt を変更した場合(新しいファイルの追加やコンパイルオプションの変更など)は、cmake .. を再実行するか、cmake --build . を直接実行する必要があります(設定の変更は自動的に検出されます)。

初めて使用する場合は、簡単なプロジェクトから始めることをお勧めします。まず単一の実行ファイルでビルドフロー全体を通し、その後でライブラリ、外部依存、カスタムコンパイルオプションを段階的に追加してください。一度に多くのものを追加すると、エラーの調査が難しくなります。

その他の拡張