首页 > 代码库 > cscope 的使用(转载)

cscope 的使用(转载)

转自:http://laokaddk.blog.51cto.com/368606/1242365/

1, cscope安装

  1. 软件下载:http://sourceforge.net/project/showfiles.php?group_id=4664

  2. 软件安装:  

    1. ./configure --with-flex  (注:如果平台是Linux,最好带上 --with-flex选项)

    2. make  (注:我没有遇到错误)

    3. make install (注: 直接安装好了)

     

2,cscope配置

  1. 修改vim配置文件vimrc.你可以修改/etc/vimrc使用所有用户都使用本配置文件,当然你还可以修改~/.vimrc

    1. 下载配置文件:cscope_map.vim  

    2. 把cscope_map.vim里从 if has("cscope")  到 endif里边的内容复制到/etc/vimrc里边去

    3. 里边的命令意思请看下边文章

     

3,cscope使用

  1. 建立cscope使用的索引文件

    1. 在你需要浏览源码的根目录下(如你想用cscope看linux源码)使用下面命令:

      • #: cscope -Rbkq<回车>

       

    2. R 表示把所有子目录里的文件也建立索引

    3. b 表示cscope不启动自带的用户界面,而仅仅建立符号数据库

    4. q生成cscope.in.out和cscope.po.out文件,加快cscope的索引速度

    5. k在生成索引文件时,不搜索/usr/include目录

     

  2. 在源码根目录下打开任意.c文件,使用如下命令:

    1. Ctrl+]将跳到光标所在变量或函数的定义处 Ctrl+T返回

    2. :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 ---- 查找包含本文件的文

    3. 2的所以命令也可以且按銉来实现:

      1. Ctrl+/ 再按 s 表示:cs find s命令

      2. 同理实现cs find + g,d,c,t,e,f,i命令

       

     

  3. cscope_map.vim说明:

    1. 有英文注释的我就不说明了,我就说一下里边的键map映射

    2. 如: nmap <C-/>s :cs find s <C-R>=expand("<cword>")<CR><CR>

      1. nmap 表示在vim的普通模式下,即相对于:编辑模块和可视模式,以下是几种模式

        1.        :map            普通,可视模式及操作符等待模式
                 :vmap           可视模式
                 :omap           操作符等待模式
                 :map!           插入和命令行模式
                 :imap           插入模式
                 :cmap           命令行模式

         

      2. <C-/>表示:Ctrl+/

      3. s表示输入(即按:s)s

      4. : 表示输入‘:‘

      5. “cs find s"表示输入"cs find s"也即是要输入的命令

      6. <C-R>=expand("cword")总体是为了得到:光标下的变量或函数。cword 表示:cursor word, 类似的还有:cfile表示光标所在处的文件名吧

      7. <CR><CR>就是回车吧,不太清楚

       

     

  4. 其它的特补充吧。。今天就写到这里。

 

 

首先在目录下建立cscope索引文件

find -name ‘*.c‘ > cscope.file

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的索引速度

接下来,就可以在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命令,查找当前目录及子目录中所有后缀名为".h", ".c"和".cc"的文件,并把查找结果重定向到文件cscope.files中。
然后cscope根据cscope.files中的所有文件,生成符号索引文件。
最后一条命令使用ctags命令,生成一个tags文件,在vim中执行":help tags"命令查询它的用法。它可以和cscope一起使用。

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

3在vim里读代码

在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: 查找包含本文件的文

cscope 的使用(转载)