1.写在前面
1. 如何使用vim. 本文不会从零开始教你如何使用vim, 如果你是第一次接触vim,
建议你先看看其他的vim入门的教程, 或者在shell下输入命令: vimtutor,
这是一个简单的入门教程.
2. 编程技巧.
3. vim脚本的编写.
我的工作环境是: Fedora Core 5
gvim是自己编译的7.0, 如果你还没有安装gvim, 请看我的这篇文章<在Redhat Linux 9中编译和配置gvim 7.0>
由于本人一直从事C语言工作, 所以下面这些例子都是在C语言程序中演示的, 其他语言的没有试过, 如果有朋友在别的语言下有问题, 可以跟我讨论一些, 我会尽量帮助你们的.
本文用的示范源码是vim7.1的源码, 可以在www.vim.org下载到源码包:vim-7.1.tar.bz2, 你也可以不用下载, 就用你自己程序的源码, 关系不大的. 我把源码解压在我的home目录下: ~/vim71
下面对文中的一些名字定义一下:
1. 文中用到的一些用<>括起来的符号比如<C-T>, <C-S-A>, 之类的, 你可以用下面的命令看看解释:
:help keycodes |
1 | 简洁明了的Buffer浏览和操作 |
2 | 文件浏览器 |
3 | tag浏览器 |
4 | 高亮的书签 |
5 | 更丰富的语法高亮 |
6 | 成员变量的下拉, 自动补全 |
2.中文帮助手册的安装
vim自带的帮助手册是英文的, 对平时编程的人来说没有多大阅读困难, 何况还有"星级译王"呢, 可偏偏有一帮人将其翻译成了中文, 可偏偏我又挡不住诱惑将它安装了, 唉.......又痛失一个学习英文的好机会, 下不为例.
大家看看我的中文帮助界面吧:
(--- 图2 ---)
安装方法:
在下面的网站下载中文帮助的文件包:
http://vimcdoc.sf.net (English)
http://vcd.gro.clinux.org (中文)
下载的文件包应该是类似这样的: vimcdoc-1.5.0.tar.gz
解压后其中有个doc文件夹, 将其中的内容全部复制到~/.vim/doc, 或者vim安装目录下的doc目录中, 此时vim中的help信息已经是中文的了.
注意:
a. 如果无法显示中文, 在~/.vimrc中增加下面这句试试:
set helplang=cn
b. 帮助文件的文本是utf-8编码的, 如果想用vim直接查看, 需要在~/.vimrc中设置:
set encoding=utf-8
3.vim编程常用命令
建议先看看帮助手册中的下面章节, 其中有关tags文件的部分你可以先跳过, 在后面的章节中会讲到, 到时候你在回来看看, 就觉得很简单了:
:help usr_29 :help usr_30 |
% | 跳转到配对的括号去 |
[[ | 跳转到代码块的开头去(但要求代码块中'{'必须单独占一行) |
gD | 跳转到局部变量的定义处 |
'' | 跳转到光标上次停靠的地方, 是两个', 而不是一个" |
mx | 设置书签,x只能是a-z的26个字母 |
`x | 跳转到书签处("`"是1左边的键) |
> | 增加缩进,"x>"表示增加以下x行的缩进 |
< | 减少缩进,"x<"表示减少以下x行的缩进 |
4.语法高亮
写程序没有语法高亮将是一件多么痛苦的事情啊, 幸亏vim的作者是个程序员(如果不是, 那可NB大了), 提供了语法高亮功能, 在上面的图片中大家也可以看到那些注释, 关键字, 字符串等, 都用不同颜色显示出来了, 要做到这样, 首先要在你的 ~/.vimrc 文件中增加下面几句话:
syntax enable syntax on |
colorscheme desert |
:help syntax.txt |
"======================================================== " Highlight All Function "======================================================== syn match cFunction "\<[a-zA-Z_][a-zA-Z_0-9]*\>[^()]*)("me=e-2 syn match cFunction "\<[a-zA-Z_][a-zA-Z_0-9]*\>\s*("me=e-1 hi cFunction gui=NONE guifg=#B5A1FF "======================================================== " Highlight All Math Operator "======================================================== " C math operators syn match cMathOperator display "[-+\*/%=]" " C pointer operators syn match cPointerOperator display "->\|\." " C logical operators - boolean results syn match cLogicalOperator display "[!<>]=\=" syn match cLogicalOperator display "==" " C bit operators syn match cBinaryOperator display "\(&\||\|\^\|<<\|>>\)=\=" syn match cBinaryOperator display "\~" syn match cBinaryOperatorError display "\~=" " More C logical operators - highlight in preference to binary syn match cLogicalOperator display "&&\|||" syn match cLogicalOperatorError display "\(&&\|||\)=" " Math Operator hi cMathOperator guifg=#3EFFE2 hi cPointerOperator guifg=#3EFFE2 hi cLogicalOperator guifg=#3EFFE2 hi cBinaryOperator guifg=#3EFFE2 hi cBinaryOperatorError guifg=#3EFFE2 hi cLogicalOperator guifg=#3EFFE2 hi cLogicalOperatorError guifg=#3EFFE2 |
"======================================================== " My Own DataType "======================================================== syn keyword cType My_Type_1 My_Type_2 My_Type_3 |
: lazy.fox.wu#gmail.com | |
Homepage | : http://blog.csdn.net/wooin |
5.在程序中跳来跳去: Ctags 的使用
哇, 这下可厉害了, Tag文件(标签文件)可是程序员的看家宝呀, 你可以不用它, 但你不能不知道它, 因为Linux内核源码都提供了"make tags"这个选项. 下面我们就来介绍Tag文件.
tags文件是由ctags程序产生的一个索引文件, ctags程序其是叫"Exuberant Ctags", 是Unix上面ctags程序的替代品, 并且比它功能强大, 是大多数Linux发行版上默认的ctags程序. 那么tags文件是做什么用的呢? 如果你在读程序时看了一个函数调用, 或者一个变量, 或者一个宏等等, 你想知道它们的定义在哪儿, 怎么办呢? 用grep? 那会搜出很多不相干的地方. 现在流行用是的<C-]>, 谁用谁知道呀, 当光标在某个函数或变量上时, 按下"Ctrl+]", 光标会自动跳转到其定义处, 够厉害吧, 你不用再羡慕Visual Studio的程序员了, 开始羡慕我吧~_~.
你现在先别急着去按<C-]>, 你按没用的, 要不要我干什么呀, 你现在要做的是查查你电脑里有没有ctags这个程序, 如果有, 是什么版本的, 如果是Ctags 5.5.4, 就象我一样, 你最好去装一个Ctags 5.6, 这个在后面的自动补全章节中会用到. 在这个网站: http://ctags.sourceforge.net, 下载一个类似 ctags-5.6.tar.gz 的文件下来(现在好像5.7版的也出来了, 不过我还没用过):
用下面的命令解压安装:
$ tar -xzvf ctags-5.6.tar.gz $ cd ctags-5.6 $ make # make install // 需要root权限 |
然后去你的源码目录, 如果你的源码是多层的目录, 就去最上层的目录, 在该目录下运行命令: ctags -R
我现在以 vim71 的源码目录做演示
$ cd /home/wooin/vim71 $ ctags -R |
此时在/home/wooin/vim71目录下会生成一个 tags 文件, 现在用vim打开 /home/wooin/vim71/src/main.c
$ vim /home/wooin/vim71/src/main.c |
再在vim中运行命令:
:set tags=/home/wooin/vim71/tags |
该命令将tags文件加入到vim中来, 你也可以将这句话放到~/.vimrc中去, 如果你经常在这个工程编程的话.
下面要开始真刀实枪的开干了, 如下图, 将光标放在setmouse()函数上
(--- 图3 ---)
此时按下<C-]>, 光标会自动跳到setmouse()函数的定义处, 见下图:
(--- 图4 ---)
如果此时你还想再跳回刚才的位置, 你还可以按<C-T>, 这样又跳回到setmouse()函数被调用的地方了, 变量, 结构, 宏, 等等, 都可以的, 赶快试试吧.....
此时在回头学习一下第3节中说的vim手册吧
:help usr_29 |
不过还有一个小瑕疵, 你修改程序后, 比如增加了函数定义, 删除了变量定义, tags文件不能自动rebuild, 你必须手动再运行一下命令:
$ ctags -R |
使tags文件更新一下, 不过让人感到欣慰的是vim不用重新启动, 正在编写的程序也不用退出, 马上就可以又正确使用<C-]>和<C-T>了. 如果有人知道更简单的方法请一定一定要告诉我, 用下面的地址:
: lazy.fox.wu#gmail.com | |
Homepage | : http://blog.csdn.net/wooin |
6.教你高效地浏览源码 -- 插件: TagList
下载地址 | http://www.vim.org/scripts/script.php?script_id=273 |
版本 | 4.4 |
安装 | 在 ~/.vim 目录下解压taglist_xx.zip |
手册 | :help taglist.txt |
:help taglist.txt |
let Tlist_Show_One_File=1 let Tlist_Exit_OnlyWindow=1 |
$ vim ~/vim/src/main.c |
:Tlist |
:help taglist.txt
7.文件浏览器和窗口管理器 -- 插件: WinManager
下载地址 | http://www.vim.org/scripts/script.php?script_id=95 |
版本 | 2.x |
安装 | 在 ~/.vim 目录下解压winmanager.zip |
手册 | :help winmanager |
:e ~/vim71 |
<F1> | 显示帮助 |
<cr> | 如果光标下是目录, 则进入该目录; 如果光标下文件, 则打开该文件 |
- | 返回上级目录 |
c | 切换vim 当前工作目录正在浏览的目录 |
d | 创建目录 |
D | 删除目录或文件 |
i | 切换显示方式 |
R | 文件或目录重命名 |
s | 选择排序方式 |
x | 定制浏览方式, 使用你指定的程序打开该文件 |
let g:winManagerWindowLayout='FileExplorer|TagList' nmap wm :WMToggle<cr> |
:help winmanager |
8.Cscope 的使用
这下更厉害了, 用Cscope自己的话说 - "你可以把它当做是超过频的ctags", 其功能和强大程度可见一斑吧, 关于它的介绍我就不详细说了, 如果你安装好了前文介绍的中文帮助手册, 用下面的命令看看介绍吧:
:help if_cscop.txt |
# ./configure # make # make install // 需要root权限 |
:set cscopequickfix=s-,c-,d-,i-,t-,e- |
$ cd /home/wooin/vim71/ $ cscope -Rbq # 此后会生成三个文件 $ ll cscope.* -rw-rw-r-- 1 wooin wooin 1.1M 2007-09-30 10:56 cscope.in.out -rw-rw-r-- 1 wooin wooin 6.7M 2007-09-30 10:56 cscope.out -rw-rw-r-- 1 wooin wooin 5.1M 2007-09-30 10:56 cscope.po.out # 打开文件, 开始Coding $ cd src $ vi main.c |
:cs add /home/wooin/vim71/cscope.out /home/wooin/vim71 |
:cs find g vim_strsave |
:cs find c vim_strsave |
:cw |
0 或 s | 查找本 C 符号(可以跳过注释) |
1 或 g | 查找本定义 |
2 或 d | 查找本函数调用的函数 |
3 或 c | 查找调用本函数的函数 |
4 或 t | 查找本字符串 |
6 或 e | 查找本 egrep 模式 |
7 或 f | 查找本文件 |
8 或 i | 查找包含本文件的文件 |
nmap <C-_>s :cs find s <C-R>=expand("<cword>")<CR><CR> nmap <C-_>g :cs find g <C-R>=expand("<cword>")<CR><CR> nmap <C-_>c :cs find c <C-R>=expand("<cword>")<CR><CR> nmap <C-_>t :cs find t <C-R>=expand("<cword>")<CR><CR> nmap <C-_>e :cs find e <C-R>=expand("<cword>")<CR><CR> nmap <C-_>f :cs find f <C-R>=expand("<cfile>")<CR><CR> nmap <C-_>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR> nmap <C-_>d :cs find d <C-R>=expand("<cword>")<CR><CR> |
9.QuickFix 窗口
在上一节的图10中大家可以看到在窗口下面有一个显示查询结果的窗口, 这个窗口中列出了查询命令的查询结果, 用户可以从这个窗口中选择每个结果进行查看, 这个窗口叫"QuickFix"窗口, 以前也是一个vim的插件来的, 只不过现在成了vim的标准插件, 不用你在去安装了, QuickFix窗口的主要作用就是上面看到的那个功能: 输出一些供选择的结果, 可以被很多命令调用, 更详细的介绍和使用方法请用下面的命令打开QuickFix的手册来学习吧:
:help quickfix |
:make |
:cw |
:cn // 切换到下一个结果 :cp // 切换到上一个结果 |
nmap <F6> :cn<cr> nmap <F7> :cp<cr> |
10.快速浏览和操作Buffer -- 插件: MiniBufExplorer
下载地址 | http://www.vim.org/scripts/script.php?script_id=159 |
版本 | 6.3.2 |
安装 | 将下载的 minibufexpl.vim文件丢到 ~/.vim/plugin 文件夹中即可 |
手册 | 在minibufexpl.vim 文件的头部 |
<Tab> | 向前循环切换到每个buffer名上 |
<S-Tab> | 向后循环切换到每个buffer名上 |
<Enter> | 在打开光标所在的buffer |
d | 删除光标所在的buffer |
let g:miniBufExplMapCTabSwitchBufs = 1 |
<C-Tab> | 向前循环切换到每个buffer上,并在但前窗口打开 |
<C-S-Tab> | 向后循环切换到每个buffer上,并在但前窗口打开 |
let g:miniBufExplMapWindowNavVim = 1 |
let g:miniBufExplMapWindowNavArrows = 1 |
11.c/h文件间相互切换 -- 插件: A
下载地址 | http://www.vim.org/scripts/script.php?script_id=31 |
版本 | |
安装 | 将a.vim 放到 ~/.vim/plugin 文件夹中 |
手册 | 无 |
下面介绍它的用法:
作为一个C程序员, 日常Coding时在源文件与头文件间进行切换是再平常不过的事了, 直接用vim打开其源/头文件其实也不是什么麻烦事, 但是只用一个按键就切换过来了, 这是多么贴心的功能啊....
安装好a.vim后有下面的几个命令可以用了:
:A | 在新Buffer中切换到c\h文件 |
:AS | 横向分割窗口并打开c\h文件 |
:AV | 纵向分割窗口并打开c\h文件 |
:AT | 新建一个标签页并打开c\h文件 |
其他还有一些命令, 你可以在它的网页上看看, 我都没用过, 其实也都是大同小异, 找到自己最顺手的就行了.
我在~/.vimrc中增加了一句:
nnoremap <silent> <F12> :A<CR> |
意思是按F12时在一个新的buffer中打开c\h文件, 这样在写程序的时候就可以不假思索地在c/h文件间进行切换, 减少了按键的次数, 思路也就更流畅了, 阿弥陀佛....
12.在工程中查找 -- 插件: Grep
下载地址 | http://www.vim.org/scripts/script.php?script_id=311 |
版本 | 1.8 |
安装 | 把grep.vim 文件丢到 ~/.vim/plugin 文件夹就好了 |
手册 | 在grep.vim 文件头部 |
下面介绍它的用法:
vim有自己的查找功能, 但是跟shell中的grep比起来还是有些差距的, 有时Coding正火急火燎的时候, 真想按下F3, 对光标所在的词来个全工程范围的grep, 不用敲那些繁琐的命令, 现在福音来了, 跟我同样懒的人不在少数, 在grep.vim脚本的前部可以找到一些说明文档:
:Grep | 按照指定的规则在指定的文件中查找 |
:Rgrep | 同上, 但是是递归的grep |
:GrepBuffer | 在所有打开的缓冲区中查找 |
:Bgrep | 同上 |
:GrepArgs | 在vim的argument filenames (:args)中查找 |
:Fgrep | 运行fgrep |
:Rfgrep | 运行递归的fgrep |
:Egrep | 运行egrep |
:Regrep | 运行递归的egrep |
:Agrep | 运行agrep |
:Ragrep | 运行递归的agrep |
上面的命令是类似这样调用的:
:Grep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Rgrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Fgrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Rfgrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Egrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Regrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Agrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:Ragrep [<grep_options>] [<search_pattern> [<file_name(s)>]] |
:GrepBuffer [<grep_options>] [<search_pattern>] |
:Bgrep [<grep_options>] [<search_pattern>] |
:GrepArgs [<grep_options>] [<search_pattern>] |
但是我从来都不用敲上面那些命令的^_^, 因为我在~/.vimrc中增加了下面这句:
nnoremap <silent> <F3> :Grep<CR> |
比如你想在/home/wooin/vim71/src/main.c中查找"FEAT_QUICKFIX", 则将光标移到"FEAT_QUICKFIX"上, 然后按下F3键, 如下图:
(--- 图14 ---)
在最下面的命令行会显示:
Search for pattern: FEAT_QUICKFIX |
此时你还可以编辑该行, grep支持正则表达式, 你想全词匹配的话可以改成:
Search for pattern: \<FEAT_QUICKFIX\> |
然后按下回车:
(--- 图15 ---)
在最下面的命令行会显示:
Search in files: * |
是问你搜索范围, 默认是该目录下的所有文件, 此时你还可以编辑该行, 比如你只想搜索源码文件:
Search in files: *.c *.h |
然后在按下回车, 会在弹出的QuickFix窗口中列出所有符合条件的搜索结果, 你可以在其中查找你想要的结果, 如下图:
(--- 图16 ---)
其实还有一些其他功能和设置, 但是我都没有用过, 这些功能再加上正则表达式, 已经够我用了, 其他的你可以在网页上看看它的文档, 如果有什么惊人发现记得跟我互通有无, 共同进步哦....
13.高亮的书签 -- 插件: VisualMark
下载地址 | http://www.vim.org/scripts/script.php?script_id=1026 |
版本 | |
安装 | 把visualmark.vim 文件丢到 ~/.vim/plugin 文件夹就好了 |
手册 | 无 |
下面介绍它的用法:
vim也和其他编辑器一样有"书签"概念, 在vim中叫"Mark", 可以用下面的命令查看相关说明:
:help Mark |
该"书签"有个很很大的缺点: 不可见.
我下面要介绍的Visual Mark插件跟vim中的"Mark"没有什么关系, 并不是使其可见, 而是自己本身就是"可见的书签", 接着往下看就明白了, 用作者的话说就是"类似UltraEdit中的书签".
另外, 网上也有使vim中的Mark可见的插件, 但是我试了一下, 好像没Visual Mark好用, 我就不介绍了.
按照上面的方法安装好Visual Mark后, 你什么也不用设置, 如果是gvim, 直接在代码上按下Ctrl+F2, 如果是vim, 用"mm", 怎么样, 发现光标所在的行变高亮了吧, 见下图:
(--- 图17 ---)
如果你设置了多个书签, 你可以用F2键正向在期间切换, 用Shift+F2反向在期间切换.
好了, 我Visual Mark介绍完了, 够简单吧^_^.
如果你嫌书签的颜色不好看, 你还可以自己定义, 不过是修改这个插件脚本的的源码, 在目录~/.vim/plugin/中找到并打开visualmark.vim, 找到下面这段代码:
if &bg == "dark" // 根据你的背景色风格来设置不同的书签颜色 highlight SignColor ctermfg=white ctermbg=blue guifg=wheat guibg=peru else // 主要就是修改guibg的值来设置书签的颜色 highlight SignColor ctermbg=white ctermfg=blue guibg=grey guifg=RoyalBlue3 endif |
我还有几个不满意的地方:
1 这个书签不能自动保存, 关闭vim就没了.
2 切换书签时不能在不同文件间切换, 只能在同一个文件中切换
如果哪位朋友能解决这两个问题, 请一定要告诉寡人啊....还是用下面的地址:
: lazy.fox.wu#gmail.com | |
Homepage | : http://blog.csdn.net/wooin |
14.自动补全
用过Microsoft Visual Studio的朋友一定知道代码补全功能, 输入一个对象名后再输入"."或者"->", 则其成员名都可以列出来, 使Coding流畅了许多, 实现很多懒人的梦想, 现在我要告诉你, 这不再是Microsoft Visual Studio的专利了, vim也可以做到! 下面由我来教你, 该功能要tags文件的支持, 并且是ctags 5.6版本, 可以看看前文介绍tags文件的章节.
我这里要介绍的功能叫"new-omni-completion(全能补全)", 你可以用下面的命令看看介绍:
:help new-omni-completion |
filetype plugin indent on |
set completeopt=longest,menu |
$ vi /home/wooin/vim71/src/main.c |
:set tags=/home/wooin/vim71/tags |
Ctrl+P | 向前切换成员 |
Ctrl+N | 向后切换成员 |
Ctrl+E | 表示退出下拉窗口, 并退回到原来录入的文字 |
Ctrl+Y | 表示退出下拉窗口, 并接受当前选项 |
Ctrl+X Ctrl+L | 整行补全 |
Ctrl+X Ctrl+N | 根据当前文件里关键字补全 |
Ctrl+X Ctrl+K | 根据字典补全 |
Ctrl+X Ctrl+T | 根据同义词字典补全 |
Ctrl+X Ctrl+I | 根据头文件内关键字补全 |
Ctrl+X Ctrl+] | 根据标签补全 |
Ctrl+X Ctrl+F | 补全文件名 |
Ctrl+X Ctrl+D | 补全宏定义 |
Ctrl+X Ctrl+V | 补全vim命令 |
Ctrl+X Ctrl+U | 用户自定义补全方式 |
Ctrl+X Ctrl+S | 拼写建议 |
15.加速你的补全 -- 插件: SuperTab
下载地址 | http://www.vim.org/scripts/script.php?script_id=1643 |
版本 | 0.43 |
安装 | 把supertab.vim 文件丢到 ~/.vim/plugin 文件夹就好了 |
手册 | supertab.vim 文件头部, 和命令 ":SuperTabHelp" |
let g:SuperTabRetainCompletionType=2 let g:SuperTabDefaultCompletionType="<C-X><C-O>" |
let g:SuperTabDefaultCompletionType="<C-X><C-O>" " 设置按下<Tab>后默认的补全方式, 默认是<C-P>, " 现在改为<C-X><C-O>. 关于<C-P>的补全方式, " 还有其他的补全方式, 你可以看看下面的一些帮助: " :help ins-completion " :help compl-omni |
let g:SuperTabRetainCompletionType=2 " 0 - 不记录上次的补全方式 " 1 - 记住上次的补全方式,直到用其他的补全命令改变它 " 2 - 记住上次的补全方式,直到按ESC退出插入模式为止 |
: lazy.fox.wu#gmail.com | |
Homepage | : http://blog.csdn.net/wooin |