感谢支持
我们一直在努力

Cscope的使用(领略Vim + Cscope的强大魅力)

1Cscope介绍


 


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


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


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


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


 


2Cscope相关命令


      


所有的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|”。

3Cscope选项


 


       使用|:set|命令来设置cscope的所有选项。理想情况是,你可以在你的启动文件中做这件事情(例如:.vimrc)。有些cscope相关变量只有在|.vimrc|中才是合法的。在vim已经启动之后再来设置它们没有任何作用!


       cscopeprg指定了执行cscpoe的命令。默认是”cscope”。例如:


              :set csprg=/usr/local/bin/cscope


 


       cscopequickfix指定了是否使用quickfix窗口来显示cscope的结果。这是一组用逗号分隔的值。每项都包含于|csope-find|命令(s, g, d, c, t, e, f, 或者i)和旗标(+, –或者0)。


       ‘+’预示着显示结果必须追加到quickfix窗口。


       ‘-’隐含着清空先前的的显示结果,’0’或者不设置表示不使用quickfix窗口。查找会从开始直到第一条命令出现。默认的值是””(不使用quickfix窗口)。下面的值似乎会很有用:”s-,c-,d-,i-,t-,e-”


 


       假如cscopetag被设置,然后诸如”:tag”ctrl+]”vim -t”等命令会始终使用|:cstag|而不是默认的:tag行为。通过设置’cst’,你将始终同时查找cscope数据库和tags文件。默认情况是关闭的,例如:


              :set cst


              :set nocst


 


       csto


       ‘csto’的值决定了|:cstag|执行查找的顺序。假如’csto’被设置为0,那么cscope数据将会被优先查找,假如cscope没有返回匹配项,然后才会查找tag文件。反之,则查找顺序相反。默认值是0,例如:


              :set csto=0


              :set csto=1


 


       假如cscopeverbose没有被设置(默认情况是如此),那么当在增加一个cscope数据库时不会显示表示表示执行成功或失败的信息。理想情况是,在增加cscope数据库之前,你应该在你的|.vimrc|中重置此选项,在增加完之后,设置它。此后,当你在vim中增加更多的数据库时,你会得到(希望是有用的)信息展示数据库增加失败。例如:


              :set csverb


              :set nocsverb


 


       cspc的值决定了一个文件的路径的多少部分被显示。默认值是0,所以整个路径都会被显示。值为1的话,那么就只会显示文件名,不带路径。其他值就会显示不同的部分。例如:


              :set cspc=3


       将会显示文件路径的最后3个部分,包含这个文件名本身。 

4、在Vim中怎么使用cscope


 


       你需要做的第一步就是为你的源文件建立一个cscope数据库。大多数情况下,可以简单的使用”cscope –b”


       假设你已经有了一个cscope数据库,你需要将这个数据库“增加”进Vim。那将会建立一个cscope“链接”并且使它能够被Vim所使用。你可以在你的.vimrc文件中做这件事,或者在Vim启动之后手动地做。例如,为了增加数据库”cscope.out”,你可以这样做:


              :cs add cscope.out


       你可以通过执行”:cs show”来再次检查以上执行的结果。这将会产生如下的输出:


       # pid      database name                       prepend path


 0 11453  cscope.out                             <none>


 


提示:


由于微软的RTL限制,Win32版本会显示0而不是真正的pid


 


一旦一个cscope链接建立之后,你可以查询cscope并且结果会反馈给你。通过命令”:cs find”来进行查找。例如:


       :cs find g FTPD_CHECK_LOGIN


执行以上命令可能会变得有点笨重的,因为它要做相当的输入次数。假如有不止一个匹配项,你将会被提供一个选择屏幕来选择你想匹配的项。在你跳转到新位置之后,可以简单的按下ctrl+t就会返回到以前的一个。


 


5、建议的用法


 


       将如下内容放置到你的.vimrc中:


       if has(“cscope”)


              set csprg=/usr/local/bin/cscope


              set csto=0


              set cst


              set nocsverb


              ” add any database in current directory


              if filereadable(“cscope.out”)


                  cs add cscope.out


              ” else add database pointed to by environment


              elseif $CSCOPE_DB != “”


                  cs add $CSCOPE_DB


              endif


              set csverb


       endif


 


       通过设置’cscopetag’,我们已经有效的将所有:tag的情况都替换为:cstag。这包括:tagctrl+],和”vim -t”。然后,正常的tag命令就会不光在tag文件中查找,也会在cscope数据库中查找。


       有些用户可能想保留常规的tag行为并且有一个不同的快捷方式来使用:cstag。例如,可以使用如下命令来映射ctrl+_(下划线)到:cstag


              map <C-_> : cstag <C-R>=expand(“<cword>”)<CR><CR>


 


       一些经常用cscope查找(使用”:cs find”)是查找调用某一特定函数的所有函数,和查找所有出现特定C符号的地方。为了做这些事,你可以使用如下的键盘映射作为例子:


              map g<C-]> :cs find 3 <C-R>=expand(“<cword>”)<CR><CR>


              map g<C-\> :cs find 0 <C-R>=expand(“<cword>”)<CR><CR>


 


       这些给ctrl+](右中括号)和ctrl+\(反斜杠)的映射可以允许你将光标放置到函数名称或者C符号上然后执行快速cscope查找匹配。


 


       或者你可以使用如下方案(很好用,可以将其添加到.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(“<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>


 


       使用’ctrl – 空格,然后查找时就会使vim水平分隔窗口,结果显示在


       新的窗口中


              nmap <C-Space>s :scs find s <C-R>=expand(“<cword>”)<CR><CR>


    nmap <C-Space>g :scs find g <C-R>=expand(“<cword>”)<CR><CR>


    nmap <C-Space>c :scs find c <C-R>=expand(“<cword>”)<CR><CR>


    nmap <C-Space>t :scs find t <C-R>=expand(“<cword>”)<CR><CR>


    nmap <C-Space>e :scs find e <C-R>=expand(“<cword>”)<CR><CR>


    nmap <C-Space>f :scs find f <C-R>=expand(“<cfile>”)<CR><CR>


    nmap <C-Space>i :scs find i <C-R>=expand(“<cfile>”)<CR><CR>


    nmap <C-Space>d :scs find d <C-R>=expand(“<cword>”)<CR><CR>


      


       两次按下’ ctrl – 空格,然后查找时就会竖直分隔窗口而不是水平分隔


              nmap <C-Space><C-Space>s


                     \:vert scs find s <C-R>=expand(“<cword>”)<CR><CR>


       nmap <C-Space><C-Space>g


              \:vert scs find g <C-R>=expand(“<cword>”)<CR><CR>


       nmap <C-Space><C-Space>c


              \:vert scs find c <C-R>=expand(“<cword>”)<CR><CR>


       nmap <C-Space><C-Space>t


              \:vert scs find t <C-R>=expand(“<cword>”)<CR><CR>


       nmap <C-Space><C-Space>e


              \:vert scs find e <C-R>=expand(“<cword>”)<CR><CR>


       nmap <C-Space><C-Space>i


              \:vert scs find i <C-R>=expand(“<cfile>”)<CR><CR>


       nmap <C-Space><C-Space>d


              \:vert scs find d <C-R>=expand(“<cword>”)<CR><CR>

6、结合实际来使用cscope


 


       我这里有一个ftp服务器的工程,主要文件如下(Secure CRT vt100, traditional, 13):  



       下面就是要cscope命令来建立数据库文件(多了3个和cscope相关的文件):


 



       说明:


a、  cscope的选项分析:


-R     :表示包含此目录的子目录,而非仅仅是当前目录;


-b     :此参数告诉cscope生成数据库后就自动退出;


-q     :生成cscope.in.outcscope.po.out文件,加快cscope的索引速度


可能会用到的其他选项:


-k     :在生成索引时,不搜索/usr/include目录;


-i      :如果保存文件列表的文件名不是cscope.files时,需要加此选项告诉cscope到哪里去找源文件列表;


-I dir :在-I选项指出的目录中查找头文件


-u     :扫描所有文件,重新生成交叉索引文件;


-C     :在搜索时忽略大小写;


-P path:在以相对路径表示的文件前加上的path,这样你不用切换到你数据库文件的目录也可以使用它了。


说明:要在VIM中使用cscope的功能,需要在编译Vim时选择”+cscope”Vimcscope接口会先调用cscope的命令行接口,然后分析其输出结果找到匹配处显示给用户。


 


b、  若是不指定-b选项,则在建立完数据库后进入如下界面: 


 



这里是想要查找C符号:FTPD_CHECK_LOGIN,你可以通过按Tab键来进行匹配内容和输入项的切换。按下ctrl+d退出。


注意:在此时,不可以使用ctrl+]进行跳转! 

下面用Vim打开其中的一个文件进行编辑,然后看看使用cscope的具体例子:


输入:vim ftpd.c


                


看到此时光标在ftpd_help这个函数声明上,现在若我们想要看看这个函数是怎么实现的,可以有如下方法:


1)直接按下ctrl+]                     # 就是按下ctrl键的同时按下’]’


2)按下ctrl+_g                          # 按下 ctrl键和下划线(同时按下shift’-’键)和g


3)输入“:cs find g ftpd_help”后回车


4)输入“:tag ftpd_help         # 假如有安装ctag的话


然后就会进行跳转:


           


       小结:在非windows系统上很多人都会选择强大的Vim作为编辑器,同时,我们要是能够用好那些同样强大的插件的话,那提高的战斗力可不止一点哦。常常会听到类似的抱怨,linux下没有好用的IDE,殊不知,用Vim结合一些插件,同样可以拥有IDE的强大功能,看代码也不错,可以有类似source insight的功能。这里展示下我的Vim,可能有些简陋,但至少有了些IDE的影子了:


      


 


       对了,还有一点:默认情况下cscope值会在当前目录下针对ciexyacc(扩展名分别为.c.h.I.y)程序文件进行解析(如果指定了-R参数则包含其自身的子目录)。这样出现的问题就是,我们对于C++Java文件怎么办,解决方案是:我们可以生成一个名为cscope.finds的文件列表,并交由cscope去解析。在Linux系统中,生成这个文件列表的方法是:


              find . –name “*.java” > cscope.files


       然后运行cscope –b 命令重新生成数据库就OK了。


 


好了,这里就先介绍这么多吧,更多用法请查阅相关资料。有空我把Vim的使用再说下。有问题希望大家不吝赐教,欢迎交流。

赞(0) 打赏
转载请注明出处:服务器评测 » Cscope的使用(领略Vim + Cscope的强大魅力)
分享到: 更多 (0)

听说打赏我的人,都进福布斯排行榜啦!

支付宝扫一扫打赏

微信扫一扫打赏