将 GCC 与 MinGW 结合使用

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

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

如果您有任何问题，请随时在VS Code 文档存储库中提交本教程的问题。

先决条件

要成功完成本教程，您必须执行以下步骤：

  1. 安装Visual Studio 代码。

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

    C/C++ 扩展

安装 MinGW-w64 工具链

通过MSYS2获取最新版本的 MinGW-w64 ，它提供了 GCC、MinGW-w64 和其他有用的 C++ 工具和库的最新本机版本。这将为您提供必要的工具来编译代码、调试代码并将其配置为与IntelliSense一起使用。

  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. toolchain按Enter接受组中默认的包数。

    MYSS2 安装程序

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

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

    1. 在 Windows 搜索栏中，键入“设置”以打开“Windows 设置”。
    2. 搜索编辑您帐户的环境变量。
    3. 在用户变量中，选择Path变量，然后选择编辑。
    4. 选择新建并将您在安装过程中记录的 MinGW-w64 目标文件夹添加到列表中。如果您使用上面的默认设置，那么这将是路径：C:\msys64\ucrt64\bin。
    5. 选择“确定”保存更新的路径。您需要重新打开所有控制台窗口才能使新的 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。从那里，您将helloworld直接在 VS Code 中打开。
mkdir projects
cd projects
mkdir helloworld
cd helloworld
code .

代码 。” 命令在当前工作文件夹中打开 VS Code，该文件夹将成为您的“工作区”。选择是，我信任作者，接受“工作空间信任”对话框，因为这是您创建的文件夹。

当您完成本教程时，您将看到在.vscode工作区的文件夹中创建的三个文件：

  • tasks.json（构建说明）
  • launch.json（调试器设置）
  • c_cpp_properties.json（编译器路径和 IntelliSense 设置）

添加源代码文件

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

新建文件标题栏按钮

添加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 ) ）中：

文件管理器

您还可以通过选择“文件” > “自动保存”来启用“自动保存”以自动保存文件更改。您可以在 VS Code用户界面文档中找到有关其他视图的更多信息。

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

探索智能感知

IntelliSense是一款通过添加代码完成、参数信息、快速信息和成员列表等代码编辑功能来帮助您更快、更高效地编码的工具。

要查看实际的 IntelliSense，请将鼠标悬停在vector或 上string以查看其类型信息。如果您输入 msg.第 10 行，您可以看到建议调用的成员函数的完整列表，全部由 IntelliSense 生成：

语句完成智能感知

您可以按Tab键插入选定的成员。如果您随后添加左括号，IntelliSense 将显示有关需要哪些参数的信息。

如果尚未配置 IntelliSense，请打开命令面板 ( ⇧⌘P (Windows、Linux Ctrl+Shift+P ) ) 并输入Select IntelliSense Configuration。从编译器的下拉列表中，选择Use gcc.exe进行配置。

运行helloworld.cpp

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

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

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

    helloworld.cpp 和播放按钮的屏幕截图

  3. 从系统上检测到的编译器列表中选择C/C++: g++.exe 构建和调试活动文件。

    C++ 调试配置下拉列表

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

  1. 构建成功后，程序的输出将出现在集成终端中。

    程序输出截图

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

了解tasks.json

第一次运行程序时，C++ 扩展会创建一个tasks.json文件，您可以在项目的.vscode文件夹中找到该文件。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}) 中创建一个与活动文件同名但扩展名.exe( ${fileBasenameNoExtension}.exe) 的可执行文件。对于我们来说，这会导致helloworld.exe.

该label值是您将在任务列表中看到的值；你可以随意命名它。

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

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

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

有了这个：

    "group": "build",

修改tasks.json

您可以tasks.json使用类似参数而"${workspaceFolder}/*.cpp"不是 来修改您的文件以构建多个 C++ 文件${file}。这将构建.cpp当前文件夹中的所有文件。"${fileDirname}\\${fileBasenameNoExtension}.exe"您还可以通过替换为硬编码文件名（例如）来修改输出文件名"${workspaceFolder}\\myProgram.exe"。

调试helloworld.cpp

要调试您的代码，

  1. 返回，helloworld.cpp使其成为活动文件。

  2. 通过单击编辑器边距或在当前行上使用 F9 设置断点。 helloworld.cpp 中断点的屏幕截图

  3. 从播放按钮旁边的下拉列表中，选择Debug C/C++ File。

    播放按钮下拉菜单的屏幕截图

  4. 从系统上检测到的编译器列表中选择C/C++: g++ 构建和调试活动文件helloworld.cpp（只有在第一次运行或调试时才会要求您选择编译器）。 C++ 调试配置下拉列表

播放按钮有两种模式：运行 C/C++ 文件和调试 C/C++ 文件。它将默认为上次使用的模式。如果您在播放按钮中看到调试图标，则只需选择播放按钮即可进行调试，而无需使用下拉菜单。

探索调试器

在开始逐步执​​行代码之前，让我们花点时间注意一下用户界面中的一些变化：

  • 集成终端出现在源代码编辑器的底部。在“调试输出”选项卡中，您会看到指示调试器已启动并正在运行的输出。

  • 编辑器会突出显示您在启动调试器之前设置断点的行：

    初始断点

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

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

    调试控件

单步执行代码

现在您已准备好开始单步执行代码。

  1. 单击或按调试控制面板中的“单步执行”图标。

    跨过按钮

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

    调试窗口

    在这种情况下，错误是预料之中的，因为虽然循环的变量名现在对调试器可见，但该语句尚未执行，因此此时没有任何内容可读取。然而，的内容msg是可见的，因为该语句已经完成。

  2. 再次按“单步执行”可前进到该程序中的下一条语句（跳过为初始化循环而执行的所有内部代码）。现在，变量窗口显示有关循环变量的信息。

  3. 再次按Step over执行该cout语句。（请注意，截至 2019 年 3 月版本，C++ 扩展在循环退出之前不会将任何输出打印到调试控制台。）

  4. 如果您愿意，可以一直按“Step over”，直到向量中的所有单词都已打印到控制台。但如果您好奇，请尝试按“单步执行”按钮单步执行 C++ 标准库中的源代码！

    gcc 标准库头中的断点

    要返回到您自己的代码，一种方法是按住Step over。另一种方法是在代码中设置断点，方法是切换到helloworld.cpp代码编辑器中的选项卡，将插入点放在cout循环内语句的某处，然后按F9。左侧装订线中出现一个红点，表示已在此行设置断点。

    main 中的断点

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

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

    在终端中调试输出

设置手表

有时您可能希望在程序执行时跟踪变量的值。您可以通过对变量设置监视来做到这一点。

  1. 将插入点放置在循环内。在“监视”窗口中，单击加号，然后在文本框中键入word，这是循环变量的名称。现在，当您单步执行循环时，请查看“监视”窗口。

    观察窗

  2. 通过在循环之前添加以下语句来添加另一个监视：int i = 0;。然后，在循环内添加以下语句：++i;。i现在，像上一步中所做的那样添加一个监视。

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

    鼠标悬停

使用 launch.json 自定义调试

当您使用播放按钮或F5进行调试时，C++ 扩展会动态创建动态调试配置。

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

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

添加调试配置播放按钮菜单

然后，您将看到各种预定义调试配置的下拉列表。选择C/C++: g++.exe 构建和调试活动文件。

C++ 调试配置下拉列表

VS Code 在文件夹中创建一个launch.json文件.vscode，如下所示：

{
  "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.exe。该args属性是在运行时传递给程序的参数数组。

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

将值更改stopAtEntry为以使调试器在开始调试时true停止在该方法上。main

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

添加附加 C/C++ 设置

如果您想要对 C/C++ 扩展进行更多控制，可以创建一个c_cpp_properties.json文件，该文件允许您更改编译器路径、包含路径、C++ 标准（默认为 C++17）等设置。

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

命令面板

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

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

命令面板

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
}

如果您的程序包含不在工作区或标准库路径中的头文件，则只需添加到包含路径数组设置。

编译路径

该扩展使用该compilerPath设置来推断 C++ 标准库头文件的路径。当扩展程序知道在哪里可以找到这些文件时，它可以提供智能完成和转到定义导航等功能。

C/C++ 扩展尝试compilerPath根据它在系统上找到的内容填充默认编译器位置。该扩展会查找几个常见的编译器位置。

搜索compilerPath顺序是：

  • 首先检查 Microsoft Visual C++ 编译器
  • 然后在 Windows Subsystem for Linux (WSL) 上查找 g++
  • 然后是 MinGW-w64 的 g++。

如果安装了 Visual Studio 或 WSL，则可能需要进行更改compilerPath以匹配项目的首选编译器。例如，如果您使用 i686 体系结构、Win32 线程和 sjlj 异常处理安装选项安装了 MinGW-w64 版本 8.1.0，则路径将如下所示：C:\Program Files (x86)\mingw-w64\i686-8.1.0-win32-sjlj-rt_v6-rev0\mingw64\bin\g++.exe。

故障排除

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。

32位MinGW

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

下一步

  • 浏览VS Code 用户指南。
  • 查看C++ 扩展概述。
  • 创建一个新工作区，将.vscodeJSON 文件复制到其中，调整新工作区路径、程序名称等必要的设置，然后开始编码！
2023 年 7 月 14 日