（vim+ctags+taglist +cscope）：（ubuntu 10.10下安装Ctags与TAGLISTS插件）

作为电子专业的使用者来说，我们主要用vim来开发c程序。那么我们需要安装两个插件来提高程序的编写效率，当然在windows下ultraedit这样的工具。但是在Linux环境下我们主要还是使用vim。下面接受如何安装以及简单的使用办法。

（1）到http://ctags.sourceforge.net/下载ctags源码ctags-5.8.tar.gz （ctags可以用命令行简单安装，不用像下面这么麻烦）

（2）解压并安装

tar zxvf ctags-5.8.tar.gz

cd ctags-5.6

./configure && make && make install

（3）使用

你放置源代码文件的目录$ ctags -R

注意：taglist依赖于ctags，所以要先装ctags，否则taglist装了也没法用！

（1）到http://vim.sourceforge.net/scripts/script.php?script_id=273

下载taglist_45.tar.gz (此文件在lijunlzu@126.com的的网盘里有，taglist不能用命令安装，ctags和cscope都可以用命令安装，然后配好.vimrc文件即可，.vimrc文件的内容见下一篇博客）

（2）解压得到两个文件

#1 解压得到doc和plugin两个目录

#2.将doc复制到/usr/share/vim/doc

#3.在~目录下建立.vim目录，并建立./vim/plugin子目录。将plugin文件复制到此目录下

#4.s使用方法请查询相关资料。

#工具(linux下的)

测试一下插件是否安装好，可以运行一下命令

1、ctags--version,有信息则说明安装好了

2、进入一个原文件，vitest.c，进入命令模式，输入命令":Tlist",如果出现左右两栏分栏显示，则说明OK

把ctags关联到taglist

vi~/.vim/plugin/taglist.vim

在命令行模式下输入命令查抄":/loaded_taglist"

找到后，在该行前面加上如下行：

letTlist_Ctags_Cmd="/usr/bin/ctags""目录可能有变，或许是/usr/local/bin/ctags

OK

到你想浏览的目录下

ctags-R

vitest.c

:syntaxon //打开语法高亮

:setcindent //打开自动缩进

:Tlist//OK

首先我的系统:fedora 7

我现在使用的是vim+ctags+taglist +cscope

下面是两张图片



效果：



注意在前：taglist说其使用的是Exuberant Ctags，因此有些系统需要作些改变，不过fedora 7就不用了，因为默认的就是Exuberant Ctags了，如下：

[liuhongdan@dan tc]$ ctags --version

Exuberant Ctags 5.6, Copyright (C) 1996-2004 Darren Hiebert

Compiled: Jul 17 2006, 11:39:49

Addresses: , http://ctags.sourceforge.net
Optional compiled features: +wildcards, +regex

ctags系统自带，先说说taglist吧（很简单，很小，才49K）：

1. taglist

能够列出源文件中的tag(function, class, variable, etc)并跳转.

注意：taglist依赖于ctags，所以要先装ctags，否则taglist装了也没法用！

（1）到http://vim.sourceforge.net/scripts/script.php?script_id=273

下载最新的taglist,我的版本是taglist_45.zip，解压你会发现俩个文件夹：doc和plugin.

(2) 把上面两个文件夹放到自己的~/.vim文件夹里面，如果自己的家目录(主目录)没有这个隐藏的文件夹，就自己mkdir .vim一下，建立一个。

然后把doc和plugin拷到.vim文件夹里。

(3)安装

在doc下面有个taglist.txt，看看会发现这是个帮助文档：

下面是它的第4部分：

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

4. Installation~

1. Download the taglist.zip file and unzip the files to the $HOME/.vim or the

$HOME/vimfiles or the $VIM/vimfiles directory. After this step, you should

have the following two files (the directory structure should be preserved):

plugin/taglist.vim - main taglist plugin file

doc/taglist.txt - documentation (help) file

Refer to the |add-plugin|and |'runtimepath'| Vim help pages for more

details about installing Vim plugins.

2. Change to the $HOME/.vim/doc or $HOME/vimfiles/doc or $VIM/vimfiles/doc

directory, start Vim and run the ":helptags ." command to process the

taglist help file. Without this step, you cannot jump to the taglist help

topics.

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝

plugin/taglist.vim – taglist插件

doc/taglist.txt - taglist帮助文件

即到~/.vim/doc下面运行vim,然后在vim中运行":helptags ."或者":helptags taglist.txt"让vim找到taglist的帮助文档，之后你就可以跳转到taglist的帮助主题了。

(4)使用

在vim中用":TlistToggle"打开左边的tag窗口，再输一次自动关闭，按ctrl+w可以在窗口之间进行切换，也可以按照如下方法定义一个快捷键

　　nnoremap :TlistToggle

":TlistOpen":Open and jump to the taglist window.

":TlistClose":Close the taglist window.

":TlistToggle":Open or close (toggle) the taglist window.

在taglist中的一些操作：

: 跳转到光标处tag的源文件(就是回车键)

o : 打开新窗口，并跳转到光标处tag的源文件。

p : 与

t : 打开新tab并跳转到光标处tag的源文件。

: 显示光标处tag的函数原型

+ : 打开tag组

- : 收拢tag组

x : 最大化／还原

我的~/.vimrc设置：

"created by liuhongdan 10-24-2007

set nu

""""""""for ctags""""""""""""""

set tags=tags;

""""""""""""""""""""""""""""""

""""""""for taglist"""""""""

let Tlist_Show_One_File = 1 "taglist插件只显示当前文件的tag

let Tlist_Use_Right_Window = 1 "让taglist窗口显示在右边，默认在左边

let Tlist_Exit_OnlyWindow = 1 "退出vim时候退出taglist

好了，taglist的基本功能差不多就这些，高级的设置请看自带的帮助文档 ^_^

2.下面介绍ctags(以后使用cscope，这是趋势的说)

下面是http://linux.chinaunix.net/bbs/thread-904179-1-1.html的RainbowBoy的帖子(在此表示感谢)：

在浏览源码时，用SourceInsight，可以很方便的进行符号定义与引用间的跳转，以及符号定义、声明的查看。在VIM中，同样也可以，但是我在这样做时，遇到了一点问题，还请知道如何解决这个问题的同道能不吝赐教！

假设我现在的工程结构如下：

D:

└─MyProject

├─Module_1

│ Module_1.h

│ Module_1.c

│ Module_a.h

│ Module_a.c

│

├─Module_2

│ Module_2.h

│ Module_2.c

│

└─Module_3

Module_3.c

Module_3.h

用ctag实现在工程中，符号到符号定义间的跳转:

在项目根目录下即（MyProject目录）下用“ctags -R .”(这个"."可以不要的说--我注)创建一个tag文件后，在.vimrc文件中加入“set tags=tags;"这条语句（一定要有末尾的分号），这样，就算我当前工作在Module_1下的文件上（当前路径也是Module_1）。但是，我一样可以用CTRL-]在Module_1.c内跳转到Module_3.c内的Symbol定义上。

但是TAG的这个功能只能跳到Symbol的定义上去，不能查找到调用它的位置。如假设Module_1.c和Module_2.c内都用到 Symbol，而Symbol被定义在Module_3.c中。所以，不管在Module_1.c还是Module_2.c中执行CTRL-]都是到 Module_3.c的Symbol定义上（这也是为什么要使用cscope的原因了－－我注）。

接着ctags用法：

详见：http://hi.baidu.com/original/blog/item/2cf8d53f00b7fcc27d1e71f0.html

[/home/brimmer/src]$ ctags -R

"-R"表示递归创建，也就包括源代码根目录下的所有子目录下的源程序。"tags"文件中包括这些对象的列表：

用#define定义的宏

枚举型变量的值

函数的定义、原型和声明

名字空间（namespace）

类型定义（typedefs）

变量（包括定义和声明）

类（class）、结构（struct）、枚举类型（enum）和联合（union）

类、结构和联合中成员变量或函数

VIM用这个"tags"文件来定位上面这些做了标记的对象，下面介绍一下定位这些对象的方法：

1)用命令行。在运行vim的时候加上"-t"参数，例如：

[/home/brimmer/src]$ vim -t foo_bar

这个命令将打开定义"foo_bar"（变量或函数或其它）的文件，并把光标定位到这一行。

2)在vim编辑器内用":ta"命令，例如：

:ta foo_bar

3)最方便的方法是把光标移到变量名或函数名上，然后按下"Ctrl-]"。用"Ctrl-o"或者"Ctrl-t"退回原来的地方。

注意：运行vim的时候，必须在"tags"文件所在的目录下运行。否则，运行vim的时候还要用":set tags="命令设定"tags"文件的路径，这样vim才能找到"tags"文件（这儿我们已经设置过了"set tags=tags;"，在子目录中也可以使用）。

在函数中移动光标

[{ 转到上一个位于第一列的"{"

}] 转到下一个位于第一列的"{"

{ 转到上一个空行

} 转到下一个空行

gd 转到当前光标所指的局部变量的定义

* 转到当前光标所指的单词下一次出现的地方

# 转到当前光标所指的单词上一次出现的地方

Vim 的创造者是一名计算机程序员，因此这就不奇怪 Vim 中有许多帮助编写程序的功能：

跳转到标识符被定义和使用的地方；在另一个窗口中预览有关的声明等等。

更详细的用法请参考:help ctags

最后：

有兴趣的可以参考：

使用VIM开发软件项目系列文章：http://blog.csdn.net/easwy/archive/2007/02/15/1510703.aspx

Cscope 的使用

这下更厉害了, 用Cscope自己的话说 - "你可以把它当做是超过频的ctags",

其功能和强大程度可见一斑吧, 关于它的介绍我就不详细说了, 如果你安装好了前

文介绍的中文帮助手册, 用下面的命令看看介绍吧:

:help if_cscop.txt

我在这里简单摘抄一点, 供还在犹豫的朋友看看:

Cscope 是一个交互式的屏幕下使用的工具，用来帮助你:

* 无须在厚厚的程序清单中翻来翻去就可以认识一个 C 程序的工作原理。

* 无须熟悉整个程序就可以知道清楚程序 bug 所要修改的代码位置。

* 检查提议的改动 (如添加一个枚举值) 可能会产生的效果。

* 验证所有的源文件都已经作了需要的修改；例如给某一个现存的函数添

加一个参数。

* 在所有相关的源文件中对一个全局变量改名。

* 在所有相关的位置将一个常数改为一个预处理符号。

它被设计用来回答以下的问题:

* 什么地方用到了这个符号？

* 这是在什么地方定义的？

* 这个变量在哪里被赋值？

* 这个全局符号的定义在哪里？

* 这个函数在源文件中的哪个地方？

* 哪些函数调用了这个函数？

* 这个函数调用了哪些函数？

* 信息 "out of space" 从哪来？

* 这个源文件在整个目录结构中处于什么位置？

* 哪些文件包含这个头文件？

安装Cscope: aptitude install cscope //这样一句就可以了（超简单），如果不能安装的话，就按照下面说的做吧

如果你的系统中有cscope命令, 则可以跳过这一小段, 如果没有, 就先跟着我

一起安装一个吧.

在Cscope的主页: http://cscope.sourceforge.net下载一个源码包, 解压后

编译安装:

# ./configure

# make

# make install // 需要root权限

先在~/.vimrc中增加一句:

:set cscopequickfix=s-,c-,d-,i-,t-,e-

这个是设定是否使用 quickfix 窗口来显示 cscope 结果, 用法在后面会说到

。

跟Ctags一样, 要使用其功能必须先为你的代码生成一个cscope的数据库, 在项

目的根目录运行下面的命令:

$ cd /home/wooin/vim71/

$ cscope -Rbq

# 此后会生成三个文件

$ ll cscope.*

-rw-rw-r-- 1 wooin wooin 1.1M 2007-09-30 10:56 cscope.in.out

-rw-rw-r-- 1 wooin wooin 6.7M 2007-09-30 10:56 cscope.out

-rw-rw-r-- 1 wooin wooin 5.1M 2007-09-30 10:56 cscope.po.out

# 打开文件, 开始Coding

$ cd src

$ vi main.c

进入vim后第一件事是要把刚才生成的cscope文件导入到vim中来, 用下面的命

令:

:cs add /home/wooin/vim71/cscope.out /home/wooin/vim71

上面这条命令很重要, 必须写全, 不能只写前半句:

:cs add /home/wooin/vim71/cscope.out

因为源码是多级目录的, 如果这样写, cscope是无法在子目录中的源码中工作

的, 当然, 如果你的源码都在同一级目录中就无所谓了. 如果你要经常用cscope的

话, 可以把上面那句加到~/.vimrc中去.

下面我们来操练一下, 查找函数vim_strsave()的定义, 用命令:

:cs find g vim_strsave

(--- 图8 ---)

按下回车后会自动跳转到vim_strsave()的定义处. 此时你肯定会说Ctags也可

以做到这个呀, 那么下面说的这个Ctags就无法做到了, 我想查找vim_strsave()到

底在那些地方被调用过了, 用命令:

:cs find c vim_strsave

按下回车后vim会自动跳转到第一个符合要求的地方, 并且在命令栏显示有多少

符合要求的结果, 如图:

(--- 图9 ---)

如果自动跳转的位置你不满意, 想看其他的结果, 可以用下面的命令打开Quick

Fix窗口:

:cw

如图:

(--- 图10 ---)

这时你就可以慢慢挑选了^_^

cscope的主要功能是通过同的子命令"find"来实现的

"cscope find"的用法:

cs find c|d|e|f|g|i|s|t name

0 或 s 查找本 C 符号(可以跳过注释)

1 或 g 查找本定义

2 或 d 查找本函数调用的函数

3 或 c 查找调用本函数的函数

4 或 t 查找本字符串

6 或 e 查找本 egrep 模式

7 或 f 查找本文件

8 或 i 查找包含本文件的文件

如果每次查找都要输入一长串命令的话还真是件讨人厌的事情, Cscope的帮助

手册中推荐了一些快捷键的用法, 下面是其中一组, 也是我用的, 将下面的内容添

加到~/.vimrc中, 并重启vim:

nmap <C-_>s :cs find s <C-R>=expand("<cword>")<CR><CR>

nmap <C-_>g :cs find g <C-R>=expand("<cword>")<CR><CR>

nmap <C-_>c :cs find c <C-R>=expand("<cword>")<CR><CR>

nmap <C-_>t :cs find t <C-R>=expand("<cword>")<CR><CR>

nmap <C-_>e :cs find e <C-R>=expand("<cword>")<CR><CR>

nmap <C-_>f :cs find f <C-R>=expand("<cfile>")<CR><CR>

nmap <C-_>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>

nmap <C-_>d :cs find d <C-R>=expand("<cword>")<CR><CR>

当光标停在某个你要查找的词上时, 按下<C-_>g, 就是查找该对象的定义, 其

他的同理.

按这种组合键有一点技巧,按了<C-_>后要马上按下一个键,否则屏幕一闪就回到

nomal状态了

<C-_>g的按法是先按"Ctrl+Shift+-", 然后很快再按"s"

很奇怪, 其中的这句:

nmap <C-_>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>

在我的vim中无法工作, 但是我改成:

nmap <C-_>i :cs find i <C-R>=expand("<cfile>")<CR><CR>

就可以正常工作了, 不知道是什么原因? 有哪位朋友知道请告诉我.

cscope的其他功能你可以通过帮助手册自己慢慢学习

reset : 重新初始化所有连接。

用法 : cs reset