VIM的高效读代码
建议在vim上安装Taglist+cscope+ctags插件有利于高效读代码,有利于学习!
1、安装
对于小编我来说我使用的是Ubuntu,安装软件一般使用的命令是apt-get install ***!
对于vim+Taglist+cscope+ctags组合编辑器的创建,vim , cscope , ctags安装起来比较方便使用上述命令即可安装!
(对于不同的Linux发行版本安装软件的命令不太一样,需要根据自己的安装版稍微修改,比如说Fedora即使用yum命令安装)
对于Taglist使用这个方法安装不了,我们需要先下载,然后安装完成:
首先上网下载Taglist插件,下载完成后解压,再将文件下的taglist.vim使用cp命令拷贝到HOME/.vim/plugin文件夹下(cp -r taglist.vim ~/.vim/plugin)
2、vim的配置
vim是一个非常好用的编辑工具,以下介绍几个常用的底行模式命令:
(1). 设置缩进
:set smartindent // 设置缩进
:set smartindent shiftwidth=4 // C语言自动缩进,缩进值为4个字符宽度
(2). 显示光标行列信息
:set ruler // 显示光标信息(右下角)
(3). 查看制表符
:set list // 显示制表符,以^符号显示制表符的位置
(4). 查看行数信息
:set number //显示行号(左边)
(5). 关键字高亮
:syntax on //关键字高亮
(6). 多文件编辑 ,在编写程序时有可能需要同时编辑多个文件,在这种情况下,需要如下设置
: split two.c // 多文件编辑
当然,如果不嫌麻烦,可以在每次打开Vim时 输入如上命令,如我经常用的是:set number :set ruler :syntax on :set smartindent 命令,如果将平时在底行模式下输入的命令直接写入配置文件,则以后使用Vim时不用再次输入这些命令。
首先,试着在Vi的底行模式下输入如下命令,如果不支持的话,去下载一个Vim的全版本,sudo apt-get install vim-full。
以下是修改配置文件的方法:
(1). 找到Vimrc文件。
(2) 查看文件的权限:
ls -l vimrc
shisir@shisir-desktop:/usr/share/vim$ cd /etc/vim
shisir@shisir-desktop:/etc/vim$ ls
gvimrc vimrc vimrc.tiny
shisir@shisir-desktop:/etc/vim$ ls -l vimrc
-r--r--r-- 1 root root 2492 2009-04-10 08:08 vimrc
(3) 如果没有写权限的话,修改权限,使我们可以修改该配置文件
sudo chmod a+w vimrc
(4)根据个人需要将上述命令写入配置文件
比如,我个人的设置是: syntax on , set ruler ,set number , set smartindent shiftwidth=4
下面贴上我的vimrc文件的配置信息:
显示行号
set number
检测文件的类型
filetype on
记录历史的行数
set history=1000
自动对齐
set autoindent
set cindent
智能选择对齐方式
set smartindent
tab为4个空格
set tabstop=4
当前行之间交错时使用4个空格
set shiftwidth=4
设置匹配模式,输入左括号会出现右括号
set showmatch
编辑时显示光标状态
set ruler
快速匹配
set incsearch
修改文件自动备份
if has(vms)
set nobackup
else
set backup
endif
设置开启ctags
settags=/home/zhouyl/linux-3.4.7/tags;这边设置的是你使用ctags -R的目录,后面有介绍!你根据自己的使用修改这个路径
set autochdir
Taglist设置
let Tlist_Auto_Open = 1
let Tlist_Ctags_Cmd = '/usr/bin/ctags'
let Tlist_Show_One_File = 1
let Tlist_Exit_OnlyWindow = 1
cscope设置
set cscopequickfix=s-,c-,d-,i-,t-,e-
if has(cscope)
set csprg=/usr/bin/cscope
set csto=1
set cst
set nocsverb
add any database in current directory
if filereadable(cscope.out)
cs add cscope.out
endif
set csverb
endif
因为我的文档中的原配置文件已经有了语法高亮:
Vim5 and later versions support syntax highlighting. Uncommenting the next
line enables syntax highlighting by default.
if has(syntax)
syntax on
endif
所以我就没写了,您如果vimrc文件里面没有此项建议自己加上syntax on 设置语法高亮
PS:在配置文件中符号后的内容是注释,而且在配置文件中是不需要添加符号的 ,这里关于cscope、ctags和Taglist的设置可以先写上,后面将对这三个插件有介绍。好了,去开一个Vim,编辑一个程序看看,是不是感觉很不一般呢?
好了,下面顺便演示下,智能补全的用法,我分四种情况:1、前面申明过的变量或者函数名的补全;2、结构体等自建结构的补全;3、STL等标准库的补全;4、括号、引号等自动匹配补全。
对于第一种情况,写程序的过程中,直接用CTRL+p即可选择,对于第二种情况,如果想申明了结构体T,想在输入T.时弹出成员供选择,只需在用之前按一下:CTRL+F12,然后效果如图:
3、Taglist插件的使用
TagList插件,是一款基于ctags,在vim代码窗口旁以分割窗口形式(如上图所示)显示当前的代码结构概览,增加代码浏览的便利程度的vim插件.
在Vim中加载代码文件后,可以使用以下命令控制taglist
:TlistOpen 打开并将输入焦点至于标签列表窗口,效果如上图所示
:TlistClose 关闭标签列表窗口
:TlistToggle 切换标签列表窗口状态(打开←→关闭),标签列表窗口是否获得焦点取决于其他配置
ctl-w + w 或ctl-w + 方向键 窗口切换(taglist本质上是一个vim分隔窗口,因此可以使用ctl-w系列快捷键对窗口进行切换操作)
在Taglist窗口主要有以下操作
按F1:打开帮助
回车键:跳到光标所在的标记的定义处(如将光标移到main函数,按回车键)
o:新建一个窗口,跳到标记定义处
p:预览标记定义(仍然在taglist窗口)
空格:显示标记的原型(如函数原型)
u:更新标记列表(比如源文件新增了一个函数,并在保存后,可在taglist窗口按u)
s:选择排序字段(暂时我也不知道什么意思)
d:删除光标所在的taglist文件(如用vi打开了两个文件f1.c,f2.c可以删除f1.c的标记)
x:n放大/缩小taglist窗口
+:展开(指标记)
-:折叠
*:全部展开
=:全部折叠
[[:将光标移到前一个文件的起点
]]:将光标移到后一个文件的起点
q:退出taglist窗口
F1:关闭帮助
4、ctags插件的使用
VIM简单易用,大家只要看看VIM自带的vitutor,大约只要20分钟就能掌握VIM的用法,上面也简单介绍了点vim的用法。但是对于Linux下的C/C++的 程序员,使用VIM+Ctags的组合来写程序也许是最佳的选择。^_^
尽管ctags也可以支持其它编辑器,但是它正式支持的只有VIM。并且VIM中已经默认安装了Ctags,它可以帮助程序员很容易地浏览源代码。
熟练的使用ctags仅需记住下面七条命令:(很简单吧,呵呵)
1. $ ctags–R * ($ 为Linux系统Shell提示符)
2. $ vi –t tag (请把tag替换为您欲查找的变量或函数名)
3. :ts (ts 助记字:tagslist, “:”开头的命令为VI中命令行模式命令)
4. :tp (tp 助记字:tagspreview)---此命令不常用,可以不用记
5. :tn (tn 助记字:tagsnext) ---此命令不常用,可以不用记
6. Ctrl + ] 跳到光标所在函数或者结构体的定义处
7. Ctrl + T 返回查找或跳转
下面我们逐条的解释上面的命令:
“$ ctags–R *”:“-R”表示递归创建,也就包括源代码根目录(当前目录)下的所有子目录。“*”表示所有文件。这条命令会在当前目录下产生一个“tags”文件, 当用户在当前目录中运行vi时,会自动载入此tags文件。Tags文件中包括这些对象的列表:
用#define定义的宏
枚举型变量的值
函数的定义、原型和声明
名字空间(namespace)
类型定义(typedefs)
变量(包括定义和声明)
类(class)、结构(struct)、枚举类型(enum)和联合(union)
类、结构和联合中成员变量或函数
VIM用这个“tags”文件来定位上面这些做了标记的对象。
剩下的命令就是定位这些对象的方法:
“$ vi –t tag” :在运行vim的时候加上“-t”参数,例如:
[/usr/src]$ vim -t main
这个命令将打开定义“main”(变量或函数或其它)的文件,并把光标定位到这一行。如果这个变量或函数有多处定义,在VI命令行模式“:ts”命令就能 列出一个列表供用户选择。 “:tp”为上一个tag标记文件,“:tn”为下一个tag标记文件。当然,若当前tags文件中用户所查找的变量或函数名只有一 个,“:tp,:tn”命令不可用。 :(
最方便的方法是把光标移到变量名或函数名上,然后按下“ Ctrl+] ”,这样就能直接跳到这个变量或函数定义的源文件中,并把光标定位到这一行。用 “ Ctrl+T ”可以退回原来的地方。即使用户使用了N次“Ctrl+]”查找了N个变量,按N次“Ctrl+t”也能回到最初打开的文件,它会按原路返 回 。 ^_^
注意:运行vim的时候,必须在“tags”文件所在的目录下运行。否则,运行vim的时候还要用“:settags=”命令设定“tags”文件的路 径,这样vim才能找到“tags”文件。在完成编码时,可以手工删掉tags文件(帚把不到,灰尘不会自己跑掉^_^)。
5、cscope插件的使用
Cscope是一个类似 ctags的工具。 你可以把它想作是超过频的 ctags,因为它功能比ctags 强大很多。 在 Vim 里,通过 cscope 查询结果来跳转就象跳转到其他的标签完全一样;它被保存在标签栈里。这样你就可以象使用 ctags一样在函数等等之间便捷的跳转 。
在VIM中使用cscope非常简单,首先调用“cscope add”命令添加一个cscope数据库,然后就可以调用“cscope find”命令进行查找了。VIM支持8种cscope的查询功能,如下:例如,我们想在代码中查找调用work()函数的函数,我们可以输入:“:cs find c work”,回车后发现没有找到匹配的功能,可能并没有函数调用work()。我们再输入“:cs find s work”,查找这个符号出现的位置,vim列出了这个符号出现的所有位置。我们还可以进行字符串查找,它会双引号或单引号括起来的内容中查找。还可以输入一个正则表达式,这类似于egrep程序的功能。
在源代码目录下打开vim。要使用cscope查找就必须加载cscope.out文件.在vim命令行下执行:(按照上述方法配置好的vimrc中有这一步)
:cs add cscope.out
在vim命令行下执行:
:cs help
cscope commands:
add : Add a new database (Usage: add file|dir [pre-path] [flags])
find : Query for a pattern (Usage: find c|d|e|f|g|i|s|t name)
c: Find functions calling this function //查找调用本函数的函数
d: Find functions called by this function //查找本函数调用的函数
e: Find this egrep pattern //查找egrep模式,相当于egrep功能,但查找速度快多了
f: Find this file //查找并打开文件,类似vim的find功能
g: Find this definition //查找函数、宏、枚举等定义的位置,类似ctags的功能
i: Find files #including this file //查找包含本文件的文件
s: Find this C symbol //查找C语言符号,即查找函数名、宏、枚举值等出现的地方
t: Find assignments to //查找指定的字符串
help : Show this message (Usage: help)
kill : Kill a connection (Usage: kill #)
reset: Reinit all connections (Usage: reset)
show : Show connections (Usage: show)
例如:使用cscope查找do_fork函数的定义:
在vim命令行下执行: :cs f g do_fork