VSCode如何调试C++/CMake项目
本文以最典型的开源C++项目结构为例,即:创建build目录并进入、
cmake ..
生成编译配置、make创建二进制文件的 的流程。以下将介绍如何使VSCode自动化运行这些流程。
安装编译工具链
首先需要安装C++的编译工具链。
- Linux下就是gcc、make、cmake这些。
- Windows下稍微复杂些,如果用微软那套的话可以搜索msvc的配置,这里就不展开了;如果用符合GNU的,可以使用MinGW+CMake的组合。
这里简单介绍ubuntu下的编译工具链的配置:
sudo apt install build-essential cmake cmake-curses-gui
一条语句搞定。
其中cmake-curses-gui是ccmake组件
至于遇到的什么特定版本的gcc啊、内核升降级啊,以及CMakeLists.txt如何编写,不在本文讨论之列。
如果你没有sudo权限,建议联系管理员运行以上命令,并安装VSCode。否则自己本地编译安装的话,会折腾死人的(亲历)
配置VSCode
这里假定你的VSCode已经安装完毕,没有的话建议去官网下载安装,不要使用ubuntu商店。
-
首先,在VSCode中安装以下扩展:C/C++、CMake、CMake Tools。
-
然后,在调试页,点击"create a launch.json file",在弹出的命令面板中随便选一个,打开生成的launch配置文件(或者手动在项目目录下创建.vscode文件夹,以及.vscode/launch.json文件),并对其进行修改,改为以下内容:
// .vscode/launch.json { "version": "0.2.0", "configurations": [ { "name": "CMake: Compile and Debug", "type": "cppdbg", "request": "launch", "program": "${workspaceFolder}/build/要调试的可执行程序名称(手动修改)", "args": [], "stopAtEntry": false, "cwd": "${workspaceFolder}", "environment": [], "externalConsole": false, "MIMode": "gdb", "preLaunchTask": "build", "setupCommands": [ { "description": "Enable pretty-printing for gdb", "text": "-enable-pretty-printing", "ignoreFailures": true } ] }, ] }
其中的
program
字段,请自行修改为CMakeLists.txt配置的可执行文件名称。如果最终编译好的可执行文件,在调试时需要传入某些参数,可以将参数写入
args
字段中。需要注意参数中不要出现空格,任何空格都拆分成两个参数放在args
字段,否则VSCode转译时会给参数加上双引号,导致最终命令出错。
例如,我希望传入的参数是-i input.txt -o output.txt
,那么args
应该是["-i","input.txt","-o","output.txt"]
,在调试时VSCode会自动拼接这些参数,并以空格分隔。 -
按F1,在命令面板中输入tasks,选择"Tasks:Configure Task->create tasks.json from template->随便选",创建tasks配置,然后将其内容修改如下:
//.vscode/tasks.json { "version": "2.0.0", "tasks": [ { "type": "shell", "label": "mkdirbuild", "command": "mkdir", "options": { "cwd": "${workspaceFolder}" }, "args": ["-p", "build"] }, { "type": "shell", "label": "cmake", "command": "cmake", "args": [ "-DCMAKE_BUILD_TYPE=Debug", //在此处添加其它CMAKE选项 ".." ], "options": { "cwd": "${workspaceFolder}/build" }, "dependsOn": [ "mkdirbuild" ] }, { "label": "make", "group": { "kind": "build", "isDefault": true }, "command": "make", "args": ["-j8",], //根据机器cpu核心数量自行调整 "options": { "cwd": "${workspaceFolder}/build" }, }, { "label": "build", "dependsOrder": "sequence", "dependsOn": ["cmake", "make"] }, ], }
其中
cmake
任务的args
字段,如果不需要打断点,那么可以删除-DCMAKE_BUILD_TYPE=Debug
选项;如果需要添加其它CMakeLists.txt中没有指定的选项,可以在注释的位置自行添加。需要注意参数中同样不要出现空格,任何空格都拆分成两个参数放在args
字段,与前文举的例子一样。其中
make
任务的"args": ["-j8",]
字段,指的是8个线程同时编译。这里请根据你的CPU核心数量自行调整,比如你是16核,可以改为-j16
,速度会更快;或者你的电脑性能较差,可以选择不启用多线程,那就改为-j1
或者直接删除这一行均可。 -
最后别忘记保存修改过的文件(个人建议将VSCode设置成自动保存)。
开始调试
在调试面板,选择CMake: Compile and Debug
选项,点击绿色三角按钮或按F5开始编译并调试。
如果代码量比较大,编译过程会比较久,请耐心等待。
如果编译失败,可以在输入面板查看错误内容,并修改对应代码。
如果需要完全重新编译,则直接删除项目目录下的build文件夹即可。
如果在cmake
任务的args
字段中声明了-DCMAKE_BUILD_TYPE=Debug
选项(或者CMakeLists.txt中声明了此选项),那么直接在代码中打断点,即可进入断点调试模式。
如果你的项目需要更复杂的编译流程,可以自行添加更多configuration或task