Vim调试程序 | 工匠之心

本文介绍使用vimspector插件将Vim打造成一个可逐行调试的IDE。

1.安装插件

首先是安装插件，在~/.vimrc中添加如下代码安装：

1 2	" 使用调试插件 Plug 'puremourning/vimspector'

我个人习惯了Visual Studio的调试快捷键，因此在Vim中继续使用，~/.vimrc中添加：

1 2	" 调试时使用visual studio的快捷键 let g:vimspector_enable_mappings = 'VISUAL_STUDIO'

完成后在Vim中使用PlugInstall安装插件，如果系统缺少依赖，可以通过提示自行安装。

2.插件语言支持安装

我个人用的最多的是C、nodejs和Python，所以只准备安装这几种语言支持，在vimspector安装目录下执行install_gadget.py命令：

1 2	cd ~/.vim/plugged/vimspector ./install_gadget.py --enable-python --enable-c --force-enable-node

官方文档说明只要完成上述操作即可，但是经个人实践，在实际操作过程中，如果是初次调试似乎还需要在Vim中继续执行VimSpectorInstall命令才能完成操作，不过好在这个过程是自动的，只要根据提示按回车即可。当然也可以手动执行，例如安装Python支持可运行：

1	:VimSpectorInstall debugpy

P.S. 命令执行过程中有些软件下载比较慢，可以根据提示用迅雷下载好再复制到对应的目录。

3.调试配置文件的使用

全局配置文件的路径看了很多文章和官方的文档均未搞定，所以我这边也不再深究，先写好了Linux下面的几个模板：

这是调试当前打开C/C++的配置文件，如果不需要输入参数，可以删除args字段：

{
  "configurations": {
    "cpp:launch": {
      "adapter": "vscode-cpptools",
      "configuration": {
        "name": "cpp",
        "type": "cppdbg",
        "request": "launch",
        "program": "${fileDirname}/${fileBasenameNoExtension}",
        "args": [
          "*${ProgramArgs}"
        ],
        "cwd": "${workspaceRoot}",
        "environment": [],
        "externalConsole": true,
        "stopAtEntry": true,
        "MIMode": "gdb",
        "logging": {
          "engineLogging": false
        }
      }
    }
  }
}

这是调试当前打开Nodejs的配置文件，如果不需要输入参数，可以删除args字段：

{
  "configurations": {
    "run": {
      "adapter": "vscode-node",
      "filetypes": [
        "javascript",
        "typescript"
      ],
      "configuration": {
        "request": "launch",
        "protocol": "auto",
        "stopOnEntry": true,
        "console": "integratedTerminal",
        "program": "${workspaceRoot}/${fileBasename}",
        "args": [
          "*${ProgramArgs}"
        ],
        "cwd": "${workspaceRoot}"
      }
    }
  }
}

这是调试当前打开Python的配置文件，如果不需要输入参数，可以删除args字段：

{
  "configurations": {
    "<name>: Launch": {
      "adapter": "debugpy",
      "filetypes": [
        "python"
      ],
      "configuration": {
        "name": "<name>: Launch",
        "type": "python",
        "request": "launch",
        "cwd": "${workspaceRoot}",
        "stopOnEntry": true,
        "console": "externalTerminal",
        "debugOptions": [],
        "program": "${workspaceRoot}/${fileBasename}",
        "args": [
          "*${ProgramArgs}"
        ]
      }
    }
  }
}

以上配置文件我保存在~/.vim/plugged/vimspector/gadgets/linux/.gadgets.d/下，但是发现系统无法读取这些全局配置，没有找到好的解决办法，自己写了个函数完成复制配置文件到当前文件夹的操作，设置其快捷键为F3：

" F3 复制vimspector配置文件到当前目录
map <F3> :call CopySpectorconfig()<CR>
func! CopySpectorconfig()
    if &filetype == 'c'
        exec "!cp ~/.vim/plugged/vimspector/gadgets/linux/.gadgets.d/c.json ./.vimspector.json"
    elseif &filetype == 'cpp'
        exec "!cp ~/.vim/plugged/vimspector/gadgets/linux/.gadgets.d/c.json ./.vimspector.json"
    elseif &filetype == 'javascript'
        exec "!cp ~/.vim/plugged/vimspector/gadgets/linux/.gadgets.d/node.json ./.vimspector.json"
    elseif &filetype == 'python'
        exec "!cp ~/.vim/plugged/vimspector/gadgets/linux/.gadgets.d/python.json ./.vimspector.json"
    endif
endfunc

3.其它的配置

完成以上操作打开源文件，按F3完成配置文件的复制后，再按F5应该就可以启动调试。不过C/C++的程序在调试前还需要编译成Debug版本，写了个函数完成，按照Visual Studio的习惯设置其快捷键为F7：

" F7编译C/C++调试版本，便于vimspector调试
map <F7> :call CompileFile()<CR>
func! CompileFile()
    exec "w"
    if &filetype == 'c'
        exec "!gcc -Wall -g2 % -o %<"
    elseif &filetype == 'cpp'
        exec "!g++ -Wall -g2 % -o %<"
    endif
endfunc

如果要退出调试状态，可以运行命令:VimspectorReset，我嫌比较麻烦，直接再设定一个快捷键F4搞定：

1 2	" F4关闭vimspector窗口 nnoremap <silent> <F4> :VimspectorReset<CR>

图 vimspector调试C程序

至此Vim的调试工作搭建完成，应该可以作为一个比较完善的IDE使用，调试工作有了早年使用Turbo C的味道了。

P.S. 如果是raspbian系统，默认安装的Vim是不带Python支持的，导致VimSpector插件无法使用，解决办法是安装带Python支持的Vim：

1	sudo apt-get install vim-nox -y

同时测试发现Raspbian尽管插件安装提示正常，但C和C++无法调试，Python和Node可用，看到官方的Github上Issue也有人提及但没有解决方案，不知道是不是架构的问题。

2022.11.9修改：

确定是vimspector在Raspbian armhf中下载了错误的架构，Raspbian arm64则是正确的。

以下是我做的一些工作：

下载codelldb-arm-linux.vsix，地址在https://github.com/vadimcn/vscode-lldb/releases。
将其重命名为codelldb-x86_64-linux并复制到/home/pi/.vim/plugged/vimspector/gadgets/linux/download/CodeLLDB/v1.7.4/。
修改~/.vim/plugged/vimspector/python3/vimspector/gadgets.py第534行，将checksum更换为codelldb-arm-linux.vsix的：21f648e522696e9af4c90cf7fcaa82b7ae52a72431140459fab2ffb3228ceaa5.

vscode-cpptools应该也是同样的问题，可以从https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools
下载最新的arm版。最新版为1.13.3，同样拷贝至对应版本的文件夹下/home/pi/.vim/plugged/vimspector/gadgets/linux/download/vscode-cpptools/1.13.3/,修改~/.vim/plugged/vimspector/python3/vimspector/gadgets.py对应的checksum。

最后进入/home/pi/.vim/plugged/vimspector/,重新安装插件： ./install_gadget.py --enable-c，至此codelldb和vscode-cpptools插件在Raspbian armhf均可用了。

Bug已经提交了，希望作者能够早点改进吧。

2022.11.14修改：

作者动作很快，直接添加了支持，目前在源码armv7分支测试功能完美，只待合并至主分支了。