在 VS Code 中试用

Linux 上 CMake Tools 入门

CMake 是一个开源的跨平台工具,它使用独立于编译器和平台的配置文件来生成特定于你的编译器和平台的原生构建工具文件。

CMake Tools 扩展集成了 Visual Studio Code 和 CMake,以便轻松配置、构建和调试 C++ 项目。

在本教程中,你将使用 Visual Studio Code 的 CMake Tools 扩展在 Linux 上配置、构建和调试一个简单的 C++ CMake 项目。除了安装 CMake、你的编译器、调试器和构建工具之外,本教程中的步骤通常适用于在其他平台(如 Windows)上使用 CMake 的方式。

如果遇到任何问题,请在VS Code 文档存储库中为此教程提交一个问题。此外,有关 CMake Tools 的更多信息,请参阅Visual Studio Code 的 CMake Tools 文档

先决条件

要在 Ubuntu 上完成本教程,请安装以下内容:

  1. Visual Studio Code.

  2. 适用于 VS Code 的 C++ 扩展。通过在扩展视图(⇧⌘X (Windows、Linux Ctrl+Shift+X))中搜索“c++”来安装 C/C++ 扩展。

    C/C++ extension

  3. 适用于 VS Code 的 CMake Tools 扩展。通过在扩展视图(⇧⌘X (Windows、Linux Ctrl+Shift+X))中搜索“CMake tools”来安装 CMake Tools 扩展。

    CMake tools extension

  4. 你还需要安装 CMake、编译器、调试器和构建工具。

视频:什么是构建系统?如何将 CMake 添加到项目中?

观看此视频以了解构建系统何时能帮助你,以及如何为项目设置 CMake,或者按照以下章节中的步骤操作。

确保已安装 CMake

VS Code CMake Tools 扩展通过使用系统上安装的 CMake 来工作。为获得最佳结果,请使用 CMake 3.27 或更高版本。

查看你的系统上是否已安装 CMake。打开终端窗口并输入以下命令:

cmake --version

要安装 CMake,或者在你没有至少 3.27 版本时获取更高版本,请参阅 Kitware APT 存储库中针对你的平台的说明。安装 3.27 或更高版本。

确保已安装开发工具

尽管你将使用 VS Code 编辑源代码,但你将使用系统上安装的编译器、调试器和构建工具(例如 make)来编译和调试源代码。

对于本 Ubuntu 教程,我们将使用 GCC 编译器、GDB 进行调试,并使用 make 构建项目。这些工具在 Ubuntu 上默认未安装,因此你需要安装它们。幸运的是,这很简单。

检查是否安装了 GCC

要查看你的系统上是否已安装 GCC,请打开终端窗口并输入以下命令:

gcc -v

如果未安装 GCC,请从终端窗口运行以下命令以更新 Ubuntu 包列表。过时的 Linux 发行版可能会干扰获取最新软件包。

sudo apt-get update

接下来,使用此命令安装 GNU 编译器、make 和 GDB 调试器:

sudo apt-get install build-essential gdb

创建 CMake 项目

如果你没有现有的 CMake 项目,请按照创建 CMake 项目中的步骤操作。

如果你已经有一个在根目录中包含 CMakeLists.txt 文件的现有 CMake 项目,请继续阅读配置 Hello World 以配置你的项目。

配置 Hello World

在使用 CMake Tools 扩展构建项目之前,你需要对其进行配置以了解系统上的编译器。在 VS Code 中配置 CMake 有两种方法:

  • 使用 CMake 预设 (推荐)
  • 使用 CMake 套件/变体

使用 CMake 预设进行配置

我们建议使用 CMake 预设来管理你的 CMake 配置。CMake 预设允许你指定一个通用的 JSON 文件,其中存储了项目的所有配置。然后,你可以在不同的 IDE 和不同的操作系统之间与他人共享此文件。

如果你按照创建 CMake 项目中的步骤创建了项目,则你的项目已配置为使用 CMake 预设。

如果你的项目有 CMakePresets.json 文件,你可以使用配置和构建预设来指定如何在你的计算机上构建项目。

你可以在 CMake Tools 视图的项目状态部分中的配置构建节点下查看预设的活动配置。你可以随时选择这些节点来设置或更改你的配置和构建预设。

CMake Side Panel with presets

你还可以通过在命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))中运行CMake: 选择配置预设CMake: 选择构建预设命令来设置任何预设。

CMake Select presets

使用 CMake 套件进行配置

如果你的项目没有 CMakePresets.json 文件,你需要使用套件。套件表示工具链,即用于构建项目的编译器、链接器和其他工具。

扫描套件:

  1. 打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 选择一个套件。扩展会自动扫描你的计算机上的套件,并创建一个系统上找到的编译器列表。

  2. 选择要使用的编译器。例如,根据你安装的编译器,你可能会看到如下内容:

    Select the kit

    你之前选择的套件现在显示在 CMake Tools 视图的项目状态部分。

    Selected kit in Sidebar

要更改套件,你可以在 CMake Tools 视图的项目状态部分中选择套件,或者再次从命令面板运行CMake: 选择一个套件命令。如果你没有看到你正在寻找的编译器,你可以在项目中编辑 cmake-tools-kits.json 文件。要编辑该文件,请打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 编辑用户本地 CMake 套件命令。

然后,你需要选择一个变体。

变体包含有关如何构建项目的说明。默认情况下,CMake Tools 扩展提供了四种变体,每种都对应一个默认构建类型:DebugReleaseMinRelSizeRelWithDebInfo。这些选项执行以下操作:

Debug:禁用优化并包含调试信息。Release:包含优化但不包含调试信息。MinRelSize:针对大小进行优化。不包含调试信息。RelWithDebInfo:针对速度进行优化并包含调试信息。

要选择一个变体,请打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 选择变体命令。

Select variant

选择Debug 以在构建中包含调试信息。

Select debug variant type

选定的变体将显示在状态栏中,活动套件旁边。

CMake: 配置

现在你已通过预设或套件/变体选择了配置设置,请打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 配置命令来配置你的项目。这将使用你选择的配置在项目的构建文件夹中生成构建文件。

构建 Hello World

配置项目后,你就可以构建了。打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 构建命令,或者从状态栏中选择构建按钮。

Build

你可以通过从命令面板中选择CMake: 设置构建目标来选择要构建的目标。默认情况下,CMake Tools 会构建所有目标。选定的目标将显示在 CMake Tools 侧边栏中构建节点下的项目状态视图中,也可以从那里进行设置。

Build Target

调试 Hello World

要运行和调试你的项目,请打开 main.cpp 并在 std::cout 行上设置一个断点。然后打开命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))并运行CMake: 调试。调试器将停在 std::cout 行。

Debug

继续并按下 F5 以继续。

你现在已使用 VS Code CMake Tools 扩展在 Ubuntu 上使用 CMake 构建和调试 C++ 应用。其他平台的步骤相同;区别在于你如何为你选择的平台安装 CMake 和编译器/调试器。有关为其他平台设置编译器/调试器的说明,请参阅以下内容:

后续步骤