Vcpkg新增库简易指南

简介

Vcpkg使用的是cmake脚本来进行包配置，并且提供了几种常用的cmake方法来完成包构建及安装。

• vcpkg_download_distfile
• vcpkg_extract_source_archive
• vcpkg_execute_required_process
• vcpkg_execute_required_process_repeat
• vcpkg_find_acquire_program
• vcpkg_build_cmake
• vcpkg_build_msbuild
• vcpkg_install_cmake
• vcpkg_configure_cmake
• vcpkg_apply_patchs
• vcpkg_copy_pdbs

常规流程

1. 获取源代码
2. 配置
3. 构建
4. 安装

获取源代码

下载源代码包并解压

vcpkg_download_distfile的功能是从目标路径下载源代码包，参数如下：

• URLS 路径
• FILENAME 文件名
• SHA512 校验码

例如:

vcpkg_download_distfile(ARCHIVE
    URLS "https://github.com/miloyip/rapidjson/archive/879def80f2e466cdf4c86dc7e53ea2dd4cafaea0.zip"
    FILENAME "rapidjson-879def80f2e466cdf4c86dc7e53ea2dd4cafaea0.zip"
    SHA512 4d9ef7cce7d179344c33245c081a142ca5fcb2a0cc170ed39e3d0add008efab8e7389feec03e1ea83b30c5778cd0600865b08bc1c23592e5154dbe1f21f9547d
)

vcpkg_extract_source_archive的功能是解压缩源码包，示例如下：

vcpkg_extract_source_archive(${ARCHIVE})

从源代码服务器下载代码

vcpkg_execute_required_process的功能是执行命令，参数如下：

• COMMAND 命令
• WORKING_DIRECTORY 工作路径
• LOGNAME 日志名

从github上clone代码的示例如下:

find_program(GIT git)

set(GIT_URL "https://github.com/erincatto/Box2D.git")
set(GIT_REF "374664b")

if(NOT EXISTS "${DOWNLOADS}/box2d.git")
    message(STATUS "Cloning")
    vcpkg_execute_required_process(
        COMMAND ${GIT} clone --bare ${GIT_URL} ${DOWNLOADS}/box2d.git
        WORKING_DIRECTORY ${DOWNLOADS}
        LOGNAME clone
    )
endif(NOT EXISTS "${DOWNLOADS}/box2d.git")
message(STATUS "Cloning done")

配置

vcpkg_configure_cmake的功能是配置cmake选项,譬如在执行cmake构建时，指定Generator之类。

构建

vcpkg_build_cmake的功能是执行cmake构建；
vcpkg_build_msbuild的功能是执行msbuild构建。

安装

vcpkg_install_cmake的功能是执行cmake安装,通常指定了安装路径后即可；
vcpkg_copy_pdbs的功能是复制pdb到安装路径；

其它

vcpkg_find_acquire_program提供了 find_program方法用来安装所需应用程序到指定路径。
vcpkg_apply_patches用来合并源代码patch。

新增包

现在大部分开源库依赖都托管于github之上，并且一般采用cmake构建，新增一个常规的开源库，方法如下：
在vcpkg的ports路径下建立对应包名称文件夹，通常包含两个文件:CONTROL、portfile.cmake。

CONTROL文件

CONTROL文件用来指定包名称、版本及描述信息

Source: 包名称
Version: 版本
Description: 描述

portfile.cmake文件

portfile.cmake文件描述了整个包的下载、构建、按照全过程

# 导入vcpkg定义的方法
include(vcpkg_common_functions)
# 设置源代码路径 
set(SOURCE_PATH ${CURRENT_BUILDTREES_DIR}/src/@ROOT_NAME@)
# 下载源代码包
vcpkg_download_distfile(ARCHIVE 
   URLS "@URL@"
   FILENAME "@FILENAME@"
   SHA512 @SHA512@
)
# 解压源代码
vcpkg_extract_source_archive(${ARCHIVE})

# 配置cmake
vcpkg_configure_cmake(
   SOURCE_PATH ${SOURCE_PATH}
   #OPTIONS -DUSE_THIS_IN_ALL_BUILDS=1
 )

# 安装
vcpkg_install_cmake()

# 处理版权信息
#file(COPY ${SOURCE_PATH}/LICENSE DESTINATION ${CURRENT_PACKAGES_DIR}/share/@PORT@)
#file(RENAME ${CURRENT_PACKAGES_DIR}/share/@PORT@/LICENSE ${CURRENT_PACKAGES_DIR}/share/@PORT@/copyright)

注意事项

必须附加版权信息到指定位置；
SHA512信息可以随便填，报错之后会提示正确的，再将正确的填写上去；
由于使用的是cmake脚本，cmake本身的文件操作等方法都可以使用；
如果不知道vcpkg方法参数及使用方法，可以参考vcpkg/script/cmake下的实现。