vim插件之ctags


ctags 是一个外部程序，它通过扫描代码库，生成关键字的索引,使得我们可以快速地跳到函数及类的定义之处。

1、用 ctags 创建代码库的索引

ctags -R

在 Vim 中直接调用 ctags：

:!ctags -R

     ctags 创建了一个名为 tags 的纯文本文件，其内容是 ctags 经过对当前目录及子目录

的源文件的分析而生成的关键字索引。标签文件的前几行由元数据组成。而此后的每一行文本

均由关键字、文件名以及关键字在源代码中的位置这 3 项内容构成。

!_TAG_FILE_FORMAT 2 /extended format/

文件格式，2指明采用扩展格式，在3项内容之后可添加附加信息， c 表示“类”，d表示“变量定义”，f代表“函数”。

!_TAG_FILE_SORTED 1 /0=unsorted, 1=sorted, 2=foldcase/----------------标签排序方式，1按字母排序

!_TAG_PROGRAM_AUTHOR Darren Hiebert //------------------作者

!_TAG_PROGRAM_NAME Exuberant Ctags //-------------插件名称

!_TAG_PROGRAM_URL http://ctags.sourceforge.net /official site/---------下载地址

!_TAG_PROGRAM_VERSION 5.8 //--------------版本号

在这之后是生成的标签信息。

另外，ctags不会生成局部变量的索引。

为某些源码生成tags文件，使用如下命令

$ ctags filename.c filename1.c file.h

或

$ ctags *.c *.h

2、配置 Vim 使用 ctags

如果我们想在 Vim 中使用基于 ctag 的跳转命令， 首先， 要确保标签文件是最新的，

其次，要让 Vim 知道到哪里去找标签文件。

'tags'选项指定了 Vim 应该到哪里去找标签文件（参见:h 'tags' ）。当'tags'

选项为 ./ 时， Vim 将把它替换成当前文件所在的路径。

以下命令用于查看缺省的配置：

:set tags?

《tags=./tags,tags

根据上述配置， Vim 会在当前文件所在目录以及工作目录中查找标签文件。在某

些情况下，如果 Vim 已在第一个标签文件中找到了匹配项，就不会在第二个标签文件

中继续查找了。

3、在每次保存文件时自动执行 ctags

Vim 的自动命令（ autocommand）功能允许我们在某个事件发生时调用一条命令，

这些事件包括缓冲区的创建、打开或者保存等。因此，我们可以创建一条自动命令，

在每次保存文件时自动调用 ctags：

:autocmd BufWritePost * call system("ctags -R")

这样一来，每当我们保存文件的改动时，都会对整个代码库进行更新索引操作。

4、使用 Vim 的标签跳转命令，浏览关键字的定义

命令 用途

<C-]> 跳转到匹配当前光标所在关键字的第一处标签

:ta[g] tagName 

（1）如果有多个匹配的Tag，则会弹出窗口，按照如下形式展示,#那一列是序号，输入序号就可跳转到对应的tag处。

Cscope tag: tagName

   #   line  filename / context / line

（2）如果只有一个匹配的tag，直接跳转到tag处。

:tn[ext] 跳转到下一处匹配的标签

:tp[rev] 跳转到上一处匹配的标签

:tfirst 跳转到第一处匹配的标签

:tlast 跳转到最后一处匹配的标签

:tselect 提示用户从标签匹配列表中选择一项进行跳转

最后三个命令，有时候不知道为什么不能使用，后续再关注吧

Ctrl + o/t 返回到跳转前的位置。

:tags 查看跳转记录，并用'>'指出当前位置