MENU
  1. ホーム
  2. C++
  3. C++初心者のためのCMake基本構文と使い方を徹底解説

C++初心者のためのCMake基本構文と使い方を徹底解説

C++

C++開発において、ビルドシステムの選択はプロジェクトの成功に直結します。多くの開発者が利用するCMakeは、プラットフォームに依存せず、効率的かつ柔軟にプロジェクトを構成するための強力なツールです。しかし、初心者にとってその導入は少し敷居が高いかもしれません。本記事では、C++のプロジェクトでCMakeを使用する際の基本的な構文や使い方について、初心者にも分かりやすく解説します。CMakeの基礎から実践的な応用までを網羅し、効率的なプロジェクト管理のための第一歩を踏み出しましょう。

目次

CMakeとは何か

CMake（CMake Makefile Generator）は、クロスプラットフォームのビルドシステムであり、ソフトウェアプロジェクトのビルドプロセスを管理するためのツールです。CMakeは、プログラムのソースコードをコンパイルし、リンクするための設定ファイル（CMakeLists.txt）を提供し、これを基にMakefileやプロジェクトファイルを生成します。

CMakeの役割

CMakeの主な役割は、以下の通りです。

1. プラットフォーム独立性の提供

CMakeは、Windows、macOS、Linuxなどの異なるプラットフォーム上で一貫したビルド環境を提供します。

2. 複雑な依存関係の管理

CMakeは、複数のライブラリやモジュール間の依存関係を効率的に管理し、ビルドプロセスを簡素化します。

3. 柔軟なプロジェクト構成

CMakeは、小規模から大規模なプロジェクトまで対応できる柔軟な設定をサポートします。

CMakeの利点

CMakeを使用することで、以下のような利点があります。

1. 簡単なビルドプロセスの自動化

CMakeを使用すると、複雑なビルドプロセスを自動化でき、手動での設定ミスを防げます。

2. 一貫した開発環境の構築

開発チーム全体で一貫したビルド環境を維持でき、新しいメンバーの参加時にもスムーズに環境を整えられます。

3. 継続的インテグレーションとの連携

CMakeは、多くの継続的インテグレーション（CI）ツールと連携でき、ビルドの自動化とテストの実行を容易にします。

CMakeを導入することで、開発プロジェクトの生産性と品質を大幅に向上させることができます。

CMakeのインストール方法

CMakeを使用するためには、まず自身の開発環境にCMakeをインストールする必要があります。ここでは、主要なオペレーティングシステムでのCMakeのインストール方法を紹介します。

Windowsでのインストール

  1. CMakeの公式ウェブサイト（cmake.org)にアクセスします。
  2. ダウンロードページから、Windows用のインストーラ（Installer）をダウンロードします。
  3. ダウンロードしたインストーラを実行し、ウィザードに従ってインストールを完了させます。
  4. インストール後、コマンドプロンプトを開き、以下のコマンドを実行してCMakeが正しくインストールされたことを確認します。
   cmake --version

macOSでのインストール

  1. macOSでは、Homebrewを使用して簡単にCMakeをインストールできます。ターミナルを開き、以下のコマンドを実行します。
   brew install cmake
  1. インストールが完了したら、以下のコマンドを実行してCMakeのバージョンを確認します。
   cmake --version

Linuxでのインストール

Linuxディストリビューションによっては、パッケージマネージャを使用してCMakeをインストールできます。以下に、主要なディストリビューションでのインストール方法を示します。

Ubuntu

  1. ターミナルを開き、以下のコマンドを実行します。
   sudo apt update
   sudo apt install cmake
  1. インストールが完了したら、以下のコマンドを実行してCMakeのバージョンを確認します。
   cmake --version

Fedora

  1. ターミナルを開き、以下のコマンドを実行します。
   sudo dnf install cmake
  1. インストールが完了したら、以下のコマンドを実行してCMakeのバージョンを確認します。
   cmake --version

以上の手順でCMakeをインストールすることで、さまざまなプラットフォームでCMakeを利用したプロジェクト開発が可能になります。次に、CMakeの基本構文について学びましょう。

CMakeLists.txtの基本構文

CMakeを使用する際には、プロジェクトのルートディレクトリにCMakeLists.txtという名前のファイルを作成します。このファイルには、プロジェクトのビルド設定や依存関係などの情報が含まれています。ここでは、CMakeLists.txtファイルの基本的な構文と重要なコマンドを紹介します。

プロジェクトの開始

CMakeLists.txtの最初に、CMakeの最小バージョンとプロジェクトの名前を設定します。

cmake_minimum_required(VERSION 3.10)
project(MyProject)

ソースファイルの指定

次に、ビルドするソースファイルを指定します。一般的には、すべてのソースファイルを変数にまとめます。

set(SOURCES
    main.cpp
    foo.cpp
    bar.cpp
)

実行ファイルの生成

指定したソースファイルを使って実行ファイルを生成します。add_executableコマンドを使用します。

add_executable(MyExecutable ${SOURCES})

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

プロジェクトに必要なコンパイラオプションや定義を設定します。

target_compile_options(MyExecutable PRIVATE -Wall -Wextra -std=c++17)

ライブラリのリンク

外部ライブラリをリンクする場合は、target_link_librariesコマンドを使用します。

target_link_libraries(MyExecutable PRIVATE SomeLibrary)

インクルードディレクトリの指定

ヘッダーファイルを含むディレクトリを指定します。

target_include_directories(MyExecutable PRIVATE ${PROJECT_SOURCE_DIR}/include)

カスタムコマンドの実行

ビルド後にカスタムコマンドを実行する場合は、add_custom_commandを使用します。

add_custom_command(TARGET MyExecutable POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config.txt ${CMAKE_BINARY_DIR}/config.txt)

構成の例

以下は、上記の要素を組み合わせたシンプルなCMakeLists.txtの例です。

cmake_minimum_required(VERSION 3.10)
project(MyProject)

set(SOURCES
    main.cpp
    foo.cpp
    bar.cpp
)

add_executable(MyExecutable ${SOURCES})

target_compile_options(MyExecutable PRIVATE -Wall -Wextra -std=c++17)
target_link_libraries(MyExecutable PRIVATE SomeLibrary)
target_include_directories(MyExecutable PRIVATE ${PROJECT_SOURCE_DIR}/include)

add_custom_command(TARGET MyExecutable POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config.txt ${CMAKE_BINARY_DIR}/config.txt)

このようにして、CMakeLists.txtファイルを作成することで、プロジェクトのビルドプロセスを簡潔に管理できます。次に、具体的なプロジェクトの初期設定方法について学びましょう。

プロジェクトの初期設定

CMakeを使用してC++プロジェクトを設定するための基本的な手順を紹介します。プロジェクトのディレクトリ構造を作成し、必要な設定を行うことで、効率的なビルド環境を整えます。

ディレクトリ構造の作成

まず、プロジェクトのディレクトリ構造を決定します。一般的なディレクトリ構造の例を示します。

MyProject/
├── CMakeLists.txt
├── src/
│   ├── main.cpp
│   ├── foo.cpp
│   └── bar.cpp
└── include/
    ├── foo.h
    └── bar.h

プロジェクトのルートディレクトリにCMakeLists.txtを作成

プロジェクトのルートディレクトリにCMakeLists.txtファイルを作成し、基本的な設定を行います。以下は、初期設定の例です。

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# ソースファイルを指定
set(SOURCES
    src/main.cpp
    src/foo.cpp
    src/bar.cpp
)

# 実行ファイルを生成
add_executable(MyExecutable ${SOURCES})

# コンパイルオプションを設定
target_compile_options(MyExecutable PRIVATE -Wall -Wextra -std=c++17)

# インクルードディレクトリを指定
target_include_directories(MyExecutable PRIVATE ${PROJECT_SOURCE_DIR}/include)

ソースファイルとヘッダーファイルの配置

ソースファイルとヘッダーファイルを適切なディレクトリに配置します。上記のディレクトリ構造に従って、srcディレクトリにはC++ソースファイルを、includeディレクトリにはヘッダーファイルを配置します。

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

ビルドプロセスを進めるために、プロジェクトのルートディレクトリとは別にビルド用のディレクトリを作成します。一般的には、buildディレクトリを作成します。

mkdir build

CMakeの実行

ビルドディレクトリに移動し、CMakeを実行してビルド環境を設定します。

cd build
cmake ..

これにより、CMakeLists.txtファイルの内容に基づいてビルド環境が構築されます。

プロジェクトのビルド

CMakeを実行した後、ビルドコマンドを実行してプロジェクトをビルドします。一般的には、以下のコマンドを使用します。

cmake --build .

この手順に従って、CMakeを使用したC++プロジェクトの初期設定を行うことで、効率的な開発環境を構築できます。次に、ターゲットの設定について学びましょう。

ターゲットの設定

CMakeでは、プロジェクト内のビルドターゲット（実行ファイルやライブラリ）を設定するための多彩な機能が提供されています。ここでは、ターゲットの定義とコンパイルオプションの設定方法について説明します。

ターゲットの定義

CMakeでターゲットを定義するには、以下のコマンドを使用します。

実行ファイルの作成

add_executableコマンドを使用して、実行ファイルを作成します。

add_executable(MyExecutable src/main.cpp src/foo.cpp src/bar.cpp)

このコマンドは、src/main.cpp、src/foo.cpp、src/bar.cppのソースファイルからMyExecutableという名前の実行ファイルを生成します。

ライブラリの作成

add_libraryコマンドを使用して、静的ライブラリまたは動的ライブラリを作成します。

# 静的ライブラリ
add_library(MyStaticLibrary STATIC src/foo.cpp src/bar.cpp)

# 動的ライブラリ
add_library(MySharedLibrary SHARED src/foo.cpp src/bar.cpp)

STATICキーワードを使用すると静的ライブラリ、SHAREDキーワードを使用すると動的ライブラリが作成されます。

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

CMakeでは、ターゲットごとにコンパイルオプションを設定できます。これにより、特定のターゲットに対して異なるコンパイルフラグを適用できます。

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

target_compile_optionsコマンドを使用して、特定のターゲットにコンパイルオプションを設定します。

target_compile_options(MyExecutable PRIVATE -Wall -Wextra -std=c++17)

PRIVATEキーワードを使用すると、指定したコンパイルオプションはそのターゲットにのみ適用されます。他にもPUBLICやINTERFACEというキーワードがありますが、基本的な使い方としてはPRIVATEが多く使われます。

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

ターゲットには多くのプロパティが設定できます。例えば、ターゲットに関連するインクルードディレクトリやリンクライブラリなどです。

インクルードディレクトリの設定

target_include_directoriesコマンドを使用して、ターゲットのインクルードディレクトリを設定します。

target_include_directories(MyExecutable PRIVATE ${PROJECT_SOURCE_DIR}/include)

リンクライブラリの設定

target_link_librariesコマンドを使用して、ターゲットにリンクするライブラリを指定します。

target_link_libraries(MyExecutable PRIVATE SomeLibrary)

複数ターゲットの設定

一つのプロジェクト内に複数のターゲットがある場合、それぞれのターゲットに対して個別に設定を行うことができます。例えば、ライブラリと実行ファイルを同時に設定する場合は以下のようにします。

add_library(MyLibrary STATIC src/foo.cpp src/bar.cpp)
target_include_directories(MyLibrary PRIVATE ${PROJECT_SOURCE_DIR}/include)

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

このように、CMakeを使えば複数のターゲットを効率的に設定し、プロジェクト全体のビルドプロセスを柔軟に管理できます。次に、外部ライブラリをプロジェクトに追加する方法について学びましょう。

外部ライブラリの追加

C++プロジェクトでは、しばしば外部ライブラリを利用して機能を拡張したり、特定のタスクを効率的に実行したりします。CMakeでは、外部ライブラリを簡単にプロジェクトに追加するための機能が提供されています。ここでは、外部ライブラリをプロジェクトに追加する方法を説明します。

find_packageコマンドを使用する

CMakeのfind_packageコマンドを使用して、システムにインストールされている外部ライブラリを検出し、プロジェクトに追加します。例えば、Boostライブラリを使用する場合は以下のようにします。

find_package(Boost 1.70 REQUIRED COMPONENTS filesystem system)
if(Boost_FOUND)
    include_directories(${Boost_INCLUDE_DIRS})
    target_link_libraries(MyExecutable PRIVATE ${Boost_LIBRARIES})
endif()

find_packageコマンドの詳細

  • find_package(Boost 1.70 REQUIRED COMPONENTS filesystem system): Boostライブラリのバージョン1.70以降を検索し、filesystemとsystemコンポーネントを要求します。
  • if(Boost_FOUND): Boostライブラリが見つかった場合に以下の設定を適用します。
  • include_directories(${Boost_INCLUDE_DIRS}): Boostのインクルードディレクトリをプロジェクトに追加します。
  • target_link_libraries(MyExecutable PRIVATE ${Boost_LIBRARIES}): BoostライブラリをMyExecutableターゲットにリンクします。

add_subdirectoryコマンドを使用する

プロジェクトに直接含まれている外部ライブラリ（ソースコードがプロジェクト内にある場合）を追加するには、add_subdirectoryコマンドを使用します。例えば、プロジェクトに独自のライブラリを含める場合は以下のようにします。

add_subdirectory(external/MyLibrary)
target_link_libraries(MyExecutable PRIVATE MyLibrary)

外部プロジェクトのダウンロードとビルド

CMakeのExternalProjectモジュールを使用して、外部ライブラリを自動的にダウンロードし、ビルドすることも可能です。以下は、Google Testをダウンロードしてビルドする例です。

include(ExternalProject)
ExternalProject_Add(
    googletest
    URL https://github.com/google/googletest/archive/release-1.10.0.zip
    PREFIX ${CMAKE_BINARY_DIR}/external
    INSTALL_COMMAND ""
)

add_library(gtest IMPORTED STATIC GLOBAL)
set_target_properties(gtest PROPERTIES
    IMPORTED_LOCATION ${CMAKE_BINARY_DIR}/external/src/googletest/googletest/build/lib/libgtest.a
    INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_BINARY_DIR}/external/src/googletest/googletest/include
)

add_dependencies(gtest googletest)
target_link_libraries(MyExecutable PRIVATE gtest)

ExternalProject_Addコマンドの詳細

  • ExternalProject_Add: 外部プロジェクトを追加するためのコマンドです。
  • URL: ダウンロードする外部プロジェクトのURLを指定します。
  • PREFIX: 外部プロジェクトのビルドディレクトリを指定します。
  • INSTALL_COMMAND: インストールコマンドを空にすることで、インストールステップを省略します。

このようにして、外部ライブラリをCMakeプロジェクトに追加することで、プロジェクトの機能を大幅に拡張できます。次に、ビルドと実行の手順について学びましょう。

ビルドと実行

CMakeを使用してプロジェクトをビルドし、実行する手順について説明します。ここでは、CMakeを使用してビルドディレクトリを設定し、プロジェクトをビルドして実行する方法を詳細に解説します。

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

まず、ビルド用のディレクトリを作成します。これは、ソースコードとビルド成果物を分離するために一般的に行われる手順です。

mkdir build
cd build

CMakeの実行

次に、CMakeを実行してビルド環境を設定します。このステップでは、CMakeLists.txtファイルに基づいて必要なMakefileやプロジェクトファイルが生成されます。

cmake ..

このコマンドを実行すると、CMakeはプロジェクトのルートディレクトリ（..）にあるCMakeLists.txtファイルを読み込み、ビルドディレクトリに必要なビルドファイルを生成します。

プロジェクトのビルド

CMakeを実行した後、以下のコマンドを使用してプロジェクトをビルドします。CMakeは、プロジェクトの依存関係を解析し、適切な順序でソースファイルをコンパイルします。

cmake --build .

このコマンドは、デフォルトのビルドツール（通常はMake）を使用してプロジェクトをビルドします。

ビルドの詳細オプション

CMakeでは、ビルドプロセスに対して追加のオプションを指定できます。例えば、リリースビルドやデバッグビルドを行う場合は、以下のようにします。

cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

また、並列ビルドを行うことでビルド時間を短縮できます。以下の例では、4つの並列プロセスでビルドを行います。

cmake --build . -- -j4

プロジェクトの実行

ビルドが完了したら、生成された実行ファイルを実行してプロジェクトをテストします。ビルドディレクトリ内に生成された実行ファイルを直接実行します。

./MyExecutable

これにより、CMakeを使用してビルドされたC++プロジェクトが正しく実行されることを確認できます。

クリーンビルドの実行

時にはビルドディレクトリをクリーンアップして、再度ビルドを行う必要があります。この場合、ビルドディレクトリ内のすべてのファイルを削除し、再度ビルドを行います。

rm -rf *
cmake ..
cmake --build .

これにより、クリーンな状態でプロジェクトをビルドし直すことができます。次に、ビルド時のデバッグ方法と一般的なエラーの解決策について学びましょう。

デバッグとエラー解決

CMakeを使用したプロジェクトのデバッグ方法と、一般的なエラーの解決策について説明します。これにより、開発中に発生する問題を効率的に特定し、修正することができます。

デバッグビルドの設定

デバッグビルドは、最適化を行わず、デバッグ情報を含むビルドです。デバッグビルドを行うには、以下のようにCMakeのビルドタイプを設定します。

cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build .

これにより、デバッガを使用してプログラムを詳細に調査できます。

デバッガの使用

デバッグビルドが完了したら、デバッガを使用してプログラムを実行します。一般的なデバッガには、GDB（GNU Debugger）があります。以下のコマンドでGDBを起動します。

gdb ./MyExecutable

GDBが起動したら、以下のようなコマンドを使用してデバッグを行います。

  • run：プログラムを開始します。
  • break <関数名>：指定した関数にブレークポイントを設定します。
  • next：次の行に進みます。
  • print <変数名>：変数の値を表示します。
  • quit：GDBを終了します。

一般的なビルドエラーの解決

ビルド時にはさまざまなエラーが発生する可能性があります。以下に、一般的なビルドエラーとその解決方法を示します。

コンパイルエラー

コンパイルエラーは、ソースコードに問題がある場合に発生します。エラーメッセージを確認し、該当するソースコードを修正します。

error: ‘someFunction’ was not declared in this scope

このエラーは、someFunctionが宣言されていないことを示しています。必要なヘッダファイルをインクルードするか、関数の宣言を追加します。

リンクエラー

リンクエラーは、必要なライブラリやシンボルが見つからない場合に発生します。

undefined reference to `someFunction’

このエラーは、someFunctionの定義が見つからないことを示しています。CMakeLists.txtファイルに適切なライブラリをリンクする設定を追加します。

target_link_libraries(MyExecutable PRIVATE SomeLibrary)

ライブラリのパスエラー

ライブラリのパスが正しく設定されていない場合、実行時にライブラリが見つからないエラーが発生します。

error while loading shared libraries: libSomeLibrary.so: cannot open shared object file

このエラーを解決するには、ライブラリのパスを設定します。

export LD_LIBRARY_PATH=/path/to/library:$LD_LIBRARY_PATH

詳細なエラーメッセージの取得

CMakeのビルドプロセスで詳細なエラーメッセージを取得するためには、VERBOSEオプションを使用します。

cmake --build . -- VERBOSE=1

これにより、ビルド中の詳細なコマンドとメッセージが表示され、問題の特定が容易になります。

ログファイルの活用

ビルドプロセスの詳細なログを保存し、後から分析するためにログファイルを使用します。

cmake .. | tee cmake_configure.log
cmake --build . | tee cmake_build.log

teeコマンドを使用してログをファイルに保存しながら、コンソールにも出力します。

これらの方法を活用して、CMakeを使用したプロジェクトのデバッグとエラー解決を効果的に行いましょう。次に、CMakeの便利な機能について学びます。

CMakeの便利な機能

CMakeには、プロジェクトのビルドプロセスを効率化し、柔軟性を高めるための多くの便利な機能があります。ここでは、特に有用な機能をいくつか紹介します。

マルチプラットフォーム対応

CMakeは、Windows、macOS、Linuxなどの異なるプラットフォーム上で同じプロジェクトをビルドできるように設計されています。これにより、クロスプラットフォーム開発が容易になります。

プラットフォーム固有の設定

プラットフォームごとの特定の設定を行うには、if文を使用します。

if(WIN32)
    # Windows特有の設定
    set(SOURCES ${SOURCES} src/windows_specific.cpp)
elseif(APPLE)
    # macOS特有の設定
    set(SOURCES ${SOURCES} src/macos_specific.cpp)
elseif(UNIX)
    # Linux特有の設定
    set(SOURCES ${SOURCES} src/linux_specific.cpp)
endif()

カスタムコマンドとターゲット

CMakeでは、ビルドプロセスの特定の段階でカスタムコマンドを実行することができます。これにより、ビルド後のファイル操作や、追加のスクリプトの実行などが可能になります。

カスタムコマンドの追加

例えば、ビルド後にファイルをコピーするカスタムコマンドを追加するには、以下のようにします。

add_custom_command(TARGET MyExecutable POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config.txt ${CMAKE_BINARY_DIR}/config.txt)

カスタムターゲットの作成

カスタムターゲットを作成して、特定のタスクを実行することもできます。

add_custom_target(copy_config ALL
    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config.txt ${CMAKE_BINARY_DIR}/config.txt)

外部プロジェクトの管理

CMakeのExternalProjectモジュールを使用して、外部プロジェクトを管理できます。これにより、外部依存関係の自動ダウンロードとビルドが可能になります。

ExternalProjectの使用例

以下は、外部プロジェクトを追加する例です。

include(ExternalProject)
ExternalProject_Add(
    my_external_project
    GIT_REPOSITORY https://github.com/some/repo.git
    GIT_TAG master
    CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
)

プロジェクトの設定とキャッシュ

CMakeは、プロジェクトの設定をキャッシュし、再ビルド時に効率的に再利用します。これにより、ビルド時間を短縮し、設定の一貫性を保つことができます。

キャッシュ変数の使用

キャッシュ変数を設定して、ビルドオプションを柔軟に管理できます。

set(MY_OPTION ON CACHE BOOL "説明文")
if(MY_OPTION)
    add_definitions(-DMY_OPTION_ENABLED)
endif()

ビルドタイプの設定

CMakeは、デバッグビルドやリリースビルドなど、異なるビルドタイプをサポートしています。ビルドタイプを設定することで、適切な最適化やデバッグ情報を含むビルドが可能になります。

ビルドタイプの指定

set(CMAKE_BUILD_TYPE Debug)

または、CMakeの実行時に以下のように指定します。

cmake -DCMAKE_BUILD_TYPE=Release ..

パッケージの生成

CMakeは、CPackを使用してプロジェクトのパッケージを生成する機能も提供しています。これにより、ソフトウェアの配布が容易になります。

CPackの使用例

include(CPack)
set(CPACK_PACKAGE_NAME "MyProject")
set(CPACK_PACKAGE_VERSION "1.0.0")

これらの機能を活用することで、CMakeを使ったプロジェクトのビルドプロセスをより効率的に、そして柔軟に管理することができます。次に、CMakeを使った具体的なプロジェクトの応用例について学びましょう。

応用例と実践

ここでは、CMakeを使用した具体的なプロジェクト例を通じて、応用方法を詳しく解説します。これにより、実際の開発においてCMakeをどのように活用できるかを理解できます。

例1: シンプルなC++プロジェクト

シンプルなC++プロジェクトでCMakeを使用する例を紹介します。このプロジェクトは、単一の実行ファイルを生成するものです。

プロジェクト構造

SimpleProject/
├── CMakeLists.txt
├── src/
│   ├── main.cpp
│   └── utils.cpp
└── include/
    └── utils.h

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(SimpleProject)

set(CMAKE_CXX_STANDARD 17)

# ソースファイルとヘッダーファイルを指定
set(SOURCES
    src/main.cpp
    src/utils.cpp
)
set(HEADERS
    include/utils.h
)

# 実行ファイルを生成
add_executable(SimpleExecutable ${SOURCES} ${HEADERS})

# インクルードディレクトリを指定
target_include_directories(SimpleExecutable PRIVATE ${PROJECT_SOURCE_DIR}/include)

例2: 外部ライブラリを使用したプロジェクト

次に、外部ライブラリを使用するC++プロジェクトの例です。このプロジェクトでは、Boostライブラリを使用します。

プロジェクト構造

BoostProject/
├── CMakeLists.txt
├── src/
│   └── main.cpp

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(BoostProject)

set(CMAKE_CXX_STANDARD 17)

# Boostライブラリを見つける
find_package(Boost 1.70 REQUIRED COMPONENTS filesystem system)

# インクルードディレクトリとライブラリディレクトリを設定
include_directories(${Boost_INCLUDE_DIRS})

# ソースファイルを指定
set(SOURCES
    src/main.cpp
)

# 実行ファイルを生成
add_executable(BoostExecutable ${SOURCES})

# Boostライブラリをリンク
target_link_libraries(BoostExecutable ${Boost_LIBRARIES})

main.cpp

#include <boost/filesystem.hpp>
#include <iostream>

int main() {
    boost::filesystem::path path("/tmp");
    if (boost::filesystem::exists(path)) {
        std::cout << "Path exists!" << std::endl;
    } else {
        std::cout << "Path does not exist!" << std::endl;
    }
    return 0;
}

例3: カスタムビルドステップを含むプロジェクト

次に、カスタムビルドステップを含むC++プロジェクトの例です。このプロジェクトでは、ビルド後に特定のファイルをコピーするカスタムコマンドを使用します。

プロジェクト構造

CustomBuildProject/
├── CMakeLists.txt
├── src/
│   └── main.cpp
├── config/
│   └── config.txt

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(CustomBuildProject)

set(CMAKE_CXX_STANDARD 17)

# ソースファイルを指定
set(SOURCES
    src/main.cpp
)

# 実行ファイルを生成
add_executable(CustomExecutable ${SOURCES})

# ビルド後にconfig.txtをコピーするカスタムコマンドを追加
add_custom_command(TARGET CustomExecutable POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/config/config.txt ${CMAKE_BINARY_DIR}/config.txt)

main.cpp

#include <iostream>

int main() {
    std::cout << "Hello, Custom Build!" << std::endl;
    return 0;
}

実践的なプロジェクトの作成と管理

これらの例を基に、自分のプロジェクトにCMakeを適用してみましょう。CMakeの基本構文やコマンドを理解し、プロジェクトの規模や要求に応じて柔軟に構成を変更することで、効率的なビルドプロセスを実現できます。

次に、この記事の内容をまとめます。

まとめ

本記事では、CMakeを使用したC++プロジェクトの基本的な設定方法から、実践的な応用例までを詳しく解説しました。以下に、主要なポイントをまとめます。

  • CMakeの基本：CMakeは、クロスプラットフォームのビルドシステムであり、プロジェクトの依存関係やビルドプロセスを効率的に管理できます。
  • インストール方法：Windows、macOS、LinuxでのCMakeのインストール手順を説明しました。
  • CMakeLists.txtの基本構文：プロジェクトの開始、ソースファイルの指定、実行ファイルやライブラリの生成、コンパイルオプションの設定方法を紹介しました。
  • プロジェクトの初期設定：ディレクトリ構造の作成から、ビルドディレクトリの設定、CMakeの実行とビルドの手順を解説しました。
  • ターゲットの設定：実行ファイルやライブラリの作成方法、コンパイルオプションやインクルードディレクトリの設定方法を説明しました。
  • 外部ライブラリの追加：find_packageやadd_subdirectory、ExternalProjectモジュールを使用して外部ライブラリをプロジェクトに追加する方法を紹介しました。
  • ビルドと実行：ビルドディレクトリの作成、CMakeの実行、プロジェクトのビルドと実行方法を解説しました。
  • デバッグとエラー解決：デバッグビルドの設定方法や一般的なビルドエラーの解決策を説明しました。
  • CMakeの便利な機能：マルチプラットフォーム対応、カスタムコマンド、外部プロジェクトの管理、プロジェクトの設定とキャッシュ、ビルドタイプの設定、パッケージの生成について紹介しました。
  • 応用例と実践：シンプルなプロジェクト、外部ライブラリを使用したプロジェクト、カスタムビルドステップを含むプロジェクトの具体例を示し、実践的なCMakeの使用方法を解説しました。

これらの知識を基に、CMakeを使用して効率的なプロジェクト管理とビルドプロセスを実現しましょう。CMakeの活用によって、C++プロジェクトの開発が一層スムーズかつ生産的になることを願っています。

C++
プログラミング C++ CMake

コメント

コメントする

目次