使用 GCC 和 MinGW
在本教程中,您将配置 Visual Studio Code 以使用 GCC C++ 编译器 (g++) 和 GDB 调试器(来自 mingw-w64)来创建在 Windows 上运行的程序。配置 VS Code 后,您将编译、运行和调试一个 Hello World 程序。
本教程不教授关于 GCC、GDB、minGW-w64 或 C++ 语言的知识。关于这些主题,网络上有许多优秀的资源。
如果您有任何问题,请随时在 VS Code 文档库 中为此教程提交问题。
先决条件
要成功完成本教程,您必须执行以下步骤
-
安装 VS Code 的 C/C++ 扩展。您可以通过在扩展视图中搜索“C++”来安装 C/C++ 扩展 (⇧⌘X (Windows、Linux Ctrl+Shift+X))。
安装 MinGW-w64 工具链
通过 MSYS2 获取最新版本的 MinGW-w64,它提供 GCC、MinGW-w64 和其他有用的 C++ 工具和库的最新原生构建。这将为您提供必要的工具来编译代码、调试代码,并配置它以与 IntelliSense 一起工作。
要安装 MinGW-w64 工具链,请查看此视频或按照以下步骤操作
-
您可以从 MSYS2 页面下载最新的安装程序,或使用此安装程序的直接链接。
-
运行安装程序并按照安装向导的步骤操作。请注意,MSYS2 需要 64 位 Windows 8.1 或更高版本。
-
在向导中,选择您所需的安装文件夹。记录此目录以备后用。在大多数情况下,建议的目录是可以接受的。当您设置开始菜单快捷方式步骤时,也同样适用。完成后,确保选中“立即运行 MSYS2”框,然后选择“完成”。这将为您打开一个 MSYS2 终端窗口。
-
在此终端中,运行以下命令安装 MinGW-w64 工具链
pacman -S --needed base-devel mingw-w64-ucrt-x86_64-toolchain
-
通过按 Enter 键接受
toolchain
组中的默认包数量。 -
当提示是否继续安装时,输入
Y
。 -
通过执行以下步骤,将 MinGW-w64
bin
文件夹的路径添加到 WindowsPATH
环境变量中- 在 Windows 搜索栏中,键入“设置”以打开 Windows 设置。
- 搜索“编辑帐户的环境变量”。
- 在“用户变量”中,选择
Path
变量,然后选择“编辑”。 - 选择“新建”,然后将您在安装过程中记录的 MinGW-w64 目标文件夹添加到列表中。如果您使用了上面的默认设置,则路径将为:
C:\msys64\ucrt64\bin
。 - 选择“确定”,然后在“环境变量”窗口中再次选择“确定”以更新
PATH
环境变量。您必须重新打开任何控制台窗口,更新后的PATH
环境变量才能生效。
检查您的 MinGW 安装
要检查您的 MinGW-w64 工具是否已正确安装并可用,请打开一个新的命令提示符并键入
gcc --version
g++ --version
gdb --version
您应该看到输出,说明您已安装的 GCC、g++ 和 GDB 版本。如果不是这种情况
- 确保您的 PATH 变量条目与工具链安装位置的 MinGW-w64 二进制文件位置匹配。如果编译器在该 PATH 条目中不存在,请确保您已按照之前的说明进行操作。
- 如果
gcc
输出了正确的结果,但gdb
没有,那么您需要从 MinGW-w64 工具集中安装您缺少的软件包。- 如果在编译时收到“miDebuggerPath 的值无效。”消息,则原因之一可能是您缺少
mingw-w64-gdb
软件包。
- 如果在编译时收到“miDebuggerPath 的值无效。”消息,则原因之一可能是您缺少
创建一个 Hello World 应用程序
首先,让我们设置一个项目。
- 启动 Windows 命令提示符(在 Windows 搜索栏中输入“Windows 命令提示符”)。
- 运行以下命令。这些命令将创建一个名为
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
。
添加 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) 保存文件。请注意,您刚刚添加的文件如何出现在文件资源管理器视图中 (⇧⌘E (Windows、Linux Ctrl+Shift+E)),位于 VS Code 的侧边栏中
您还可以启用 自动保存 以自动保存您的文件更改,方法是选择“文件”>“自动保存”。您可以在 VS Code 用户界面文档中找到有关其他视图的更多信息。
注意:当您保存或打开 C++ 文件时,您可能会看到来自 C/C++ 扩展的关于 Insiders 版本的可用性的通知,该版本允许您测试新功能和修复程序。您可以通过选择
X
(“清除通知”)来忽略此通知。
探索 IntelliSense
IntelliSense 是一种工具,通过添加代码编辑功能(如代码完成、参数信息、快速信息和成员列表)来帮助您更快、更高效地编写代码。
要查看 IntelliSense 的实际效果,请将鼠标悬停在 vector
或 string
上以查看其类型信息。如果您在第 10 行键入 msg.
,您可以看到 IntelliSense 生成的建议成员函数调用完成列表
您可以按 Tab 键插入选定的成员。如果您然后添加左括号,IntelliSense 将显示有关所需参数的信息。
如果尚未配置 IntelliSense,请打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 并输入“选择 IntelliSense 配置”。从编译器下拉列表中,选择“使用 gcc.exe
”进行配置。更多信息可以在 IntelliSense 配置文档中找到。
运行 helloworld.cpp
请记住,C++ 扩展使用您安装在计算机上的 C++ 编译器来构建您的程序。在尝试在 VS Code 中运行和调试 helloworld.cpp
之前,请确保您已完成“安装 MinGW-w64 工具链”步骤。
-
打开
helloworld.cpp
,使其成为活动文件。 -
按编辑器右上角的播放按钮。
-
从系统上检测到的编译器列表中选择“C/C++: g++.exe 生成和调试活动文件”。
您只需在第一次运行 helloworld.cpp
时选择编译器。此编译器将设置为 tasks.json
文件中的“默认”编译器。
-
构建成功后,程序的输出将出现在集成的终端中。
恭喜!您刚刚在 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}
) 中创建一个输出文件(-o
开关),该文件与活动文件同名,但带有 .exe
扩展名 (${fileBasenameNoExtension}.exe
)。对我们来说,这将生成 helloworld.exe
。
label
值是您将在任务列表中看到的名称;您可以随意命名它。
detail
值是您将在任务列表中看到的任务描述。强烈建议重命名此值,以便将其与类似任务区分开来。
problemMatcher
值选择输出分析器,用于在编译器输出中查找错误和警告。对于 GCC,如果您使用 $gcc
问题匹配器,您将获得最佳结果。
从现在开始,播放按钮将从 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++ 文件,您必须显式列出文件,使用像 make
或 cmake
这样的构建系统,或者实现以下解决方法:https://www.msys2.org/docs/c/#expanding-wildcard-arguments。
如果您以前使用 "${workspaceFolder}/*.cpp"
来编译当前文件夹中的所有 .cpp
文件,这将不再直接工作。相反,您可以手动列出文件或定义构建脚本。
调试 helloworld.cpp
要调试您的代码,
- 返回到
helloworld.cpp
,使其成为活动文件。 - 通过单击编辑器边距或在当前行使用 F9 设置断点。
- 从播放按钮旁边的下拉列表中,选择“调试 C/C++ 文件”。
- 从系统上检测到的编译器列表中选择“C/C++: g++ 生成和调试活动文件”(您只需在第一次运行或调试
helloworld.cpp
时选择编译器)。
播放按钮有两种模式:“运行 C/C++ 文件”和“调试 C/C++ 文件”。它将默认为上次使用的模式。如果您在播放按钮中看到调试图标,您可以直接选择播放按钮进行调试,而不是使用下拉列表。
探索调试器
在您开始单步执行代码之前,让我们花点时间注意用户界面的几个变化
-
集成终端出现在源代码编辑器的底部。在“调试控制台”选项卡中,您会看到指示调试器正在运行的输出。
-
编辑器突出显示您在启动调试器之前设置断点的行
-
左侧的“运行和调试”视图显示调试信息。您将在本教程稍后看到一个示例。
-
在代码编辑器的顶部,会出现一个调试控制面板。您可以通过抓住左侧的点将其在屏幕上移动。
单步执行代码
现在您已准备好开始单步执行代码。
-
选择调试控制面板中的“单步跳过”图标。
这将使程序执行前进到 for 循环的第一行,并跳过在创建和初始化
msg
变量时调用的vector
和string
类中的所有内部函数调用。请注意左侧“变量”窗口中的变化。在本例中,错误是预期的,因为虽然循环的变量名称现在对调试器可见,但语句尚未执行,因此此时没有任何内容可读取。但是,
msg
的内容是可见的,因为该语句已完成。 -
再次按“单步跳过”以前进到程序中的下一个语句(跳过所有执行以初始化循环的内部代码)。现在,“变量”窗口显示有关循环变量的信息。
-
再次按“单步跳过”以执行
cout
语句。(请注意,C++ 扩展在循环退出之前不会将任何输出打印到“调试控制台”。) -
如果您愿意,您可以继续按“单步跳过”直到向量中的所有单词都已打印到控制台。但是,如果您好奇,请尝试按“单步进入”按钮单步执行 C++ 标准库中的源代码!
要返回到您自己的代码,一种方法是继续按“单步跳过”。另一种方法是在代码编辑器中切换到
helloworld.cpp
选项卡,将插入点放在循环内cout
语句的某个位置,然后按 F9。左侧的装订线中会出现一个红点,指示已在此行设置断点。然后按 F5 从标准库标头中的当前行开始执行。执行将在
cout
处中断。如果您愿意,可以再次按 F9 以关闭断点。循环完成后,您可以在集成终端中看到输出,以及 GDB 输出的一些其他诊断信息。
设置监视
有时您可能希望在程序执行时跟踪变量的值。您可以通过在变量上设置监视来执行此操作。
-
将插入点放在循环内。在“监视”窗口中,选择加号,然后在文本框中键入
word
,这是循环变量的名称。现在,当您单步执行循环时,查看“监视”窗口。 -
通过在循环前添加此语句来添加另一个监视:
int i = 0;
。然后,在循环内,添加此语句:++i;
。现在像在上一步中一样为i
添加监视。 -
要在执行暂停在断点时快速查看任何变量的值,您可以将鼠标指针悬停在其上方。
使用 launch.json 自定义调试
当您使用播放按钮或 F5 进行调试时,C++ 扩展会动态创建调试配置。
在某些情况下,您可能希望自定义调试配置,例如指定在运行时传递给程序的参数。您可以在 launch.json
文件中定义自定义调试配置。
要创建 launch.json
,请从播放按钮下拉菜单中选择“添加调试配置”。
然后,您将看到各种预定义的调试配置的下拉列表。选择“C/C++: g++.exe 生成和调试活动文件”。
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.exe
。args
属性是要在运行时传递给程序的参数数组。
默认情况下,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。
这将打开“C/C++ 配置”页面。当您在此处进行更改时,VS Code 会将它们写入 .vscode
文件夹中名为 c_cpp_properties.json
的文件。
在这里,我们将“配置名称”更改为“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
}
仅当您的程序包含不在您的工作区或标准库路径中的头文件时,才需要添加到“包含路径”数组设置中。强烈建议不要为我们支持的编译器将系统包含路径添加到 includePath
设置中。
编译器路径
扩展使用 compilerPath
设置来推断 C++ 标准库头文件的路径。当扩展知道在哪里找到这些文件时,它可以提供诸如智能完成和“转到定义”导航之类的功能。
C/C++ 扩展尝试根据在您的系统上找到的内容来填充 compilerPath
,并使用默认编译器。扩展程序会在几个常见的编译器位置查找,但只会自动选择“Program Files”文件夹中的一个或路径列在 PATH 环境变量中的一个。如果可以找到 Microsoft Visual C++ 编译器,则将选择它,否则它将选择 gcc、g++ 或 clang 的版本。
如果您安装了多个编译器,您可能需要更改 compilerPath
以匹配您项目的首选编译器。您也可以使用命令面板中的 C/C++: 选择 IntelliSense 配置... 命令来选择扩展程序检测到的编译器之一。
故障排除
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 位
如果您需要 32 位版本的 MinGW 工具集,请查阅 MSYS2 wiki 上的 下载 部分。它包含 32 位和 64 位安装选项的链接。
后续步骤
- 探索 VS Code 用户指南。
- 查看 C++ 扩展概述。
- 创建一个新的工作区,将您的
.vscode
JSON 文件复制到其中,调整新工作区路径、程序名称等的必要设置,然后开始编码!