C++プロジェクトのためのCMakeLists.txt完全ガイド

C++プロジェクトにおけるビルドシステムは、開発効率やプロジェクトの規模に大きな影響を与える重要な要素です。CMakeは、こうしたビルドシステムの一つとして、プロジェクトの構成や依存関係の管理を自動化し、複数のプラットフォームに対応したビルド設定を簡素化するために広く利用されています。本記事では、C++プロジェクトにおけるCMakeLists.txtの役割と重要性を中心に、CMakeの基本的な使用方法から実践的なテクニックまでを詳しく解説します。CMakeLists.txtを適切に構成することで、プロジェクトのビルドプロセスが大幅に改善され、開発者の生産性向上につながります。これからCMakeを学びたい方や既存のプロジェクトでCMakeを活用したい方にとって、実用的なガイドとなる内容を提供します。

CMakeとは何か

CMakeは、C++を含む多くのプログラミング言語で使用されるクロスプラットフォームのビルドシステムです。CMakeは、ソースコードをビルドするための設定ファイルであるCMakeLists.txtを利用して、プロジェクトの依存関係やビルドプロセスを管理します。これにより、異なる開発環境やプラットフォーム間で一貫したビルドプロセスを実現することができます。

CMakeの基本概念

CMakeは、プロジェクトの設定を記述するためのシンプルなスクリプト言語を提供します。このスクリプト言語を使用して、ソースファイルの指定、コンパイルオプションの設定、外部ライブラリの導入、ビルドターゲットの定義など、さまざまな設定を行います。CMakeはこれらの設定を基に、MakefileやVisual Studioプロジェクトファイルなどのビルドシステム固有のファイルを自動生成します。

なぜCMakeを使用するのか

CMakeを使用する主な理由には以下の点があります。

クロスプラットフォーム対応

CMakeは、Windows、Linux、macOSなど、さまざまなプラットフォームで動作します。一度設定したCMakeLists.txtファイルを使用して、異なる環境で同じプロジェクトをビルドすることが可能です。

依存関係の管理

CMakeは、プロジェクト内の複数のモジュールや外部ライブラリの依存関係を自動的に管理します。これにより、手動での依存関係の設定ミスを減らし、ビルドプロセスを効率化します。

簡素なビルド設定

CMakeを使用すると、複雑なビルド設定もシンプルなスクリプトで記述できます。また、設定の再利用やカスタマイズが容易です。

CMakeを理解し活用することで、C++プロジェクトのビルド管理が大幅に改善され、開発の効率化が図れます。次のセクションでは、CMakeLists.txtの基本構成について詳しく見ていきます。

CMakeLists.txtの基本構成

CMakeLists.txtは、CMakeプロジェクトの設定を記述するためのファイルで、プロジェクトのビルドに関する情報が含まれています。基本的なCMakeLists.txtの構成要素を理解することは、効果的なビルド管理の第一歩です。

基本要素

CMakeLists.txtには、以下のような基本要素が含まれます。

プロジェクトの設定

プロジェクトの名前やバージョンを設定します。これにより、プロジェクト全体の識別情報が決まります。

cmake_minimum_required(VERSION 3.10)
project(MyProject VERSION 1.0)

ソースファイルの指定

プロジェクトで使用するソースファイルを指定します。これにより、CMakeはどのファイルをビルド対象とするかを把握します。

set(SOURCES main.cpp other_file.cpp)
add_executable(MyExecutable ${SOURCES})

コンパイルオプションの設定

コンパイル時のオプションを設定します。これにより、特定のコンパイルフラグを指定したり、デバッグモードや最適化モードを切り替えたりすることができます。

target_compile_options(MyExecutable PRIVATE -Wall -Wextra -O2)

ライブラリのリンク

外部ライブラリや内部ライブラリのリンクを設定します。これにより、依存するライブラリをプロジェクトに組み込むことができます。

find_package(SomeLibrary REQUIRED)
target_link_libraries(MyExecutable PRIVATE SomeLibrary::SomeLibrary)

インストール設定

ビルド成果物のインストール先を設定します。これにより、実行ファイルやライブラリを特定のディレクトリにインストールできます。

install(TARGETS MyExecutable DESTINATION bin)
install(FILES config.h DESTINATION include)

コメントの使用

CMakeLists.txtには、他のコードと同様にコメントを追加できます。コメントを追加することで、設定内容の説明やメモを残すことができます。

# This is a comment in CMake

これらの基本要素を理解し組み合わせることで、CMakeLists.txtを効果的に構成し、プロジェクトのビルドプロセスを管理することが可能になります。次のセクションでは、プロジェクトの初期設定について詳しく説明します。

プロジェクトの初期設定

プロジェクトの初期設定は、CMakeLists.txtの冒頭で行う重要なステップです。ここでは、プロジェクトの基本情報を設定し、CMakeがプロジェクトを正しく認識できるようにします。

cmake_minimum_required

このコマンドは、プロジェクトで必要とする最低限のCMakeバージョンを指定します。これにより、プロジェクトが特定のCMake機能に依存している場合に、古いバージョンのCMakeを使用しているユーザーに対して適切なエラーメッセージを表示できます。

cmake_minimum_required(VERSION 3.10)

project

projectコマンドは、プロジェクトの名前、バージョン、および使用する言語を設定します。この情報は、プロジェクト全体で使用され、ビルドプロセスや生成されるアーティファクトに影響を与えます。

project(MyProject VERSION 1.0 LANGUAGES CXX)

プロジェクト名

プロジェクト名は、プロジェクトを一意に識別するための名前です。通常、プロジェクトのルートディレクトリの名前と一致させます。

バージョン番号

バージョン番号は、プロジェクトのバージョン管理に使用されます。メジャーバージョン、マイナーバージョン、パッチバージョンなどを指定できます。

project(MyProject VERSION 1.2.3)

使用する言語

プロジェクトで使用する言語を指定します。C++プロジェクトの場合はCXXを指定します。複数の言語を使用する場合は、スペースで区切って指定できます。

project(MyProject LANGUAGES C CXX)

追加の初期設定

プロジェクトの初期設定には、その他にもいくつかのオプションがあります。例えば、プロジェクトの設定ファイルを読み込むディレクトリを指定する場合は、以下のようにします。

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")

また、ビルドの種類（Debug, Releaseなど）を設定することもできます。

if(NOT CMAKE_BUILD_TYPE)
  set(CMAKE_BUILD_TYPE Release)
endif()

これらの初期設定を行うことで、CMakeはプロジェクトのビルドプロセスを適切に管理し、必要な設定を適用することができます。次のセクションでは、プロジェクトにソースファイルを追加し、管理する方法について詳しく説明します。

ソースファイルの指定

C++プロジェクトでは、ソースファイルの管理が重要です。CMakeLists.txtを使用して、プロジェクトに含まれるソースファイルを指定し、ビルドシステムに認識させる方法を学びます。

ソースファイルの追加

ソースファイルをCMakeプロジェクトに追加するには、setコマンドを使用して変数にファイルリストを格納します。その後、add_executableやadd_libraryコマンドで指定されたターゲットにファイルを割り当てます。

set(SOURCES
    main.cpp
    helper.cpp
    utils.cpp
)
add_executable(MyExecutable ${SOURCES})

この例では、SOURCESという変数にmain.cpp、helper.cpp、utils.cppの3つのソースファイルを追加し、それらを使ってMyExecutableという実行ファイルを作成しています。

ヘッダーファイルの管理

CMakeLists.txtでヘッダーファイルを明示的に追加する必要はありませんが、ヘッダーファイルを含むディレクトリをインクルードディレクトリとして指定することは重要です。

include_directories(${CMAKE_SOURCE_DIR}/include)

このコマンドにより、コンパイラはincludeディレクトリ内のヘッダーファイルを検索します。

ファイルの自動検出

大規模なプロジェクトでは、手動でソースファイルを追加するのは手間がかかります。CMakeには、ディレクトリ内のソースファイルを自動的に検出する機能があります。

file(GLOB_RECURSE SOURCES "src/*.cpp" "include/*.h")
add_executable(MyExecutable ${SOURCES})

この例では、srcディレクトリ内のすべての.cppファイルと、includeディレクトリ内のすべての.hファイルを再帰的に検索し、それらをSOURCES変数に格納しています。

複数のターゲットの定義

一つのプロジェクトで複数の実行ファイルやライブラリをビルドする場合、各ターゲットごとにソースファイルを指定する必要があります。

# 実行ファイルのターゲット
add_executable(MyExecutable main.cpp)

# ライブラリのターゲット
add_library(MyLibrary helper.cpp utils.cpp)

# ライブラリをリンクする
target_link_libraries(MyExecutable PRIVATE MyLibrary)

この例では、main.cppを使用してMyExecutableという実行ファイルを作成し、helper.cppとutils.cppを使用してMyLibraryというライブラリを作成しています。さらに、MyLibraryをMyExecutableにリンクしています。

条件付きのソースファイル追加

特定の条件下でソースファイルを追加する場合、if文を使用して条件付きでファイルを追加できます。

if(WIN32)
  set(PLATFORM_SOURCES windows_specific.cpp)
else()
  set(PLATFORM_SOURCES unix_specific.cpp)
endif()

add_executable(MyExecutable main.cpp ${PLATFORM_SOURCES})

この例では、Windows環境ではwindows_specific.cppを、他の環境ではunix_specific.cppを追加しています。

これらの方法を組み合わせることで、CMakeLists.txtでプロジェクトのソースファイルを効率的に管理できます。次のセクションでは、コンパイラオプションの設定方法について詳しく説明します。

コンパイラオプションの設定

コンパイラオプションの設定は、C++プロジェクトのビルドプロセスにおいて重要な役割を果たします。適切なコンパイラオプションを指定することで、コードの最適化、警告の管理、デバッグ情報の追加などが可能になります。

基本的なコンパイラオプションの設定

CMakeでは、ターゲットごとにコンパイラオプションを設定するためにtarget_compile_optionsコマンドを使用します。以下の例では、警告オプションと最適化オプションを設定しています。

target_compile_options(MyExecutable PRIVATE -Wall -Wextra -O2)

この設定により、MyExecutableターゲットに対して全ての警告を表示し、追加の警告も有効にし、最適化レベルを2に設定します。

ビルドタイプの設定

CMakeは、プロジェクトのビルドタイプを指定するための便利なオプションを提供しています。デフォルトのビルドタイプには、Debug、Release、RelWithDebInfo、MinSizeRelの4種類があります。

set(CMAKE_BUILD_TYPE Debug)

Debugビルドタイプでは、デバッグ情報が追加され、最適化が無効化されます。一方、Releaseビルドタイプでは、最適化が有効になり、デバッグ情報が削除されます。

条件付きコンパイルオプション

特定の条件下でコンパイラオプションを設定することも可能です。例えば、プラットフォームによって異なるオプションを設定する場合には、以下のように記述します。

if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
  target_compile_options(MyExecutable PRIVATE -Wall -Wextra)
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  target_compile_options(MyExecutable PRIVATE /W4)
endif()

この例では、GNUコンパイラを使用する場合とMSVCコンパイラを使用する場合で異なる警告オプションを設定しています。

ターゲット固有のオプション

異なるターゲットに対して異なるコンパイラオプションを設定することもできます。これにより、各ターゲットに最適なオプションを指定できます。

target_compile_options(MyExecutable PRIVATE -O3)
target_compile_options(MyLibrary PRIVATE -O2)

この設定により、MyExecutableは最適化レベル3でコンパイルされ、MyLibraryは最適化レベル2でコンパイルされます。

定義の追加

プロジェクト内で使用する定義を追加するためには、target_compile_definitionsコマンドを使用します。これにより、プリプロセッサ定義をターゲットに追加できます。

target_compile_definitions(MyExecutable PRIVATE MY_DEFINE=1)

この例では、MY_DEFINEという定義がMyExecutableに追加され、値は1に設定されます。

デバッグ情報の追加

デバッグ情報を追加するためのオプションも設定可能です。デバッグビルドの場合には、以下のようにデバッグ情報を追加できます。

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
  target_compile_options(MyExecutable PRIVATE -g)
endif()

この設定により、デバッグビルドの場合にはデバッグ情報が追加されます。

これらのコンパイラオプションを活用することで、C++プロジェクトのビルドプロセスを細かく制御し、最適なビルド結果を得ることができます。次のセクションでは、外部ライブラリの導入とその依存関係の管理方法について詳しく説明します。

外部ライブラリの導入

外部ライブラリの導入と依存関係の管理は、C++プロジェクトを効率的に開発するために重要なステップです。CMakeを使用することで、外部ライブラリを簡単にプロジェクトに組み込み、依存関係を適切に管理することができます。

find_packageの使用

CMakeには、外部ライブラリを検索してインクルードするためのfind_packageコマンドがあります。find_packageは、指定したライブラリがインストールされているかどうかを確認し、必要な設定をプロジェクトに追加します。

find_package(SomeLibrary REQUIRED)

このコマンドにより、SomeLibraryがシステムにインストールされていることを確認し、プロジェクトに必要な設定を自動的に追加します。REQUIREDオプションを指定することで、ライブラリが見つからない場合にエラーメッセージを表示します。

ライブラリのリンク

ライブラリが見つかったら、target_link_librariesコマンドを使用して、ターゲットにライブラリをリンクします。

target_link_libraries(MyExecutable PRIVATE SomeLibrary::SomeLibrary)

この設定により、MyExecutableターゲットにSomeLibraryがリンクされます。

外部ライブラリの手動インクルード

find_packageコマンドが使用できない場合、手動で外部ライブラリのインクルードパスやリンクパスを指定することも可能です。

# インクルードパスの追加
include_directories(${CMAKE_SOURCE_DIR}/external/SomeLibrary/include)

# ライブラリパスの追加
link_directories(${CMAKE_SOURCE_DIR}/external/SomeLibrary/lib)

# ライブラリのリンク
target_link_libraries(MyExecutable PRIVATE SomeLibrary)

この例では、external/SomeLibraryディレクトリにあるライブラリのインクルードパスとリンクパスを手動で設定しています。

FetchContentの使用

CMakeのFetchContentモジュールを使用すると、外部ライブラリを自動的にダウンロードしてビルドすることができます。これにより、外部依存関係の管理が簡素化されます。

include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG release-1.10.0
)
FetchContent_MakeAvailable(googletest)

target_link_libraries(MyExecutable PRIVATE gtest gtest_main)

この設定により、Google Testライブラリが自動的にダウンロードされ、MyExecutableターゲットにリンクされます。

パッケージ管理ツールの利用

外部ライブラリの管理には、vcpkgやConanなどのパッケージ管理ツールを利用することもできます。これらのツールを使用すると、外部ライブラリのインストールや管理が容易になります。

# vcpkgを使用する場合
set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake)
find_package(fmt CONFIG REQUIRED)
target_link_libraries(MyExecutable PRIVATE fmt::fmt)

この例では、vcpkgを使用してfmtライブラリをプロジェクトに追加しています。

これらの方法を組み合わせることで、外部ライブラリを効率的にプロジェクトに導入し、依存関係を適切に管理することができます。次のセクションでは、ビルドターゲットの定義方法について詳しく説明します。

ビルドターゲットの定義

ビルドターゲットの定義は、CMakeLists.txtでプロジェクトの実行ファイルやライブラリを構築する際に重要なステップです。ここでは、実行ファイルやライブラリのビルドターゲットの設定方法について説明します。

実行ファイルの定義

CMakeを使用して実行ファイルを定義するためには、add_executableコマンドを使用します。このコマンドは、実行ファイルの名前とそのソースファイルを指定します。

add_executable(MyExecutable main.cpp helper.cpp)

この設定により、main.cppとhelper.cppからMyExecutableという名前の実行ファイルが生成されます。

ライブラリの定義

ライブラリをビルドするためには、add_libraryコマンドを使用します。ライブラリは静的ライブラリ（アーカイブ）または動的ライブラリ（共有オブジェクト）として作成できます。

# 静的ライブラリの定義
add_library(MyStaticLibrary STATIC utils.cpp)

# 動的ライブラリの定義
add_library(MySharedLibrary SHARED utils.cpp)

この例では、utils.cppからMyStaticLibraryという静的ライブラリとMySharedLibraryという動的ライブラリが生成されます。

ライブラリのリンク

ビルドターゲット間でライブラリをリンクするためには、target_link_librariesコマンドを使用します。これにより、他のターゲットで作成されたライブラリを利用できます。

# MyExecutableにMyStaticLibraryをリンク
target_link_libraries(MyExecutable PRIVATE MyStaticLibrary)

# MySharedLibraryに外部ライブラリをリンク
find_package(SomeExternalLibrary REQUIRED)
target_link_libraries(MySharedLibrary PRIVATE SomeExternalLibrary::SomeExternalLibrary)

この設定により、MyExecutableはMyStaticLibraryをリンクし、MySharedLibraryはSomeExternalLibraryをリンクします。

ターゲットプロパティの設定

ターゲットにはさまざまなプロパティを設定できます。例えば、ターゲットのインクルードディレクトリやコンパイルオプションを設定することが可能です。

# インクルードディレクトリの設定
target_include_directories(MyExecutable PRIVATE ${CMAKE_SOURCE_DIR}/include)

# コンパイルオプションの設定
target_compile_options(MyExecutable PRIVATE -Wall -Wextra)

この例では、MyExecutableに対してインクルードディレクトリとコンパイルオプションを設定しています。

ビルド後の処理

ビルド後の処理として、ターゲットをインストールする設定を追加することもできます。これには、installコマンドを使用します。

# 実行ファイルのインストール
install(TARGETS MyExecutable DESTINATION bin)

# ライブラリのインストール
install(TARGETS MyStaticLibrary MySharedLibrary DESTINATION lib)

この設定により、ビルド後にMyExecutableはbinディレクトリに、MyStaticLibraryとMySharedLibraryはlibディレクトリにインストールされます。

テストターゲットの追加

プロジェクトにユニットテストを追加する場合、add_testコマンドを使用してテストターゲットを定義できます。

# テストの追加
enable_testing()
add_executable(MyTest test.cpp)
target_link_libraries(MyTest PRIVATE MyStaticLibrary)
add_test(NAME MyTest COMMAND MyTest)

この設定により、test.cppからMyTestというテストターゲットが作成され、MyStaticLibraryとリンクされます。さらに、MyTestがテストとして登録されます。

これらの方法を組み合わせることで、CMakeLists.txtで実行ファイルやライブラリのビルドターゲットを効果的に定義し、管理することができます。次のセクションでは、ユニットテストの追加とCMakeによるテスト管理について詳しく説明します。

テストの追加

ユニットテストは、ソフトウェアの品質を保証し、コードの変更による不具合を早期に検出するために重要です。CMakeを使用して、ユニットテストを追加し、テストを管理する方法について説明します。

CTestの有効化

CTestは、CMakeに組み込まれているテストフレームワークです。CTestを有効にするためには、enable_testingコマンドを使用します。

enable_testing()

このコマンドにより、CTestが有効になり、テストを追加できるようになります。

テストターゲットの定義

テスト用の実行ファイルを作成し、その実行ファイルをテストとして登録するために、add_executableコマンドとadd_testコマンドを使用します。

# テスト用の実行ファイルを作成
add_executable(MyTest test.cpp)

# 必要なライブラリをリンク
target_link_libraries(MyTest PRIVATE MyStaticLibrary)

# テストを登録
add_test(NAME MyTest COMMAND MyTest)

この設定により、test.cppからMyTestという実行ファイルが作成され、MyStaticLibraryとリンクされます。その後、MyTestがテストとして登録されます。

複数のテストの追加

プロジェクト内に複数のテストがある場合、各テストを個別に登録することができます。

# テスト1の設定
add_executable(Test1 test1.cpp)
target_link_libraries(Test1 PRIVATE MyStaticLibrary)
add_test(NAME Test1 COMMAND Test1)

# テスト2の設定
add_executable(Test2 test2.cpp)
target_link_libraries(Test2 PRIVATE MyStaticLibrary)
add_test(NAME Test2 COMMAND Test2)

この設定により、test1.cppとtest2.cppからそれぞれTest1とTest2という実行ファイルが作成され、それぞれが個別のテストとして登録されます。

テストプロパティの設定

テストにはさまざまなプロパティを設定することができます。例えば、タイムアウトや環境変数を設定することができます。

# テストのタイムアウトを設定
set_tests_properties(MyTest PROPERTIES TIMEOUT 30)

# 環境変数を設定
set_tests_properties(MyTest PROPERTIES ENVIRONMENT "MY_ENV_VAR=1")

この設定により、MyTestは30秒のタイムアウトが設定され、MY_ENV_VARという環境変数が設定されます。

CTestの実行

CTestを実行するためには、CMakeでプロジェクトをビルドした後、コマンドラインからctestコマンドを実行します。

ctest

このコマンドにより、登録されたすべてのテストが実行され、結果が表示されます。

Google Testの使用

Google Testなどの外部テストフレームワークを使用する場合も、CMakeを使用してテストを追加できます。以下は、Google Testを使用した例です。

# Google Testの取得と設定
include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG release-1.10.0
)
FetchContent_MakeAvailable(googletest)

# テストの追加
add_executable(MyGTest test.cpp)
target_link_libraries(MyGTest PRIVATE gtest gtest_main MyStaticLibrary)
add_test(NAME MyGTest COMMAND MyGTest)

この設定により、Google Testがプロジェクトに追加され、test.cppを使用してMyGTestという実行ファイルが作成され、テストとして登録されます。

これらの方法を組み合わせることで、CMakeを使用して効果的にユニットテストを追加し、管理することができます。次のセクションでは、ビルド成果物のインストール設定について詳しく説明します。

インストールの設定

CMakeを使用してビルド成果物のインストールを設定することで、プロジェクトの実行ファイルやライブラリを指定したディレクトリに配置することができます。このセクションでは、インストールの基本設定と応用例について説明します。

インストールの基本設定

CMakeには、インストールターゲットとインストールファイルを指定するためのinstallコマンドがあります。これにより、ビルドした成果物を指定のディレクトリに配置できます。

# 実行ファイルのインストール
install(TARGETS MyExecutable DESTINATION bin)

# ライブラリのインストール
install(TARGETS MyStaticLibrary MySharedLibrary DESTINATION lib)

この設定により、MyExecutableはbinディレクトリに、MyStaticLibraryとMySharedLibraryはlibディレクトリにインストールされます。

ヘッダーファイルのインストール

プロジェクトのヘッダーファイルをインストールする場合、install(FILES)コマンドを使用して、ヘッダーファイルを指定のインクルードディレクトリに配置します。

install(FILES ${CMAKE_SOURCE_DIR}/include/myheader.h DESTINATION include)

この設定により、myheader.hがincludeディレクトリにインストールされます。

ディレクトリ全体のインストール

複数のファイルを含むディレクトリをまとめてインストールする場合、install(DIRECTORY)コマンドを使用します。

install(DIRECTORY ${CMAKE_SOURCE_DIR}/include/ DESTINATION include)

この設定により、includeディレクトリ内のすべてのファイルとサブディレクトリがインストールされます。

コンフィギュレーションファイルのインストール

プロジェクトのコンフィギュレーションファイルをインストールする場合、ファイルの種類に応じて適切なディレクトリに配置します。

install(FILES ${CMAKE_SOURCE_DIR}/config/myconfig.conf DESTINATION etc/myproject)

この設定により、myconfig.confがetc/myprojectディレクトリにインストールされます。

エクスポート設定

プロジェクトを他のプロジェクトで利用可能にするために、エクスポート設定を追加することができます。これにより、ターゲットやインクルードディレクトリなどの情報を他のCMakeプロジェクトに提供できます。

# ターゲットのエクスポート設定
install(EXPORT MyProjectTargets
        FILE MyProjectTargets.cmake
        NAMESPACE MyProject::
        DESTINATION lib/cmake/MyProject)

# パッケージ構成ファイルの作成
include(CMakePackageConfigHelpers)
write_basic_package_version_file(
    "${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake"
    VERSION ${MyProject_VERSION}
    COMPATIBILITY AnyNewerVersion
)
install(FILES
        "${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfig.cmake"
        "${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake"
        DESTINATION lib/cmake/MyProject)

この設定により、MyProjectのターゲットがエクスポートされ、他のCMakeプロジェクトで利用可能になります。

インストール後の処理

インストール後に特定のスクリプトやコマンドを実行するために、install(CODE)またはinstall(SCRIPT)コマンドを使用できます。

# コードを実行
install(CODE "MESSAGE(STATUS \"Installation complete\")")

# スクリプトを実行
install(SCRIPT ${CMAKE_SOURCE_DIR}/cmake/post_install.cmake)

この設定により、インストール後にメッセージを表示したり、指定したスクリプトを実行することができます。

これらの設定を組み合わせることで、CMakeLists.txtを使用してビルド成果物のインストールを柔軟に管理できます。次のセクションでは、CMakeを使用してプロジェクトをパッケージ化する方法について詳しく説明します。

パッケージ化

CMakeを使用してプロジェクトをパッケージ化することで、プロジェクトを配布しやすくなります。これには、ライブラリや実行ファイル、関連するヘッダーファイルや設定ファイルを含むインストールパッケージを作成する方法が含まれます。このセクションでは、CMakeを用いたパッケージ化の手順を説明します。

CPackの有効化

CPackは、CMakeに組み込まれているパッケージングツールです。CPackを使用することで、さまざまなパッケージフォーマット（例えば、ZIP、TGZ、DEB、RPMなど）を作成できます。まず、CMakeLists.txtにCPackを有効化する設定を追加します。

include(CPack)

これにより、CPackが有効になり、パッケージングのための設定が可能になります。

パッケージ情報の設定

次に、パッケージのメタ情報（名前、バージョン、記述など）を設定します。これらの情報は、生成されるパッケージに含まれます。

set(CPACK_PACKAGE_NAME "MyProject")
set(CPACK_PACKAGE_VERSION "1.0.0")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "MyProject is a C++ project.")
set(CPACK_PACKAGE_VENDOR "MyCompany")
set(CPACK_PACKAGE_CONTACT "support@mycompany.com")

パッケージフォーマットの指定

CPackは、複数のパッケージフォーマットをサポートしています。必要に応じて、生成したいパッケージフォーマットを指定します。

set(CPACK_GENERATOR "TGZ;ZIP")

この例では、TGZとZIPの2種類のパッケージが生成されます。

インストールターゲットの指定

パッケージに含めるインストールターゲットを指定します。これには、実行ファイル、ライブラリ、ヘッダーファイルなどが含まれます。

install(TARGETS MyExecutable DESTINATION bin)
install(TARGETS MyStaticLibrary MySharedLibrary DESTINATION lib)
install(FILES ${CMAKE_SOURCE_DIR}/include/myheader.h DESTINATION include)

この設定により、指定したファイルやディレクトリがパッケージに含まれます。

パッケージバージョンファイルの作成

プロジェクトのバージョン管理のために、パッケージバージョンファイルを作成します。

include(CMakePackageConfigHelpers)
write_basic_package_version_file(
    "${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake"
    VERSION ${CPACK_PACKAGE_VERSION}
    COMPATIBILITY AnyNewerVersion
)
install(FILES
    "${CMAKE_CURRENT_BINARY_DIR}/MyProjectConfigVersion.cmake"
    DESTINATION lib/cmake/MyProject)

パッケージ生成の実行

CMakeプロジェクトをビルドした後、コマンドラインからcpackコマンドを実行してパッケージを生成します。

cpack

このコマンドにより、指定したフォーマットのパッケージが生成されます。

追加のパッケージ設定

さらに詳細な設定が必要な場合、CPackのドキュメントを参照して、さまざまなパラメータを調整することができます。例えば、DEBパッケージ用の設定を追加する場合、以下のように記述します。

set(CPACK_DEBIAN_PACKAGE_MAINTAINER "MyCompany") #required
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.3.1-6)")
set(CPACK_DEBIAN_PACKAGE_SECTION "utils")

この設定により、DEBパッケージに必要な情報が追加されます。

これらの手順を通じて、CMakeを使用してプロジェクトを効果的にパッケージ化することができます。次のセクションでは、CMakeLists.txtでよく発生する問題とそのトラブルシューティング方法について詳しく説明します。

トラブルシューティング

CMakeLists.txtの設定やビルドプロセス中に発生する一般的な問題とその解決方法を理解することは、プロジェクトをスムーズに進めるために重要です。このセクションでは、CMakeを使用する際によく遭遇する問題とそのトラブルシューティング方法について説明します。

一般的なエラーメッセージと解決方法

find_packageエラー

CMake Error at CMakeLists.txt:10 (find_package):
  By not providing "FindSomeLibrary.cmake" in CMAKE_MODULE_PATH this project
  has asked CMake to find a package configuration file provided by
  "SomeLibrary", but CMake did not find one.

このエラーは、指定したライブラリが見つからない場合に発生します。解決策として、CMAKE_MODULE_PATHに必要なモジュールパスを追加するか、ライブラリが正しくインストールされていることを確認します。

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
find_package(SomeLibrary REQUIRED)

ターゲットが存在しないエラー

CMake Error at CMakeLists.txt:20 (target_link_libraries):
  Cannot specify link libraries for target "MyExecutable" which is not built
  by this project.

このエラーは、指定したターゲットが定義されていない場合に発生します。ターゲット名を確認し、正しい名前で指定しているかどうかを確認します。

add_executable(MyExecutable main.cpp)
target_link_libraries(MyExecutable PRIVATE MyLibrary)

変数が未定義エラー

CMake Error at CMakeLists.txt:15 (include_directories):
  include_directories given empty-string as include directory.

このエラーは、指定した変数が未定義または空である場合に発生します。変数が正しく設定されているかどうかを確認します。

set(MY_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/include")
include_directories(${MY_INCLUDE_DIR})

ビルド失敗のトラブルシューティング

コンパイルエラー

コンパイルエラーが発生した場合、エラーメッセージを確認し、コードや設定に問題がないかを調べます。コンパイルオプションやインクルードパスの設定を見直すことが必要です。

リンクエラー

リンクエラーは、ライブラリが見つからない場合やシンボルが未解決の場合に発生します。target_link_librariesで正しいライブラリをリンクしているかを確認します。

target_link_libraries(MyExecutable PRIVATE MyLibrary)

デバッグのための設定

メッセージの表示

messageコマンドを使用して、変数の値や処理の進行状況を表示できます。これにより、設定が正しく適用されているかを確認できます。

message(STATUS "CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")

ビルドタイプの設定

デバッグビルドとリリースビルドを切り替えることで、異なるコンパイルオプションを適用できます。デバッグビルドでは、デバッグ情報を追加し、最適化を無効にします。

set(CMAKE_BUILD_TYPE Debug)

その他のトラブルシューティング方法

キャッシュのクリア

ビルドキャッシュが古くなっている場合、予期しないエラーが発生することがあります。キャッシュをクリアすることで、問題を解決できることがあります。

rm -rf CMakeCache.txt CMakeFiles/
cmake .

ドキュメントとヘルプの活用

CMakeの公式ドキュメントやコマンドのヘルプを参照することで、多くの問題を解決できます。

cmake --help

これらのトラブルシューティング方法を使用することで、CMakeLists.txtの設定やビルドプロセス中に発生する問題を迅速に解決できるようになります。次のセクションでは、本記事の内容を総括し、CMakeLists.txtの重要性とその利点を再確認します。

まとめ

本記事では、C++プロジェクトにおけるCMakeLists.txtの重要性とその具体的な設定方法について詳しく説明しました。CMakeは、クロスプラットフォームのビルドシステムとして、依存関係の管理やビルドプロセスの自動化を大幅に簡素化し、プロジェクトの効率的な開発をサポートします。

導入部分では、CMakeの基本的な概念とその利点について説明しました。CMakeLists.txtの基本構成では、プロジェクトの初期設定からソースファイルの指定、コンパイラオプションの設定、外部ライブラリの導入、ビルドターゲットの定義、ユニットテストの追加、ビルド成果物のインストール設定、そしてプロジェクトのパッケージ化までを詳しく解説しました。

特に、トラブルシューティングのセクションでは、CMakeを使用する際に一般的に遭遇する問題とその解決方法について説明しました。これにより、CMakeLists.txtの設定やビルドプロセス中に発生する問題を迅速に解決し、プロジェクトのスムーズな進行を支援します。

CMakeを効果的に活用することで、プロジェクトのビルドプロセスが大幅に改善され、開発者の生産性が向上します。適切な依存関係管理、ビルドターゲットの定義、ユニットテストの導入、そして成果物のパッケージ化により、プロジェクト全体の品質と保守性が向上します。

今後もCMakeを活用し続けることで、プロジェクトの効率的な管理とスムーズな開発が実現できるでしょう。本記事が、CMakeLists.txtを理解し、実際のプロジェクトに適用するための参考になれば幸いです。