背景

在 vim 中应用 fzf.vim 插件能够进行不便的搜寻文件, 源码TAG, GIT 记录等, 最近抽空看了下 BTags 命令在 c, c++ 文件中, 无奈显示头文件中的函数申明 标签问题.

比方在头文件中有如下一个函数申明, 应用 BTags 命令是无奈显示出这个函数原型的.

/*=========================================================================函 数 名： IMGVideoAlgOpen功    能： 算法初始化算法实现： 无参    数： pvHandle                    算法句柄[in]emIMGAlgType                算法类型[in]pvOpen                      初始化构造体指针[in]返 回 值： 返回函数调用信息===========================================================================*/int IMGVideoAlgOpen(void** pvHandle,                                                EMIMGAlgType emIMGAlgType,                                               void* pvOpen);

剖析

通过代码定位, 在 ~/.vim/bundle/fzf.vim/autoload/fzf/vim.vim 文件中, 能够看到 BTags 是通过 ctags 生成的标签.

" query, [tag commands], [spec (dict)], [fullscreen (bool)]function! fzf#vim#buffer_tags(query, ...)  ...  let sort = has('unix') && !has('win32unix') && executable('sort') ? '| sort -s -k 5' : ''  let tag_cmds = (len(args) > 1 && type(args[0]) != type({})) ? remove(args, 0) : [    \ printf('ctags -f - --sort=yes --excmd=number --language-force=%s %s 2> %s %s', get({ 'cpp': 'c++' }, &filetype, &filetype), escaped, null, sort),    \ printf('ctags -f - --sort=yes --excmd=number %s 2> %s %s', escaped, null, sort)]  ...endfunction

通过在命令行执行 ctags 命令, 的确是没有生成函数申明的标签.

$ ctags -f - --sort=yes --excmd=number --language-force=c  include/VideoAlg.h | grep IMGVideoAlgInit# output nothing

通过查问 ctags 文档理解到, 每个语言生成标签时, 都有默认的标签类型列表.
能够通过 --kinds-(<LANG>|all)=[+|-](<kinds>|*) 参数去管制, 比方我须要管制 c 语言的生成标签类型, 能够写成这样: --kinds-C=+类型.

具体的标签类型能够通过 ctags --list-kinds-full 进行查看, 如下.

$ ctags --list-kinds-full# output#LANGUAGE            LETTER NAME                  ENABLED REFONLY NROLES MASTER DESCRIPTION...C                    D      macroparam            no      no      0      C      parameters inside macro definitionsC                    L      label                 no      no      0      C      goto labelsC                    d      macro                 yes     no      1      C      macro definitionsC                    e      enumerator            yes     no      0      C      enumerators (values inside an enumeration)C                    f      function              yes     no      0      C      function definitionsC                    g      enum                  yes     no      0      C      enumeration namesC                    h      header                yes     yes     2      C      included header filesC                    l      local                 no      no      0      C      local variablesC                    m      member                yes     no      0      C      struct, and union membersC                    p      prototype             no      no      0      C      function prototypesC                    s      struct                yes     no      0      C      structure namesC                    t      typedef               yes     no      0      C      typedefsC                    u      union                 yes     no      0      C      union namesC                    v      variable              yes     no      0      C      variable definitionsC                    x      externvar             no      no      0      C      external and forward variable declarationsC                    z      parameter             no      no      0      C      function parameters inside function definitions...

由上 ENABLED 列可知, 默认 ctags 为 c 语言生成的 tags 是不蕴含 prototype 的, 如果须要反对生成 prototype, 须要应用参数加上.

解决

批改 ~/.vim/bundle/fzf.vim/autoload/fzf/vim.vim 文件, 减少 ctags --kinds-C=+p 参数来反对 prototype 办法签名.

    \ printf('ctags -f - --sort=yes --kinds-C=+p --excmd=number --language-force=%s %s 2> %s %s', get({ 'cpp': 'c++' }, &filetype, &filetype), escaped, null, sort),    \ printf('ctags -f - --sort=yes --kinds-C=+p --excmd=number %s 2> %s %s', escaped, null, sort)]

搞定出工, 同时也提交了 PR 到 github , 不晓得是否会驳回.

总结

如果须要其它语言额定的标签类型, 能够基于相似的办法增加.回忆了一下 ctag 之所以默认不提供 prototype 类型的标签, 可能是因为一个文件中如果有申明和定义, 可能会有两个雷同的标签影响查看. 我这边是做了标签抉择预览的, 所以不存在这个问题.

参考

  • https://docs.ctags.io/en/latest/man/ctags.1.html