vim+ctags+taglist和vim中gdb调试

ctags

本节所用命令的帮助入口：

: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功能比较少，所以一般我们使用Exuberant Ctags(在大多数Linux系统上，它是缺省的ctags程序)，它能够支持多达33种程序语言，足以满足我们开发的需要了。这里是它的中文手册。如果你的系统上未安装此程序，请到下载。

emacs则使用etags来生成tag文件，如果希望vim也能支持etags的tag文件格式，需要编译vim时加入”+emacs_tags“选项。在这篇文章介绍了编译vim的方法。

Tag文件需要遵循一定的格式，由Exuberant Ctags生成的tag文件，缺省是如下格式：

{tagname} {TAB} {tagfile} {TAB} {tagaddress} {term} {field} .. 
{tagname} - 标识符名字，例如函数名、类名、结构名、宏等。不能包含制表符。
{tagfile} - 包含 {tagname} 的文件。它不能包含制表符。
{tagaddress} - 可以定位到 {tagname}光标位置的 Ex 命令。通常只包含行号或搜索命令。出于安全的考虑，vim会限制其中某些命令的执行。
{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
46
Choice number ( cancels):
这里并没有src/main.c文件，怎么回事呢？这是因为ctags并不是编译器，它在处理编译预处理指令受到局限，因此并没有生成src/main.c中main()函数的标签。你可以在生成tag文件时给ctags指定参数来解决这个问题。见ctags手册。

或者你可以用”:grep“或”:vimgrep“来查找main(这篇文章讲解grep及vimgrep的用法)：

:cd ~/src/vim70
:vimgrep /\/ src/*.c
:cw
这时下面的quickfix窗口将显示出来，在quickfix窗口中找到我们想跳转的位置(本例中是src/main.c)，按回车，就可以跳到对应的位置了。

点击查看大图
如果你只记得部分的标签名，那么可以使用”tag“命令的搜索模式，你可以输入一个vim正则表达式来表示你所查找的名字，如：

:tag /\C\<\k\+ain\>
# 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
34
Choice 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“。

####################################################

taglist

本节所用命令的帮助入口：

:help helptags
:help taglist.txt
上篇文章介绍了在vim中如何使用tag文件，本文主要介绍如何使用taglist插件(plugin)。

想必用过Source Insight的人都记得这样一个功能：SI能够把当前文件中的宏、全局变量、函数等tag显示在Symbol窗口，用鼠标点上述tag，就跳到该tag定义的位置；可以按字母序、该tag所属的类或scope，以及该tag在文件中出现的位置进行排序；如果切换到另外一个文件，Symbol窗口更新显示这个文件中的tag。

在vim中的taglist插件所实现的就是上述类似的功能，有些功能比SI弱，有些功能比SI更强。而且，taglist插件还在不断完善中！

要使用taglist plugin，必须满足：

打开vim的文件类型自动检测功能：filetype on
系统中装了Exuberant ctags工具，并且taglist plugin能够找到此工具（因为taglist需要调用它来生成tag文件）
你的vim支持system()调用
在文章vimrc初步中，我们使用了vim自带的示例vimrc，这个vimrc中已经打开了文件类型检测功能；在上篇文章中，我们也已用到了Exuberant ctags；system()调用在一般的vim版本都会支持(suse Linux发行版中出于安全考虑，关闭了此功能)，所以我们已经满足了这三个条件。

现在我们到下载最新版本的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为1；
如果你想taglist窗口出现在右侧，设置Tlist_Use_Right_Window为1。缺省显示在左侧。
在gvim中，如果你想显示taglist菜单，设置Tlist_Show_Menu为1。你可以使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度；
缺省情况下，在双击一个tag时，才会跳到该tag定义的位置，如果你想单击tag就跳转，设置Tlist_Use_SingleClick为1；
如果你想在启动vim后，自动打开taglist窗口，设置Tlist_Auto_Open为1；
如果你希望在选择了tag后自动关闭taglist窗口，设置Tlist_Close_On_Select为1；
当同时显示多个文件中的tag时，设置Tlist_File_Fold_Auto_Close为1，可使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为1设置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中定义了下面的映射，使用键就可以打开/关闭taglist窗口：

map :TlistToggle
Taglist插件还提供了很多命令，你甚至可以用这些命令创建一个taglist的会话，然后在下次进入vim时加载此会话。

######################################

vim中gdb调试

本节所用命令的帮助入口：

:help vimgdb 在UNIX系统最初设计时，有一个非常重要的思想：每个程序只实现单一的功能，通过管道等方式把多个程序连接起来，使之协同工作，以完成更强大的功能。程序只实现单一功能，一方面降低了程序的复杂性，另一方面，也让它专注于这一功能，把这个功能做到最好。就好像搭积木一样，每个积木只提供简单的功能，但不同的积木垒在一起，就能搭出大厦、汽车等等复杂的东西。

从UNIX系统(及其变种，包括Linux)的命令行就可以看出这一点，每个命令只专注于单一的功能，但通过管道、脚本等把这些命令揉合起来，就能完成复杂的任务。

vi/vim的设计也遵从这一思想，它只提供了文本编辑功能(与Emacs的大而全刚好相反)，而且正如大家所看到的，它在这一领域做的是如此的出色。

也正因为如此，vim自身并不提供集成开发环境所需的全部功能(它也不准备这样做，vim只想成为一个通用的文本编辑器)。它把诸如编译、调试这样功能，交给更专业的工具去实现，而vim只提供与这些工具的接口。

我们在前面已经介绍过vim与编译器的接口(即quickfix)，vim也提供了与调试器的接口，这一接口就是netbeans。除此之外，还可以给vim打一个补丁，以使其支持gdb调试器。

由于netbeans接口只能在gvim中使用，而使用vimgdb补丁，无论在终端的vim，还是gvim，都可以调试。所以我更喜欢打补丁的方式，我首先介绍这种方法。

打补丁的方式，需要重新编译vim，刚好借这个机会，介绍一下vim的编译方法。我只介绍Linux上编译方法，如果你想在windows上编译vim，可以参考这篇文档：Vim: Compiling HowTo: For Windows。

[ 下载vim源代码 ]

首先我们需要下载vim的源码。到vim主页下载当前最新的vim 7.1的源代码，假设我们把代码放到~/install/目录，文件名为vim-7.1.tar.bz2。

[ 下载vimgdb补丁 ]

接下来，我们需要下载vimgdb补丁，下载页面在：

在这里，选择vim 7.1的补丁，把它保存到~/install/vimgdb71-1.12.tar.gz。

[ 打补丁 ]

运行下面的命令，解压源码文件，并打上补丁：

cd ~/install/
tar xjf vim-7.1.tar.bz2
tar xzf vimgdb71-1.12.tar.gz
patch -d vim71 --backup -p0 < vimgdb/vim71.diff [ 定制vim的功能 ]

缺省的vim配置已经适合大多数人，但有些时候你可能需要一些额外的功能，这时就需要自己定制一下vim。定制vim很简单，进入~/install/vim71/src文件，编辑Makefile文件。这是一个注释很好的文档，根据注释来选择：

如果你不想编译gvim，可以打开–disable-gui选项；
如果你想把perl, python, tcl, ruby等接口编译进来的话，打开相应的选项，例如，我打开了–enable-tclinterp选项；
如果你想在vim中使用cscope的话，打开–enable-cscope选项；
我们刚才打的vimgdb补丁，自动在Makefile中加入了–enable-gdb选项；
如果你希望在vim使用中文，使能–enable-multibyte和–enable-xim选项；
可以通过–with-features=XXX选项来选择所编译的vim特性集，缺省是–with-features=normal；
如果你没有root权限，可以把vim装在自己的home目录，这时需要打开prefix = $(HOME)选项；
编辑好此文件后，就可以编辑安装vim了。如果你需要更细致的定制vim，可以修改config.h文件，打开/关闭你想要的特性。

[ 编译安装 ]

编译和安装vim非常简单，使用下面两个命令：

make
make install 你不需要手动运行./configure命令，make命令会自动调用configure命令。

上面的命令执行完后，vim就安装成功了。

我在编译时打开了”prefix = $(HOME)”选项，因此我的vim被安装在~/bin目录。这时需要修改一下PATH变量，以使其找到我编辑好的vim。在~/.bashrc文件中加入下面这两句话：

PATH=$HOME/bin:$PATH
export PATH 退出再重新登录，现在再敲入vim命令，发现已经运行我们编译的vim了。

[ 安装vimgdb的runtime文件 ]

运行下面的命令，解压vimgdb的runtime文件到你的~/.vim/目录：

cd ~/install/vimgdb/
tar zxf vimgdb_runtime.tgz –C~/.vim/ 现在启动vim，在vim中运行下面的命令以生成帮助文件索引：

:helptags ~/.vim/doc 现在，你可以使用”:help vimgdb“命令查看vimgdb的帮助了。

至此，我们重新编译了vim，并为之打上了vimgdb补丁。下面我以一个例子来说明如何在vim中完成”编码—编译—调试”一条龙服务。

[ 在vim中调试 ]

首先确保你的计算机上安装了gdb ，vimgdb支持5.3以上的gdb版本，不过最好使用gdb 6.0以上的版本。

我使用下面这个简单的例子，来示例一下如何在vim中使用gdb调试。先来看示例代码：

文件~/tmp/sample.c内容如下，这是主程序，调用函数计算某数的阶乘并打印：

/* ~/tmp/sample.c */
#include
extern int factor(int n, int *rt);

int main(int argc, char **argv)
{
    int i;
    int result = 1;

    for (i = 1; i < 6; i++)
    {
        factor(i, &result);
        printf("%d! = %d\n", i, result);
    }

    return 0;
}  文件~/tmp/factor/factor.c内容如下，定义了子函数factor()。之所以把它放到子目录factor/，是为了演示vimgdb可以根据调试位置自动打开文件，不管该文件在哪个目录下：

/* ~/tmp/factor/factor.c */
int factor(int n, int *r)
{
    if (n <= 1)
        *r =  n;
    else
    {
        factor(n - 1, r);
        *r *= n;
    }

    return 0;
}  Makefile文件，用来编译示例代码，最终生成的可执行文件名为sample。

# ~/tmp/Makefile
sample: sample.c factor/factor.c
gcc -g -Wall -o sample sample.c factor/factor.c  假设vim的当前工作目录是~/tmp(使用”:cd ~/tmp“命令切换到此目录)。我们编辑完上面几个文件后，输入命令”:make“，vim就会根据Makefile文件进行编译。如果编译出错，vim会跳到第一个出错的位置，改完后，用”:cnext“命令跳到下一个错误，以此类推。这种开发方式被称为quickfix，我们已经在剑不离手 - quickfix一文中讲过，不再赘述。

现在，假设已经完成链接，生成了最终的sample文件，我们就可以进行调试了。

vimgdb补丁已经定义了一些键绑定，我们先加载这些绑定：

:run macros/gdb_mappings.vim 加载后，一些按键就被定义为调试命令(vimgdb定义的键绑定见”:help gdb-mappings“)。按可以在按键的缺省定义和调试命令间切换。

好了，我们现在按空格键，在当前窗口下方会打开一个小窗口(command-line窗口)，这就是vimgdb的命令窗口，可以在这个窗口中输入任何合法的gdb命令，输入的命令将被送到gdb执行。现在，我们在这个窗口中输入”gdb“，按回车后，command-line窗口自动关闭，而在当前窗口上方又打开一个窗口，这个窗口是gdb输出窗口。现在vim的窗口布局如下(我又按空格打开了command-line窗口)：

点击查看大图
小技巧: command-line窗口是一个特殊的窗口，在这种窗口中，你可以像编辑文本一样编辑命令，完成编辑后，按回车，就会执行此命令。你要重复执行某条命令，可以把光标移到该命令所在的行，然后按回车即可；你也可以对历史命令进行修改后再执行。详见”:help cmdline-window“。

接下来，在command-line窗口中输入以下命令：

cd ~/tmp
file sample 这两条命令切换gdb的当前工作目录，并加载我们编译的sample程序准备调试。

现在使用vim的移动命令，把光标移动到sample.c的第7行和14行，按”CTRL-B“在这两处设置断点，然后按”R“，使gdb运行到我们设置的第一个断点处(”CTRL-B“和”R“都是gdb_mappings.vim定义的键绑定，下面介绍的其它调试命令相同)。现在vim看起来是这样：

点击查看大图
断点所在的行被置以蓝色，并在行前显示标记1和2表明是第几个断点；程序当前运行到的行被置以黄色，行前以”=>”指示，表明这是程序执行的位置(显示的颜色用户可以调整)。

接下来，我们再按”C“，运行到第2个断点处，现在，我们输入下面的vim命令，在右下方分隔出一个名为gdb-variables的窗口：

:bel 20vsplit gdb-variables 然后用”v“命令选中变量i，按”CTRL-P“命令，把变量i加入到监视窗口，用同样的方式把变量result也加入到监视窗口，这里可以从监视窗口中看到变量i和result的值。

点击查看大图
现在我们按”S“步进到factor函数，vim会自动打开factor/factor.c文件并标明程序执行的位置。我们再把factor()函数中的变量n加入到监视窗口；然后按空格打开command-line窗口，输入下面的命令，把变量*r输入到变量窗口：

createvar *r 现在，vim看起来是这样的：

点击查看大图
现在，你可以用”S“、”CTRL-N“或”C“来继续执行，直至程序运行结束。

如果你是单步执行到程序结束，那么vim最后可能会打开一个汇编窗口。是的，vimgdb支持汇编级的调试。这里我们不用进行汇编级调试，忽略即可。

如果你发现程序有错误，那么可以按”Q“退出调试(gdb会提示是否退出，回答y即可)，然后修改代码、编译、调试，直到最终完成。在修改代码时，你可能并不喜欢vimgdb的键映射(例如，它把CTRL-B映射为设置断点，而这个键又是常用的翻页功能)，你可以按取消vimgdb的键映射，或者你直接修改gdb_mappings.vim文件中定义的映射。

看，vim + gdb调试是不是很简单?!

我们可以再定制一下，使调试更加方便。

打开~/.vim/macros/ gdb_mappings.vim文件，在”let s:gdb_k = 0“这一行下面加上这段内容：

" easwy add
if ! exists("g:vimgdb_debug_file")
    let g:vimgdb_debug_file = ""
elseif g:vimgdb_debug_file == ""
    call inputsave()
    let g:vimgdb_debug_file = input("File: ", "", "file")
    call inputrestore()
endif
call gdb("file " . g:vimgdb_debug_file)
" easwy end 在”let s:gdb_k = 1“这一行下面加上这段内容：

" easwy add
call gdb("quit")
" end easwy 注释掉最后一行的”call s:Toggle()“。

然后在你的vimrc中增加这段内容：

""""""""""""""""""""""""""""""
" vimgdb setting
""""""""""""""""""""""""""""""
let g:vimgdb_debug_file = ""
run macros/gdb_mappings.vim 现在，在启动vim后，按，就进入调试模式以及设定调试的键映射。在第一次进入调试模式时，会提示你输入要调试的文件名，以后就不必再输入了。再按一次，就退出调试模式，取消调试的键映射。

利用vim的键映射(map)机制，你可以把你喜欢的gdb命令映射为vim的按键，方便多了。映射的例子可以参照~/.vim/macros/ gdb_mappings.vim。

再附上一张抓图，这是使用putty远程登录到linux上，在终端vim中进行调试。这也是我为什么喜欢vimgdb的原因，因为它可以在终端vim中调试，而clewn只支持gvim：

点击查看大图
因为我不常使用gdb调试，所以本文仅举了个简单的例子，以抛砖引玉。欢迎大家共享自己的经验和心得。

转自: http://easwy.com/blog/