vim + cscope

最新推荐文章于 2024-07-15 11:13:33 发布

akjsdhg

最新推荐文章于 2024-07-15 11:13:33 发布

阅读量652

点赞数

分类专栏： Linux 文章标签： vim 数据库 linux 正则表达式 makefile search

Linux 专栏收录该内容

0 篇文章 0 订阅

订阅专栏

linux下使用 vim + cscope 查看代码

先备份一下，还没有弄好。

1. vim的准备
首先 vim --version | grpe cscope，看看vim是否支持cscope，如果不支持需要重新安装vim。最简单的是在./configure 后加上-enable-cscope，当然可以在Makefile文件（./src/Makefile）中修改（把原来的注释去掉），这是最根本的：
CONF_OPT_CSCOPE = --enable-cscope
然后安装：make && make install

2. cscope的准备
安装cscope（我的版本15.6），由于是非root用户，需要./configure --prefix=$HOME/local/cscope指可执行定文件和man文件的地址。

3. 生成所需的文件
前两样都具备了，现在可以在vim中用cscope来看代码了。怎么看？？如同sourceingight一样，cscope需要一些数据文件（数据库&索引）来查找代码的相关关键字信息。
这些文件需要手工生成：格式： cscope [options]
下面是cscope的常用选项：

现在进入代码的根目录然后：cscope -Rbq。这个命令会生成三个文件：cscope.out, cscope.in.out, cscope.po.out。其中cscope.out是基本的符号索引，后两个文件是使用"-q"选项生成的，可以加快cscope的索引速度。
cscope缺省只解析C文件(.c和.h)、lex文件(.l)和yacc文件(.y)，虽然它也可以支持C++以及Java，但它在扫描目录时会跳过C++及Java后缀的文件。如果你希望cscope解析C++或Java文件，需要把这些文件的名字和路径保存在一个名为cscope.files的文件。当cscope发现在当前目录中存在cscope.files时，就会为cscope.files中列出的所有文件生成索引数据库。
一般用如下命令生成包含cpp文件的cscope.files:
find ./ -name "*.h" -o -name "*.c" -o -name "*.cpp" > cscope.files
在cscope.files生成以后，就可以cscope -bq来得到索引（.out）文件了。

-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，这样，你不用切换到你数据库文件所在的目录也可以使用它了。

4. 在vim中使用cscope

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

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

可以看到，想查找一个关键词要输入不少命令，降低了效率，其实可以通过快捷键实现快速查找。下面是从网上找到的一个.vimrc中进行cscope选项和键盘映射的脚本段：

"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" cscope setting
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
if has("cscope")
       set csprg=/usr/bin/cscope
       set csto=1
       set cst
       set nocsverb
       " add any database in current directory
       if filereadable("cscope.out")
           cs add cscope.out
       endif
       set csverb
endif

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>

初次使用可能会觉得恨不适应，慢慢习惯了就好。在VIM的网站上有很多与cscope相关的插件：http://www.vim.org/scripts/script_search_results.php?keywords=cscope&script_type=&order_by=rating&direction=descending&search=search，还有cscope的主页：http://cscope.sourceforge.net/ 。

Vim + Cscope打造Linux下的Source Insight

　　Source Insight是Windows下最方便浏览代码的工具。但是Source Insight是没有Linux版本的。为了方便在Linux下浏览代码并进行学习，可以利用Vim配合Cscope来打造Linux下的Source Insight。

　　Cscope是Vim适用的工具和插件，通过Cscope可以方便地获知某个函数的定义以及被哪些函数调用。

Cscope安装

　　可以在http://cscope.sourceforge.net/下载源码包，然后解压，编译安装。

./configure

make

make install

生成Cscope数据库

　　使用cscope前，必须为代码生成一个cscope数据库。假设当前代码在/usr/src/linux目录下，则运行下列命令。

cd /usr/src/linux

cscope –Rbq

　　然后会生成3个文件：cscope.in.out，cscope.out，cscope.po.out。

　　用vim打开代码文件，将刚才生成的cscope文件导入到vim中。

vim init/main.c

:cs add /usr/src/linux/cscope.out /usr/src/linux

　　也可以将下面语句添加到vim的配置文件.vimrc中。

if fileradable("cscope.out")
    cs add csope.out
elseif $CSCOPE_DB  != ""
    cs add $CSCOPE_DB
endif

Cscope的功能

　　Cscope的功能通过它的子命令“find”来实现。

cs find c|d|e|g|f|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("<cword>")<CR><CR>
nmap <C-@>i :cs find i ^<C-R>=expand("<cword>")<CR>$<CR>
nmap <C-@>d :cs find d <C-R>=expand("<cword>")<CR><CR>