cscope -Vim中文维基

注意：在cygwin下安装cscope，并根据本文说明下载键盘映射设置文件  放入  C:\Program Files\Vim\vim70\plugin\后，运行cscope -Rb 生成cscope.out文件，发现windows版的vim启动时出错，提示：“无法生成cscope进程“,下载windwos版的cscope.exe 放入源代码所在目录运行生成cscope.out后此问题消失。

     而cygwin下的vim则通吃，无论是win32版本还是linux版本的cscope.out都能顺利使用cscope.

url:

  

 

 

---

cscope是什么？

cscope 是一个 C 语言的浏览工具，通过这个工具可以很方便地找到某个函数或变量的定义位置、被调用的位置等信息。目前支持 C 和 C++。cscope 自身带一个基于文本的用户界面，不过 gvim 提供了cscope接口，因此可以在 gvim 中调用 cscope，方便快捷地浏览源代码。

为什么要使用cscope？

假设我们在读一份很大的项目的源代码。我们也许会需要进行如下操作。

• 函数 foo() 调用了函数 bar()，想看看函数 bar() 的内容。
• 想知道 foo() 在什么地方被调用。
• 想知道一个结构类型的定义。

虽然在 Linux 下使用 grep 或者在 Windows 下使用文件查找功能也能找到想找的文件，但是效率太低了。有没有什么更为方便快捷的方法？

这就需要用到cscope。gvim结合cscope，可以很方便地完成以上的操作，只需简单地敲几下键盘即可跳转到想去的地方。

如何使用cscope？

下载

如果你使用的是Linux，那么恭喜你，很可能操作系统已经为你提供了cscope工具。使用下面的命令确认它是否存在：

cscope -V

如果cscope工具已经安装，上面的命令将显示cscope的版本号，类似于下面的结果：

cscope: version 16.0a

但是如果提示错误说找不到cscope命令，说明cscope尚未安装。你可以到网上去寻找cscope的RPM包。另外，我们可以从上下载到 cscope 的最新源代码。在Linux下你可以编译该源代码生成cscope的可执行文件。

如果你是Windows用户，就没有这么好的福气了，因为在Windows下编译程序并不是很简单的事情。好在已经有人为我们编译好了Windows版，可以从这里下载到：。

安装

安装很简单，只要将cscope的可执行文件放到PATH环境变量包含的目录中即可。推荐Windows用户将上面下载到的 cscope.exe 与 gvim 放在同一个目录下，如 C:\Program Files\Vim\gvim64 下，然后单击开始菜单选择运行，输入 cmd，启动命令行提示符程序，执行

cscope -V

如果能看到cscope的版本好则说明安装成功。

另外，为了方便地使用cscope，我们还需要下载cscope的键盘映射设置，这样就可以在gvim中简单地通过快捷键来使用 cscope，而不必敲复杂的命令了。键盘映射可以从这里下载：

将下载到的 cscope_maps.vim 放在gvim的插件目录里，如 C:\Program Files\Vim\vimfiles\plugin 中。Linux用户可以放在 $HOME/.vim/plugin 中。

建立符号数据库

我们假设我们要阅读的代码放在 D:\src\myproject 下。然后打开命令行，进入源代码所在的目录，为 cscope 建立搜索文件列表。在命令行中执行以下命令：

dir /s /b *.c *.h  > cscope.files

如果你的源代码是C++，则可以将 cpp 等扩展名也加入到上面的命令中。

dir /s /b *.c *.h *cpp *.hpp  > cscope.files

如果是Linux用户，则可以使用 find 命令实现同样的功能：

find $(pwd) -name "*.[ch]"

然后执行以下命令：

cscope -b

执行结束后你可以在当前目录下发现 cscope.out 文件，这就是 cscope 建立的符号数据库。

上面这个命令中，-b参数使得cscope不启动自带的用户界面，而仅仅建立符号数据库。

浏览源代码

使用 gvim 打开你的源代码目录中任意一个C程序文件。然后在gvim中执行如下命令：

:cscope add D:\src\myproject\cscope.out

由于在 gvim 中可以使用命令缩写，因此上面的命令可以写成：

:cs a D:\src\myproject\cscope.out

这样就打开了刚刚建立的符号数据库。通过下面的命令可以检查数据库连接的存在。

:cscope show

该命令可以缩写为

:cs s

现在将光标移动到源代码中的某个函数名上，依次按下一下组合键：

s

稍等片刻之后你会在屏幕下放看到如下的字样：

Cscope tag: display
   #   line  filename / context / line
   1    342  D:\src\myproject\src\global.h <>
             void display(void );
   2    616  D:\src\myproject\src\command.c <>
             display();
   3    138  D:\src\myproject\src\display.c <>
             display(void )
   4    385  D:\src\myproject\src\main.c <>
             display();
   5    652  D:\src\myproject\src\main.c <>
             display();
   6    663  D:\src\myproject\src\main.c <>
             display();
Enter nr or choice ( to abort):

这里显示出的就是整个工程中使用到了 display 这个标识符的位置。此时输入 4，回车，即可跳转到 main.c 的 385 行调用 display() 函数的地方进行浏览。浏览结束后按 或者 可以回到跳转前的位置。

然后将光标移动到源代码某个函数名上，迅速地依次安下面的组合键：

s

其中 按 Ctrl-2 即可输入。同样，屏幕上出现了一排结果，选择之后你会发现，跳转到的文件将在水平方向的新窗口中打开。

然后将光标移动到源代码某个函数名上，迅速地依次安下面的组合键：

s

选择之后你会发现，跳转到的文件将在垂直方向的新窗口中打开。

以上我们简单介绍了cscope的使用方法，其中我们只用到了一个 s 命令，即跟在 和 后面的 s 键。同样，我们可以使用以下的功能键实现不同的跳转功能。

• c: 查找该函数被调用的位置
• d: 查找该函数调用了哪些函数
• e: 查找指定的正规表达式
• f: 查找指定的文件
• g: 查找指定标识符的定义位置
• i: 查找该文件在哪些地方被包含
• s: 查找指定标识符的使用位置
• t: 查找指定的文本字符串

命令行使用说明

除了上述通过快捷键映射的方式使用cscope之外，也可以直接在gvim命令行中使用cscope。这样就可以随意定义查找字符串，而不必局限于源代码中已有的标识符。命令格式如下：

:cscope find  <关键字>

该命令可以缩写为

:cs f  <关键字>

一个比较实用的技巧是使用cscope打开文件。使用以下命令即可直接打开名为display.c的文件，而不必先切换到display.c所在的目录。

:cs f f display.c

cscope也支持正规表达式。如果记不清某个函数的名称，可以用下面的方式来找到该函数的定义位置。

:cs f g .*SetConfiguration.*

版权

Cscope虽然不是GPL版权，但是Cscope是开放源码的自由软件，使用Cscope无须支付任何费用。

参考

• Cscope官方主页,
• The Vim/Cscope tutorial,
• Cscope on Win32,
• Vim中关于 cscope 的帮助，使用 :help cscope 命令查看

其他

本文所需的cscope Win32版以及键盘映射配置等，在这里做了备份。万一文章中提到的URL无法下载时，请使用以下的下载链接。

• cscope 16.0a Win32版: cscope-16.0a-win32.7static.zip
• 键盘映射配置: cscope_maps.zip