2022-03-30 VsCode中使用clangd插件的各种设置

Swift 2022-06-23

最近尝试clang编译c++，所以用了clangd插件代替mscpp插件，其中有不少问题，都是通过各种搜索，各种猜，才能完善，记录一下，以便广大同仁阅览。

第一步，设置clang工具链，我用msys2构建的clang64工具链，这个搜一下，非常容易构建。

第二步，下载vscode插件clangd，这是官方插件，由于与mscpp插件冲突，需要将mscpp关闭。

第三步，设置clangd插件，这是最折腾的。

  1. 设置clangd可执行文件的位置，一定要设置为你构建的clang64中的clangd可执行文件位置，切记。

    因为安装插件，本身也下载一个clangd，但是那不能用，不能识别clang的标准库文件。

  2. 设置clangd参数：编译器执行程序，提示风格，是否自动加头文件，启用clang-tidy，当c++构建文件不存在时搜索位置。

           "clangd.arguments": [
       "--query-driver=K:\\msys64\\clang64\\bin\\clang*","--completion-style=detailed","--header-insertion=never","--clang-tidy",],"clangd.fallbackFlags": [
       "-IK:\\msys64\\mingw64\\include\\"
       ],

  3. 设置编辑器格式化风格。这个需要在项目文件夹下建立一个 “ .clang-format ” 文件，内容如下：我使用的时微软风格，没办法，习惯mscpp的format了。

---
Language:        Cpp
# BasedOnStyle:  Microsoft
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignArrayOfStructures: None
AlignConsecutiveMacros: None
AlignConsecutiveAssignments: None
AlignConsecutiveBitFields: None
AlignConsecutiveDeclarations: None
AlignEscapedNewlines: Right
AlignOperands:   Align
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllConstructorInitializersOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortEnumsOnASingleLine: false
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: None
AllowShortLambdasOnASingleLine: All
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: MultiLine
AttributeMacros:
  - __capability
BinPackArguments: true
BinPackParameters: true
BraceWrapping:
  AfterCaseLabel:  false
  AfterClass:      true
  AfterControlStatement: Always
  AfterEnum:       true
  AfterFunction:   true
  AfterNamespace:  true
  AfterObjCDeclaration: true
  AfterStruct:     true
  AfterUnion:      false
  AfterExternBlock: true
  BeforeCatch:     true
  BeforeElse:      true
  BeforeLambdaBody: false
  BeforeWhile:     false
  IndentBraces:    false
  SplitEmptyFunction: true
  SplitEmptyRecord: true
  SplitEmptyNamespace: true
BreakBeforeBinaryOperators: None
BreakBeforeConceptDeclarations: true
BreakBeforeBraces: Custom
BreakBeforeInheritanceComma: false
BreakInheritanceList: BeforeColon
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit:    80
CommentPragmas:  '^ IWYU pragma:'
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: false
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DeriveLineEnding: true
DerivePointerAlignment: false
DisableFormat:   false
EmptyLineAfterAccessModifier: Never
EmptyLineBeforeAccessModifier: LogicalBlock
ExperimentalAutoDetectBinPacking: false
FixNamespaceComments: true
ForEachMacros:
  - foreach
  - Q_FOREACH
  - BOOST_FOREACH
IfMacros:
  - KJ_IF_MAYBE
IncludeBlocks:   Preserve
IncludeCategories:
  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
    Priority:        2
    SortPriority:    0
    CaseSensitive:   false
  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
    Priority:        3
    SortPriority:    0
    CaseSensitive:   false
  - Regex:           '.*'
    Priority:        1
    SortPriority:    0
    CaseSensitive:   false
IncludeIsMainRegex: '(Test)?$'
IncludeIsMainSourceRegex: ''
IndentAccessModifiers: false
IndentCaseLabels: false
IndentCaseBlocks: false
IndentGotoLabels: true
IndentPPDirectives: None
IndentExternBlock: AfterExternBlock
IndentRequires:  false
IndentWidth:     4
IndentWrappedFunctionNames: false
InsertTrailingCommas: None
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
LambdaBodyIndentation: Signature
MacroBlockBegin: ''
MacroBlockEnd:   ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
ObjCBinPackProtocolList: Auto
ObjCBlockIndentWidth: 2
ObjCBreakBeforeNestedBlockParam: true
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: true
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 19
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 1000
PenaltyIndentedWhitespace: 0
PointerAlignment: Right
PPIndentWidth:   -1
ReferenceAlignment: Pointer
ReflowComments:  true
ShortNamespaceLines: 1
SortIncludes:    CaseSensitive
SortJavaStaticImport: Before
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: true
SpaceBeforeAssignmentOperators: true
SpaceBeforeCaseColon: false
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceAroundPointerQualifiers: Default
SpaceBeforeRangeBasedForLoopColon: true
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles:  Never
SpacesInConditionalStatement: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInLineCommentPrefix:
  Minimum:         1
  Maximum:         -1
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
BitFieldColonSpacing: Both
Standard:        Latest
StatementAttributeLikeMacros:
  - Q_EMIT
StatementMacros:
  - Q_UNUSED
  - QT_REQUIRE_VERSION
TabWidth:        4
UseCRLF:         false
UseTab:          Never
WhitespaceSensitiveMacros:
  - STRINGIZE
  - PP_STRINGIZE
  - BOOST_PP_STRINGIZE
  - NS_SWIFT_NAME
  - CF_SWIFT_NAME
...
  1. 设置clangd tidy规则，用于静态分析提示，需要在项目文件夹下建立“ .clang-tidy ”文件，内容如下：我设置的比较多，通常会导致各种提示问题，如果觉得烦，可以自主选择，需参考clangd官方文档。
---
Checks: "bugprone-*,\
google-*,\
misc-*,\
modernize-*,\
performance-*,\
readability-*,\
portability-*,\
"
HeaderFilterRegex: 'Source/cm[^/]*\.(h|hxx|cxx)$'
CheckOptions:
  - key:   modernize-use-default-member-init.UseAssignment
    value: '1'
  - key:   modernize-use-equals-default.IgnoreMacros
    value: '0'
  - key:   modernize-use-auto.MinTypeNameLength
    value: '80'
...
  1. 设置模拟编译环境

根据官方文档，需要通过cmake为每个文件设置compile_commands.json文件，如果可以的话，请照做。这个不设置的话，对于只用系统库的编程，没有问题。

但涉及到非系统库头文件时候，就比较蛋疼。你无法指定文件位置，只能用第二条的 “ clangd.fallbackFlags ” 设置。然而所有头文件都会视为C++文件标准，如果你编辑C头文件，会痛不欲生。对于我这样写袖珍程序的主儿，这个不能忍。

解决办法是在你的每个子项目文件夹里添加一个 “ compile_flags.txt ” 文件，内容很简单：设置代码类型：C是 " -xc ",C++是 " -xc++ "，不可混用。设置C或C++的标准，一般C++11即可，版本太高，编译器不一定有实现。

-xc
-std=c11
-Wall
-Ik:/msys64/mingw64/include/
-Ik:/msys64/mingw64/include/cuda/

通过以上的设置，基本就可以比较愉快的使用clangd协助编程了。

还有一个问题，就是debug，把mscpp禁用的后果是无法debug， 而clang的默认debug工具是lldb，下载请认准：
CodeLLDB Vadim Chugunov

补充一下debug的问题

这是debug时的launch文件，在vscode可以直接添加配置，基本就是这个样子，比msCPP的设置简化很多，只是type变成了lldb，其余是一样的，Code LLDB会完成剩下的debug问题。
提醒一下，CodeLLDB插件的默认配置不要轻易动，尤其涉及lldb路径的问题，一定要用插件自己下载的，不要用Clang64工具链中的，这个和clangd设置相反，切记。

        {
            "name": "clang",
            "type": "lldb",
            "request": "launch",
            "program": "${fileDirname}/${fileBasenameNoExtension}.exe",
            "args": [
            ],
            "cwd": "${workspaceFolder}",
            "sourceLanguages": [
                "C"
            ],
            "preLaunchTask": "clangBuild_C",
        },
        {
            "name": "clang++",
            "sourceLanguages": [
                "C++"
            ],
            "preLaunchTask": "clangBuild_C++"
        },

lldb插件可以近乎完美解决debug问题，只有一个小问题，就是在终端显示的错误无法映射到 “问题” 窗口，原因比较简单，原先用于gcc的problemmatcher无法捕捉clang返回的问题，毕竟不是一种编译器。

估计由于只有百万级开发者使用clang在vscode中编程，未能引起vscode团队的重视。所以需要自己设置。

这个问题困扰了我很久，经过翻阅各种issue，得到解决，这是在tasks中的完整实现：最难之处是多行正则匹配语法，见problemMatcher部分，可以解决一些问题。上边是clang用于编译C的，下边是用于clang++用于编译C++的。

{
            "type": "process",
            "label": "clangBuild_C",
            "command": "K:\\msys64\\clang64\\bin\\clang.exe",
            "args": [
                "-glldb",
                "-std=c11",
                "${fileBasenameNoExtension}*",
                "-o",
                "${fileDirname}\\${fileBasenameNoExtension}.exe",
            ],
            "options": {
                "cwd": "${fileDirname}"
            },
            "problemMatcher": {
                "owner": "lldb",
                "fileLocation": [
                    "relative",
                    "${fileDirname}"
                ],
                "pattern": [
                    {
                        "regexp": "^(ld.lld:.*)$",
                        "message": 1,
                    },
                    {
                        "regexp": ">>> referenced by (.*):(\\d+)",
                        "file": 1,
                        "line": 2,
                ]
            }
        },
        {
            "type": "process",
            "label": "clangBuild_C++",
            "command": "K:\\msys64\\clang64\\bin\\clang++.exe",
                "-std=c++11",
                "${fileBasename}",
                "-Ik:/msys64/mingw64/include/",
                "pattern": {
                    "regexp": "^(.*\\.cpp):(\\d+):(\\d+): (.*)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "message": 4
                },
            }
        }

我的.vscode\settings.json 文件中关于lldb插件设置：

{
    "lldb.consoleMode": "evaluate",    //调试控制台模式为终端命令模式，可调用lldb命令
    "lldb.launch.sourceLanguages": [   //调试语言
        "cpp",
        "c"
    ],
    "lldb.launch.expressions": "native",  //使用原生表达式
    "lldb.displayFormat": "auto",
    "lldb.dereferencePointers": false,
    "lldb.showDisassembly": "auto",
}

有以上设置，就可以进行常规的lldb的debug了，比如有个变量temp，想要看他的值和地址，在调试控制台输入`p a,`p &a 即可，和在终端进行debug是一样的。

这里记录一点私货，如何监视动态数组值，比如有一个struct 指针pf1，scores是pf1中一个含有5个double数据的动态数组：请用vscode的debug监视输入：

(double(*)[5])pf1->scores

如果用控制台`p (double(*)[5])pf1->scores 会返回一个指针。

再加一项，文件重定向：

在vscode中使用lldb，是不可以直接用args方法的，如下设置不通。

            "args": [
                "(A*B|AC)D",
                "<",
                "E:\\clangC++\\suanfa\\data\\tinyL.txt",

lldb插件有个自己的关键词设置：stdio

            "stdio": [
                "E:\\clangC++\\suanfa\\data\\tinyL.txt",
                "stu1.txt",

第一项是标准输入，第二项是标准输出，如果有第三项，是标准err，请务必注意，这条它的官网有，但我没看，是自己试验出来的，虽然对初学者不常用，但对工程调试，没有这个大概会疯。

如有问题，请访问：clangd官方地址

相关文章

效率成吨提升之代码生成器-蓝湖工具神器iOS,Android,Swift,Flutter
软件简介:蓝湖辅助工具,减少移动端开发中控件属性的复制和粘...
【Audio音频开发】音频基础知识及PCM技术详解
现实生活中，我们听到的声音都是时间连续的，我们称为这种信...
见过仙女蹦迪吗？一起用python做个小仙女代码蹦迪视频
前言最近在B站上看到一个漂亮的仙女姐姐跳舞视频，循环看了亿...
【Android App】实战项目之仿抖音的短视频分享App附源码和演示视频 超详细必看
【Android App】实战项目之仿抖音的短视频分享App（附源码和...
自定义ava数据集及训练与测试 完整版 时空动作/行为 视频数据集制作 yolov5, deep sort, VIA MMAction, SlowFast
前言这一篇博客应该是我花时间最多的一次了，从2022年1月底至...
【视频+源码】登录鉴权的三种方式：token、jwt、session实战分享
因为我既对接过session、cookie，也对接过JWT，今年因为工作...