dde-shell 调试简明指南
桌面环境组件的开发调试相比应用组件总会有或多或少的不同,本文就旨在提供一个快速简明的描述,给期望开发或调试 dde-shell 以及其插件的开发者一个参考,以便快速上手。
环境推荐
你实际上可以使用任意自己喜欢的 IDE/开发环境,方便起见,此处以下列环境作为基础。若你使用其他开发工具或环境,则需自己参照实际情况进行调整。
- IDE: Visual Studio Code 或其衍生版本
- 推荐安装的插件
- Native Debug (webfreak.debug) (用于使用 gdb 启动调试)
- clangd (llvm-vs-code-extensions.vscode-clangd) (用于提供 C++ LSP)
- CMake Tools (ms-vscode.cmake-tools) (用于初始的配置和构建)
- 推荐安装的插件
推荐使用 VSCode 或衍生版本是因为 VSCode 目前事实上是主流 IDE。后附的三个插件均是 VSCode 官方仓库以及 Open VSX 仓库 都可以获取到的。下面所涉及的配置文件主要会和 Native Debug 插件有一定相关性。
构建项目
事实上,dde-shell 的项目和常规 CMake 项目并无不同,常规的 CMake 配置和构建过程即适用于 dde-shell 项目。不过为了更好的 IDE 集成,建议确保 -DCMAKE_EXPORT_COMPILE_COMMANDS=ON 配置以便在构建目录中生成可供 clangd 消费的 compile_commands.json。
你亦可直接使用 CMake Tools 完成配置和构建,也是本文推荐的做法。好处是你还可以在 VSCode 中看到相关的单元测试,以及直接在 IDE 中点击相关按钮完成整个构建过程。
[!NOTE] 请注意:不要进行安装(
make install/cmake --build build --target install),因为默认的安装位置是/usr/local/bin,并非期望的位置。盲目手动安装意味着卸载也会非常困难。若要运行自己所构建的版本,请参阅后面的部分。