【vcpkg】像Python一样方便的import 自己的c++库

简介: 使用此种方式可无需设置 CMAKE_TOOLCHAIN_FILE 即可使用 vcpkg,且更容易完成配置工作。

介绍vcpkg的背景

什么是vcpkg

vcpkg是一个开源的C++库管理工具,它可以帮助开发者在Windows、Linux和macOS等操作系统上快速安装和管理C++库。vcpkg支持超过1500个C++库,包括Boost、OpenSSL、SDL2等常用库。

vcpkg的历史和发展

vcpkg最初由微软开发,旨在为Visual Studio用户提供一个方便的C++库管理工具。随着vcpkg的不断发展,它已经成为了一个跨平台的C++库管理工具,并且得到了广泛的应用和支持。


vcpkg的优势和特点

  • vcpkg的优势和特点主要包括:


  • 支持多个操作系统和编译器
  • 支持超过1500个C++库
  • 支持自动解决依赖问题
  • 支持集成到项目中
  • 支持自定义安装选项

vcpkg的安装方法

支持的操作系统和编译器

vcpkg支持的操作系统和编译器包括:


  • Windows:Visual Studio 2015及以上版本、MSBuild、MinGW、Cygwin等
  • Linux:GCC、Clang等
  • macOS:Xcode、Clang等

安装vcpkg的步骤

安装vcpkg的步骤如下:


  1. 克隆vcpkg仓库:git clone https://github.com/microsoft/vcpkg.git
  2. 进入vcpkg目录:cd vcpkg
  3. 运行bootstrap脚本:./bootstrap-vcpkg.sh
  4. 安装vcpkg:./vcpkg install vcpkg

配置vcpkg的环境变量

配置vcpkg的环境变量可以让您在任何位置使用vcpkg命令。配置方法如下:


  1. 打开环境变量设置界面
  2. 新建一个名为VCPKG_ROOT的环境变量,值为vcpkg的根目录
  3. 将vcpkg的根目录添加到PATH环境变量中

vcpkg的使用示例

安装和管理库

安装和管理库是vcpkg的主要功能之一。您可以使用以下命令来安装和管理库:


  • ./vcpkg install :安装指定的库
  • ./vcpkg remove :卸载指定的库
  • ./vcpkg list:列出所有已安装的库
  • ./vcpkg search :搜索指定的库

例如,要安装Boost库,可以使用以下命令:


./vcpkg install boost


集成vcpkg到项目中

将vcpkg集成到项目中可以让您更方便地管理库的依赖关系。您可以使用以下命令来集成vcpkg到项目中:


./vcpkg integrate install


这将会自动将vcpkg的库目录添加到系统路径中,并生成一个vcpkg.json文件,用于描述项目的依赖关系。


解决依赖问题

vcpkg可以自动解决库的依赖关系,让您更方便地管理库的依赖关系。例如,要安装SDL2库及其依赖库,可以使用以下命令:


./vcpkg install --recurse sdl2


这将会自动安装SDL2库及其依赖库,并解决它们之间的依赖关系。


总结

vcpkg是一个非常方便的C++库管理工具,它可以帮助开发者快速安装和管理C++库。本文介绍了vcpkg的背景、安装方法和使用示例,希望能够帮助您更好地使用vcpkg。


下面是vcpkg的官方说明文档的翻译:


vcpkg 是什么

Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。 这个工具和生态链正在不断发展,我们一直期待您的贡献!


若您从未使用过 vcpkg,或者您正在尝试了解如何使用 vcpkg,请查阅 入门 章节。


如需获取有关可用命令的简短描述,请在编译 vcpkg 后执行 vcpkg help 或执行 vcpkg help [command] 来获取具体的帮助信息。


GitHub: https://github.com/microsoft/vcpkg

Slack: https://cppalliance.org/slack/, #vcpkg 频道

Discord: #include , #🌏vcpkg 频道

文档: Documentation

vcpkg 怎么用

入门

首先,请阅读以下任一快速入门指南: Windows 或 macOS 和 Linux, 这取决于您使用的是什么平台。


有关更多信息,请参见 安装和使用软件包。 如果 vcpkg 目录中没有您需要的库, 您可以 在 GitHub 上打开问题。 vcpkg 团队和贡献者可以看到它的地方, 并可能将这个库添加到 vcpkg。


安装并运行 vcpkg 后, 您可能希望将 TAB 补全 添加到您的 Shell 中。


最后,如果您对 vcpkg 的未来感兴趣,请查看 清单! 这是一项实验性功能,可能会出现错误。 因此,请尝试一下并打开所有问题!


快速开始: Windows

前置条件:


Windows 7 或更新的版本

Git

Visual Studio 2015 Update 3 或更新的版本(包含英文语言包)

首先,请使用 git clone vcpkg 并执行 bootstrap.bat 脚本。 您可以将 vcpkg 安装在任何地方,但是通常我们建议您使用 vcpkg 作为 CMake 项目的子模块,并将其全局安装到 Visual Studio 项目中。 我们建议您使用例如 C:\src\vcpkg 或 C:\dev\vcpkg 的安装目录,否则您可能遇到某些库构建系统的路径问题。


> git clone https://github.com/microsoft/vcpkg
> .\vcpkg\bootstrap-vcpkg.bat


使用以下命令安装您的项目所需要的库:


> .\vcpkg\vcpkg install [packages to install]


请注意: vcpkg 在 Windows 中默认编译并安装 x86 版本的库。 若要编译并安装 x64 版本,请执行:


> .\vcpkg\vcpkg install [package name]:x64-windows



> .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows


您也可以使用 search 子命令来查找 vcpkg 中集成的库:


> .\vcpkg\vcpkg search [search term]


若您希望在 Visual Studio 中使用 vcpkg,请运行以下命令 (可能需要管理员权限)


> .\vcpkg\vcpkg search [search term]


在此之后,您可以创建一个非 CMake 项目 (或打开已有的项目)。 在您的项目中,所有已安装的库均可立即使用 #include 包含您需使用的库的头文件且无需额外配置。


若您在 Visual Studio 中使用 CMake 工程,请查阅这里。


为了在 IDE 以外在 CMake 中使用 vcpkg,您需要使用以下工具链文件:


> cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
> cmake --build [build directory]

1

2

在 CMake 中,您仍需通过 find_package 来使用 vcpkg 中已安装的库。 请查阅 CMake 章节 获取更多信息,其中包含了在 IDE 中使用 CMake 的内容。


对于其他工具 (包括 Visual Studio Code),请查阅 集成指南。


快速开始: Unix

Linux平台前置条件:


Git

g++ >= 6

macOS 平台前置条件:


Apple Developer Tools

首先,请使用 git clone vcpkg 并执行 bootstrap.sh 脚本。 我们建议您将 vcpkg 作为 CMake 项目的子模块使用。


$ git clone https://github.com/microsoft/vcpkg
$ ./vcpkg/bootstrap-vcpkg.sh


使用以下命令安装任意包:


$ ./vcpkg/vcpkg install [packages to install]

您也可以使用 search 子命令来查找 vcpkg 中已集成的库:


$ ./vcpkg/vcpkg search [search term]

为了在 CMake 中使用 vcpkg,您需要使用以下工具链文件:


$ cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
$ cmake --build [build directory]


在 CMake 中,您仍需通过 find_package 来使用 vcpkg 中已安装的库。 为了您更好的在 CMake 或 VSCode CMake Tools 中使用 vcpkg, 请查阅 CMake 章节 获取更多信息, 其中包含了在 IDE 中使用 CMake 的内容。


对于其他工具,请查阅 集成指南。


安装 Linux Developer Tools

在 Linux 的不同发行版中,您需要安装不同的工具包:


Debian,Ubuntu,popOS 或其他基于 Debian 的发行版:

$ sudo apt-get update
$ sudo apt-get install build-essential tar curl zip unzip


CentOS
$ sudo yum install centos-release-scl
$ sudo yum install devtoolset-7
$ scl enable devtoolset-7 bash


对于其他的发行版,请确保已安装 g++ 6 或更新的版本。 若您希望添加特定发行版的说明,请提交一个 PR!


安装 macOS Developer Tools

在 macOS 中,您唯一需要做的是在终端中运行以下命令:


$ xcode-select --install


后按照出现的窗口中的提示进行操作。 此时,您就可以使用 bootstrap.sh 编译 vcpkg 了。 请参阅 快速开始


在 CMake 中使用 vcpkg

若您希望在 CMake 中使用vcpkg,以下内容可能帮助您:


Visual Studio Code 中的 CMake Tools

将以下内容添加到您的工作区的 settings.json 中将使 CMake Tools 自动使用 vcpkg 中的第三方库:


{
  "cmake.configureSettings": {
    "CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
  }
}


Visual Studio CMake 工程中使用 vcpkg

打开 CMake 设置选项,将 vcpkg toolchain 文件路径在 CMake toolchain file 中:


[vcpkg root]/scripts/buildsystems/vcpkg.cmake


CLion 中使用 vcpkg

打开 Toolchains 设置 (File > Settings on Windows and Linux, CLion > Preferences on macOS), 并打开 CMake 设置 (Build, Execution, Deployment > CMake)。 最后在 CMake options 中添加以下行:


-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake


遗憾的是,您必须手动将此选项加入每个项目配置文件中。


将 vcpkg 作为一个子模块

当您希望将 vcpkg 作为一个子模块加入到您的工程中时, 您可以在第一个 project() 调用之前将以下内容添加到 CMakeLists.txt 中, 而无需将 CMAKE_TOOLCHAIN_FILE 传递给 CMake 调用。


set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
  CACHE STRING "Vcpkg toolchain file")


使用此种方式可无需设置 CMAKE_TOOLCHAIN_FILE 即可使用 vcpkg,且更容易完成配置工作。


Tab 补全/自动补全

vcpkg 支持命令,包名称,以及 Powershell 和 Bash 中的选项。 若您需要在指定的 shell 中启用 Tab 补全功能,请依据您使用的 shell 运行:


> .\vcpkg integrate powershell



$ ./vcpkg integrate bash # 或 zsh


然后重新启动控制台。


示例

请查看 文档 获取具体示例, 其包含 安装并使用包, 使用压缩文件添加包 和 从 GitHub 源中添加一个包。


我们的文档现在也可以从 vcpkg.io 在线获取。 我们真诚的希望您向我们提出关于此网站的任何建议! 请在这里 创建 issue.


观看 4 分钟 demo 视频。


贡献

Vcpkg是一个开源项目,并通过您的贡献不断发展。 下面是一些您可以贡献的方式:


提交一个关于 vcpkg 或已支持包的新 issue

提交修复 PR 和创建新包

请参阅我们的 贡献准则 了解更多详细信息。


该项目采用了 Microsoft 开源行为准则。 获取更多信息请查看 行为准则 FAQ 或联系 opencode@microsoft.com 提出其他问题或意见。


开源协议

在此存储库中使用的代码均遵循 MIT License。


数据收集

vcpkg 会收集使用情况数据,以帮助我们改善您的体验。 Microsoft 收集的数据是匿名的。 您也可以通过以下步骤禁用数据收集:


将选项 -disableMetrics 传递给 bootstrap-vcpkg 脚本并重新运行此脚本

向 vcpkg 命令传递选项 --disable-metrics

设置环境变量 VCPKG_DISABLE_METRICS

请在 privacy.md 中了解有关 vcpkg 数据收集的更多信息。

目录
相关文章
|
2天前
|
调度 开发者 网络架构
探索Python中的异步编程:深入理解asyncio库
【9月更文挑战第32天】在现代软件开发中,异步编程已成为提升性能和响应性的关键策略之一。本文将深入探讨Python的asyncio库,一个强大的异步I/O框架,它允许开发者编写单线程并发代码,同时处理多个任务而无需复杂的多线程或多进程编程。通过本文,你将学习到如何利用asyncio来构建高效、可扩展的应用程序,并了解其背后的原理和设计哲学。
7 2
|
6天前
|
编译器 API C语言
超级好用的C++实用库之跨平台实用方法
超级好用的C++实用库之跨平台实用方法
19 6
|
6天前
|
安全 C++
超级好用的C++实用库之环形内存池
超级好用的C++实用库之环形内存池
21 5
|
5天前
|
数据挖掘 Python
【Python】应用:pyproj地理计算库应用
这篇博客介绍了 `pyproj` 地理计算库的应用,涵盖地理坐标系统转换与地图投影。通过示例代码展示了如何进行经纬度与UTM坐标的互转,并利用 `pyproj.Geod` 计算两点间的距离及方位角,助力地理数据分析。 安装 `pyproj`:`pip install pyproj`。更多内容欢迎关注本博客,一起学习进步! Pancake 🍰 不迷路。😉*★,°*:.☆( ̄▽ ̄)/$:*.°★* 😏
10 1
|
6天前
|
缓存 网络协议 Linux
超级好用的C++实用库之套接字
超级好用的C++实用库之套接字
19 1
|
6天前
|
存储 算法 安全
超级好用的C++实用库之sha256算法
超级好用的C++实用库之sha256算法
12 1
|
6天前
|
存储 算法 安全
超级好用的C++实用库之国密sm4算法
超级好用的C++实用库之国密sm4算法
16 0
|
6天前
|
网络协议 Linux C++
超级好用的C++实用库之网络
超级好用的C++实用库之网络
16 0
|
6天前
|
算法 安全 Serverless
超级好用的C++实用库之国密sm3算法
超级好用的C++实用库之国密sm3算法
12 0
|
6天前
|
数据挖掘 API 数据处理
Python 数据分析及预处理常用库
Python自身数据分析功能有限,需借助第三方库增强。常用库包括NumPy、pandas、Matplotlib等。NumPy由Numeric发展而来,提供了多维数组对象及各种API,支持高效的数据处理,如数学、逻辑运算等,常作为其他高级库如pandas和Matplotlib的依赖库。其内置函数处理速度极快,建议优先使用以提升程序效率。
7 0
下一篇
无影云桌面