vim cscope 插件使用

本文摘自 《linux内核修炼之道》，写的很好，抄下来供自己查看。同时自己修改一下说的不明确的地方。

1.Cscope 介绍

通过 Cscope,可以方便地获知某个函数定义的确切位置以及被哪些函数所调用,某个变量在哪里被赋
值,某个符号曾经在哪些地方使用过等。
如果安装了 Vim 的中文帮助手册,就可以使用下面的命令阅读 Cscope 的详细介绍。

:help if_cscop.txt

2.安装 Cscope

通常,系统安装时并不会默认安装 Cscope,所以如果你的 Linux 系统中没有 Cscope 命令,就首先需
要进行安装。
如果希望从源码进行安装,需要登录 Cscope 的主页(http://cscope.sourceforge.net)下载一个源码包,
解压后编译安装。
# ./configure
# make
# make install

（ubuntu下，可以用sudo apt-get install直接安装）

3.生成 Cscope 的数据库
使用 Cscope 的功能前,必须先为内核代码生成一个 Cscope 的数据库。在内核代码树的根目录运行下
面的命令。
# cd /usr/src/linux
# cscope –Rbq
然后会生成以下 3 个文件。
# ll cscope.*
-rw-rw-r-- 1 root root 19030016 2008-07-18 10:56 cscope.in.out
-rw-rw-r-- 1 root root 147895939 2008-07-18 10:56 cscope.out
-rw-rw-r-- 1 root root 105656256 2008-07-18 10:56 cscope.po.out
打开内核文件,将刚才生成的 Cscope 文件导入 Vim 中,如下所示。
# vim init/main.c
# : cs add /usr/src/linux/cscope.out /usr/src/linux

（意思是每次打开vim，都要加载cscope库，需要先输入 “:” ，进入命令模式——原文中没有这个符号，让菜鸟误解）
也可以将下面的语句添加到 Vim 配置文件.vimrc 中,
这样就可以不用每次打开 Vim 都去执行上面的命
令。
" add any cscope database in current directory
if filereadable("cscope.out")
  cs add cscope.out
" else add the database pointed to by environment variable
elseif $CSCOPE_DB != ""
cs add $CSCOPE_DB
endif

(注意，" 是注释符号，cs是命令，所以原文中cs前面有“是多余的。我去掉了)

（同时，这个.vimrc是在～/的根目录下，我的ubuntu系统没有这个文件，自己创建个就行了，把上面代码复制过去，然后，去已经初始化过的内核代码目录下，命令会识别出当前目录下的cscope.out这个文件）

4.使用 Cscope
实用 Cscope 查找函数 start_kernel 的定义的指令如下:
:cs f g start_kernel

命令栏里显示找到了多个 start_kernel 的定义,在光标提示处输入“4”
,按回车键,将会跳转到
init/main.c 文件中定义 start_kernel 的位置。

以上步骤就能查看关联代码了，其它更多的功能请百度或者根据步骤1查看doc。

【附录】

Cscope 的主要功能通过它的子命令“find”来实现。
cs find c|d|e|f|g|i|s|t name
s:查找本 C 代码符号。
g:查找本定义。
d:查找本函数调用的函数。
c:查找调用本函数的函数。
t:查找本字符串。
e:查找本 egrep 模式。
f:查找本文件。
I:查找包含本文件的文件。

如果不愿意每次都要输入一长串的命令,还可以在.vimrc 文件中添加下面的快捷键。
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,
即先按
“Ctrl+\” 然后很快再按“g”将会查找该对象的定义。