ctag使用详解

使用方法：
1、生成tags文件
在目录树的根目录里，使用命令：ctags -R 或 ctags --recurse
如：ctags -R src/*，则会在当前目录下生成tags文件
2、编辑vim配置文件.vimrc
添加两行：　
set tags=tags;
set autochdir
注意第一个命令里的分号是必不可少的。这个命令让vim首先在当前目录里寻找tags文件，如果没有找到tags文件，或者没有找到对应的目标，就到父目录中查找，一直向上递归。因为tags文件中记录的路径总是相对于tags文件所在的路径，所以要使用第二个设置项来改变vim的当前目录。
当然你如果想直接使用绝对路径，这样也是可以的：
set tags=/home/xxx/myproject/tags

3、vim文件时，用用ctrl+]来执行跳转，通过ctrl+t来跳转回来就可以了，很方便的。

=======================================================================

本节所用命令的帮助入口：
:help ‘tags’
:help :tag
:help :tags
:help CTRL-]
:help CTRL-T
:help vimgrep
:help cw
:help pattern
尽管相关的文章已非常多了，但tag文件实在是太有用了，所以还是?嗦一次。
Tag文件(标签文件)无疑是研发人员的利器之一，有了tag文件的协助，你能在VIM查看函数调用关系，类、结构、宏等的定义，能在任意标签中跳转、返回……相信使用过Source Insight的人对这些功能并不陌生，而在VIM中，此功能的实现依赖于tag文件。
对于程式来说，Tag文件中保存了诸如函数、类、结构、宏等的名字，他们所处的文件，及怎么通过Ex命令跳转到这些标签。他是个纯文本文件，因此你能手工的编辑他，也能使用脚本对其进行操作。
通常我们使用名为ctags的程式来生成这样的tag文件。VIM能直接使用ctags程式所生成的tag文件。在UNIX系统下的ctags功能比较少，所以一般我们使用ExuberantCtags（在大多数Linux系统上，他是缺省的ctags程式），他能够支持多达33种程式语言，足以满足我们研发的需要了。如果你的系统上未安装此程式，请到
http://ctags.sourceforge.net
下载。
EMACS则使用etags来生成tag文件，如果希望VIM也能支持etags的tag文件格式，需要在编译VIM时加入” +emacs_tags”选项。
Tag文件需要遵循一定的格式，由Exuberant Ctags生成的tag文件，缺省是如下格式：
{tagname} {TAB} {tagfile} {TAB} {tagaddress} {term} {field} ..
{tagname}      标识符名字，例如函数名、类名、结构名、宏等。不能包含制表符。
{tagfile}  包含 {tagname} 的文件。他不能包含制表符。
{tagaddress}   能定位到 {tagname}光标位置的 Ex 命令。
{term}           设为“;"”。这是为了兼容Vi编辑器，使Vi忽略后面的{field}字段。
{field} ..  此字段可选，通常用于表示此{tagname}的类型是函数、类、宏或是其他。
在{tagname}、{tagfile}和{tagaddress}之间，采用制表符（TAB符，即C语言中的”＼t”）分隔，也就是说{tagname}、{tagfile}中不能包含制表符。
Tag文件的开头能包含以“!_TAG_”开头的行，用来在tag文件中加入其他信息。VIM能够识别两种这样的标记，经常用到的是“_TAG_FILE_SORTED”标记，例如：
!_TAG_FILE_SORTED1{anything}
上面这个标记说明tag文件是经过排序的，并且排序时区分了大小写，对排序的tag，VIM会使用二分法来进行查找，大大加快了查找速度；如果值为0，则表示tag文件未经排序；如果值为2，则表示tag文件是忽略大小写排序的。
之所以在这里介绍tag文件的格式，是因为我们在后面提到的lookupfile插件中，会自己生成tag文件。

虽然ctags有为数众多的选项，但通常我们所使用的非常简单。还是以VIM 7.0的代码为例，我们执行：
cd ~/src/vim70
ctags ?R src
上面这条命令会在~/src/vim70/目录下生成一个名为tags的文件，这个文件中包含~/src/vim70/src/目录下所有.c、.h文件中的标签。他一个文本文件，你能用VIM打开他看一下。此文件缺省按区分字母大小写排序，所以直接能被VIM使用。
目前我们进入VIM，执行下面的命令：
:cd ~/src/vim70      "转换当前目录为~/src/vim70
:set tags=tags       "设置tags选项为当前目录下的tags文件
目前，我们设置好了tags选项，接下来我们使用他：
:tag VimMain
你会看到VIM打开了src/main.c文件，并把光标定位到第167行VimMain上。
我们知道，一般主程式的函数名为main，如果你尝试下面的命令：
:tag main
  #pri kind tag               file  1 F   f    main             src/xxd/xxd.c               main(argc, argv)  2 FS  d    main             src/if_python.c               46Choice number ( cancels):
这里并没有src/main.c文件，怎么回事呢？这是因为ctags并不是编译器，他在处理编译预处理指令受到局限，因此并没有生成src/main.c中main()函数的标签。你能在生成tag文件时给ctags指定参数来解决这个问题。
或你能用”:grep”或”:vimgrep”来查找main（这已超出本文的范围了，因此只给出例子，在后续的文章再做讲解）：
:cd ~/src/vim70
:vimgrep /＼/ src/*.c
:cw
这时下面的窗口将显示出来，在quickfix窗口中找到我们想跳转的位置（本例中是src/main.c），按回车，就能跳到对应的位置了。

如果你只记得部分的标签名，那么能使用“tag”命令的搜索模式，你能输入一个VIM正则表达式来表示你所查找的名字，如：
:tag /＼C＼
  #pri kind tag               file  1 F   f    VimMain          src/main.c               VimMain  2 F   d    bindtextdomain   src/vim.h               483  3 F   d    bindtextdomain    src/vim.h              502  4 F   d    bindtextdomain    src/vim.h              504  5 F   f    main              src/xxd/xxd.c              main(argc, argv)  6 F   d    textdomain        src/vim.h              488  7 F   d    textdomain        src/vim.h               510  8 F  d    textdomain        src/vim.h               512  9 FS  d   bindtextdomain    src/gui_gtk.c               54 10 FS  d   bindtextdomain    src/gui_gtk_x11.c               37 11 FS  f   cmdsrv_main       src/main.c               cmdsrv_main(argc, argv,serverName_arg, serverStr) 12 FS  d    main             src/if_python.c               46 13 FS  d    textdomain       src/gui_gtk.c               51 14 FS  d    textdomain       src/gui_gtk_x11.c               34Choice number ( cancels):
这表示我想查找一个以一个或多个keyword开始的标签，此标签以ain做为结尾，在查找时区分大小写。要读懂这个正则表达式，请“:help pattern”。

VIM会保存一个跳转的标签栈，以允许你在跳转到一个标签后，再跳回来，能使用“:tags”命令查找你处于标签栈的哪个位置。
我们经常用到的tag跳转命令见下（一般只需要知道CTRL-]和CTRL-T就能了）：
:tag {ident}            "跳转到指定的标签
:tags                   "显示标签栈
CTRL-]                  "跳转到当前光标下的标签
CTRL-T                  "跳到标签栈中较早的标签
如果想了解更多命令，能“:help 29.1”（强烈建议程式员完整的阅读usr_29.txt和usr_30.txt）。
如果想更深入了解tag命令和相关知识，能“:help tagsrch”。
我之前写的一篇关于ctags和cscope的文章，参见：
Vim + Cscope/Ctags


没想到写了这么长……看来taglist插件要在下篇文章中介绍了。
本节所用命令的帮助入口：
:help helptags
:help taglist.txt
上篇文章介绍了在VIM中怎么使用tag文件，本文主要介绍怎么使用taglist插件。
想必用过SourceInsight的人都记得这样一个功能：SI能够把当前文件中的宏、全局变量、函数等tag显示在Symbol窗口，用鼠标点上述tag，就跳到该tag定义的位置；能按字母序、该tag所属的类或scope，及该tag在文件中出现的位置进行排序；如果转换到另外一个文件，Symbol窗口更新显示这个文件中的tag。
在VIM中的taglist插件所实现的就是上述类似的功能，有些功能比SI弱，有些功能比SI更强。而且，taglist插件仍在不断完善中！
要使用taglist插件，必须满足：
1. 打开VIM的文件类型自动检测功能；
2. 系统中装了Exuberant ctags工具，并且taglist能够找到此工具（因为taglist需要调用他来生成tag文件）；
3. 你的VIM支持system()调用；
在本系列第3篇文章(vimrc初步)中，我们使用了VIM自带的示例vimrc，这个vimrc中已打开了文件类型检测功能；在上篇文章中，我们也已用到了Exuberant ctags；system()调用在一般的VIM版本都会支持(只有suseLinux发行版中出于安全考虑，关闭了此功能)，所以我们已满足了这三个条件。
目前我们到
http://www.vim.org/scripts/script.php?script_id=273
下载最新版本的taglist plugin，目前版本是4.3。
下载后，把该文件在~/.vim/目录中解压缩，这会在你的~/.vim/plugin和~/.vim/doc目录中各放入一个文件：
       plugin/taglist.vim ? taglist插件
       doc/taglist.txt    - taglist帮助文件
注：windows用户需要把这个插件解压在你的$VIM/vimfiles或$HOME/vimfiles目录。

使用下面的命令生成帮助标签（下面的操作在VIM中进行）：
:helptags ~/.vim/doc
生成帮助标签后，你就能用下面的命令查看taglist的帮助了：
:help taglist.txt
Taglist提供了相当多的功能，我的vimrc中这样设置：
   """"""""""""""""""""""""""""""
   " Tag list (ctags)
   """"""""""""""""""""""""""""""
   if MySys() == "windows"                "设定windows系统中ctags程式的位置
     let Tlist_Ctags_Cmd = ’ctags’
   elseif MySys() == "linux"              "设定linux系统中ctags程式的位置
     let Tlist_Ctags_Cmd = ’/usr/bin/ctags’
   endif
   let Tlist_Show_One_File = 1            "不同时显示多个文件的tag，只显示当前文件的
   let Tlist_Exit_OnlyWindow = 1          "如果taglist窗口是最后一个窗口，则退出vim
   let Tlist_Use_Right_Window = 1         "在右侧窗口中显示taglist窗口
这样设置后，当你输入“:TlistOpen”时，显示如下窗口：

在屏幕右侧出现的就是taglist窗口，你从中能看到在main.c文件中定义的所有tag：宏、定义、变量、函数等；你也能双击某个tag，跳到该tag定义的位置；你还能把某一类的tag折叠起来（使用了VIM的折行功能），方便查看，就像图中macro和variable那样。更多的功能，请查看taglist的帮助页，本文也会介绍一些常用功能。

下面介绍常用的taglist设置选项，你能根据自己的习惯进行设置：
- Tlist_Ctags_Cmd选项用于指定你的Exuberant ctags程式的位置，如果他没在你PATH变量所定义的路径中，需要使用此选项设置一下；
- 如果你不想同时显示多个文件中的tag，设置Tlist_Show_One_File为1。缺省为显示多个文件中的tag；
- 设置Tlist_Sort_Type为”name”能使taglist以tag名字进行排序，缺省是按tag在文件中出现的顺序进行排序。按tag出现的范围（即所属的namespace或class）排序，已加入taglist的TODO List，但尚未支持；
- 如果你在想taglist窗口是最后一个窗口时退出VIM，设置Tlist_Exit_OnlyWindow为１；
- 如果你想taglist窗口出目前右侧，设置Tlist_Use_Right_Window为１。缺省显示在左侧。
- 在gvim中，如果你想显示taglist菜单，设置Tlist_Show_Menu为１。你能使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度；
- 缺省情况下，在双击一个tag时，才会跳到该tag定义的位置，如果你想单击tag就跳转，设置Tlist_Use_SingleClick为１；
- 如果你想在启动VIM后，自动打开taglist窗口，设置Tlist_Auto_Open为1；
- 如果你希望在选择了tag后自动关闭taglist窗口，设置Tlist_Close_On_Select为1；
- 当同时显示多个文件中的tag时，设置Tlist_File_Fold_Auto_Close为１，可使taglist只显示当前文件tag，其他文件的tag都被折叠起来。
- 在使用:TlistToggle打开taglist窗口时，如果希望输入焦点在taglist窗口中，设置Tlist_GainFocus_On_ToggleOpen为1；
- 如果希望taglist始终解析文件中的tag，不管taglist窗口有没有打开，设置Tlist_Process_File_Always为1；
- Tlist_WinHeight和Tlist_WinWidth能设置taglist窗口的高度和宽度。Tlist_Use_Horiz_Window为１设置taglist窗口横向显示；
在taglist窗口中，能使用下面的快捷键：
          跳到光标下tag所定义的位置，用鼠标双击此tag功能也相同
o             在一个新打开的窗口中显示光标下tag
       显示光标下tag的原型定义
u             更新taglist窗口中的tag
s             更改排序方式，在按名字排序和按出现顺序排序间转换
x             taglist窗口放大和缩小，方便查看较长的tag
+             打开一个折叠，同zo
-             将tag折叠起来，同zc
*             打开所有的折叠，同zR
=             将所有tag折叠起来，同zM
[[            跳到前一个文件
]]            跳到后一个文件
q             关闭taglist窗口
          显示帮助
能用“:TlistOpen”打开taglist窗口，用“:TlistClose”关闭taglist窗口。或使用“:TlistToggle”在打开和关闭间转换。在我的vimrc中定义了下面的映射，使用“,tl”键就能打开/关闭taglist窗口：
map  tl :TlistToogle
Taglist插件还提供了非常多Ex命令，你甚至能用这些命令创建一个taglist的会话，然后在下次进入VIM时加载此会话。
Taglist插件还能和winmanager插件协同使用，这将在下篇文章中介绍。

[参考文件]
1. VIM帮助文件
2.
http://vimcdoc.sourceforge.net/

3. taglist帮助文件
[尾记]
本文能自由应用于非商业用途。转载请注明出处。
原文链接：
http://blog.csdn.net/easwy