vim牛逼的code工具: ctags+ cscope

自己总结

在我的工作目录里的.vimrc中做了这样的配置：

  set tags=tags;

  set autochdir

在项目根目录里利用“sudo ctags -R *”，生成了tags文件。

ctags      ctrl＋［   寻找变量

ctags      ctrl＋]   寻找函数

ctags      ctrl＋o  返回函数

http://blog.csdn.net/syfly007/article/details/6413523

http://www.cnblogs.com/chijianqiang/archive/2012/12/17/vim-4.html

https://segmentfault.com/q/1010000000262368

转载

Vi大家都很熟悉，某些情况下它是我们在Linux下唯一可用的文本编辑器。其实我们平时所指的VI其实是VIM（ViImproved，VI增强版）。有人常常拿VIM和emacs比较，VIM尽管不象emacs那样有那么多的功能，但是比emacs更方便、好用。VIM简单易用，只要看看VIM自带的vitutor，大约只要20分钟就能掌握VIM的用法。对于Linux下的C/C++的程序员，使用VIM+Ctags的组合来写程序也许是最佳的选择。

VI的使用方法这里就不罗嗦了，本文假设大家已花了20分钟学习过了vitutor。本节我们主要讲一下Ctags这个程序。尽管ctags也可以支持其它编辑器，但是它正式支持的只有VIM。并且VIM中已经默认安装了Ctags，它可以帮助程序员很容易地浏览源代码。

熟练的使用ctags仅需记住下面七条命令：

1．$ ctags –R *   ($ 为Linux系统Shell提示符)

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

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

4．：tp          (tp 助记字：tags preview)---此命令不常用，可以不用记

5．：tn          (tn 助记字：tags next) ---此命令不常用，可以不用记

6． Ctrl + ]

7． Ctrl + T

下面我们逐条的解释上面的命令：

“$ ctags –R ”：“-R”表示递归创建，也就包括源代码根目录（当前目录）下的所有子目录。“”表示所有文件。这条命令会在当前目录下产生一个“tags”文件，当用户在当前目录中运行vi时，会自动载入此tags文件。Tags文件中包括这些对象的列表：

用#define定义的宏

枚举型变量的值

函数的定义、原型和声明

名字空间（namespace）

类型定义（typedefs）

变量（包括定义和声明）

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

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

VIM用这个“tags”文件来定位上面这些做了标记的对象。

剩下的命令就是定位这些对象的方法：

“$ vi –t tag” ：在运行vim的时候加上“-t”参数，例如：

[/usr/src]$ vim -t main

这个命令将打开定义“main”（变量或函数或其它）的文件，并把光标定位到这一行。如果这个变量或函数有多处定义，在VI命令行模式“：ts”命令就能列出一个列表供用户选择。    “：tp”为上一个tag标记文件，“：tn”为下一个tag标记文件。当然，若当前tags文件中用户所查找的变量或函数名只有一个，“:tp,:tn”命令不可用。

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

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

cscope

1、安装cscope

yum install cscope -y

2、知识点

生成索引文件cscope -Rbq则生成cscope.in.out cscope.out cscope.po.out三个文件
:cs add path/cscope.out 添加索引文件的位置

:cs find c function 查看function被调用的位置

:cs find s 查找本c符号

:cs find g 查找本定义

:cs find d 查找本函数调用的函数

:cs find t 查找本字符串

:cs find f 查找本文件

:cs find i 查找包含本文件的文件

3)在~/.vimrc中添加set cscopequickfix=s-,c-,d-,i-,t-,e-

这样通过:cs find xxx查找某个符号后，会立即跳转到第一个找到该符号出现的位置，

然后可以通过:copen来打开quickfix窗口，在quickfix窗口中显示所有出现的位置。

update201709

http://edsionte.com/techblog/archives/1689/comment-page-1#comment-7620

有网络的时候，使用LXR（The Linux Cross Referencer）在线阅读源码固然是一件很爽的事情。在无网络的情况下，只通过vim进入内核源码那样查找就显得有些勉强。接下来，本文将介绍一种快速定位源码的工具：ctags和cscope。通过vim编辑器，再配合使用上述两种工具就可以快速定位想要查看的源码。好了，开始吧！

1.下载最新内核源码包，解压至主目录下

接下来的步骤当然可以在当前系统内核源码目录下进行，不过为了保险期间还是最好在主目录下专门创建一个存放源码的目录。下文所说的源码目录均指主目录下的源码目录。

2.安装ctags

使用命令：sudo apt-get install ctags

3.安装cscope

使用命令：sudo apt-get install cscope

4.成标签文件

在源码目录下通过命令make tags生成标签文件

5.生成索引文件

在源码目录下通过命令make cscope生成索引文件。

6.将索引文件导入vim中

使用命令打开vim的配置文件：sudo gedit /etc/vim/vimrc；然后在该文件下添加如下代码：

1

if filereadable("cscope.out")

2

cs add cscope.out

3

endif

这样每次打开vim就可以直接使用cscope了。

完成以上步骤以后就可以通过vim进行源码的快速定位了。上述安装的ctags和cscope都属于源码索引工具，因此仅安装两者之一也是可以的。不错，虽然ctags可以快速定位所输入的标签，但cscope的使用方法则更灵活。所以两者同时安装使用起来更方便。下面是一些简单的使用方法，仅供参考。

1.使用ctags

ctags的使用特别简单，首先进入源码目录下，打开vim编辑器，在命令模式下输入：tag tag_name 按回车即可。通常tag_name可以是结构体名称，函数名称，宏变量名称等。通常输入上述命令后，因为找到的标签并不唯一，所以还需要配合使用下述命令：

tfirst：跳至第一个

tnext：跳至下一个

tlast：跳至最后一个

2.使用cscope

虽然ctags使用方便快捷，但有时候使用cscope更灵活，首先可以看cscope的帮助文件：

01

cscope 命令:

02

add ：添加一个新的数据库 (用法： add file|dir [pre-path] [flags])

03

find ：查询一个模式 (用法： find c|d|e|f|g|i|s|t name)

04

c：找到调用这个函数的函数

05

d：找到被这个函数调用的函数

06

e：找到这个 egrep 模式

07

f：找到此文件夹

08

g：找到这个定义

09

i：找文件 #包括这个文件

10

s：找到这个 C 符号

11

t：找到对其的赋值

12

help ：显示此信息 (用法： help)

13

kill ：结束一个连接 (用法： kill #)

14

reset：重置所有连接 (用法： reset)

15

show ：显示连接 (用法： show)

通过上面的帮助文件可以发现如果想找到request_irq函数的定义处代码，即可使用这个命令：cs find g request_irq来进行查找。大多数情况下查找的结果并不唯一，因为需要在多个结果中通过头文件来继续查看。

通常是先通过cscope大致定位到头文件，再通过ctags在该头文件中详细定位。其实这两种工具并不局限于上述用法，更多用法可以再深入使用的过程中慢慢摸索，而且配合正则表达式等效果会更好。