Source Insight的强大的代码分析功能让所有windows下的众生受益菲浅。
而Source insight的价格即使是面对Windows Vista也不逞多。嘿嘿。东西是好东西。
个人认为它也对得起这个价格。可惜没米。用不起呀。
咋办呢。用vim,cscope打造一个免费的吧。
1安装cscope
cscope的编译和安装没有特别之处,./configure - make - make install即可。
安转完毕后先阅读说明: vi /usr/share/vim/vim63/doc/if_cscop.txt.gz
网上也有中文版本:http://vcd.gro.clinux.org/doc/if_cscop.html
在vim中使用并不需要进行太多的设置,不过首先vim编译时必须加入了cscope的支持
$ vim --version | grep cscope
+cryptv +cscope +dialog_con +diff +digraphs -dnd -ebcdic +emacs_tags +eval
嗯,我用的这个版本的vim是支持cscope的。
按 照vim里cscope的参考手册(在vim中执行":help cscope"命令),把cscope功能加到.vimrc里后(需要你的vim在编译时选择了"--enable-cscope"选项,否则你需要重新 编译vim),配置就算完成了。然后用下面的命令生成代码的符号索引文件:
cscope -Rbkq
这个命令会生成三个文件:cscope.out, cscope.in.out, cscope.po.out。
其中cscope.out是基本的符号索引,后两个文件是使用"-q"选项生成的,可以加快cscope的索引速度。
上面所用到的命令参数,含义如下:
-R: 在生成索引文件时,搜索子目录树中的代码
-b: 只生成索引文件,不进入cscope的界面
-k: 在生成索引文件时,不搜索 / usr / include目录
-q: 生成cscope . in . out和cscope . po . out文件,加快cscope的索引速度
-b: 只生成索引文件,不进入cscope的界面
-k: 在生成索引文件时,不搜索 / usr / include目录
-q: 生成cscope . in . out和cscope . po . out文件,加快cscope的索引速度
接下来,就可以在vim里读代码了。
不 过在使用过程中,发现无法找到C++的类、函数定义、调用关系。仔细阅读了cscope的手册后发现,原来cscope在产生索引文件时,只搜索类型为 C, lex和yacc的文件(后缀名为.c, .h, .l, .y),C++的文件根本没有生成索引。不过按照手册上的说明,cscope支持c++和Java语言的文件。
于是按照cscope手册上提供的方法,先产生一个文件列表,然后让cscope为这个列表中的每个文件都生成索引。
为了方便使用,编写了下面的脚本来更新cscope和ctags的索引文件:
#!/bin/sh
find . -name "*.h" -o -name "*.c" -o -name "*.cc" > cscope.files
cscope -bkq -i cscope.files
ctags -R
find . -name "*.h" -o -name "*.c" -o -name "*.cc" > cscope.files
cscope -bkq -i cscope.files
ctags -R
这个脚本,首先使用find命令,查找当前目录及子目录中所有后缀名为".h", ".c"和".cc"的文件,并把查找结果重定向到文件cscope.files中。
然后cscope根据cscope.files中的所有文件,生成符号索引文件。
最后一条命令使用ctags命令,生成一个tags文件,在vim中执行":help tags"命令查询它的用法。它可以和cscope一起使用。
目前只能在unix系列操作系统下使用cscope,虽然也有windows版本的cscope,不过还有很多bug。在Linux技术中坚站上看到有作者在win2000上成功运行了gvim + cscope,详情可以参阅:
http://www.chinalinuxpub.com/bbs/showthread.php?t=30185
cscope的主页在: http://cscope.sourceforge.net/
在vim的网站上,有很多和cscope相关的插件,可以去找一下你有没有所感兴趣的。搜索结果在这里:
点这里
为了方便地使用cscope,我们还需要下载cscope的键盘映射设置,
这样就可以在gvim中简单地通过快捷键来使用 cscope,而不必敲复杂的命令了。键盘映射可以从
这里下载:http://cscope.sourceforge.net/cscope_maps.vim
将下载到的 cscope_maps.vim
|
放在gvim的插件目录里,如 C:\Program Files\Vim\vimfiles\plugin 中。Linux用户可以放在
$HOME/.vim/plugin 中。
↑
建立符号数据库 †
我们假设我们要阅读的代码放在 D:\src\myproject 下。然后打开命令行,进入源代码所在的目录,
为 cscope 建立搜索文件列表。在命令行中执行以下命令:
dir /s /b *.c *.h > cscope.files
如果你的源代码是C++,则可以将 cpp 等扩展名也加入到上面的命令中。
dir /s /b *.c *.h *cpp *.hpp > cscope.files
如果是Linux用户,则可以使用 find 命令实现同样的功能:
find $(pwd) -name "*.[ch]"
然后执行以下命令:
cscope -b
执行结束后你可以在当前目录下发现 cscope.out 文件,这就是 cscope 建立的符号数据库。
上面这个命令中,-b参数使得cscope不启动自带的用户界面,而仅仅建立符号数据库。
↑
浏览源代码 †
使用 gvim 打开你的源代码目录中任意一个C程序文件。然后在gvim中执行如下命令:
:cscope add D:\src\myproject\cscope.out
由于在 gvim 中可以使用命令缩写,因此上面的命令可以写成:
:cs a D:\src\myproject\cscope.out
这样就打开了刚刚建立的符号数据库。通过下面的命令可以检查数据库连接的存在。
:cscope show
该命令可以缩写为
:cs s
现在将光标移动到源代码中的某个函数名上,依次按下一下组合键:
s
稍等片刻之后你会在屏幕下放看到如下的字样*1:
Cscope tag: display
# line filename / context / line
1 342 D:\src\myproject\src\global.h <>
void display(void );
2 616 D:\src\myproject\src\command.c <>
display();
3 138 D:\src\myproject\src\display.c <>
display(void )
4 385 D:\src\myproject\src\main.c <>
display();
5 652 D:\src\myproject\src\main.c <>
display();
6 663 D:\src\myproject\src\main.c <>
display();
Enter nr or choice ( to abort):
这里显示出的就是整个工程中使用到了 display 这个标识符的位置。此时输入 4,回车,
即可跳转到 main.c 的 385 行调用 display() 函数的地方进行浏览。浏览结束后按 或者
可以回到跳转前的位置。
然后将光标移动到源代码某个函数名上,迅速地依次安下面的组合键:
s
其中 按 Ctrl-2 即可输入。同样,屏幕上出现了一排结果,选择之后你会发现,
跳转到的文件将在水平方向的新窗口中打开。
然后将光标移动到源代码某个函数名上,迅速地依次安下面的组合键:
s
选择之后你会发现,跳转到的文件将在垂直方向的新窗口中打开。
以上我们简单介绍了cscope的使用方法,其中我们只用到了一个 s 命令,即跟在 和 后面的 s 键。
同样,我们可以使用以下的功能键实现不同的跳转功能。
c: 查找该函数被调用的位置
d: 查找该函数调用了哪些函数
e: 查找指定的正规表达式
f: 查找指定的文件
g: 查找指定标识符的定义位置
i: 查找该文件在哪些地方被包含
s: 查找指定标识符的使用位置
t: 查找指定的文本字符串
↑
命令行使用说明 †
除了上述通过快捷键映射的方式使用cscope之外,也可以直接在gvim命令行中使用cscope。这样就可以
随意定义查找字符串,而不必局限于源代码中已有的标识符。命令格式如下:
:cscope find <关键字>
该命令可以缩写为
:cs f <关键字>
一个比较实用的技巧是使用cscope打开文件。使用以下命令即可直接打开名为display.c的文件,
而不必先切换到display.c所在的目录。
:cs f f display.c
cscope也支持正规表达式。如果记不清某个函数的名称,可以用下面的方式来找到该函数的定义位置。
:cs f g .*SetConfiguration.*
↑
版权 †
Cscope虽然不是GPL版权,但是Cscope是开放源码的自由软件,使用Cscope无须支付任何费用。
↑
参考 †
Cscope官方主页, http://cscope.sourceforge.net/
The Vim/Cscope tutorial, http://cscope.sourceforge.net/cscope_vim_tutorial.html
Cscope on Win32, http://iamphet.nm.ru/cscope/
Vim中关于 cscope 的帮助,使用 :help cscope 命令查看