vcpkg_cmake_configure

[アーティクル]
01/10/2024

CMake ベースのプロジェクトを構成します。

使用方法

vcpkg_cmake_configure(
    SOURCE_PATH <source-path>
    [DISABLE_PARALLEL_CONFIGURE]
    [NO_CHARSET_FLAG]
    [WINDOWS_USE_MSBUILD]
    [GENERATOR <generator>]
    [LOGFILE_BASE <logname-base>]
    [OPTIONS
        <configure-setting>...]
    [OPTIONS_RELEASE
        <configure-setting>...]
    [OPTIONS_DEBUG
        <configure-setting>...]
    [MAYBE_UNUSED_VARIABLES
        <option-name>...]
)

この関数を使用するには、ヘルパーポート vcpkg-cmakeに依存する必要があります。

"dependencies": [
  {
    "name": "vcpkg-cmake",
    "host": true
  }
]

パラメーター

SOURCE_PATH

を含むディレクトリを CMakeLists.txt指定します。

この値は、通常、次のような vcpkg_from_github()ソース取得コマンドを呼び出した結果として取得されます。

DISABLE_PARALLEL_CONFIGURE

CMake 構成ステップの並列実行を無効にします。

既定では、vcpkg は (文書化されていない CMake フラグ CMAKE_DISABLE_SOURCE_CHANGESを使用して) ソースディレクトリへの書き戻しを無効にし、(Windows の場合) リリースとデバッグを並列で構成します。このフラグは、ソースディレクトリの書き込みを許可し、構成手順を順番に実行するように vcpkg に指示します。

NO_CHARStandard EditionT_FLAG

組み込みの Windows ツールチェーンを使用するときに渡し/utf-8を無効にします。

これは、MSVC をターゲットにするときに独自のソースコードの文字セットを設定するライブラリに必要です。詳細については、 MSVC のドキュメントを /utf-8 参照してください。

WINDOWS_UStandard Edition_MSBUILD

Windows プラットフォームを対象とする場合は、別のジェネレーターの代わりに MSBuild を使用します。

既定では、vcpkg は、すべてのプラットフォームの CMake ジェネレーターとして Ninja を使用することを好みます。ただし、MSBuild の動作が Ninja とは異なるエッジケースがあります。このフラグは、プロジェクトで MSBuild を正しくビルドする必要がある場合にのみ渡す必要があります。このフラグは MinGW ターゲットには影響しません。

ジェネレーター

使用するジェネレーターを指定します。

既定では、vcpkg では、すべてのプラットフォームで CMake ジェネレーターとして Ninja を使用し、Ninja を使用できない場合は Windows 以外のプラットフォームの場合は "Unix Makefiles" を使用します。このパラメーターは、プロジェクト固有のビルドシステムが特定のジェネレーターに依存するエッジケースに使用できます。

LOGFILE_BAStandard Edition

構成ログの代替ルート名。

既定値は config-${TARGET_TRIPLET} です。パス区切り記号は含めないようにしてください。パターンに一致するログが生成されます ${CURRENT_BUILDTREES_DIR}/${LOGFILE_BASE}-<suffix>.log

OPTIONS

構成中に CMake に渡す追加のオプション。

暗黙的なオプションも参照してください。

OPTIONS_RELEAStandard Edition

リリース構成中に CMake に渡す追加のオプション。

これらに加えて OPTIONS.

OPTIONS_DEBUG

デバッグ構成中に CMake に渡す追加のオプション。

これらに加えて OPTIONS.

MAYBE_UNUStandard EditionD_VARIABLES

構成手順中に読み取られない可能性がある CMake オプションの一覧。

vcpkg は、CMake 構成手順中に読み取られないオプションについて、このリストの外部にあるオプションについて警告します。この一覧には、特定の構成中 (特定の機能が有効な場合 VCPKG_LIBRARY_LINKAGE など) にのみ読み取るオプションが "static" 含まれている必要があります。

暗黙的なオプション

このコマンドは、CMake にいくつかのオプションを自動的に提供します。

CMAKE_BUILD_TYPEが設定されているか、必要"Debug"に"Release"応じて設定されます。
BUILD_SHARED_LIBS の値 VCPKG_LIBRARY_LINKAGEに従って設定されます。
CMAKE_INSTALL_PREFIX=${CURRENT_PACKAGES_DIR}</debug> 構成に応じて
CMAKE_TOOLCHAIN_FILEvcpkg VCPKG_CHAINLOAD_TOOLCHAIN_FILE ツールチェーンファイルとトリプレットツールチェーンを含むように設定されます。
CMAKE_SYSTEM_NAME=${VCPKG_CMAKE_SYSTEM_NAME}. 設定が解除されている場合 VCPKG_CMAKE_SYSTEM_NAME 、既定値は "Windows".
CMAKE_SYSTEM_VERSION=${VCPKG_CMAKE_SYSTEM_VERSION} が設定されている場合 VCPKG_CMAKE_SYSTEM_VERSION は。
CMAKE_EXPORT_NO_PACKAGE_REGISTRY=ON
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY=ON
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY=ON
CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP=TRUE
CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION=ON
CMAKE_INSTALL_LIBDIR:STRING=lib
CMAKE_INSTALL_BINDIR:STRING=bin
FETCHCONTENT_FULLY_DISCONNECTED=ON (バージョン 2022-10-30 以降)

また、このコマンドは、すべてのオプション VCPKG_CMAKE_CONFIGURE_OPTIONS と構成固有のオプションを以下から VCPKG_CMAKE_CONFIGURE_OPTIONS_RELEASE 渡します VCPKG_CMAKE_CONFIGURE_OPTIONS_DEBUG。

最後に、依存すべきでない追加の内部オプションが渡されます (プレフィックス付 VCPKG_ き)。

例

vcpkg_from_github(OUT_SOURCE_PATH source_path ...)
vcpkg_cmake_configure(
    SOURCE_PATH "${source_path}"
    OPTIONS
        -DBUILD_EXAMPLES=OFF
        -DBUILD_TESTS=OFF
)
vcpkg_cmake_install()

例について microsoft/vcpkg を検索する

解説

このコマンドは vcpkg_configure_cmake().

ソース

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

次の方法で共有