vim+ctags+taglist 安装使用

vim+ctags+taglist 安装使用

好久没写了，嘻嘻，今天写个关于类unix下安装读源代码工具的安装的东东。

因为测试需要，最近读了sysbench的部分源代码。本身就是个菜鸟，加上人家写的代码感觉使用指针很巧妙，读得我头晕眼花。今天装了个ctags+taglist感觉还是很好用的。嘻嘻这里记下。

1 ctags

安装

tar zxvf ctags-5.7.tar.gz
cd ctags-5.7
./configure && make && make install
使用
$ ctags -R

"-R"表示递归创建，也就包括源代码根目录下的所有子目录下的源程序。"tags"文件中包括这些对象的列表：
l 用#define定义的宏
l 枚举型变量的值
l 函数的定义、原型和声明
l 名字空间（namespace）
l 类型定义（typedefs）
l 变量（包括定义和声明）
l 类（class）、结构（struct）、枚举类型（enum）和联合（union）
l 类、结构和联合中成员变量或函数
2 taglist

$unzip -d taglist taglist_45.zip

在~下面建立.vim目录，将解压后的doc和plugin文件夹mv到下面

进入vim，在命令行模式下输入:helptags ~/.vim/doc 生成帮助标签

修改~.vimrc文件加入如下选项：

let Tlist_Ctags_Cmd = '/usr/bin/ctags'
let Tlist_Show_One_File = 1            "不同时显示多个文件的tag，只显示当前文件的
   let Tlist_Exit_OnlyWindow = 1          "如果taglist窗口是最后一个窗口，则退出vim
   let Tlist_Use_Right_Window = 1         "在右侧窗口中显示taglist窗口

这样就ok了。

读源代码时，先进入src目录，用ctags -R生成tags文件。之后打开源代码文件，就可以使用:tag funcname做不同文件之间函数变量的定位了。

:tag {ident}            "跳转到指定的标签
:tags                   "显示标签栈
CTRL-]                  "跳转到当前光标下的标签
CTRL-T                  "跳到标签栈中较早的标签

 

vim+ctags+taglist
在linux下构建类似于windows sourceinsight的源码阅读环境



/***********************************/
/*******      前期准备       *******/
/***********************************/
在fedora 8中，默认已经安装了ctags
[atom@localhost ~]$ rpm -qa | grep ctags
ctags-5.6-1.1

没有安装则官网下载tags rpm安装包 rpm -ivh tags.rpm

对应的vim则是
[atom@localhost ~]$ rpm -qa | grep vim
vim-minimal-7.1.135-1.fc8
vim-common-7.1.135-1.fc8
vim-enhanced-7.1.135-1.fc8

所以只需要下载taglist，最新的版本是taglist_45.zip
［下载地址］：http://vim.sourceforge.net/scripts/script.php?script_id=273



/***********************************/
/*******      安装taglist    *******/
/***********************************/
1.在用户主目录建立.vim
[atom@localhost ~]$ mkdir .vim

2.解压taglist_45.zip到.vim目录下
[atom@localhost ~]$ unzip taglist_45.zip -d taglist
解压后的目录结构如下
[atom@localhost ~]$ ls -R taglist
taglist:
doc plugin

taglist/doc:
taglist.txt

taglist/plugin:
taglist.vim

3.安装taglist
[root@localhost atom]# cp /taglist/doc/taglist.txt /usr/share/vim/vim71/doc/
[root@localhost atom]# cp /taglist/plugin/taglist.vim /usr/share/vim/vim71/plugin/

4.生成帮助标签
进入vim的doc路径。
cd /usr/share/vim/vim71/doc

启动vim，命令模式下输入
:helptags . (.不可少，表示当前目录。也可以在任意目录中启动vim，只要指定:helptags usr/share/vim/vim71/doc/)
生成帮助标签后，就可以使用下面的命令查看taglist帮助
:help taglist.txt

现在可以vim中试着打开taglist，输入命令
:TlistToggle 来打开和关闭taglist窗口。（命令可以简写为Tlist）

5.配置taglist
编辑/etc/vimrc
[root@localhost atom]# vim /etc/vimrc
加入下面一段话：

"for taglist
let Tlist_Ctags_Cmd='/usr/bin/ctags'
let Tlist_Exit_OnlyWindow=1
这是指定ctags的路径。（也可以在/usr/share/vim/vim71/plugin/taglist.vim中指定）

更多的选项（设置格式为let xxxx=1,如 let Tlist_Ctags_Cmd=1）
下面介绍常用的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窗口横向显示；

个人认为这些选项不痛不痒，还不如使用快捷键，默认的设置就已经很舒适了。


/***********************************/
/******* 使用ctags和taglist *******/
/***********************************/
1.使用ctags生成某份源码的tags
以oRTP的源码为例。
进入oRTP文件夹下（/home/atom/Download/linphone/linphone-2.1.1/oRTP）
主要的文件夹有
.
|-- build
|-- doc
|-- include
`-- src
运行 ctags -R ，在当前目录（oRTP）下生成索引文件“tags”
[atom@localhost oRTP]$ ctags -R
[atom@localhost oRTP]$ file tags
tags: Exuberant Ctags tag file text

2.启动vim将tags导入
这里以打开/home/atom/Download/linphone/linphone-2.1.1/oRTP/src/tests/rtpsend.c为例。
当前的工作目录是/home/atom/Download/linphone/linphone-2.1.1/oRTP，主要文件树如下
.
|-- build
|-- doc
|-- include
|-- scr
`-- tags

运行vim
[atom@localhost oRTP]$ vim src/tests/rtpsend.c
在命令模式下输入
:TlistToggle    （可以缩写为Tlist）
看看左边是否打开了tlist窗口，如果有，说明代码和tags关联上了。


注：这里是通过保证tags在vim的工作目录下来关联。
也可以进入vim后，指定绝对路径，使用命令：
:set tags=/home/atom/Download/linphone/linphone-2.1.1/oRTP/tags
还可以启动vim时，指定tags位置
vim -t /home/atom/Download/linphone/linphone-2.1.1/oRTP/tags

还有一种做法是把经常使用到的tags加入vimrc中。

3.常用快捷键
在taglist窗口中，可以使用下面的快捷键：
<CR>          跳到光标下tag所定义的位置，用鼠标双击此tag功能也一样
o             在一个新打开的窗口中显示光标下tag
<Space>       显示光标下tag的原型定义
u             更新taglist窗口中的tag
s             更改排序方式，在按名字排序和按出现顺序排序间切换
x             taglist窗口放大和缩小，方便查看较长的tag
+                 打开一个折叠，同zo
-                 将tag折叠起来，同zc
*                 打开所有的折叠，同zR
=                 将所有tag折叠起来，同zM
[[                跳到前一个文件
]]                跳到后一个文件
q             关闭taglist窗口
<F1>          显示帮助

可以用“:TlistOpen”打开taglist窗口，用“:TlistClose”关闭taglist窗口。或者使用“:TlistToggle”在打开和关闭间切换

在左边的tlist窗口和右边正常的编辑区切换用 ctrl+2个w
ctrl+] 查找光标下的标签（可查看函数定义）
ctrl+t 返回跳转到标签的前一次位置（即上一个标签）
ctrl+o 返回源文件

在vim编辑器内使用tag命令
:tag foo_bar 跳转到foo_bar函数位置

将光标置于函数名上，shift+k 查看库函数


附：设置vim语法高亮显示和自动缩进
1、 打开vimrc，添加以下语句来使得语法高亮显示：
syntax on  
2、设置Windows风格的C/C++自动缩进（添加以下set语句到vimrc中）
1）设置（软）制表符宽度为4：
set tabstop=4
set softtabstop=4
2）设置缩进的空格数为4
set shiftwidth=4
3）设置自动缩进：即每行的缩进值与上一行相等；使用 noautoindent 取消设置：
set autoindent
4）设置使用 C/C++ 语言的自动缩进方式：
set cindent
5）在左侧显示文本的行号，可以用以下语句：
set number
6) 括号匹配
set showmatch