vim插件cscope使用详解

简介

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

  cscope是一个类似ctags的工具。 你可以把它想作是超过频的ctags，因为它功能比ctags强大很多。 在 Vim里，通过cscope查询结果来跳转就象跳转到其他的标签完全一样；它被保存在标签栈里。这样你就可以象使用tags一样在函数等等之间便捷的跳转。在VIM中使用cscope非常简单，首先调用cscope add cscope.out命令添加一个cscope数据库，然后就可以调用cscope find命令进行查找了。VIM支持8种cscope的查询功能，然后列出目标出现的所有位置。我们还可以进行字符串查找，它会在双引号或单引号括起来的内容中查找。还可以输入一个正则表达式，这类似于egrep程序的功能。

安装

• 手动编译安装
  • 从http://cscope.sourceforge.net/下载源码
  • 解压后进入源码根目录
  • 配置：./configure --with-flex (注：如果平台是Linux,最好带上 –with-flex选项)
  • 编译：make (注：我没有遇到错误)
  • 安装：make install
• 下载已编译的二进制包
  • sudo apt install cscope

注意：cscope即可以单独使用，也可以在作为vim的一个插件来使用，但要求vim编译时配置了--enable-cscepe特性。可以使用$ vim --version |grep cscepe来查看是否支持。

配置

• 修改vim配置文件vimrc.你可以修改/etc/vimrc使用所有用户都使用本配置文件，当然你还可以修改~/.vimrc
• 下载配置文件：cscope_map.vim
• 把cscope_map.vim里从 if has(“cscope”) 到 endif里边的内容复制到/etc/vimrc里边去，也可以自行修改。

使用

建立数据库：cscope -Rbq

进入vim

添加数据库: :add file|dir [pre-path] [flags])

搜索: :find {querytype} {name}，除了 4 和 6 之外的类型忽略 name之前的空格。4 和 6 在 querytype和name 之间只能有一个空格分隔。多余的空格是 name}的一部分。

0 或 s: 查找本 C 符号

1 或 g: 查找本定义

2 或 d: 查找本函数调用的函数

3 或 c: 查找调用本函数的函数

4 或 t: 查找本字符串

6 或 e: 查找本 egrep 模式

7 或 f: 查找本文件

8 或 i: 查找#include本文件的文件

9 或 a: 查找此符号被赋值的位置

显示帮助: :help

断开连接: :kill #

重置连接::reset

显示连接::show

除了 4 和 6 之外的类型忽略 {name} 之前的空格。4 和 6 在 {querytype} 和 {name} 之间只能有一个空格分隔。多余的空格是 {name} 的一部分。 

命令详解

概要和描述

命令 ：

cscope [-bCcdehkLlqRTUuVvX] [-Fsymfile] [-freffile] [-Iincdir] [-inamefile] [-0123456789pattern] [-pn] [-sdir] [files] 

描述：cscope是一个交互式的，面向屏幕的工具，允许用户浏览C源文件以获取指定的代码元素。默认情况下，cscope检查当前目录中的C（.c和.h），lex（.l）和yacc（.y）源文件。可以在命令行上指明源文件。cscope会搜索头文件目录。 cscope使用交叉引用符号（默认情况下称为cscope.out）来定位文件中的函数，函数调用，宏，变量和预处理器符号。cscope将在首次浏览程序源文件时构建交叉引用符号数据库。在后续调用中，仅当源文件已更改或源文件列表不同时，cscope才会重建交叉引用。重建交叉引用时，将从旧的交叉引用复制未更改文件的数据数据库，这使得重建速度比初始构建更快。

选项

• -I，-c，-k，-p，-q和-T选项也可以位于cscope.files文件中。

初始搜索请求

• 交叉索引数据库准备就绪后，cscope将显示以下菜单：

  • Find this C symbol——找到这个C符号
  • Find this function definition——找到此函数定义：
  • Find functions called by this function——查找此函数调用的函数：
  • Find functions calling this function——查找调用此函数的函数：
  • Find this text string——找到这个文字字符串：
  • Change this text string——更改此文本字符串：
  • Find this egrep pattern——找到这个egrep pattern：
  • Find this file——找到这个文件：
  • Find files #including this file——查找文件#include文件
  • Find assignments to this symbol——查找此符号的赋值

• 反复按<up>或<down>键移动到所需的输入字段，键入要搜索的文本，然后按<return>键搜索。如果搜索成功，则可以使用以下任何单字符命令：

发出后续请求

• 搜索成功后可以使用下例命令

• 在任何时候，可以使用这些单字符命令：

注意：如果要搜索的文本的第一个字符与上述命令之一匹配，请先键入（反斜杠）以将其转义。

• 用新文本替换旧文本:键入要被改变的文本后，cscope将提示输入新文本，然后显示包含旧文本的行。 使用这些单字符命令选择要更改的行

特殊键：如果终端具有在vi中工作的箭头键，则可以使用它们在输入字段中移动。 向上箭头键可用于移动到上一个输入字段，而不是重复使用<Tab>键。如果您有<CLEAR>，<NEXT>或<PREV>键，它们将分别充当^l，+和 – 命令。

注：一直没有搞明白这个是怎么使用的

命令行模式

• -l选项允许您在面向屏幕的界面不会有用的情况在使用cscope，例如，来自另一个面向屏幕的程序。
• 当cscope准备输入以字段编号（从0开始计数）后立即跟随搜索模式的输入行时，它将提示>>，例如，lmain找到主函数的定义。
• 如果您只想要单个搜索，请使用-L和-num模式选项，
• 而不是-l选项，并且不会获得>>提示。
• 对于-l，cscope输出参考行数 cscope：2行
• 对于每个找到的索引，cscope输出文件名，函数名，行号，行文本，用空格隔开
• 请注意，与面向屏幕的界面不同，不会调用编辑器来显示单个引用。
• 您可以使用c命令在搜索时忽略/使用字母大小写。
• 您可以使用r命令重建数据库。
• 当cscope检测到文件结束时，或者当输入行的第一个字符是“^d”或“q”时，它将退出。

环境变量

文件

相关文章:

vim下按Ctrl+S造成编辑器“僵死”或“锁定”的解决方案 vim之c语言函数跳转功能 Git忽略一些文件跟踪和.gitignore的使用 解决打开Vim报“NoExtraConfDetected: No .ycm_extra_conf.py file detected”错误 vim的visual模式详解