– 代理会话日,2月19日

使用 GCC 与 MinGW

在本教程中,您将配置 Visual Studio Code 以使用来自 mingw-w64 的 GCC C++ 编译器 (g++) 和 GDB 调试器,以创建在 Windows 上运行的程序。配置 VS Code 后,您将编译、运行和调试一个 Hello World 程序。

本教程不会教您关于 GCC、GDB、minGW-w64 或 C++ 语言的知识。对于这些主题,网络上有许多优秀的资源可用。

如果您遇到任何问题,请随时在此教程的 VS Code 文档仓库 中提交 issue。

先决条件

要成功完成本教程,你必须执行以下步骤

  1. 安装 Visual Studio Code

  2. 安装 VS Code 的 C/C++ 扩展。您可以通过在扩展视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 中搜索 'C++' 来安装 C/C++ 扩展。

    C/C++ extension

安装 MinGW-w64 工具链

通过 MSYS2 获取最新版本的 MinGW-w64,它提供 GCC、MinGW-w64 和其他有用的 C++ 工具和库的最新原生构建。这将为您提供编译代码、调试代码以及将其配置为与 IntelliSense 协同工作所需的工具。

要安装 MinGW-w64 工具链,请观看此视频或按照以下步骤操作

  1. 您可以从 MSYS2 页面下载最新的安装程序,或使用此 安装程序的直接链接

  2. 运行安装程序并按照安装向导的步骤操作。请注意,MSYS2 需要 64 位 Windows 8.1 或更高版本。

  3. 在向导中,选择您所需的安装文件夹。稍后记录此目录。在大多数情况下,建议的目录是可以接受的。当您到达设置开始菜单快捷方式步骤时,情况也是如此。完成操作后,确保选中 立即运行 MSYS2 复选框,然后选择 完成。这将为您打开一个 MSYS2 终端窗口。

  4. 在此终端中,通过运行以下命令安装 MinGW-w64 工具链

    pacman -S --needed base-devel mingw-w64-ucrt-x86_64-toolchain
    
  5. 通过按 Enter 接受 toolchain 组中的默认软件包数量。

    MYSS2 Installer

  6. 当提示是否继续安装时,输入 Y

  7. 通过以下步骤将 MinGW-w64 bin 文件夹的路径添加到 Windows PATH 环境变量

    1. 在 Windows 搜索栏中,键入 设置 以打开您的 Windows 设置。
    2. 搜索 编辑您的帐户的环境变量
    3. 在您的 用户变量 中,选择 Path 变量,然后选择 编辑
    4. 选择 新建 并将安装过程中记录的 MinGW-w64 目标文件夹添加到列表中。如果您使用了上述默认设置,则此路径为:C:\msys64\ucrt64\bin
    5. 选择 确定,然后在 环境变量 窗口中再次选择 确定 以更新 PATH 环境变量。您必须重新打开任何控制台窗口才能使更新的 PATH 环境变量可用。

检查您的 MinGW 安装

要检查您的 MinGW-w64 工具是否正确安装并可用,请打开一个 新的 命令提示符并键入

gcc --version
g++ --version
gdb --version

您应该看到输出,其中说明您安装了哪些版本的 GCC、g++ 和 GDB。如果不是这种情况

  1. 确保您的 PATH 变量条目与安装工具链的 MinGW-w64 二进制位置匹配。如果编译器不存在于该 PATH 条目中,请确保您已遵循先前的说明。
  2. 如果 gcc 具有正确的输出但 gdb 没有,则需要从 MinGW-w64 工具集中安装缺少的软件包。
    • 如果在编译时收到“miDebuggerPath 的值无效”消息,则可能的原因是您缺少 mingw-w64-gdb 软件包。

创建一个 Hello World 应用

首先,让我们设置一个项目。

  1. 启动 Windows 命令提示符(在 Windows 搜索栏中输入 Windows 命令提示符)。
  2. 运行以下命令。这些命令将创建一个名为 projects 的空文件夹,您可以在其中放置所有 VS Code 项目。然后,接下来的命令将在 helloworld 子文件夹中创建并导航到该文件夹。从那里,您将直接在 VS Code 中打开 helloworld
mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

“code .” 命令在当前工作文件夹中打开 VS Code,该文件夹将成为您的“工作区”。接受 工作区信任 对话框,选择 是,我信任作者,因为您创建了此文件夹。

在浏览教程的过程中,您将在工作区的 .vscode 文件夹中看到创建了三个文件

  • tasks.json(生成说明)
  • launch.json(调试器设置)
  • c_cpp_properties.json(编译器路径和 IntelliSense 设置)

添加 Hello World 源代码文件

在“文件资源管理器”标题栏中,选择新建文件按钮并将文件命名为 helloworld.cpp

New File title bar button

添加 Hello World 源代码

现在粘贴以下源代码

#include <iostream>
#include <vector>
#include <string>

using namespace std;

int main()
{
    vector<string> msg {"Hello", "C++", "World", "from", "VS Code", "and the C++ extension!"};

    for (const string& word : msg)
    {
        cout << word << " ";
    }
    cout << endl;
}

现在按 ⌘S (Windows、Linux 为 Ctrl+S) 保存文件。请注意,你刚刚添加的文件出现在 VS Code 侧边栏的文件资源管理器视图 (⇧⌘E (Windows、Linux 为 Ctrl+Shift+E)) 中

File Explorer

您还可以启用 自动保存 以自动保存您的文件更改,方法是选择 文件 > 自动保存。您可以在 VS Code 的 用户界面文档 中了解有关其他视图的更多信息。

注意:当你保存或打开 C++ 文件时,你可能会看到来自 C/C++ 扩展的关于 Insiders 版本可用性的通知,该版本可让你测试新功能和修复。你可以通过选择 X清除通知)来忽略此通知。

探索 IntelliSense

IntelliSense 是一种工具,可帮助您更快、更高效地编写代码,方法是添加代码编辑功能,例如代码完成、参数信息、快速信息和成员列表。

要查看 IntelliSense 的实际效果,请将鼠标悬停在 vectorstring 上以查看其类型信息。如果您在第 10 行键入 msg.,您将看到一个推荐成员函数的完成列表,所有这些都由 IntelliSense 生成

Statement completion IntelliSense

您可以按 Tab 键插入选定的成员。如果您然后添加打开括号,IntelliSense 将显示需要哪些参数。

如果 IntelliSense 尚未配置,请打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并输入 选择 IntelliSense 配置。从编译器下拉列表中,选择 Use gcc.exe 进行配置。有关详细信息,请参阅 IntelliSense 配置文档

运行 helloworld.cpp

请记住,C++ 扩展使用您机器上安装的 C++ 编译器来构建您的程序。在尝试在 VS Code 中运行和调试 helloworld.cpp 之前,请确保您已完成“安装 MinGW-w64 工具链”步骤。

  1. 打开 helloworld.cpp,使其成为活动文件。

  2. 单击编辑器右上角的播放按钮。

    Screenshot of helloworld.cpp and play button

  3. 从您的系统中检测到的编译器列表中选择 C/C++: g++.exe build and debug active file

    C++ debug configuration dropdown

你只会在第一次运行 helloworld.cpp 时被要求选择一个编译器。此编译器将被设置为 tasks.json 文件中的“默认”编译器。

  1. 生成成功后,你的程序输出将显示在集成终端中。

    screenshot of program output

恭喜!您刚刚在 VS Code 中运行了您的第一个 C++ 程序!

了解 tasks.json

第一次运行程序时,C++ 扩展会在您的项目的 .vscode 文件夹中创建一个 tasks.json 文件。tasks.json 存储您的构建配置。

你的新 tasks.json 文件应类似于下面的 JSON

{
  "tasks": [
    {
      "type": "cppbuild",
      "label": "C/C++: g++.exe build active file",
      "command": "C:\\msys64\\ucrt64\\bin\\g++.exe",
      "args": [
        "-fdiagnostics-color=always",
        "-g",
        "${file}",
        "-o",
        "${fileDirname}\\${fileBasenameNoExtension}.exe"
      ],
      "options": {
        "cwd": "${fileDirname}"
      },
      "problemMatcher": ["$gcc"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ],
  "version": "2.0.0"
}

注意:你可以在变量参考中了解有关 tasks.json 变量的更多信息。

command 设置指定要运行的程序;在这种情况下,它是 g++

args 数组指定传递给 g++ 的命令行参数。这些参数以编译器期望的特定顺序在此文件中列出。

此任务告诉 g++ 采用活动文件 (${file}),对其进行编译,并在当前目录 (${fileDirname}) 中创建一个输出文件 (-o 开关),该文件的名称与活动文件名相同,但带有 .exe 扩展名 (${fileBasenameNoExtension}.exe)。对于我们来说,这将产生 helloworld.exe

label 值是你在任务列表中将看到的内容;你可以随意命名。

detail 值是您将在任务列表中看到的任务描述。强烈建议重命名此值以将其与类似任务区分开来。

problemMatcher 值选择用于查找编译器输出中的错误和警告的输出解析器。对于 GCC,如果您使用 $gcc problem matcher,您将获得最佳结果。

从现在开始,播放按钮将从 tasks.json 读取以确定如何构建和运行您的程序。您可以在 tasks.json 中定义多个构建任务,并且播放按钮将使用标记为默认的任务。如果您需要更改默认编译器,可以在命令面板中运行 任务:配置默认构建任务。或者,您可以修改 tasks.json 文件并删除默认值

    "group": {
        "kind": "build",
        "isDefault": true
    },

替换为

    "group": "build",

修改 tasks.json

从 2024 年 11 月 3 日开始,MSYS2 默认情况下禁用了 mingw-w64 的通配符支持。此更改会影响构建命令中通配符(如 "*.cpp")的处理方式。要在 tasks.json 中构建多个 C++ 文件,您必须显式列出文件,使用像 makecmake 这样的构建系统,或者实现以下解决方法:https://www.msys2.org/docs/c/#expanding-wildcard-arguments。

如果您之前使用 "${workspaceFolder}/*.cpp" 编译当前文件夹中的所有 .cpp 文件,则现在将无法直接使用。相反,您可以手动列出文件或定义构建脚本。

调试 helloworld.cpp

要调试你的代码,

  1. 回到 helloworld.cpp,使其成为活动文件。
  2. 通过单击编辑器边距或在当前行使用 F9 设置断点。helloworld.cpp 中断点的屏幕截图
  3. 从播放按钮旁边的下拉菜单中,选择调试 C/C++ 文件播放按钮下拉菜单的屏幕截图
  4. 从您的系统中检测到的编译器列表中选择 C/C++: g++ build and debug active file(您只需在第一次运行或调试 helloworld.cpp 时才会被要求选择编译器)。C++ debug configuration dropdown

播放按钮有两种模式:运行 C/C++ 文件调试 C/C++ 文件。它将默认为上次使用的模式。如果您在播放按钮上看到调试图标,您可以选择播放按钮进行调试,而不是使用下拉菜单。

探索调试器

在开始单步调试代码之前,我们花点时间注意用户界面中的几处变化

  • 集成终端出现在源代码编辑器的底部。在 调试控制台 选项卡中,您将看到指示调试器正在运行的输出。

  • 编辑器会高亮显示你在启动调试器之前设置断点的行

    Initial breakpoint

  • 左侧的运行和调试视图显示调试信息。你将在本教程的后面看到一个示例。

  • 代码编辑器顶部会出现一个调试控制面板。你可以通过抓取左侧的点来在屏幕上移动它。

    Debugging controls

单步调试代码

现在你已准备好开始单步调试代码。

  1. 选择调试控制面板中的 逐行执行 图标。

    Step over button

    这将使程序执行前进到 for 循环的第一行,并跳过在创建和初始化 msg 变量时调用的所有内部函数调用。请注意左侧 变量 窗口的变化。

    Debugging windows

    在这种情况下,错误是可以预期的,因为尽管循环的变量名称现在对调试器可见,但该语句尚未执行,因此此时没有任何内容可读取。但是,由于该语句已完成,因此 msg 的内容是可见的。

  2. 再次按跳过以推进到此程序中的下一个语句(跳过用于初始化循环的所有内部代码)。现在,变量窗口显示有关循环变量的信息。

  3. 再次按 逐行执行 以执行 cout 语句。(请注意,C++ 扩展在循环退出之前不会在 调试控制台 中打印任何输出。)

  4. 如果你愿意,可以继续按单步跳过,直到向量中的所有单词都打印到控制台。但如果你好奇,可以尝试按单步进入按钮来单步执行 C++ 标准库中的源代码!

    要返回到你自己的代码,一种方法是继续按单步跳过。另一种方法是在你的代码中设置一个断点,方法是切换到代码编辑器中的 helloworld.cpp 选项卡,将插入点放在循环内的 cout 语句的某处,然后按 F9。左侧的边栏会出现一个红点,表示已在此行设置了断点。

    Breakpoint in main

    然后按 F5 从标准库头文件的当前行开始执行。执行将在 cout 处中断。如果你愿意,可以再次按 F9 来关闭断点。

    循环完成后,您可以在集成终端中看到输出,以及 GDB 输出的一些其他诊断信息。

    Debug output in terminal

设置监视

有时您可能希望跟踪程序执行时变量的值。您可以通过在变量上设置 监视 来执行此操作。

  1. 将插入点放在循环内。在 监视 窗口中,选择加号并在文本框中键入 word,这是循环变量的名称。现在,在逐步执行循环时查看监视窗口。

    Watch window

  2. 通过在循环前添加此语句来添加另一个监视:int i = 0;。然后,在循环内部添加此语句:++i;。现在,像上一步一样为 i 添加监视。

  3. 要在执行暂停在断点处时快速查看任何变量的值,你可以将鼠标指针悬停在其上方。

    Mouse hover

使用 launch.json 自定义调试

当你使用播放按钮或 F5 进行调试时,C++ 扩展会即时创建一个动态调试配置。

在某些情况下,你可能希望自定义调试配置,例如指定在运行时传递给程序的参数。你可以在 launch.json 文件中定义自定义调试配置。

要创建 launch.json,请从播放按钮下拉菜单中选择添加调试配置

Add debug configuration play button menu

然后,您将看到各种预定义的调试配置的下拉菜单。选择 C/C++: g++.exe build and debug active file

C++ debug configuration dropdown

VS Code 在 .vscode 文件夹中创建一个 launch.json 文件,其外观如下

{
  "configurations": [
    {
      "name": "C/C++: g++.exe build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "${fileDirname}\\${fileBasenameNoExtension}.exe",
      "args": [],
      "stopAtEntry": false,
      "cwd": "${fileDirname}",
      "environment": [],
      "externalConsole": false,
      "MIMode": "gdb",
      "miDebuggerPath": "C:\\msys64\\ucrt64\\bin\\gdb.exe",
      "setupCommands": [
        {
          "description": "Enable pretty-printing for gdb",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        },
        {
          "description": "Set Disassembly Flavor to Intel",
          "text": "-gdb-set disassembly-flavor intel",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++.exe build active file"
    }
  ],
  "version": "2.0.0"
}

在上面的 JSON 中,program 指定要调试的程序。此处设置为活动文件文件夹 (${fileDirname}) 和带有 .exe 扩展名 (${fileBasenameNoExtension}.exe) 的活动文件名,如果 helloworld.cpp 是活动文件,则为 helloworld.exeargs 属性是在运行时传递给程序的参数数组。

默认情况下,C++ 扩展不会向你的源代码添加任何断点,并且 stopAtEntry 值设置为 false

stopAtEntry 值更改为 true,以便在开始调试时让调试器在 main 方法处停止。

从现在开始,播放按钮和 F5 在启动程序进行调试时将从你的 launch.json 文件中读取信息。

添加额外的 C/C++ 设置

如果你想对 C/C++ 扩展进行更多控制,可以创建一个 c_cpp_properties.json 文件,它将允许你更改编译器路径、包含路径、C++ 标准(默认为 C++17)等设置。

你可以通过从命令面板 (⇧⌘P (Windows、Linux 为 Ctrl+Shift+P)) 运行 C/C++: 编辑配置 (UI) 命令来查看 C/C++ 配置 UI。

Command Palette

这将打开C/C++ 配置页面。当你在此处进行更改时,VS Code 会将它们写入 .vscode 文件夹中名为 c_cpp_properties.json 的文件。

在这里,我们将 配置名称 更改为 GCC,将 编译器路径 下拉列表设置为 g++ 编译器,并将 IntelliSense 模式 设置为与编译器匹配 (gcc-x64)。

Command Palette

Visual Studio Code 将这些设置放置在 .vscode\c_cpp_properties.json 中。 如果您直接打开该文件,它应该如下所示

{
  "configurations": [
    {
      "name": "GCC",
      "includePath": ["${workspaceFolder}/**"],
      "defines": ["_DEBUG", "UNICODE", "_UNICODE"],
      "windowsSdkVersion": "10.0.22000.0",
      "compilerPath": "C:/msys64/mingw64/bin/g++.exe",
      "cStandard": "c17",
      "cppStandard": "c++17",
      "intelliSenseMode": "windows-gcc-x64"
    }
  ],
  "version": 4
}

只有当您的程序包含不在您的工作区或标准库路径中的头文件时,才需要添加到 Include path 数组设置中。 强烈建议不要将系统包含路径添加到我们支持的编译器的 includePath 设置中。

编译器路径

扩展使用 compilerPath 设置来推断 C++ 标准库头文件的路径。 当扩展知道在哪里找到这些文件时,它可以提供诸如智能完成和 Go to Definition 导航等功能。

C/C++ 扩展会尝试根据系统上找到的内容,使用默认编译器填充 compilerPath。 扩展会在几个常见的编译器位置中查找,但只会自动选择位于“Program Files”文件夹之一或其路径列在 PATH 环境变量中的编译器。 如果可以找到 Microsoft Visual C++ 编译器,它将被选中,否则它将选择 gcc、g++ 或 clang 的版本。

如果您安装了多个编译器,可能需要更改 compilerPath 以匹配您项目的首选编译器。 您还可以使用命令面板中的 C/C++: Select IntelliSense Configuration... 命令来选择扩展检测到的编译器之一。

故障排除

MSYS2 已安装,但仍未找到 g++ 和 gdb

您必须按照 MSYS2 网站 上的步骤,使用 MSYS CLI 安装完整的 MinGW-w64 工具链 (pacman -S --needed base-devel mingw-w64-ucrt-x86_64-toolchain),以及所有必需的先决条件。 该工具链包括 g++ 和 gdb。

作为 Windows 用户,运行 pacman 命令会给我一个错误

Windows 机器上的 UCRT 仅包含在 Windows 10 或更高版本中。 如果您使用的是其他版本的 Windows,请运行以下不使用 UCRT 的命令

pacman -S --needed base-devel mingw-w64-x86_64-toolchain

当将 MinGW-w64 目标文件夹添加到您的环境变量列表中时,默认路径将为:C:\msys64\mingw64\bin

MinGW 32 位

如果您需要 MinGW 工具集的 32 位版本,请参阅 MSYS2 wiki 上的 下载 部分。 其中包含指向 32 位和 64 位安装选项的链接。

后续步骤

  • 探索 VS Code 用户指南
  • 查看 C++ 扩展概述
  • 创建一个新的工作区,将您的 .vscode JSON 文件复制到其中,调整新的工作区路径、程序名称等必要的设置,然后开始编码!
© . This site is unofficial and not affiliated with Microsoft.