vim +ctags+ vimlist +scope 转载


1.如何使用taglist插件(plugin)。

想必用过Source Insight的人都记得这样一个功能:SI能够把当前文件中的宏、全局变量、函数等tag显示在Symbol窗口,用鼠标点上述tag,就跳到该tag定义的位置;可以按字母序、该tag所属的类或scope,以及该tag在文件中出现的位置进行排序;如果切换到另外一个文件,Symbol窗口更新显示这个文件中的tag。

在vim中的taglist插件所实现的就是上述类似的功能,有些功能比SI弱,有些功能比SI更强。而且,taglist插件还在不断完善中!

要使用taglist plugin,必须满足:

  • 打开vim的文件类型自动检测功能:filetype on
  • 系统中装了Exuberant ctags工具,并且taglist plugin能够找到此工具(因为taglist需要调用它来生成tag文件)
  • 你的vim支持system()调用

在文章vimrc初步中,我们使用了vim自带的示例vimrc,这个vimrc中已经打开了文件类型检测功能;在上篇文章中,我们也已用到了Exuberant ctags;system()调用在一般的vim版本都会支持(suse Linux发行版中出于安全考虑,关闭了此功能),所以我们已经满足了这三个条件。

现在我们到http://www.vim.org/scripts/script.php?script_id=273下载最新版本的taglist plugin,目前版本是4.3。

下载后,把该文件在~/.vim/目录中解压缩,这会在你的~/.vim/plugin和~/.vim/doc目录中各放入一个文件:

plugin/taglist.vim – taglist插件
doc/taglist.txt    - taglist帮助文件 

注:windows用户需要把这个插件解压在你的$vim/vimfiles或$HOME/vimfiles目录。

使用下面的命令生成帮助标签(下面的操作在vim中进行):

:helptags ~/.vim/doc 

生成帮助标签后,你就可以用下面的命令查看taglist的帮助了:

:help taglist.txt 

Taglist提供了相当多的功能,我的vimrc中这样配置:

""""""""""""""""""""""""""""""
" Tag list (ctags)
""""""""""""""""""""""""""""""
if MySys() == "windows"                "设定windows系统中ctags程序的位置
let Tlist_Ctags_Cmd = 'ctags'
elseif MySys() == "linux"              "设定linux系统中ctags程序的位置
let Tlist_Ctags_Cmd = '/usr/bin/ctags'
endif
let Tlist_Show_One_File = 1            "不同时显示多个文件的tag,只显示当前文件的
let Tlist_Exit_OnlyWindow = 1          "如果taglist窗口是最后一个窗口,则退出vim
let Tlist_Use_Right_Window = 1         "在右侧窗口中显示taglist窗口 

这样配置后,当你输入”:TlistOpen“时,显示如下窗口:

点击查看大图

在屏幕右侧出现的就是taglist窗口,你从中可以看到在main.c文件中定义的所有tag:宏、定义、变量、函数等;你也可以双击某个tag,跳到该tag定义的位置;你还可以把某一类的tag折叠起来(使用了vim的折行功能),方便查看,就像上图中macro和variable那样。更多的功能,请查看taglist的帮助页,本文也会介绍一些常用功能。

下面介绍常用的taglist配置选项,你可以根据自己的习惯进行配置:

  • Tlist_Ctags_Cmd选项用于指定你的Exuberant ctags程序的位置,如果它没在你PATH变量所定义的路径中,需要使用此选项设置一下;
  • 如果你不想同时显示多个文件中的tag,设置Tlist_Show_One_File为1。缺省为显示多个文件中的tag;
  • 设置Tlist_Sort_Type为”name“可以使taglist以tag名字进行排序,缺省是按tag在文件中出现的顺序进行排序。按tag出现的范围(即所属的namespace或class)排序,已经加入taglist的TODO List,但尚未支持;
  • 如果你在想taglist窗口是最后一个窗口时退出vim,设置Tlist_Exit_OnlyWindow为1;
  • 如果你想taglist窗口出现在右侧,设置Tlist_Use_Right_Window为1。缺省显示在左侧。
  • 在gvim中,如果你想显示taglist菜单,设置Tlist_Show_Menu为1。你可以使用Tlist_Max_Submenu_ItemsTlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度;
  • 缺省情况下,在双击一个tag时,才会跳到该tag定义的位置,如果你想单击tag就跳转,设置Tlist_Use_SingleClick为1;
  • 如果你想在启动vim后,自动打开taglist窗口,设置Tlist_Auto_Open为1;
  • 如果你希望在选择了tag后自动关闭taglist窗口,设置Tlist_Close_On_Select为1;
  • 当同时显示多个文件中的tag时,设置Tlist_File_Fold_Auto_Close为1,可使taglist只显示当前文件tag,其它文件的tag都被折叠起来。
  • 在使用:TlistToggle打开taglist窗口时,如果希望输入焦点在taglist窗口中,设置Tlist_GainFocus_On_ToggleOpen为1;
  • 如果希望taglist始终解析文件中的tag,不管taglist窗口有没有打开,设置Tlist_Process_File_Always为1;
  • Tlist_WinHeightTlist_WinWidth可以设置taglist窗口的高度和宽度。Tlist_Use_Horiz_Window为1设置taglist窗口横向显示;

在taglist窗口中,可以使用下面的快捷键:

          跳到光标下tag所定义的位置,用鼠标双击此tag功能也一样
o             在一个新打开的窗口中显示光标下tag
       显示光标下tag的原型定义
u             更新taglist窗口中的tag
s             更改排序方式,在按名字排序和按出现顺序排序间切换
x             taglist窗口放大和缩小,方便查看较长的tag
+             打开一个折叠,同zo
-             将tag折叠起来,同zc
*             打开所有的折叠,同zR
=             将所有tag折叠起来,同zM
[[            跳到前一个文件
]]            跳到后一个文件
q             关闭taglist窗口
          显示帮助 

可以用”:TlistOpen“打开taglist窗口,用”:TlistClose“关闭taglist窗口。或者使用”:TlistToggle“在打开和关闭间切换。在我的vimrc中定义了下面的映射,使用键就可以打开/关闭taglist窗口:

map   :TlistToggle 

Taglist插件还提供了很多命令,你甚至可以用这些命令创建一个taglist的会话,然后在下次进入vim时加载此会话。


2.vimrc配置

~/.vimrc下面做如下配置:

set nocompatible

set number

syntax on

set showmatch

set incsearch

set background=dark

set ignorecase smartcase

set mouse=a

""""""""""

"Tag list

""""""""""

map :TlistToggle

let Tlist_Ctags_Cmd="/usr/local/bin/ctags"

let Tlist_Show_One_File=1

let Tlist_Exit_OnlyWindow=1

let Tlist_Use_Left_Window=1

let Tlist_File_Fold_Auto_Close=1 


3.scope

介绍完了ctags和taglist,下面该cscope出场了,其实cscope我也是刚用没两天的,没仔细的看帮助,只是在帮助中看了一下如何启用cscope和cscope的搜索功能,其他的以后慢慢摸索.

由于taglist从目前我掌握的情况来看,我尚且不知道怎么去查找某个函数究竟在那些有地方调用,所以才找到了cscope.

1.首先打开.vimrc文件,添加如下内容(显然没有添加的话好像也是可以的,我就没有添加,只是可能用的时候稍微的麻烦点)
用来设定是否使用 quickfix 窗口来显示 cscope 结果

"set cscopequickfix=s-,c-,d-,i-,t-,e-"

2.同样进入源代码根目录,执行

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的索引速

3.完成了索引文件的生成之后启动vim  例如vim drivers/net/cs89x0.c 在命令模式下执行cs a cscope.out加入索引文件,添加完毕后可以用cs s来察看是否有添加

 表示有添加成功


注意:由于cscope是基于相对路径的,可能存在找不到文件的错误,需要使用绝对路径方式来生成:cscope.out

在/usr/bin下添加如下脚本gencscope.sh

#!/bin/bash

TARGET='/tmp/cscope.files'

find $1 -name "*.h" -o -name "*.cpp" > ${TARGET}

mycwd = `pwd`

cd $1

ctags -R *

cscope -bq -i ${TARGET}

cd ${mycwd}


如此只需要执行gencscopes  xxxx目录即可


4.下面就可以在vim中进行实际演练操作了.

(1)把光标移到某个函数上,使用Ctrl+],就可以跳到函数的定义中.

(2)查找某个函数的声明和定义:

  :cs find g strcpy

(3)如果出现找出多个函数声明和定义的情况,可以使用quickFix窗口进行选择切换:

   :cw

其实我主要是用find,cscope find的用法:

cs find c|d|e|f|g|i|s|t name

0 或 s 查找本 C 符号(可以跳过注释)
1 或 g 查找本定义
2 或 d 查找本函数调用的函数
3 或 c 查找调用本函数的函数
4 或 t 查找本字符串
6 或 e 查找本 egrep 模式
7 或 f 查找本文件
8 或 i 查找包含本文件的文件

当然如果每次输入这么长的命令肯定有人受不了, Cscope的帮助手册中推荐了一些快捷键的用法, 下面是其中一组,虽然我个人暂时没用,但还是贴出来,将下面的内容添加到~/.vimrc中, 并重启vim:

nmap s :cs find s =expand("")
nmap g :cs find g =expand("")
nmap c :cs find c =expand("")
nmap t :cs find t =expand("")
nmap e :cs find e =expand("")
nmap f :cs find f =expand("")
nmap i :cs find i ^=expand("")$
nmap d :cs find d =expand("")

当光标停在某个你要查找的词上时, 按下g, 就是查找该对象的定义, 其他的同理.按这种组合键有一点技巧,按了后要马上按下一个键,否则屏幕一闪就回到nomal状态了g的按法是按"Ctrl+Shift+-", 然后很快再按"g"



如果想让cscope以绝对路径的形式进行加载的话:需要做以下操作(利用cscope.files文件)

在~/.bashrc中添加如下alias:

[plain]  view plain copy print ?
  1. alias mkcscopefile='find `pwd` -name "*.[ch]" -o -name "*.cpp" > cscope.files'  
  2. alias mktag='ctags -R;cscope -bR'  

然后,在terminal中source ~/.bashrc,就可以使用mkcscopefile;mktag命令来生成cscope.out和tags文件了。

如果路径中含有空格,需要使用sed对生成的cscope.files文件进行处理,命令:

sed -i ‘s/^/"/;s/$/"/' cscope.files


你可能感兴趣的:(linxu系统,VIM)