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下的实现。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,185评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,652评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,524评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,339评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,387评论 6 391
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,287评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,130评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,985评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,420评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,617评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,779评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,477评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,088评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,716评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,857评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,876评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,700评论 2 354

推荐阅读更多精彩内容