CMAKE_MODULE_PATH と find_package を活用して Visual Studio SDK をプロジェクトに含める

CMAKE_VS_SDK_SOURCE_DIRECTORIES は、Visual Studio SDK のソースディレクトリを指定するために使用される CMake 変数です。デフォルトでは、Visual Studio は SDK のソースファイルを検索するために既定の場所を使用します。しかし、この変数を使用することで、CMake プロジェクト内で独自のソースディレクトリを指定することができます。

バージョン:

この変数は CMake 3.12 で導入されました。

設定方法:

この変数は、cmake-gui などの CMake GUI ツールを使用して設定することができます。また、CMakeLists.txt ファイルで以下のコードを使用して設定することもできます。

set(CMAKE_VS_SDK_SOURCE_DIRECTORIES
  "C:/path/to/source/directory1"
  "C:/path/to/source/directory2"
)

使用例:

この変数は、Visual Studio SDK のソースファイルに依存するカスタムビルドターゲットを作成する場合に役立ちます。例えば、以下のようなコードを使用して、SDK のソースファイルから静的ライブラリを作成するビルドターゲットを作成することができます。

add_library(my_library STATIC
  ${CMAKE_VS_SDK_SOURCE_DIRECTORIES}/my_library.cpp
)

注意事項:

• この変数は、Visual Studio でのみ使用できます。
• この変数を設定する前に、CMAKE_VS_SDK_LOCATION 変数が設定されていることを確認してください。
• この変数は、Visual Studio のバージョンによって異なる場合があります。詳細は、Visual Studio のドキュメントを参照してください。

補足:

• この変数は、Visual Studio 2015 以降で使用できます。
• この変数を設定すると、Visual Studio IDE でプロジェクトを開いたときに、指定されたソースディレクトリが "ソリューション エクスプローラー" に表示されます。

この解説が、CMAKE_VS_SDK_SOURCE_DIRECTORIES 変数の理解に役立つことを願っています。

CMAKE_VS_SDK_SOURCE_DIRECTORIES 変数を使用したサンプルコード

set(CMAKE_VS_SDK_SOURCE_DIRECTORIES
  "C:/path/to/sdk1/source"
  "C:/path/to/sdk2/source"
)

SDK ソースファイルに依存するカスタムビルドターゲットを作成する

add_library(my_library STATIC
  ${CMAKE_VS_SDK_SOURCE_DIRECTORIES}/my_library.cpp
)

Visual Studio ソリューションファイルに SDK ソースディレクトリを追加する

set(CMAKE_VS_SOLUTION_FOLDERS
  ${CMAKE_VS_SDK_SOURCE_DIRECTORIES}
)

Visual Studio プロジェクトファイルに SDK ソースファイルを追加する

set(CMAKE_VS_PROJECT_SOURCES
  ${CMAKE_VS_SDK_SOURCE_DIRECTORIES}/my_library.cpp
)

Visual Studio プロジェクトファイルに SDK ヘッダーファイルを追加する

set(CMAKE_VS_PROJECT_INCLUDE_DIRECTORIES
  ${CMAKE_VS_SDK_SOURCE_DIRECTORIES}/include
)

CMAKE_VS_SDK_SOURCE_DIRECTORIES 変数を使用しない方法

Visual Studio の既定の場所を使用する

Visual Studio は、SDK のソースファイルを検索するために既定の場所を使用します。これらの場所は、Visual Studio のバージョンによって異なりますが、通常は以下のとおりです。

• Visual Studio 2015 以降: %ProgramFiles(x86)%\\Microsoft Visual Studio\\2017\\Professional\\SDK\\Windows\\v10.0.10586\\Include
• Visual Studio 2013: %ProgramFiles(x86)%\\Microsoft Visual Studio 12.0\\SDK\\Windows\\v8.1\\Include

プロジェクトでこれらの場所を使用するには、#include ディレクティブを使用して SDK ヘッダーファイルを直接参照する必要があります。

CMAKE_MODULE_PATH 変数を使用して、SDK のソースファイルを含むディレクトリを指定することができます。この方法は、SDK のソースファイルが複数のディレクトリに分散している場合に役立ちます。

set(CMAKE_MODULE_PATH
  ${CMAKE_MODULE_PATH}
  "C:/path/to/sdk/source"
)

プロジェクトでこの方法を使用するには、find_package コマンドを使用して SDK を検索する必要があります。

カスタムビルドターゲットを作成する

SDK のソースファイルから静的ライブラリなどのビルドアーティファクトを作成するカスタムビルドターゲットを作成することができます。この方法は、SDK のソースファイルをプロジェクトに含めたくない場合に役立ちます。

add_custom_command(
  TARGET my_target
  COMMAND ${CMAKE_COMMAND} -E copy
  ARGS "C:/path/to/sdk/source/my_library.cpp"
  "C:/path/to/build/my_library.cpp"
)

add_library(my_library STATIC
  "C:/path/to/build/my_library.cpp"
)