VSCode中使用CMake调试时CallStack源路径异常问题求助

问题描述 #

在VSCode中搭建CMake调试环境，相同配置在Visual Studio中调试断点完全正常，但VSCode里CallStack指向的源文件路径异常：

• 实际源文件路径：C:/Workspace/CPU_Raytracing/main.cpp
• 调试控制台输出正常：

Thread 1 "Renderer_Tester" hit Breakpoint 2, main () at C:/Workspace/CPU_Raytracing/main.cpp:7
7 in C:/Workspace/CPU_Raytracing/main.cpp

• 但复制调用栈得到的路径出现错误拼接：main() (c:\Workspace\CPU_Raytracing\build\C\Workspace\CPU_Raytracing\main.cpp:7)

已尝试清除CMake缓存、删除build文件夹重新构建，问题依旧，需实现VSCode中CMake调试时断点正常触发并指向正确源代码。

解决方案 #

1. 修正CMakeLists.txt路径引用 #

检查CMake配置文件，避免错误的路径拼接逻辑，确保直接引用源码文件：

# 错误示例：手动拼接可能导致路径混乱
# add_executable(Renderer_Tester ${CMAKE_BINARY_DIR}/${CMAKE_SOURCE_DIR}/main.cpp)

# 正确写法：直接使用相对路径或标准变量
add_executable(Renderer_Tester main.cpp)
# 若文件在子目录，使用相对路径
# add_executable(Renderer_Tester src/main.cpp)

2. 配置launch.json的路径映射 #

在.vscode/launch.json中添加sourceFileMap，将错误路径映射到正确源码路径：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "CMake Debug",
            "type": "cppvsdbg", // 根据实际使用的调试器调整，如gdb
            "request": "launch",
            "program": "${command:cmake.launchTargetPath}",
            "args": [],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "externalConsole": false,
            "sourceFileMap": {
                "c:/Workspace/CPU_Raytracing/build/C:/Workspace/CPU_Raytracing/": "C:/Workspace/CPU_Raytracing/"
            }
        }
    ]
}

3. 调试器路径替换命令 #

若使用MSVC调试器或GDB，可在launch.json的setupCommands中添加路径替换命令：

"setupCommands": [
    {
        "description": "Enable pretty-printing",
        "text": "-enable-pretty-printing",
        "ignoreFailures": true
    },
    {
        "text": "set substitute-path c:/Workspace/CPU_Raytracing/build/C:/Workspace/CPU_Raytracing/ C:/Workspace/CPU_Raytracing/"
    }
]

4. 规范CMake构建命令 #

运行CMake时使用绝对路径指定源码和构建目录，避免路径混淆：

cmake -B "C:/Workspace/CPU_Raytracing/build" -S "C:/Workspace/CPU_Raytracing"

5. 检查VSCode CMake插件设置 #

打开VSCode设置（Ctrl+,），搜索CMake: Build Directory，确保设置为正确的绝对路径，例如${workspaceFolder}/build，避免多余路径前缀。

内容的提问来源于stack exchange，提问作者JoinKwang Choi