vim+cscope

2023-10-17 01:20
文章标签 vim cscope

本文主要是介绍vim+cscope,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

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

 

cscopevim

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 / line1     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|”。

 

3、Cscope选项

       使用|: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 path0 11453  cscope.out                             <none>

 

 

提示:

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

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

 :cs find g FTPD_CHECK_LOGIN

 

 

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

本文转载自:http://blog.csdn.net/dengxiayehu/article/details/6330200

转载自:http://blog.csdn.net/dengxiayehu/article/details/6330200

 

首先在目录下建立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: 查找包含本文件的文
cs help
find 的选项
0或则S:查找本符号
1或则G:查找本定义
2或则D:查找本函数调用的函数
3或则C:查找调用本函数的函数
4或则T:查找本字符串
6或则E:查找本EGREP模式
7或则F:查找本文件
8或则I:查找包含本文件的文件
热后就可以在vim中使用cscope了,具体使用方法参考

 

 

 

 

vim+cscope时自动更新cscope的数据库文件

 

在linux环境下vim和emacs是当仁不让的主流编辑器。现在记录一下本人使用vim时遇到的一个问题(如题),和解决方法。

        vim只是一个编辑器,如工程中的符号跳转、符号搜索等功能它并不具备。那么在阅读kernel等大型工程的时候单纯用vim是不方便的。那么就需要借助 cscope进行上述功能的补充。如果只是代码阅读,则一次生成数据库就可以了,但是如果是在正常的开发过程中,需要经常对文件进行修改就会发现有一个麻 烦。

        那就是cscope并不会自动更新它的数据库,如我们新增或者删除某个函数后并不会体现到当前连接到vim中的这个数据库里。此时将出现跳转失败等问题。

        而source insight等工具是能够自动更新其数据库的,我们的修改可以实时被其看到而不出现跳转失败等问题。那么能否让系统也自动更新cscope的数据库呢?当然可以,当然了,cscope是不能自动更新的,那么就需要依赖于操作系统了,下面将从windows和linux两方面说一下本人自动更新的实现。

        一、windows:stackoverflow 中了解到,GVIM有一个server/remote工作模式。即在gvim外部向vim发指令让其做某些事情。我们知道,windows下某个文件被打 开后是不能再对它进行操作的。数据库文件cscope.out一但被连接到vim那么就不能再对该文件进行操作了。那怎么办呢,此时就需要用到上面说的方 法了。需要让vim知道我们将要更新数据库了,需要它先断开连接,更新完成后再重新连接,这样就完成了一次完整的更新了。在windows中当然是使 用.bat文件做这样事情了,我实现上述功能的代码如下:

首先需要实现vim需要干事的函数(在_vimrc文件中添加下面两个函数):

1:断开scope数据库连接

 

 
  1. function! disable_cscope()

  2. cs kill -1

  3. endfunction

 

 

2:重新连接scope数据库(我的数据库在E:\Linux_kernel\linux-2.6.11.1\目录中)

 

 
  1. function! connect_cscope()

  2. cs add E:\Linux_kernel\linux-2.6.11.1\cscope_bak.out

  3. endfunction

 

 

3:后台更新数据库的bat文件

 

 
  1. @echo off

  2. %2 //进入运行文件时传入的第二个参数指示的盘

  3. cd %1 //进入第一个参数指定的具体目录

  4. :loop

  5. del cscope.out cscope.files //删除老的数据库文件

  6. echo "cscope db create"

  7. dir /s /b *.c *.h > cscope.files //生成文件列表

  8. cscope -Rbqk //生成数据库文件

  9. cmd /c vim --servername gvim --remote-expr "disable_cscope()" //发指令让vim断开cscope连接

  10. copy %1\cscope.out %1\cscope_bak.out //拷贝cscope.out为cscope_bak.out

  11. cmd /c vim --servername gvim --remote-expr "connect_cscope()" //发指令让vim重新连接数据库

  12. echo sleep 180s

  13. ping -n 180 localhost >nul //通过ping本机实现延时,时间自定

  14. goto loop

  15. @echo on

 

 

代码解释:

1、 其中一个值得解释的地方是重新连接的是cscope.out的副本,而不是原件,这样做的目的在于,不让vim断开连接太久。首先我们是删除了数据库文件 才开始再生成的,如果连接的是原件,则在删除之前就需要断开连接,且生成文件列表和数据库上非常耗时的,这样就会导致vim中长时间没有cscope的数 据库连接而让人忍受不了。使用了副本就只需要等到数据库生成后,断开连接,进行一次拷贝,再重新连接一次副本。这个断开的时间非常短,人是感觉不到的。

2、另一个值得解释的地方在于运行文件的时候需要传入参数,如:我的bat文件名叫auto_load_cscope.bat,而我的工程目录在E:\Linux_kernel\linux-2.6.11.1\中,我运行文件的方法是在cmd中进入auto_load_cscope.bat所在的目录后输入auto_load_cscope.bat E:\Linux_kernel\linux-2.6.11.1 E:即可更新E:\Linux_kernel\linux-2.6.11.1中的工程。通过参数运行文件的好处在于非常的灵活,通过参数可以做非常多的事,比如同时打开多工程都是可以实现的。

二、接下来就到linux了,在linux中会简单得多,因为它可以操作打开的文件,它可以不需要断开连接就能复制数据库文件。

        在linux中我们使用.sh文件进行后台运行,代码如下:

 

 
  1. #!/bin/bash

  2. cd $1

  3. while :; do

  4. rm -f cscope.out

  5. cscope -Rbqk

  6. cp cscope.out cscope_bak.out

  7. sleep 180s

  8. done

 

 

解释:

1、在linux中打开vim后需要手动连接数据库的副本,以后就高枕无忧了。

2、同样使用参数运行.sh文件:进入.sh文件的目录后输入命令./auto_load_cscope.sh /home/jiang/work/Linux_kernel/linux-2.6.11.1/ &即可。

3、在linux中没有打开的文件不能操作的限制后,进行多工程编辑将比windows下容易得多,直接用不同的参数运行多次.sh文件,并打开不同的工程即可。

 

       说明:

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

这篇关于vim+cscope的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/221982

相关文章

centos 6安装 vim

centos 安装vim 1.首先查询当前当前vim所依赖的包存在不存在.检查缺少哪个几个依赖包 [root@bogon firstCopy]# rpm -qa|grep vivimvim-common-7.4.160-5.el7.x86_64vim-enhanced-7.4.160-5.el7.x86_64vim-filesystem-7.4.160-5.el7.x86_64vim-

文本编辑器-Vim

http://www.vim.org/ 简单介绍 Vim是一种高度可配置的文本编辑器,用于创建和更改任何类型的文本非常高效。它与大多数UNIX系统和苹果OS X一起被列为 “vi”。 Vim是稳定的,并且不断被开发以变得更好。 其功能包括: 1. 持久的,多级的撤消树 2. 广泛的插件系统 3. 支持数百种编程语言和文件格式 4. 强大的搜索和替换 5. 与许多工具集成 下载

Vim命令记录

2019年4月26日22:46修改 好玩网站:https://coolshell.cn/articles/5426.html http://c.biancheng.net/view/813.html vim启动进入普通模式,处于插入模式或命令行模式时只需要按Esc或者Ctrl+[即可进入普通模式。普通模式中按i(插入)或a(附加)键都可以进入插入模式,普通模式中按:进入命令行模式。命令行模

Linux 中常用的 Vim 命令大全

Vim 是 Linux 系统中最常用的文本编辑器之一,因其强大的功能和轻量级的性能广泛应用于开发者和系统管理员的日常工作中。无论是代码编辑、系统配置还是日志分析,掌握 Vim 的基础和高级命令都能极大提升工作效率。本文将汇总 Vim 的常用命令及其功能,帮助你在 Linux 环境中高效操作 Vim。 一、Vim 基础介绍 Vim 是一个基于 vi 的高级文本编辑器,提供了更多强大的功能。它

vim 安装与配置教程(详细教程)

vim就是一个功能非常强大的文本编辑器,可以自己DIY的那种 ,不但可以写代码 ,还可编译 ,可以让你手不离键盘的完成鼠标的所有操作。  如果想要了解vim的的发展历史和详细解说,可以自行上网搜索,我主要是记录一下安转和配置流程以及基础的使用方法,可以简单入个门。话不多说 直接开始吧!!! 注意: 本教程是在linux系统下进行的,当然vim 还支持Windows、CentOs等系统  1、

Linux下新手如何将VIM配置成C++编程环境(可以STL自动补全)

~ 弄拉老半天,终于弄的差不多啦,果然程序员还是需要有点折腾精神啊。 首先你要安装vim,命令:sudo apt-get install vim vim它只是一个编辑器,它不是IDE(比如codeblocks),IDE相当于已经给一个房子装好啦各种东西,你只要使用就行,vim却要自己装各种东西,相当于买了一个毛坯房,自己要给房子装潢。 如何安装g++编译器可以参考我上一篇博文. 1:vi

nano 和 vim对比

nano 和 vim 是两种流行的文本编辑器,各有优缺点和适用场景。以下是对这两种编辑器的详细对比: Nano 优点: 1.简单易用:nano 的界面和命令非常简单,易于新手上手。所有的命令都列在屏幕底部,不需要记住复杂的命令。 2. 直接编辑:打开文件后可以直接开始编辑,不需要进入插入模式。 3. 轻量便捷:通常预装在大多数Linux发行版上,启动速度快。 缺点: 1.功能有限:相比于vim

vim 括号匹配 以及各种好用跳转技巧

括号匹配: % 可以让光标从它当前所在的括号跳转到与它相匹配的括号上去, 对花括号和 圆括号, 方括号都有效, 常用于手工检查括号是否匹对. 标示位置 -------- 你可以在档案□做些标记再随时返回被标记的位置. m char (MARK) 把这个地方标示成 char ' char (quote character) 跳到被标为 char的

Vim多文件搜索特定内容

reference: http://blog.chinaunix.NET/uid-14770335-id-3025369.html 用VIM开发或浏览项目时,经常会用到多文件的模式搜索。一些场合,可以用cscope find t可以解决了。可是遇到复杂的模式,该命令就捉襟见肘了。这时候就得用vim自带的匹配利器---vimgrep。 vimgrep有两种使用的方式: 1)将匹配模式

VIM标识符跳转命令

跳转到函数、变量定义处: [+ctrl+i 跳转到函数、变量和#define(按键的按下先后顺序需从左到右,对函数定义的跳转存在疑问) [+ctrl+d 跳转到#define处 ctrl+i 向前跳到前几次光标位置 ctrl+o 向后跳到后几次光标位置