cscope的使用

1、Cscope介绍

 

       Cscope是类似于ctags一样的工具，但可以认为她是ctags的增强版，因为她比ctags能够做更多的事。在Vim中，通过cscope的查询，跳转到指定的地方就像跳转到任何标签；她能够保存标签栈，所以通过合适的键盘映射绑定，你能够在函数向后或向前跳转，就像通常使用的tags一样。

       首次使用Cscope时，他会根据源文件生成符号数据库。然后在以后的使用中，cscope只是在源文件有改动或源文件列表不同时才会重建数据库。当在重建数据库时，未改动过的文件对应的数据库信息会从旧的数据库中拷贝过来，所以会使重建数据库快于一开始的新建数据库。

       当你在命令行下调用cscope时，你会获得一个全屏选择窗口，能够使你查询特定的内容。然而，一旦你查询的有匹配，那么就会用你默认的编辑器来编辑该源文件，但是你不能够简单的使用Ctrl+]或者:tag命令来从一个标签跳转到另一个标签。

       Vim中的cscope接口是通过以命令行形式调用完成的，然后解析查询返回的结果。最终的结果就是cscope查询结果就像通常的tags一样，这样你就可以自由跳转，就像在使用通常的tags（用ctrl+]或者:tag跳转）。

 

2、Cscope相关命令

      

所有的cscope命令都是通过向主cscope命令”:cscope”传递参数选项。她最短的缩写是”:cs”。”:scscope”命令也做同样的事情并且同时会横向分隔窗口（简称：”scs”）。

      

可用的缩写有：

add ：增加一个新的cscope数据库/链接库

              使用方法：

                     :cs add {file|dir} [pre-path] [flags]

              其中：

                     [pre-path] 就是以-p选项传递给cscope的文件路径，是以相对路径表示的文件

前加上的path，这样你不要切换到你数据库文件所在的目录也可以使用它了。

                     [flags] 你想传递给cscope的额外旗标

              实例：

                     :cscope add /root/code/vimtest/ftpd

                     :cscope add /project/vim/cscope.out /usr/local/vim

                     :cscope add cscope.out /usr/local/vim –C

 

       find ：查询cscope。所有的cscope查询选项都可用除了数字5（“修改这个匹配模式”）。

              使用方法：

                     :cs find {querytype} {name}

              其中：

                     {querytype} 即相对应于实际的cscope行接口数字，同时也相对应于nvi命令：

                            0或者s   —— 查找这个C符号

                            1或者g  —— 查找这个定义

                            2或者d  —— 查找被这个函数调用的函数（们）

                            3或者c  —— 查找调用这个函数的函数（们）

                            4或者t   —— 查找这个字符串

                            6或者e  —— 查找这个egrep匹配模式

                            7或者f   —— 查找这个文件

                            8或者i   —— 查找#include这个文件的文件（们）

              实例：（#号后为注释）

                     :cscope find c ftpd_send_resp                     # 查找所有调用这个函数的函数（们）

                     :cscope find 3 ftpd_send_resp                     # 和上面结果一样

                    

                     :cscope find 0 FTPD_CHECK_LOGIN       # 查找FTPD_CHECK_LOGIN这个符号

              执行结果如下：

                     Cscope tag: FTPD_CHECK_LOGIN                   

   #   line  filename / context / line

   1     19  ftpd.h <<GLOBAL>>

             #define FTPD_CHECK_LOGIN() \

   2    648  ftpd.c <<ftpd_do_pwd>>

             FTPD_CHECK_LOGIN();

   3    661  ftpd.c <<ftpd_do_cwd>>

             FTPD_CHECK_LOGIN();

   4    799  ftpd.c <<ftpd_do_list>>

             FTPD_CHECK_LOGIN();

   5    856  ftpd.c <<ftpd_do_nlst>>

             FTPD_CHECK_LOGIN();

   6    931  ftpd.c <<ftpd_do_syst>>

             FTPD_CHECK_LOGIN();

   7    943  ftpd.c <<ftpd_do_size>>

             FTPD_CHECK_LOGIN();

   8    960  ftpd.c <<ftpd_do_dele>>

             FTPD_CHECK_LOGIN();

   9    981  ftpd.c <<ftpd_do_pasv>>

             FTPD_CHECK_LOGIN();

Enter nr of choice (<CR> to abort):

然后输入最前面的序列号即可。

 

       help ：显示一个简短的摘要。

              使用方法：

              :cs help

 

       kill  ：杀掉一个cscope链接（或者杀掉所有的cscope链接）

              使用方法：

              :cs kill {num|partial_name}

              为了杀掉一个cscope链接，那么链接数字或者一个部分名称必须被指定。部分名

称可以简单的是cscope数据库文件路径的一部分。要特别小心使用部分路径杀死一个cscope链接。

 

              假如指定的链接数字为-1，那么所有的cscope链接都会被杀掉。

 

       reset：重新初始化所有的cscope链接。

              使用方法：

              :cs reset

 

       show：显示cscope的链接

              使用方法：

              :cs show

 

       假如你在使用cscope的同时也使用ctags，|:cstag|可以允许你在跳转之前指定从一个或另一个中查找。例如，你可以选择首先从cscope数据库中查找，然后再查找你的tags文件（由ctags生成）。上述执行的顺序取决于|csto|的值。

       |:cstag|当从cscope数据库中查找标识符时等同于“:cs find g”。

       |:cstag|当从你的tags文件中查找标识符时等同于“|:tjump|”。

另一网友的使用总结：

如果项目比较简单， 那就直接cscope -R, 会在当前目录下生成一个数据库文件cscope.out

这个时候用vim编辑项目中的任意一个源文件， :cs show  可能会显示 “no cscope connection"

这是因为vim没有帮你自动加载数据库文件， 用:cs add cscope.out就可以了

这个时候命令:cs find s tagname就可以用了， 但用ctrl + ]的时候不会自动跳转， 这还是因为vim没有把你的cscope数据库文件当成tag文件， 需要用: set cst 或者:set cscopetag， 这样就会把cscope的数据库当成tag文件了

把下面代码放到.vimrc文件中， 以后系统就会自动帮你做了 

"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 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 csverbendifnmap <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>

如果有大型的项目， cscope -R不但会消耗大量的时间， 而且还会干扰tags，所以一般会现生成一个列表

 

 LNX=/home/jru/linux-2.4.18    cd /      find  $LNX                                                                \ -path "$LNX/arch/*" ! -path "$LNX/arch/i386*" -prune -o               \ -path "$LNX/include/asm-*" ! -path "$LNX/include/asm-i386*" -prune -o \ -path "$LNX/tmp*" -prune -o                                           \ -path "$LNX/Documentation*" -prune -o                                 \ -path "$LNX/scripts*" -prune -o                                       \ -path "$LNX/drivers*" -prune -o                                       \        -name "*.[chxsS]" -print >/home/jru/cscope/cscope.files

然后使用这个列表生成一个cscope.out的数据库文件，（上面加了绝对路径，使得数据库文件可以放在任意地方）

 cd  /home/jru/cscope

  cscope -bkq -i cscope.files

这样就会生成一个数据库文件了
cscope的一些参数的意义如下

 

• -R: 在生成索引文件时，搜索子目录树中的代码
• -b: 只生成索引文件，不进入cscope的界面
• -q: 生成cscope.in.out和cscope.po.out文件，加快cscope的索引速度
• -k: 在生成索引文件时，不搜索/usr/include目录
• -i: 如果保存文件列表的文件名不是cscope.files时，需要加此选项告诉cscope到哪儿去找源文件列表。可以使用”-“，表示由标准输入获得文件列表。
• -Idir: 在-I选项指出的目录中查找头文件
• -u: 扫描所有文件，重新生成交叉索引文件
• -C: 在搜索时忽略大小写
• -Ppath: 在以相对路径表示的文件前加上的path，这样，你不用切换到你数据库文件所在的目录也可以使用它了。

cscope的一些命令如下

 

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

可以在.vimrc设置一个自动更新的快捷键

 nmap <F5> :!find . -iname '*.c' -o -iname '*.cpp' -o -iname '*.h' -o -iname '*.hpp' > cscope.files<CR> 
                        \ :!cscope -b -i cscope.files -f cscope.out<CR> 
                        \ :cs reset<CR>