vscode-cmake-settings

cmake是一个C/C++的跨平台的构建工具，也是现在的事实标准，QT6、KDE、ROS2及其他知名库均开始采用cmake构建。
cmake是构建工具的构建工具。cmake可以生成 VS工程文件、makefile、ninja及其他构建工具。而这些构建工具又会将它们自己的配置文件转换成编译器和链接器的参数供其调用。而cmake本身是没有什么预配置的，我们最好做些cmake构建的预配置才能让我们使用的方便，比如针对特定编译器的编译选项和调试选项等。
1
    // // 1. CMake设置 适用于GCC/CLang/Clang-cl
2
    "cmake.configureSettings": {
3
        // 默认Debug模式
4
        "CMAKE_BUILD_TYPE": "Debug",
5
        // 生成编译命令数据库，供clangd使用
6
        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
7
        // 为C/C++调试版本添加调试信息，使用DWARF-4格式
8
        // -g: 生成调试信息
9
        // -gdwarf-5是最新的
10
        "CMAKE_CXX_FLAGS_DEBUG": "${CMAKE_CXX_FLAGS_DEBUG} -g -gdwarf-5 -fdiagnostics-color=always -fno-omit-frame-pointer",
11
        "CMAKE_C_FLAGS_DEBUG": "${CMAKE_C_FLAGS_DEBUG} -g -gdwarf-5 -fdiagnostics-color=always -fno-omit-frame-pointer",
12
        // Release版本优化
13
        "CMAKE_CXX_FLAGS_RELEASE": "${CMAKE_CXX_FLAGS_RELEASE} -O3 -DNDEBUG",
14
        "CMAKE_C_FLAGS_RELEASE": "${CMAKE_C_FLAGS_RELEASE} -O3 -DNDEBUG",
15
        // RelWithDebInfo版本（推荐用于性能分析）
16
        "CMAKE_CXX_FLAGS_RELWITHDEBINFO": "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -O2 -g -gdwarf-5",
17
        "CMAKE_C_FLAGS_RELWITHDEBINFO": "${CMAKE_C_FLAGS_RELWITHDEBINFO} -O2 -g -gdwarf-5",
18
        // C/C++标准设置
19
        "CMAKE_CXX_STANDARD": "23", // 98 11 14 17 20 23 26
20
        "CMAKE_C_STANDARD": "23", // 90 99 11 17 23
21
        "CMAKE_CXX_STANDARD_REQUIRED": "ON", // 强制要求指定的C++标准，如果不支持则编译失败
22
        // 编译器警告设置 - 启用全面的代码质量检查
23
        // "CMAKE_CXX_FLAGS": "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic",  // -Wall:常见警告 -Wextra:额外警告 -Wpedantic:严格标准合规警告
24
        // "CMAKE_C_FLAGS": "${CMAKE_C_FLAGS} -Wall -Wextra -Wpedantic",      // 同上，针对C语言代码
25
        // 显示详细的编译信息 - 用于调试构建过程
26
        "CMAKE_VERBOSE_MAKEFILE": "OFF", // 设为ON可以看到完整的编译命令，用于调试构建问题，一般设置为OFF即可
27
        // 生成位置无关代码 - 对于共享库和现代安全特性很重要
28
        "CMAKE_POSITION_INDEPENDENT_CODE": "ON",
29
        // 着色输出设置 - 让编译错误和警告信息更易读
30
        "CMAKE_COLOR_MAKEFILE": "ON", // 在Makefile生成器中启用彩色输出
31
        "CMAKE_COLOR_DIAGNOSTICS": "ON", // 在支持的编译器中启用彩色诊断信息
32
        // 并行编译设置 - 提高编译速度
33
        "CMAKE_BUILD_PARALLEL_LEVEL": "0", // 0表示使用所有可用CPU核心进行并行编译
34
        // 让CMake自动检测是否支持
35
        // "CMAKE_INTERPROCEDURAL_OPTIMIZATION": "ON",
36
        "CMAKE_INTERPROCEDURAL_OPTIMIZATION_DEBUG": "OFF", // Debug版本关闭LTO
37
        "CMAKE_INTERPROCEDURAL_OPTIMIZATION_RELEASE": "ON", // 仅Release版本启用
38
    },
39
    // // 2. CMake设置 适用于MSVC
40
    // "cmake.configureSettings": {
41
    //  // 默认Debug模式
42
    //  "CMAKE_BUILD_TYPE": "Debug",
43
    //  // 生成编译命令数据库，供clangd使用
44
    //  "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
45
    //  // Debug 调试信息 - 修正了语法错误
46
    //  "CMAKE_CXX_FLAGS_DEBUG": "/ZI /Od /MDd",
47
    //  "CMAKE_C_FLAGS_DEBUG": "/ZI /Od /MDd",
48
    //  "CMAKE_EXE_LINKER_FLAGS_DEBUG": "/DEBUG:FULL /INCREMENTAL",
49
    //  // Release版本优化
50
    //  "CMAKE_CXX_FLAGS_RELEASE": "/O2 /DNDEBUG /MD",
51
    //  "CMAKE_C_FLAGS_RELEASE": "/O2 /DNDEBUG /MD",
52
    //  "CMAKE_EXE_LINKER_FLAGS_RELEASE": "/INCREMENTAL:NO /OPT:REF /OPT:ICF",
53
    //  // RelWithDebInfo版本（推荐用于性能分析）
54
    //  "CMAKE_CXX_FLAGS_RELWITHDEBINFO": "/O2 /Zi /DNDEBUG /MD",
55
    //  "CMAKE_C_FLAGS_RELWITHDEBINFO": "/O2 /Zi /DNDEBUG /MD",
56
    //  "CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO": "/DEBUG /INCREMENTAL:NO /OPT:REF",
57
    //  // C/C++标准设置
58
    //  "CMAKE_CXX_STANDARD": "20",
59
    //  "CMAKE_C_STANDARD": "17",  // C23在MSVC中支持有限，建议用C17
60
    //  "CMAKE_CXX_STANDARD_REQUIRED": "ON",
61
    //  "CMAKE_C_STANDARD_REQUIRED": "ON",
62
    //  // MSVC 编译器警告设置
63
    //  "CMAKE_CXX_FLAGS": "/W4 /WX- /permissive- /EHsc", // W4高级警告，permissive-严格标准
64
    //  "CMAKE_C_FLAGS": "/W4 /WX-",
65
    //  // 调试和开发相关设置
66
    //  "CMAKE_VERBOSE_MAKEFILE": "OFF",
67
    //  "CMAKE_COLOR_DIAGNOSTICS": "ON",
68
    //  // MSVC 特定优化
69
    //  "CMAKE_MSVC_RUNTIME_LIBRARY": "MultiThreadedDLL", // Release用MD，Debug会自动用MDd
70
    //  "CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD": "ON",
71
    //  // 并行编译
72
    //  "CMAKE_BUILD_PARALLEL_LEVEL": "0"
73
    // // Windows 动态库导出全部符号（.dll, .lib等）对于使用动态库来说必不可少
74
    // "CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS": "ON",
75
    // },
76
    "cmake.generator": "Ninja", // cmake的生成器为Ninja
77
    "cmake.preferredGenerators": [
78
        "Ninja", // 优先使用Ninja 快且跨平台
79
        "Unix Makefiles"
80
    ],
81
    "cmake.configureOnOpen": false, // 打开文件夹不自动构建
82
    "cmake.buildBeforeRun": true, // 运行前自动构建
83
    "cmake.clearOutputBeforeBuild": true, // 构建前清除输出
84
    "cmake.launchBehavior": "reuseTerminal",
85
    "cmake.installPrefix": "bin",
86
    // // 1.适用于GCC/Clang/Clang-cl的调试
87
    // // 1.1 使用GDB
88
    // "cmake.debugConfig": {
89
    //  "stopAtEntry": true, // 在代码开头设置断点
90
    //  "type": "cppdbg",
91
    //  "MIMode": "gdb", // 据说可以用lldb，但还没找到配置
92
    //  "cwd": "${workspaceFolder}",
93
    //  "setupCommands": [
94
    //   {
95
    //    "description": "Enable pretty printing for better data structure display",
96
    //    "text": "-enable-pretty-printing",
97
    //    "ignoreFailures": true
98
    //   },
99
    //   {
100
    //    "description": "Set assembly code display to Intel syntax format",
101
    //    "text": "-gdb-set disassembly-flavor intel",
102
    //    "ignoreFailures": true
103
    //   },
104
    //   {
105
    //    "description": "Set maximum string display length to 512 characters",
106
    //    "text": "set print elements 512",
107
    //    "ignoreFailures": true
108
    //   },
109
    //   {
110
    //    "description": "Enable printing of object's actual type (for polymorphic objects)",
111
    //    "text": "set print object on",
112
    //    "ignoreFailures": true
113
    //   },
114
    //   {
115
    //    "description": "Enable pretty printing of arrays",
116
    //    "text": "set print array on",
117
    //    "ignoreFailures": true
118
    //   },
119
    //   {
120
    //    "description": "Disable pagination for continuous output",
121
    //    "text": "set pagination off",
122
    //    "ignoreFailures": true
123
    //   }
124
    //  ]
125
    // },
126
    // // 1.2 使用LLDB
127
    "cmake.debugConfig": {
128
    "type": "lldb",
129
    // "MIMode": "lldb", // 哥们，必不可少啊，不然默认是gdb(~~呜呜，有点玄幻)
130
    "cwd": "${workspaceFolder}",
131
    "stopOnEntry": true, // 在代码开头设置断点
132
    "environment": [],
133
    "console": "integratedTerminal",
134
    "setupCommands": [
135
        {
136
            "description": "Set assembly code display to Intel syntax format",
137
            "text": "settings set target.x86-disassembly-flavor intel",
138
            "ignoreFailures": true
139
        },
140
        {
141
            "description": "Customize stack frame format to include function name, arguments, and file location",
142
            "text": "settings set frame-format \"frame #${frame.index}: ${frame.pc}{ ${module.file.basename}{`${function.name-with-args}{${frame.no-debug}${function.pc-offset}}}}{ at ${line.file.basename}:${line.number}}{${function.is-optimized} [opt]}\\n\"",
143
            "ignoreFailures": true
144
        },
145
        {
146
            "description": "Set thread format to display thread ID, name, and current execution position",
147
            "text": "settings set thread-format \"thread #${thread.index}: tid = ${thread.id%tid}{, ${frame.pc}}{ ${module.file.basename}{`${function.name-with-args}{${frame.no-debug}${function.pc-offset}}}}{ at ${line.file.basename}:${line.number}}{, name = '${thread.name}'}\\n\"",
148
            "ignoreFailures": true
149
        },
150
        {
151
            "description": "Enable detailed type information display for dynamic objects",
152
            "text": "settings set target.prefer-dynamic-value run-target",
153
            "ignoreFailures": true
154
        },
155
        {
156
            "description": "Set maximum string display length to 512 characters",
157
            "text": "settings set target.max-string-summary-length 512",
158
            "ignoreFailures": true
159
        }
160
    ]
161
    },
162
    // // 2. 适用于MSVC的调试
163
    // // 使用MSVC的调试器
164
    // "cmake.debugConfig": {
165
    //  "type": "cppvsdbg", // 使用VS的调试器
166
    //  "cwd": "${workspaceFolder}",
167
    //  "environment": [],
168
    //  "console": "integratedTerminal",
169
    // },
170
    // lldb插件相关设置
171
    // 启动时执行的初始化命令（在目标程序启动前执行）
172
    "lldb.launch.initCommands": [],
173
    // 运行前执行的命令（在目标程序启动后、断点命中前执行）
174
    "lldb.launch.preRunCommands": [],
175
    // 自动解引用指针，显示指针指向的实际值而不是地址
176
    "lldb.dereferencePointers": true,
177
    // 抑制缺失源文件的警告信息，避免调试时的干扰
178
    "lldb.suppressMissingSourceFiles": true,
179
    // 反汇编显示模式：never=从不显示，auto=自动，always=总是显示
180
    "lldb.showDisassembly": "never",
181
    // 启用详细日志记录，便于调试LLDB本身的问题
182
    "lldb.verboseLogging": true,
183
    // 启用命令自动补全功能，提高调试效率
184
    "lldb.commandCompletions": true,
185
    // 控制台模式：split=分割模式，可以直接在Debug Console中输入变量名查看值
186
    // 其他选项：commands=仅命令模式，evaluate=仅求值模式
187
    "lldb.consoleMode": "split",
188
    "lldb.displayFormat": "auto", // 变量显示格式
189
    "lldb.launch.expressions": "simple", // 表达式求值模式
如上是对cmake的编译选项及调试的设置