CMakeにおけるVS_WINRT_COMPONENTを使用したサンプルコード

CMakeにおける"VS_WINRT_COMPONENT"の詳細解説

"VS_WINRT_COMPONENT"は、CMakeでWindows向けRTコンポーネントをビルドする際に使用するプロパティです。このプロパティを設定することで、Visual Studioソリューションファイル (.sln) とプロジェクトファイル (.vcxproj) の生成に必要な情報を提供できます。

主な機能

• コンポーネントの種類を指定する
• コンポーネントのバージョンを指定する
• コンポーネントの依存関係を指定する
• コンポーネントのビルド設定を指定する

設定方法

"VS_WINRT_COMPONENT"は、ターゲットプロパティとして設定できます。以下の例は、"MyComponent"という名前のRTコンポーネントをビルドする例です。

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  ...)

詳細

以下の表は、"VS_WINRT_COMPONENT"プロパティの各オプションと、その意味をまとめたものです。

補足

• "VS_WINRT_COMPONENT"プロパティは、Visual Studio 2015以降でのみ使用できます。
• CMake 3.14以降では、"VS_WINRT_COMPONENT"プロパティは廃止予定となっています。代わりに、winrt::component()ヘルパー関数を使用することを推奨します。

CMakeにおける"VS_WINRT_COMPONENT"を使用したサンプルコード

シンプルなRTコンポーネント

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  ...)

依存関係を持つRTコンポーネント

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_sources(MyOtherComponent PRIVATE
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  VS_WINRT_COMPONENT_DEPENDENCIES "MyOtherComponent"
  ...)

target_properties(MyOtherComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyOtherComponent"
  VS_WINRT_COMPONENT_TYPE "library"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  ...)

複数のターゲットプラットフォームをサポートするRTコンポーネント

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  VS_WINRT_COMPONENT_TARGET_PLATFORM "x86;x64"
  ...)

複数のアーキテクチャをサポートするRTコンポーネント

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  VS_WINRT_COMPONENT_TARGET_ARCHITECTURE "arm;x86"
  ...)

追加ファイルを指定するRTコンポーネント

target_sources(MyComponent PRIVATE
  main.cpp
  ...)

target_properties(MyComponent PROPERTIES
  VS_WINRT_COMPONENT    "MyComponent"
  VS_WINRT_COMPONENT_TYPE "app"
  VS_WINRT_COMPONENT_VERSION "1.0.0"
  VS_WINRT_COMPONENT_ADDITIONAL_FILES "resources.xml"
  ...)

CMakeでRTコンポーネントをビルドする他の方法

winrt::component()ヘルパー関数を使用する

CMake 3.14以降では、winrt::component()ヘルパー関数を使用してRTコンポーネントをビルドすることができます。このヘルパー関数は、"VS_WINRT_COMPONENT"プロパティよりも簡潔で分かりやすいコードを書くことができます。

winrt::component(
  "MyComponent"
  "app"
  "1.0.0"
  {
    sources("main.cpp")
  }
)

手動でソリューションファイルとプロジェクトファイルを作成する

"VS_WINRT_COMPONENT"プロパティやwinrt::component()ヘルパー関数を使用せずに、手動でソリューションファイルとプロジェクトファイルを作成することもできます。この方法は、より細かい制御が必要な場合に役立ちます。

既存のビルドシステムを使用する

CMake以外にも、Visual StudioやMSBuildなどの既存のビルドシステムを使用してRTコンポーネントをビルドすることができます。

どの方法を選択するべきかは、ご自身のニーズとスキルレベルによって異なります。

• 初めてRTコンポーネントをビルドする場合は、"VS_WINRT_COMPONENT"プロパティを使用するのが最も簡単です。
• より簡潔で分かりやすいコードを書きたい場合は、winrt::component()ヘルパー関数を使用することを推奨します。
• より細かい制御が必要な場合は、手動でソリューションファイルとプロジェクトファイルを作成する必要があります。
• 既存のビルドシステムに慣れている場合は、そのビルドシステムを使用してRTコンポーネントをビルドすることができます。