在CMake中利用vcpkg配置C/C++环境

在CMake中利用vcpkg配置C/C++环境

许多复杂的开源项目常常依赖数个C/C++库，挨个配置依赖库是非常繁琐的劳动。所幸现在我们有了vcpkg，可以帮我们省去很多配置的劳动。

vcpkg是一个跨平台的C/C++库配置工具。它可以方便地下载、编译、管理大多数的开源库。
其使用方式在微软文档中有详细说明。

在CMake中启用vcpkg工具链

我们将vcpkg的路径为$VCPKG_ROOT，那么工具链文件vcpkg.cmake的全路径是$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake。

例如，在我的计算机上vcpkg放在E盘，那么工具链文件的路径是E:/vcpkg/scripts/buildsystems/vcpkg.cmake。

一般而言，使用命令行配置工具链更方便；但也可以使用图形界面配置；还可以直接在CMakeLists.txt文件中指定变量CMAKE_TOOLCHAIN_FILE。下面分别介绍这三种配置方式。

命令行配置

相比常规的CMake命令，添加选项-DCMAKE_TOOLCHAIN_FILE=以启用工具链：

cmake .. -DCMAKE_TOOLCHAIN_FILE=E:/vcpkg/scripts/buildsystems/vcpkg.cmake

需要注意，CMake的命令行选项中的等号两侧不能有空格。即

cmake .. -DCMAKE_TOOLCHAIN_FILE = E:/vcpkg/scripts/buildsystems/vcpkg.cmake

这样的写法是错误的。会产生报错：

CMake Error: Parse error in command line argument: CMAKE_TOOLCHAIN_FILE
Should be: VAR:type=value
CMake Error: Run ‘cmake --help’ for all supported options.

图形界面配置

有的开发者喜欢使用cmake-gui.exe来配置项目，其界面如下图所示。

点击“Configure”，弹出如下对话框：

选择“Specify toolchain file for cross-compiling”，点击Next，然后选择vcpkg.cmake的路径，如下图所示：

然后，点击“Finish”，完成工具链的设置，开始配置。

在CMakeLists.txt中配置

在CMakeLists.txt中的project()之前添加下面的语句：

set(CMAKE_TOOLCHAIN_FILE E:/vcpkg/scripts/buildsystems/vcpkg.cmake)

如果系统中设置了VCPKG_ROOT环境变量，则可以改成直接使用$ENV{VCPKG_ROOT}，以便在不同计算机上通用：

set(CMAKE_TOOLCHAIN_FILE $ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake)

这种方式等价于上面两种配置方式。

完整配置项

在vcpkg官方的教程中，推荐用户使用两个文件CMakePresets.json和CMakeUserPresets.json。将这两个文件放在CMakeLists.txt同级目录中，然后利用--preset=选项运行cmake .. --preset=default即可。它们的内容如下：

CMakePresets.json

{
  "version": 3,
  "configurePresets": [
    {
      "name": "vcpkg",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}

CMakeUserPresets.json

{
  "version": 3,
  "configurePresets": [
    {
      "name": "default",
      "inherits": "vcpkg",
      "environment": {
        "VCPKG_ROOT": "<path to vcpkg>"
      }
    }
  ]
}

扩展阅读

CMake的Presets机制
vcpkg in CMake projects
vcpkg-GitHub
教程：通过 CMake 安装和使用包