跳转至

在macOS上用VSCode写C++代码 10 极速版

大家好,今天(210902)有同学跟我反映说教程中Intel Mac无法调试,具体表现为:按F5开启调试之后弹出终端,终端一片空白,没有任何输出;上滑后发现一些从来没见过的命令。我在自己的电脑上试了一下也出现了这样的情况。

通过查看GitHub microsoft/vscode-cpptools 仓库的issues,确认这是在扩展商店安装的C++扩展插件新版本v1.6.0 (August 24, 2021)的bug,工程师已经发现了这个问题并且在代码中修复,在下一个版本的更新中应该会解决这个问题。

最近需要进行调试的同学可以先将C++插件降级为1.5.1 (July 9, 2021),降级方法如下: 1. 打开VS Code设置(⌘,)搜索c_cpp.update,将选项从Insiders更改为Default(关闭C++插件的自动更新) 2. 退出重启VS Code 3. 打开插件商店,找到安装的扩展C/C++,右键选择Install Another Version,选择v1.5.1 4. 退出重启VS Code,等待v1.5.1版本的C/C++扩展安装完毕即可。

问题描述:

解决方案:

代码修复:

前言

此教程为两种人设计:

1 看了我之前上传的在macOS上配置VSCode编程Cpp的环境2至7课的教程希望回顾如何快速在macOS上配置VSCode编程Cpp的环境的同学

2 希望通过这几分钟的教程就明白如何在macOS上配置VSCode编程Cpp的环境的同学

我希望你将这份极速版教程当作复习资料而不是学习材料,因为总共五个多小时所讲的东西,没法压缩为几分钟的内容。

话不多说,我们开始!

安装

安装命令行工具

方法一:从App Store安装Xcode.app

方法二:在苹果开发者网站下载Command Line Tool并进行安装。

任选一种即可。

安装VS Code

VS Code官网下载解压安装Visual Studio Code.app

安装插件

打开VS Code在插件市场搜索安装C/C++Code Runner

新建文件夹

在桌面新建名为CODE的文件夹,在其中新建名为Cpp的文件夹。以后我们的所有代码都写在其中。

注意:关于编程的任何路径尽量不要出现空格,这是因为shell在解析你的命令时会用空格隔开各种参数,如果你的路径中有空格,同时你又处理不得当,shell可能会将其分为两部分。这里我推荐大家在新建文件夹时或给文件起名字的时候都不带空格,或者将空格改为下划线_,这样能有效避免一些错误。

将文件夹Cpp拖到Dock栏VS Code上打开该文件夹。

注意:请尽量不要在任何关于代码和程序的地方出现空格。空格作为shell分隔命令的符号,在路径或文件名中出现空格可能会导致意想不到的后果。你可以将空格替换为下划线,或者直接删掉空格。如将VS Code的文件夹改名为VS_CodeVSCode

我所写的讲稿中Code Runner编译对空格有很好的处理,但是调试总是处于两难的境地,有了空格就不能调试。很抱歉到现在才发现问题(210110)

写三份文件位于.vscode文件夹下的文件

settings.json

(注意json文件的格式)

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
  // 添加希望被忽略的文件,这样一些文件虽然存在于当前工作目录下,但是不会被显示在左侧的文件浏览器里
  "files.exclude": {
    // dSYM文件具有调试信息,普通使用的话不看到它就可以了
    "**/*.dSYM": true,
    "**/*.out": true,
  },
  // --------------------------------------------------------------------------------------
  // Code Runner
  // To run code:
  //   use shortcut "Ctrl Opt N" *
  //   or press F1 and then select/type Run Code,
  //   or right click the Text Editor and then click Run Code in editor context menu
  //   or click Run Code button in editor title menu
  //   or click Run Code button in context menu of file explorer
  // To stop the running code:
  //   use shortcut "Ctrl Opt M" *
  //   or press F1 and then select/type Stop Code Run
  //   or right click the Output Channel and then click Stop Code Run in context menu
  "code-runner.executorMap": {
    // Introduction:
    //   Make sure the executor PATH of each language is set in the environment variable.
    //   You could also add entry into "code-runner.executorMap" to set the executor PATH.
    // Supported customized parameters:
    //   $workspaceRoot: The path of the folder opened in VS Code
    //   $dir: The directory of the code file being run
    //   $fullFileName: The full name of the code file being run
    //   $fileName: The base name of the code file being run, that is the file without the directory
    //   $fileNameWithoutExt: The base name of the code file being run without its extension
    /* ------ 编译、运行只有一个文件的cpp文件 ------ */
    // 注:路径中有空格不会出现问题
    "cpp": "g++ $fullFileName -o $dir\"$fileNameWithoutExt\"\".out\" -W -Wall -O2 -std=c++17 && $dir\"$fileNameWithoutExt\"\".out\"",
    // 其中 $fullFileName 是绝对路径,是主文件
    // 自己决定是否加入 && rm $dir\"$fileNameWithoutExt\"\".out\"(也可以添加"files.exclude")
    /* ------ 编译、运行多个cpp文件 ------ */
    // "cpp": "g++ $fullFileName <file_to_link> -o $dir\"$fileNameWithoutExt\"\".out\" -W -Wall -O2 -std=c++17 && $dir\"$fileNameWithoutExt\"\".out\"",
    // <file_to_link>的写法:
    //   一般的,你也可以直接写绝对路径
    //     \"/path/xxxx.cpp\"
    //   如果你链接的cpp文件和主文件在一个目录下:
    //     $dir\"xxxx.cpp\"
    //   更一般的,如果你链接的cpp文件不和主文件在一个目录下,需要从当前VSCode的工作目录补充相对路径从而形成绝对路径:
    //     $workspaceRoot\"relative/path/xxxx.cpp\"
    /* ------ 编译c文件 ------ */
    "c": "gcc $fullFileName -o $dir\"$fileNameWithoutExt\"\".out\" -W -Wall -O2 -std=c17 && $dir\"$fileNameWithoutExt\"\".out\"",
    // "c": "gcc $fullFileName <file_to_link> -o $dir\"$fileNameWithoutExt\"\".out\" -W -Wall -O2 -std=c17 && $dir\"$fileNameWithoutExt\"\".out\"",
  },
  // Whether to clear previous output before each run (default is false):
  "code-runner.clearPreviousOutput": true,
  // Whether to save all files before running (default is false):
  "code-runner.saveAllFilesBeforeRun": false,
  // Whether to save the current file before running (default is false):
  "code-runner.saveFileBeforeRun": true,
  // Whether to show extra execution message like [Running] ... and [Done] ... (default is true):
  "code-runner.showExecutionMessage": true, // cannot see that message is you set "code-runner.runInTerminal" to true
  // Whether to run code in Integrated Terminal (only support to run whole file in Integrated Terminal, neither untitled file nor code snippet) (default is false):
  "code-runner.runInTerminal": true, // cannot input data when setting to false
  // Whether to preserve focus on code editor after code run is triggered (default is true, the code editor will keep focus; when it is false, Terminal or Output Channel will take focus):
  "code-runner.preserveFocus": false,
  // Whether to ignore selection to always run entire file. (Default is false)
  "code-runner.ignoreSelection": true,
  // --------------------------------------------------------------------------------------
}

tasks.json

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
{
  // Tasks in VS Code can be configured to run scripts and start processes
  // so that many of these existing tools can be used from within VS Code 
  // without having to enter a command line or write new code.
  // Workspace or folder specific tasks are configured from the tasks.json file in the .vscode folder for a workspace.
  "version": "2.0.0",
  "tasks": [
    {
      // The task's label used in the user interface.
      // Terminal -> Run Task... 看到的名字
      "label": "g++ compile",
      // The task's type. For a custom task, this can either be shell or process.
      // If shell is specified, the command is interpreted as a shell command (for example: bash, cmd, or PowerShell).
      // If process is specified, the command is interpreted as a process to execute.
      "type": "shell",// shell: 输入命令
      // The actual command to execute.
      // 因为g++已经在环境变量中了,所以我们这里写命令就行不用写g++的绝对路径
      "command": "g++",
      "args": [
        "${file}", // 表示当前文件(绝对路径)
        // 在这里添加你还需要链接的.cpp文件
        "-o",
        "${fileDirname}/${fileBasenameNoExtension}.out",
        "-W",
        "-Wall",
        "-g",
        "-std=c++17",
      ],
      // Defines to which execution group this task belongs to.
      // It supports "build" to add it to the build group and "test" to add it to the test group.
      // Tasks that belong to the build/test group can be executed by running Run Build/Test Task from the Command Palette (sft cmd P).
      // Valid values:
      //   "build",
      //   {"kind":"build","isDefault":true}, 
      //   "test",
      //   {"kind":"test","isDefault":true}, 
      //   "none".
      "group": {
        "kind": "build",
        "isDefault": true, // Defines if this task is the default task in the group.
      },
      // Configures the panel that is used to present the task's output and reads its input.
      "presentation": {
        // Controls whether the executed command is echoed to the panel. Default is true.
        "echo": true, // 打开可以看到编译的命令,把命令本身输出一次
        // Controls whether the terminal running the task is revealed or not. Default is "always".
        //   always: Always reveals the terminal when this task is executed.
        //   silent: Only reveals the terminal if the task exits with an error or the problem matcher finds an error.(会显示错误,但不会显示警告)
        //   never: Never reveals the terminal when this task is executed.
        "reveal": "silent", // 控制在集成终端中是否显示。如果没问题那我不希望终端被切换、如果有问题我希望能看到编译过程哪里出错,所以选silent(可能always会好一些)
        // Controls whether the panel takes focus. Default is false.
        "focus": false, // 我的理解是:是否将鼠标移过去。因为这个是编译任务,我们不需要输入什么东西,所以选false
        // Controls if the panel is shared between tasks, dedicated to this task or a new one is created on every run.
        "panel": "shared", // shared:不同任务的输出使用同一个终端panel(为了少生成几个panel我们选shared)
        // Controls whether to show the `Terminal will be reused by tasks, press any key to close it` message.
        "showReuseMessage": true, // 就一句话,你想看就true,不想看就false
        // Controls whether the terminal is cleared before executing the task.
        "clear": false, // 还是保留之前的task输出信息比较好。所以不清理
      },
      // Other two choices: options & runOptions (cmd I to use IntelliSense)
      "options": {
        // The current working directory of the executed program or script. If omitted Code's current workspace root is used.
        "cwd": "${workspaceFolder}",// 默认就是这个,删掉也没问题
      },
      // problemMatcher: 用正则表达式提取g++的输出中的错误信息并将其显示到VS Code下方的Problems窗口
      // check: https://code.visualstudio.com/docs/editor/tasks#_defining-a-problem-matcher
      "problemMatcher": {
        "owner": "cpp",
        "fileLocation": "absolute",
        "pattern": {
          "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
          "file": 1,
          "line": 2,
          "column": 3,
          "severity": 4,
          "message": 5,
        },
      },
      // 官网教程 https://code.visualstudio.com/docs/cpp/config-clang-mac#_build-helloworldcpp 
      // 提到了另一种problemMatcher,但试了之后好像不起作用,甚至还把我原本的电脑搞出了一些问题……
    },
    {
      "label": "Open Terminal.app",
      "type": "shell",
      "command": "osascript -e 'tell application \"Terminal\"\ndo script \"echo now VS Code is able to open Terminal.app\"\nend tell'",
      "problemMatcher": [],
      "group": "none",
    }
  ]
}

保存后⇧⌘P调出所有命令搜索run task选择Open Terminal.app,给VS Code打开终端的权限。

launch.json

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  // One of the key features of Visual Studio Code is its great debugging support.
  // VS Code's built-in debugger helps accelerate your edit, compile and debug loop.
  // VS Code keeps debugging configuration information in a launch.json file
  // located in a .vscode folder in your workspace (project root folder).
  "version": "0.2.0",
  "configurations": [
    {
      /* ------ these three options are mandatory ------ */
      // The type of debugger to use for this launch configuration.
      "type": "cppdbg", // C++ debug
      // The request type of this launch configuration. Currently, launch and attach are supported.
      //   If you come from a server or desktop background, 
      //   it's quite normal to have your editor launch your process for you, 
      //   and your editor automatically attaches its debugger to the newly launched process.
      //   A launch configuration starts your app in debug mode before VS Code attaches to it.
      // 大概意思是说,如果你开始debug的时候你的项目已经启起来了,那就attach(把debug的工具附加上去)
      // 如果你开始debug的时机和你启动项目的时机是相同的,那就launch
      "request": "launch", // debug的类型,launch表示启动,attach表示附加
      // The reader-friendly name to appear in the Debug launch configuration drop-down.
      "name": "C++ Debug", // 在VSCode侧边栏Run那里看到的名字(可以随便起)
      /* ------ some optional attributes available to all launch configurations ------ */
      // To launch a task before the start of a debug session, set this attribute to the label of a task specified in tasks.json.
      "preLaunchTask": "g++ compile", //在调试之前要进行的工作 compile是在 tasks.json 的编译任务里面的label
      /* ------ Many debuggers support some of the following attributes: ------ */
      // executable or file to run when launching the debugger
      // !!不要在程序和代码的路径及文件名中出现空格!!否则无法调试(我尝试解决这个问题,但真的无法解决)
      "program": "${fileDirname}/${fileBasenameNoExtension}.out", // debug的对象(-g编译出来的二进制文件),需要和.vscode/tasks.json中生成的可执行文件一致
      // arguments passed to the program to debug
      "args": [], // 比如运行你的程序添加输入参数(argc/argv),需要在这里添加
      // Environment variables to add to the environment for the program
      "environment": [], // 放置环境变量
      // current working directory for finding dependencies and other files
      "cwd": "${workspaceFolder}",
      // break immediately when the program launches
      "stopAtEntry": false,
      // If true, a console is launched for the debuggee.
      // If false, on Linux and Windows, it will appear in the Integrated Console.
      "externalConsole": true,
      // 为true则会打开系统终端在其中进行交互
      // 如果为 true,则为调试对象启动控制台。如果为 false,它在 Linux 和 Windows 上会显示在集成控制台中
      // macOS不适用:https://code.visualstudio.com/docs/cpp/launch-json-reference#_externalconsole
      /* ------ Customizing GDB or LLDB ------ */
      // Indicates the debugger that VS Code will connect to. Must be set to gdb or lldb. 
      // 但是macOS只安装了llbd(有可能是安装命令行工具的时候安装的),那就用lldb吧
      "MIMode": "lldb",
    }
  ]
}

如何运行

使用默认快捷键或右键。推荐大家⌘K⌘S打开快捷键设置,搜索run code,设置运行为⌘R,停止运行为⇧⌘R

在主文件打开时按⌘R可在下方集成终端看到输出(记得用过之后改回去)

链接文件时只需要在settings.jsoncode-runner.executorMapcpp那里的$fullFileName-o之间添加你需要链接的.cpp文件。

如何调试

使用快捷键F5或点击菜单栏Run -> Start Debugging或点击Touch Bar上的播放键开始调试。

分屏将终端放在左边、VS Code放在右边。

添加链接的文件

链接文件时只需要在tasks.jsonargs"${file}","-o",添加你还需要链接的.cpp文件.

Attachment

hello.cpp

C++
1
2
3
4
5
6
7
#include <cstdio>

int main() {
  printf("Hello, world!\n");
  printf("Hello, world!\n");
  printf("Hello, world!\n");
}

one_file.cpp

C++
1
2
3
4
5
6
#include <cstdio>

int twoSum(int a, int b) { return a + b; }
int fourSum(int a, int b, int c, int d) { return twoSum(a, b) + twoSum(c, d); }

int main() { printf("Addition = %d\n", fourSum(1, 2, 3, 4)); }

two_files.cpp

main_file.cpp

C++
1
2
3
4
5
#include <cstdio>

#include "myAdd.hpp"

int main() { printf("Addition = %d\n", threeSum(2, 3, 4)); }

myAdd.hpp

Text Only
1
2
3
4
5
6
7
#ifndef myAdd_hpp
#define myAdd_hpp

int threeSum(int a, int b, int c);
int fourSum(int a, int b, int c, int d);

#endif /* myAdd_hpp */

myAdd.cpp

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#include "myAdd.hpp"

/// Just add three integers.
/// @param a int1
/// @param b int2
/// @param c int3
/// @return additon of a, b and c
int threeSum(int a, int b, int c) { return a + b + c; }

int fourSum(int a, int b, int c, int d) { return a + b + c + d; }