Vim标签文件配置

Vim标签文件配置

发表于  2011 年 03 月 06 日  由  admin

当工程项目相对较大/复杂时，源文件常常分类别/层次存放在不同子目中。这种情况下，可以在工程根路径下，使用"-R"选项使ctags遍历各级子文件夹，为工程生成单一的标签文件。一般地，工程的标签文件存放于工程根文件夹之下。通过对vim配置文件中(一般为~/.vimrc)中"tags"项目的设置，我们可以控制Vim查找标签文件的位置和顺序。

1. 使用多个标签文件

"tags"项为tags文件列表，每一个对应于一个标签文件，列表项中的多个项目用','隔开。Vim进行标签查找时，从前至后依列表序在指定文件中查找标签，直到找到与当前文件缓冲区匹配的标签或全局标签为止。

例：以下设置指定Vim查找标签文件的顺序是：当前文件所在路径下的tags文件("./tags")、Vim工作路径下的tags文件("tags")、用户根目录之下/.vim/tags/linux/ctags路径下的tags文件。

1. set tags=./tags,tags,~/.vim/tags/linux/ctags/tags  

注意，"./tags"和"tags"项目所指路径可能相同，也可能不同。假定我们在用户根路径(~)之下调用命令"vim proj/main.c"，则"./tags"等价于"~/proj/tags"，而"tags"等价于"~/tags"。如果工作在"autochdir"状态下，Vim会自动将工作路径切换为当前打开文件所在路径，这样"./tags"就等同于"tags"。

2. 配置Vim自动逐级向上查找标签文件

对于使用多级目录形式存放的某一个项目，一般地，为了方便查找，通常只为整个项目生成一个标签文件，存放在项目根文件夹下。

在Vim选项"autochdir"未打开条件下，从项目根路径调用Vim，如果Vim配置中"tags"指定标签文件列表中包含"tags"(非"./tags")，则无论打开哪一级子文件夹下的文件，Vim始终可以正确找到标签文件，因为Vim工作路径始终保持在项目根路径下；如果Vim选项"autochdir"有效，或者我们并非从项目根路径调用Vim，则Vim就没办法找到正确的标签文件了。

以上问题的解决方法很简单，可以将项目的标签生成到一个固定路径之下（如~/.vim/tags/usr/ctags/tags)，并写入Vim配置中。但如果同时有多个工程项目，那标签的重复/查找会有些不便。

Vim允许指定从当前路径开始，逐级向上查找文件的方式。因此一种更好的方法是

1. set tags=./tags;,~/.vim/tags/linux/ctags/tags  

以上配置指定Vim从当前打开文件所在文件夹下开始，并逐级向自动查找tags文件，直至找到标签或到达根路径('/')。（当然还有一另一个固定的标签文件~/.vim/tags/linux/ctags/tags)。

3. 自动更新标签文件

Vim中的au[tocmd]命令，可以设定用事件来触发执行用户指定命令。此外，Vim也支持脚本的使用。结合Vim脚本和au命令，可以完成代码修改后自动更新标签文件定义的功能。

如果代码标签文件位置固定(如~/.vim/tags/usr/ctags/tags)，则可以在Vim配置中进行如下设置：

1. au BufWritePost *.cpp,*.h,*.c,*.def call system("ctags --tag-relative -a  -o ~/.vim/tags/usr/ctags/tags --extra=+q " . expand("%:p"))  

以上配置当"*.cpp,*.h,*.c,*.def"文件在完成保存操作后(BufWritePost)，自动调用系统命令(system)去执行ctags命令，并指定ctags以相对路径("--tag-relative")、追加("-a")方式将当前文件(expand("%:p"))的标签生成至目标文件(~/.vim/tags/usr/ctags/tags)中。

如果我们使用了上面将标签文件存放在项目根路径下、Vim从当前打开文件所在路径开始逐级向上查找标签文件的方式，则需要额外定位所使用标签文件所在位置。

1. function RegenTag()  
2.     let tagfile = findfile("tags", ".;")  
3.   
4.     if strlen(tagfile) == 0  
5.         let tagfile = "./tags"  
6.     endif  
7.   
8.     call system("ctags --tag-relative -a --extra=+q -o " .tagfile ." " .expand("%:p"))  
9. endfunction  
10.   
11. au BufWritePost *.cpp,*.h,*.c,*.def call RegenTag()  

RegenTag()函数中，我们使用了Vim内置函数findfile()从当前路径开始逐级向上去查找是否存在tags文件。如果找到，则将当前文件的标签定向到此文件；如未找到，则在当前打开文件所在文件夹下新建标签文件tags。RegenTag()被"*.cpp,*.h,*.c,*.def"类型文件的保存完成事件自动触发。

4. 完整配置

最终，Vim配置文件中，tags相关设置如下：

1. set tags=./tags;,~/.vim/tags/linux/ctags/tags  
2.   
3. function RegenTag()  
4.     let tagfile = findfile("tags", ".;")  
5.   
6.     if strlen(tagfile) == 0  
7.         let tagfile = "./tags"  
8.     endif  
9.   
10.     call system("ctags --tag-relative -a --extra=+q -o " .tagfile ." " .expand("%:p"))  
11. endfunction  
12.   
13. au BufWritePost *.cpp,*.h,*.c,*.def call RegenTag()  

5. 参考

以上配置/脚本，更详细的信息可参考Vim帮助

:help function
:help script
:help tags
:help autocmd
...

此条目发表在  others,  Unix-like 分类目录，贴了  plugin,  vim 标签。将 固定链接加入收藏夹。