Cscope的使用（领略Vim + Cscope的强大魅力）

àì夳堔傛蜴生んèń 2022-05-09 16:06 1911阅读 0赞

# 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|”。

# 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 path
     0 11453  cscope.out                             <none>

提示：

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