CMake ディレクトリラベル： コードの整理整頓は CMAKE_DIRECTORY_LABELS にお任せ

CMakeのディレクトリラベル：CMAKE_DIRECTORY_LABELS

CMAKE_DIRECTORY_LABELS は CMake 3.10 以降で導入された変数で、現在のディレクトリにラベルを設定するために使用されます。

設定方法

CMAKE_DIRECTORY_LABELS は、以下の形式で設定できます。

set(CMAKE_DIRECTORY_LABELS label1 label2 ...)

ここで、label1 と label2 は、ディレクトリに関連付けるラベルです。 複数のラベルを設定する場合は、スペースで区切ります。

例

set(CMAKE_DIRECTORY_LABELS src tests)

この例では、現在のディレクトリに src と tests というラベルを設定しています。

使用例

CMAKE_DIRECTORY_LABELS は、以下の目的で使用できます。

• ターゲットの依存関係を制御する

target_sources コマンドで、ラベルを指定してターゲットのソースファイルを設定できます。

target_sources(my_target PUBLIC
    $<TARGET_OBJECTS:foo>
    $<FILES:src/*.cpp>
)

target_sources(my_test PRIVATE
    $<TARGET_OBJECTS:foo>
    $<FILES:tests/*.cpp>
)

この例では、my_target は src ディレクトリにあるソースファイルに依存し、my_test は tests ディレクトリにあるソースファイルに依存します。

• インストールディレクトリを制御する

install コマンドで、ラベルを指定してインストール先のディレクトリを設定できます。

install(FILES src/*.h DESTINATION include)
install(FILES tests/*.h DESTINATION tests)

この例では、src ディレクトリにあるヘッダーファイルは include ディレクトリにインストールされ、tests ディレクトリにあるヘッダーファイルは tests ディレクトリにインストールされます。

• カスタムコマンドを制御する

add_custom_command コマンドで、ラベルを指定してカスタムコマンドを実行するディレクトリを設定できます。

add_custom_command(
    TARGET my_target
    POST_BUILD
    COMMAND echo "Building target: ${TARGET_NAME}"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

add_custom_command(
    TARGET my_test
    POST_BUILD
    COMMAND echo "Testing target: ${TARGET_NAME}"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

この例では、my_target のビルド後と my_test のテスト後に、現在のソースディレクトリでメッセージを出力するカスタムコマンドを実行します。

注意事項

• CMAKE_DIRECTORY_LABELS は、CMake 3.10 以降でのみ使用できます。
• ラベル名は、英数字、アンダースコア、ハイフンのみ使用できます。
• ラベル名は、CMake キャッシュ内で一意である必要があります。

CMakeのディレクトリラベル：CMAKE_DIRECTORY_LABELS のサンプルコード

ターゲットの依存関係を制御する

set(CMAKE_DIRECTORY_LABELS src tests)

target_sources(my_target PUBLIC
    $<TARGET_OBJECTS:foo>
    $<FILES:src/*.cpp>
)

target_sources(my_test PRIVATE
    $<TARGET_OBJECTS:foo>
    $<FILES:tests/*.cpp>
)

インストールディレクトリを制御する

set(CMAKE_DIRECTORY_LABELS src tests)

install(FILES src/*.h DESTINATION include)
install(FILES tests/*.h DESTINATION tests)

この例では、src ディレクトリにあるヘッダーファイルは include ディレクトリにインストールされ、tests ディレクトリにあるヘッダーファイルは tests ディレクトリにインストールされます。

カスタムコマンドを制御する

set(CMAKE_DIRECTORY_LABELS src tests)

add_custom_command(
    TARGET my_target
    POST_BUILD
    COMMAND echo "Building target: ${TARGET_NAME}"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

add_custom_command(
    TARGET my_test
    POST_BUILD
    COMMAND echo "Testing target: ${TARGET_NAME}"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

この例では、my_target のビルド後と my_test のテスト後に、現在のソースディレクトリでメッセージを出力するカスタムコマンドを実行します。

複雑なディレクトリ構造

set(CMAKE_DIRECTORY_LABELS
    app
    app/gui
    app/backend
    tests
    tests/unit
    tests/integration
)

target_sources(my_app PUBLIC
    $<TARGET_OBJECTS:foo>
    $<FILES:app/gui/*.cpp>
    $<FILES:app/backend/*.cpp>
)

target_sources(my_test PRIVATE
    $<TARGET_OBJECTS:foo>
    $<FILES:tests/unit/*.cpp>
    $<FILES:tests/integration/*.cpp>
)

install(FILES app/gui/*.h DESTINATION include/app/gui)
install(FILES app/backend/*.h DESTINATION include/app/backend)
install(FILES tests/unit/*.h DESTINATION include/tests/unit)
install(FILES tests/integration/*.h DESTINATION include/tests/integration)

この例では、より複雑なディレクトリ構造と、それに基づいたターゲットの依存関係、インストールディレクトリ、カスタムコマンドの設定を示しています。

その他のサンプル

• ラベルを使用して、特定のディレクトリにあるファイルをビルドから除外する
• ラベルを使用して、特定のディレクトリにあるファイルにのみテストを実行する
• ラベルを使用して、特定のディレクトリにあるファイルにのみデバッグ情報を生成する

CMAKE_DIRECTORY_LABELS は、CMake でディレクトリを管理するための強力なツールです。 これを使用して、ターゲットの依存関係、インストールディレクトリ、カスタムコマンドなどを制御できます。

CMakeでディレクトリを管理するその他の方法

サブディレクトリ

最も単純な方法は、サブディレクトリを使用することです。

add_subdirectory(src)
add_subdirectory(tests)

この例では、src と tests ディレクトリはそれぞれサブディレクトリとして扱われ、CMake はこれらのディレクトリ内の CMakeLists.txt ファイルを自動的に検索します。

ファイルグループを使用して、特定のディレクトリにあるファイルをまとめて管理することができます。

file(GLOB_RECURSE SRCS src/*.cpp)
file(GLOB_RECURSE TESTS tests/*.cpp)

add_library(my_app ${SRCS})
add_executable(my_test ${TESTS})

この例では、SRCS と TESTS はそれぞれファイルグループであり、src ディレクトリと tests ディレクトリにあるすべての .cpp ファイルが含まれます。

ターゲットの属性を使用して、ターゲットのソースファイル、インストールディレクトリなどを制御することができます。

target_sources(my_app PUBLIC
    $<TARGET_OBJECTS:foo>
    $<FILES:src/*.cpp>
)

target_install(my_app
    RUNTIME DESTINATION bin
    LIBRARY DESTINATION lib
    ARCHIVE DESTINATION lib)

この例では、my_app ターゲットは src ディレクトリにあるすべての .cpp ファイルに依存し、bin ディレクトリに実行ファイル、lib ディレクトリに共有ライブラリとスタティックライブラリがインストールされます。

カスタムコマンドを使用して、特定のディレクトリにあるファイルに対して独自の処理を実行することができます。

add_custom_command(
    TARGET my_app
    POST_BUILD
    COMMAND echo "Building target: ${TARGET_NAME}"
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

この例では、my_app ターゲットがビルドされた後に、現在のソースディレクトリでメッセージを出力するカスタムコマンドを実行します。

どの方法を使用するかは、プロジェクトの規模と複雑さに依存します。 サブディレクトリは単純なプロジェクトに適していますが、複雑なプロジェクトにはファイルグループ、ターゲット属性、カスタムコマンドなどのより高度な方法が必要になる場合があります。