Ctags + taglist + cscope

linux下有很多工具，有写工具可以给我们在编程活读代码时带来很大方便。

最近由于项目需求，老师读代码，读虚拟机，读数据分析工具……
快要崩溃了。
在读代码过程中linux下的tags工具给我带来了很大的方便。其他的jtags 和 ptags我没有使用过，不过最近实用Ctags比较多。

1、Ctags
下面就简单介绍一下Ctags 和实用方法吧。

       ctags（Generate tag files for source code）是vim下方便代码阅读的工具。尽管ctags也可以支持其它编辑器，但是它正式支持的只有VIM。并且VIM中已经默认安装了Ctags，它可以帮助程序员很容易地浏览源代码。

       ctags 最先是用来生成C代码的tags文件，后来扩展成可以生成各类语言的tags, 有些语言也有专有的tags生成工具（比如java的jtags, python的 ptags).

安装：
ctags
（1）到http://ctags.sourceforge.net/下载ctags源码ctags-5.6.tar.gz
http://prdownloads.sourceforge.net/ctags/ctags-5.6.tar.gz
（2）解压并安装
tar zxvf ctags-5.6.tar.gz
cd ctags-5.6
./configure && make && make install
如果是debian或ubuntu系统，那么可以使用如下命令直接安装：sudo apt-get install ctags。

生成索引文件

在源码目录下执行

$ctags –R*

“-R”表示递归创建，也就包括源代码根目录（当前目录）下的所有子目录。“*”表示所有文件。这条命令会在当前目 录下产生一个“tags”文件，当用户在当前目录中运行vi时，会自动载入此tags文件。Tags文件中包括这些对象的列表：用#define定义的宏 枚举型变量的值函数的定义、原型和声明名字空间（namespace）类型定义（typedefs）变量（包括定义和声明）类（class）、结构 （struct）、枚举类型（enum）和联合（union）类、结构和联合中成员变量或函数VIM用这个“tags”文件来定位上面这些做了标记的对 象。

ctags配置

使用sudo vim /etc/vim/vimrc 编辑vim的配置文档，在其中加入如下命令：

set tags=/home/zhouyl/linux-3.4.7/tags;"后面的路径是使用ctags -R 后生成的tags文件所在目录，如果需要配置多个tags，只需如下再添加即可

set tags=/home/zhouyl/rap/libpcap-1.3.0/tags;

set autochdir

使用

熟练的使用ctags仅需记住下面七条命令：（很简单吧，呵呵）

1．$ctags –R * ($为Linux系统Shell提示符,这个命令上面已经有所介绍)

2. $ vi –t tag (请把tag替换为您欲查找的变量或函数名)

3．:ts(ts助记字：tagslist, “:”开头的命令为VI中命令行模式命令)

4．:tp(tp助记字：tagspreview)---此命令不常用，可以不用记

5．:tn(tn助记字：tagsnext) ---此命令不常用，可以不用记

6．Ctrl+ ]跳到光标所在函数或者结构体的定义处

7．Ctrl+ T返回查找或跳转

“$vi –t tag” ：在运行vim的时候加上“-t”参数，例如：[/usr/src]$vim -tmain这个命令将打开定义“main”（变量或函数或其它）的文件，并把光标定位到这一行。如果这个变量或函数有多处定义，

在VI命令行模式 “：ts”命令就能列出一个列表供用户选择。

“：tp”为上一个tag标记文件，

“：tn”为下一个tag标记文件。

当然，若当前tags文件中用户所查找的变量或函数名只有一个，“:tp,:tn”命令不可用。

（最方便的方法是把光标移到变量名或函数名上，然后按下“Ctrl+]”，这样就能直接跳到这个变量或函数定义的源 文件中，并把光标定位到这一行。用“Ctrl+T”可以退回原来的地方。即使用户使用了N次“Ctrl+]”查找了N个变量，按N次“Ctrl+t”也能 回到最初打开的文件，它会按原路返回 。

注意：运行vim的时候，必须在“tags”文件所在的目录下运行。否则，运行vim的时候还要用“:set tags=”命令设定“tags”文件的路径，这样vim才能找到“tags”文件。在完成编码时，可以手工删掉tags文件

大部分都是从别的地方超过来的。写这篇日志一则方便自己记忆，二则方便大家查阅学习。

2、taglist

“Tag List" 插件是一个为VIM编写的源代码浏览插件,需要ctags的支撑 ，直接可以在左边列出函数列表，全局参数列表，宏。（可以排序）
1、下载taglist.zip文件，解压到$HOME/.vim目录下，或者$HOME/vimfiles或$VIM/vimfiles目录下，在这一步后，你应该有这两个文件（目录结构应该被保留）
          plugin/taglist.vim  - taglist 插件文件
          doc/taglist.txt     -  文档（帮助）文件

2. 进入 $HOME/.vim/doc 或者 $HOME/vimfiles/doc 或者 $VIM/vimfiles/doc 
    目录, 运行Vim,在命令行模式下运行 " :helptags  ." 命令处理taglist帮助文件，如果没有这上步，你将不能得到taglist帮助提示

3、如果ctags工具不在你的PATH搜索路径中，你需要在$HOME/.vimrc中设置Tlist_Ctags_Cmd 变量指出ctags的路径。

4、如果你运行的是terminal/console版本的VIM，以及terminal 不支持改变窗口的宽度，你需要在$/HOME/.vimrc设置    'Tlist_Inc_Winwidth'  变量为0,

5、重启vim

6、你可以在vim的命令行模式中使用 " :TlistToggle "  (Tlist) 命令打开/关闭taglist窗口，你可以使用 " :help taglist " 命令得到更多的关于使用taglist插件的信息

 

在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”在打开和关闭间切换。

可以自定义快捷键，在我的vimrc中定义了下面的映射，使用“,tl”键就可以打开/关闭taglist窗口：

map <silent> <leader>tl :TlistToogle<cr> 

3、cscope

安装：

首先 sudo apt-get install cscope , 安装cscope。

Cscope 使用：

建立cscope使用的索引文件：

在你需要浏览源码的 根目录 下（如你想用cscope看linux源码)使用下面命令：

#: cscope -Rbkq<回车>

这个命令会生成三个文件：cscope.out, cscope.in.out, cscope.po.out。
其中cscope.out是基本的符号索引，后两个文件是使用"-q"选项生成的，可以加快cscope的索引速度。
这个脚本，首先使用find命令，查找当前目录及子目录中所有后缀名为".h", ".c"和".c"的文件，并把查找结果重定向到文件cscope.files中。 然后cscope根据cscope.files中的所有文件，生成符号索引文件。最后一条命令使用ctags命令，生成一个tags文件，在vim中执行":help tags"命令查询它的用法。它可以和cscope一起使用。上面所用到的命令参数，含义如下：

-R: 在生成索引文件时，搜索子目录树中的代码
-b: 只生成索引文件，不进入cscope的界面
-q: 生成cscope.in.out和cscope.po.out文件，加快cscope的索引速度
-k: 在生成索引文件时，不搜索/usr/include目录
-i: 如果保存文件列表的文件名不是cscope.files时，需要加此选项告诉cscope到哪儿去找源文件列表。可以使用“-”，表示由标准输入获得文件列表。
-I dir: 在-I选项指出的目录中查找头文件
-u: 扫描所有文件，重新生成交叉索引文件
-C: 在搜索时忽略大小写
-P path: 在以相对路径表示的文件前加上的path，这样，你不用切换到你数据库文件所在的目录也可以使用它了。

在Vim中使用cscope查找：

加载cscope.out文件
       在VIM中使用cscope非常简单，首先调用“cscope add”命令添加一个cscope数据库，然后就可以调用“cscope find”命令进行查找了。VIM支持8种cscope的查询功能，如下：例如，我们想在代码中查找调用work()函数的函数，我们可以输入：“:cs find c work”，回车后发现没有找到匹配的功能，可能并没有函数调用work()。我们再输入“:cs find s work”，查找这个符号出现的位置，现在vim列出了这个符号出现的所有位置。我们还可以进行字符串查找，它会双引号或单引号括起来的内容中查找。还可以输入一个正则表达式，这类似于egrep程序的功能。
在源代码目录下打开vim。要使用cscope查找就必须加载cscope.out文件.在vim命令行下执行：

:cs add cscope.out

在vim命令行下执行：

:cs help
cscope commands:
add  : Add a new database             (Usage: add file|dir [pre-path] [flags])
find : Query for a pattern            (Usage: find c|d|e|f|g|i|s|t name)
       c: Find functions calling this function
       d: Find functions called by this function
       e: Find this egrep pattern
       f: Find this file
       g: Find this definition
       i: Find files #including this file
       s: Find this C symbol
       t: Find assignments to
help : Show this message              (Usage: help)
kill : Kill a connection              (Usage: kill #)
reset: Reinit all connections         (Usage: reset)
show : Show connections               (Usage: show)

s: 查找C语言符号，即查找函数名、宏、枚举值等出现的地方
g: 查找函数、宏、枚举等定义的位置，类似ctags所提供的功能
d: 查找本函数调用的函数
c: 查找调用本函数的函数
t: 查找指定的字符串
e: 查找egrep模式，相当于egrep功能，但查找速度快多了
f: 查找并打开文件，类似vim的find功能
i: 查找包含本文件的文