[开发工具]Cscope使用方法小结

1.安装cscope软件
ubuntu:
sudo apt-get install cscope

或者通过源码编译
./configure --prefix=/usr
make

make install

2.vim配置cscope

打开VIM配置文件，~/vimrc中增加一句:
set cscopequickfix=s-,c-,d-,i-,t-,e-
上述配置用于设定是否使用 quickfix 窗口来显示 cscope 结果, 用法在后面会说到。

3.生成Cscope的索引文件

切换至项目代码根目录运行下面的命令生成cscope的索引库。
$ cscope -Rbkq
R 表示把所有子目录里的文件也建立索引
b 表示cscope不启动自带的用户界面，而仅仅建立符号数据库
q生成cscope.in.out和cscope.po.out文件，加快cscope的索引速度
k在生成索引文件时，不搜索/usr/include目录

hongtao.wang@fae01:~/work/build/bootloader_rd/bl33/v2015$ ls -l cscope.*
-rw-r--r-- 1 hongtao.wang software 13869056 Oct 27 10:48 cscope.in.out
-rw-r--r-- 1 hongtao.wang software 73190304 Oct 27 10:48 cscope.out
-rw-r--r-- 1 hongtao.wang software 72095160 Oct 27 10:48 cscope.po.out

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

4.索引库的加载

使用vim打开C文件后，通过如下方法加载上面生成的索引库。

:cs add /home/user/work/build/bootloader_rd/bl33/v2015/cscope.out /home/user/work/build/bootloader_rd/bl33/v2015

说明：
上面这条命令必须写全, 不能只写前半句:
:cs add /home/user/work/build/bootloader_rd/bl33/v2015/cscope.out
因为源码是多级目录的, 如果这样写, cscope是无法在子目录中的源码中工作的, 当然, 如果你的源码都在同一级目录中就无所谓了. 如果你要经常用cscope的话, 可以把上面那句加到~/.vimrc中去.

为了避免每次手动加载检索库文件，可以把上述加载索引库操作放在~/.vimrc文件中，这样每次打开vim时自动加载。

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

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

:cs find g platform_driver_register

按下回车后会自动跳转到platform_driver_register()的定义处.

查找platform_driver_register()被调用的地方 使用如下命令:

:cs find c platform_driver_register

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

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

:cw

根据实际情况找打定义处即可。

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

6.cscope扩展操作

如果每次查找都要输入一长串命令的话还真是件讨人厌的事情, 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+\", 然后很快再按"g"
这样可以避免用户手动输入变量、函数以及结构体名字信息