在VS Code中使用Clang作为你的C++编译器

相比庞大的Visual Studio来说,VS Code实在是一款非常便捷的编辑器,如果你对使用Visual Studio来写C++内心有极大的抗拒或者只是想拿一个简单的工具来写C++的话,不妨可以考虑一下给VS Code 配置上编译器,在VS Code 中完成轻量级的工作。
说到编译器,你最先想到的可能是GCC,本文使用的是Clang,相比GCC,Clang有很多优点,优点不是本文所讨论的内容。如果使用GCC作为编译器,可参考我的这篇文章

Clang 是一个C、C++、Objective-C和Objective-C++编程语言的编译器前端。它采用了底层虚拟机作为其后端。它的目标是提供一个GNU编译器套装的替代品。作者是克里斯·拉特纳,在苹果公司的赞助支持下进行开发,而源代码授权是使用类BSD 的开源授权。 Clang 项目包括Clang 前端和Clang 静态分析器等。

编写中为了能提高效率,我们可以使用VS Code的一些C++的扩展来实现智能感知和调试功能,且听我娓娓道来。

安装VS Code

Visual Studio Code下载

安装LLVM

LLVM Download Page,在网页中找到适用于Windows
64位的最新预编译版本,不需要下载sig签名文件。安装过程中注意选择为所有用户安装,这样会为你添加到环境变量。
这两步完成以后打开cmd,输入clang应该可以看到如下输出。

输出

如果看到上图,说明你的Clang安装成功了。
那么如果你写了一个.cpp的文件,比如一个hello world。

#include <iostream>
using namespace std;
int main()
{
    cout << "hello world" << endl;
}

用命令clang hello.cpp编译,你会发现如下错误输出。

clang.exe: warning: unable to find a Visual Studio installation; try running Clang from a developer command prompt [-Wmsvc-not-found]
main.cpp:1:10: fatal error: 'iostream' file not found
#include <iostream>
         ^~~~~~~~~~
1 error generated.

难道没有头文件???
如果你已经安装了Visual Studio 的C++工具,可能没有这条错误,能够成功编译,如果你不想用Visual Studio自带的C++呢?我们还要在VS Code里调试呢。
为了解决这个错误,我们需要MinGW-w64。

安装MinGW-w64

MinGW-w64 - for 32 and 64 bit Windows,安装时注意选择体系架构为x86_64。由于网络原因,你可能不能把它下载下来,经过一点探索,安装程序需要下载一个叫做x86_64-7.1.0-release-posix-seh-rt_v5-rev2的文件,其实我们可以直接在SourceForge上搜到这个MinGW-w64 - for 32 and 64 bit Windows,到里面选择第一个下载。下载完成后解压里面的mingw64文件夹中的内容到你安装LLVM的同一个目录合并,合并里面所有文件夹,不会有冲突。

配置VS Code。

这里需要4个json配置文件。
用VS Code打开你的工作区文件夹,新建一个.vscode文件夹,注意有个点。
而后在这个文件夹下新建c_cpp_properties.json,这个文件用于指定一些头文件的目录,代码如下,注意修改里面的路径,我这里是F盘。

c_cpp_properties.json

{
    "configurations": [
        {
            "name": "Win32",
            "intelliSenseMode": "clang-x64",
            "includePath": [
                "${workspaceRoot}",
                "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++",
                "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++/x86_64-w64-mingw32",
                "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++/backward",
                "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include",
                "F:/llvm/include",
                "F:/llvm/x86_64-w64-mingw32/include",
                "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include-fixed"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE",
                "__GNUC__=7",
                "__cdecl=__attribute__((__cdecl__))"
            ],
            "browse": {
                "path": [
                    "F:/llvm/x86_64-w64-mingw32/include",
                    "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include",
                    "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include-fixed",
                    "F:/llvm/include/*",
                    "${workspaceRoot}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }
    ],
    "version": 3
}

完成以后,再新建一个settings.json文件,还是需要修改路径,注意。

settings.json

// 将设置放入此文件中以覆盖默认值和用户设置。
{
    "files.defaultLanguage": "c", // ctrl+N新建文件后默认的语言
    "c-cpp-flylint.cppcheck.enable": false,
    "c-cpp-flylint.flexelint.enable": false,
    "c-cpp-flylint.run": "onType", // 此选项貌似不起作用 
    "c-cpp-flylint.clang.includePaths": [
        "${workspaceRoot}",
        "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++",
        "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++/x86_64-w64-mingw32",
        "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include/c++/backward",
        "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include",
        "F:/llvm/include",
        "F:/llvm/x86_64-w64-mingw32/include",
        "F:/llvm/lib/gcc/x86_64-w64-mingw32/7.1.0/include-fixed"
    ],
    "c-cpp-flylint.clang.defines": [
        "_DEBUG",
        "UNICODE",
        "__GNUC__=7",
        "__cdecl=__attribute__((__cdecl__))"
    ],
    "c-cpp-flylint.standard": [ // 此选项貌似也不起作用 
        "c11",
        "c++1z"
    ],
    "code-runner.runInTerminal": true, // 设置成false会在“输出”中输出,无法交互 
    "code-runner.executorMap": {
        "c": "cd $dir && clang $fileName -o $fileNameWithoutExt.exe -Wall -g -Og -static-libgcc -fcolor-diagnostics --target=x86_64-w64-mingw -std=c11 && $dir$fileNameWithoutExt",
        "cpp": "cd $dir && clang++ $fileName -o $fileNameWithoutExt.exe -Wall -g -Og -static-libgcc -fcolor-diagnostics --target=x86_64-w64-mingw -std=c++1z && $dir$fileNameWithoutExt"
    },
    "code-runner.saveFileBeforeRun": true,
    "C_Cpp.clang_format_sortIncludes": true,
    "C_Cpp.errorSquiggles": "Disabled"
}

完成之后,继续新建一个tasks.json,用于编译参数,直接复制就行,不用修改。

tasks.json

{
    "version": "2.0.0",
    "tasks": [
        {
            "taskName": "Compile", // 任务名称,与launch.json的preLaunchTask相对应
            "command": "clang++", // 如果用MinGW,编译C用gcc,编译c++用g++
            "args": [
                "${file}",
                "-o", // 指定输出文件名,不加该参数则默认输出a.exe 
                "${fileDirname}/${fileBasenameNoExtension}.exe",
                "-g", // 生成和调试有关的信息
                "-Wall", // 开启额外警告
                "-static-libgcc", // 静态链接 
                "-fcolor-diagnostics",
                "--target=x86_64-w64-mingw", // 默认target为msvc,不加这一条就会找不到头文件
                "-std=c++1z" // c++1z即c++17,C语言最新标准为c11,或根据自己的需要进行修改 
            ], // 编译命令参数 
            "type": "shell",
            "group": {
                "kind": "build",
                "isDefault": true // 设为false可做到一个tasks.json配置多个编译指令,需要自己修改本文件,我这里不多提
            },
            "presentation": {
                "echo": true,
                "reveal": "silent", // 设置是否在“终端”中显示编译信息,可以为always,silent,never。一些错误提示也在这里,但是因为有静态检测,我就设为silent了。 
                "focus": false,
                "panel": "shared" // 不同的文件的编译信息共享一个终端面板
            },
            "problemMatcher": {
                "owner": "cpp",
                "fileLocation": [
                    "relative",
                    "/"
                ],
                "pattern": {
                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$", // 正则表达式,用于描述在“问题”栏中显示的信息。
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "severity": 4,
                    "message": 5
                }
            } // 1.11.0的更新日志里说可以直接写"problemMatcher": "$gcc",但是我试了一下不行。
        }
    ]
}

最后新建一个launch.json文件,里面是调试参数。

launch.json

// https://github.com/Microsoft/vscode-cpptools/blob/master/launch.md 
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(gdb) Launch", // 配置名称,将会在启动配置的下拉菜单中显示 
            "type": "cppdbg", // 配置类型,这里只能为cppdbg 
            "request": "launch", // 请求配置类型,可以为launch(启动)或attach(附加)
            "program": "${fileDirname}/${fileBasenameNoExtension}.exe", // 将要进行调试的程序的路径 
            "args": [], // 程序调试时传递给程序的命令行参数,一般设为空即可 
            "stopAtEntry": false, // 设为true时程序将暂停在程序入口处,我一般设置为true 
            "cwd": "${workspaceRoot}", // 调试程序时的工作目录
            "environment": [], // (环境变量?)
            "externalConsole": false, // 调试时是否显示控制台窗口,一般设置为true显示控制台
            "MIMode": "gdb", // 指定连接的调试器,可以为gdb或lldb。但目前lldb在windows下没有预编译好的版本。
            "miDebuggerPath": "F:\\LLVM\\bin\\gdb.exe", // 调试器路径。 
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": false
                }
            ],
            "preLaunchTask": "Compile" // 调试会话开始前执行的任务,一般为编译程序。与tasks.json的taskName相对应 
        }
    ]
}

安装VS Code扩展

为了能编译并获得自动补全,还要漂亮,你可能需要如下VS Code 扩展。

  • C/C++
  • C/C++ Snippets
  • C/C++ Advanced Lint(vscode-c-cpp-flylint)
  • Code Runner
  • Include Autocomplete
  • One Dark Pro:大概是VS Code安装量最高的主题

其他

完成上面的操作之后,可以在工作区中创建C++文件了,写完以后使用快捷键Ctrl+Shift+B编译,或者直接F5编译并调试。
在上面的配置文件中,用到了一些VS Code 的变量,如果你想自定义一些东西,下面这些可能会有帮助。

${workspaceRoot} 当前打开的文件夹的绝对路径+文件夹的名字
${workspaceRootFolderName} 当前打开的文件夹的名字
${file} 当前打开正在编辑的文件名,包括绝对路径,文件名,文件后缀名
${relativeFile} 从当前打开的文件夹到当前打开的文件的路径
${fileBasename} 当前打开的文件名+后缀名,不包括路径
${fileBasenameNoExtension} 当前打开的文件的文件名,不包括路径和后缀名
${fileDirname} 当前打开的文件所在的绝对路径,不包括文件名
${fileExtname} 当前打开的文件的后缀名
${cwd} 同 pwd , 当前绝对路径
${lineNumber} 当前打开的文件,光标所在的行数


文中配置文件参考了知乎的这个回答 https://www.zhihu.com/question/30315894/answer/154979413

推荐阅读更多精彩内容