vi/vim使用进阶: 智能补全

<< 返回vim使用进阶: 目录

本节所用命令的帮助入口:

:help ins-completion
:help compl-omni
:help 'omnifunc'
:help i_CTRL-X_CTRL-O
:help ins-completion-menu
:help popupmenu-keys
:help 'completeopt'
:help compl-omni-filetypes
:help omnicppcomplete.txt 

使用过Source Insight的人一定对它的自动补全功能印象深刻,在很多的集成开发环境中,也都支持自动补全。vim做为一个出色的编辑器,这样的功能当然少不了。而且,作为一个通用的编辑器,vim实现的补全功能并不仅仅限于对程序的补全,它可以对文件名补全、根据字典进行补全、根据本缓冲区或其它缓冲区类似的内容进行补全、根据文件语法补全等等,它甚至允许用户自己编写函数来实现定制的补全。

作为vim进阶系列文章中的一篇,本文以介绍vim对程序的补全为主,也顺带介绍一下其它的补全方式。本文将分为两篇,第一篇主要介绍vim的OMNI补全,下一篇简要介绍其它的补全方式,以及SuperTab插件。

vim的OMNI补全(以下称”全能补全”)可以支持多种程序语言,包括C,C++, XML/HTML,CSS,JAVASCRIPT,PHP,RUBY等,详细列表请参阅”:help compl-omni-filetypes“。在本文中,主要介绍C及C++的全能补全。

vim在对不同类型的文件进行补全时,会根据文件类型,为其设置不同的补全函数。也就是说,要实现全能补全功能,需要打开文件类型检测。把下面的命令加到你的vimrc中:

filetype plugin indent on 

你可以查看’omnifunc‘选项,来知道当前的补全函数是什么。

对C及C++代码的全能补全需要使用Exuberant ctags生成的标签文件,我们在前面的文章中介绍过如何使用Exuberant ctags程序来生成标签文件。不过,如果你的Exuberant ctags版本为5.5.4,那么需要为其打上增加”typename:“字段补丁,才能支持C的全能补全。补丁在这里下载:

ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch

可以在这里找到MS-Windows上已经编译好的可执行版本:

http://georgevreilly.com/vim/ctags.html 

不过我建议使用最新5.6版本Exuberant Ctags。在下面的网站可以下载:

http://ctags.sourceforge.net/

你可以直接下载已经编译好的rpm版本,或者下载源代码。如果是后者,使用以下命令对源代码进行编译:

tar zvxf ctags-5.6.tar.gz
cd ctags-5.6
./configure
make
make install 

如果你没有系统目录的写权限,你可能要把Exuberant Ctags安装到自己的主目录,只需要把上面的”./configure“命令改为”./configure –prefix=/home/xxx“就可以了。

Ctags升级后,使用”ctags –R“更新一下标签文件,现在再进入vim就可以在C程序中全能补全了。我们依旧以vim 7.0的源代码为例。

例如,我们在VimMain()函数中,输入”gui“三个字符,然后按下”CTRL-X CTRL-O“,在vim的状态行会显示”Omni Completeion“,表明现在进行的是全能补全,同时会弹出一个下拉菜单,显示所有匹配的标签。你可以使用来”CTRL-P“和”CTRL-N“上下选择,在选择的同时,所选中的项就被放在光标位置,不需要再按回车来把它放在光标位置(像Source Insight那样)。

如果更习惯于使用Source Insight这种方式,你可以使用上、下光标键来选择项目,然后按回车把选中的项目放到光标位置。不过这样一来,你的手指就会离开主编辑区,并且需要多输入一个回车键。

本文结尾处提供了一个键绑定,允许在使”CTRL-P“和”CTRL-N“时,输入回车表示补全结束,而不是插入回车。

如果补全处于激活状态,可以用”CTRL-E“停止补全并回到原来录入的文字。用”CTRL-Y“可以停止补全,并接受当前所选的项目。

下图是使用”CTRL-N”选择的抓图。该图中,我选择了”gui_exit(“函数,接下来可以直接输入这个函数的参数,这会结束当前补全,并插入我所输入的参数。

下图是对结构的成员进行补全的抓图:

缺省的,vim会使用下拉菜单和一个preview窗口(预览窗口)来显示匹配项目,下拉菜单列出所有匹配的项目,预览窗口则显示选中项目的详细信息。打开预览窗口会导致下拉菜单抖动,因此我一般都去掉预览窗口的显示,这需要改变’completeopt‘的值,我的设置如下:

set completeopt=longest,menu 

上面的设置表明,只在下拉菜单中显示匹配项目,并且会自动插入所有匹配项目的相同文本。

如果要支持C++的全能补全,需要到vim主页下载OmniCppComplete插件,链接如下:

    http://www.vim.org/scripts/script.php?script_id=1520

下载后,把它解压到你的.vim目录(在windows下是vimfiles目录),它会安装以下文件:

after\ftplugin\cpp.vim
autoload\omni\common\debug.vim
\utils.vim
autoload\omni\cpp\complete.vim
\includes.vim
\items.vim
\maycomplete.vim
\namespaces.vim
\settings.vim
\tokenizer.vim
\utils.vim
doc\omnicppcomplete.txt 

确保你已关闭了vi兼容模式,并允许进行文件类型检测:

set nocp
filetype plugin on 

接下来,使用下面的命令,为C++文件生成标签文件,假定你的文件在src目录树下:

ctags -R --c++-kinds=+p --fields=+iaS --extra=+q src 

在对C++文件进行补全时,OmniCppComplete插件需要tag文件中包含C++的额外信息,因此上面的ctags命令不同于以前我们所使用的,它专门为C++语言生成一些额外的信息,上述选项的含义如下:

--c++-kinds=+p  : 为C++文件增加函数原型的标签
--fields=+iaS   : 在标签文件中加入继承信息(i)、类成员的访问控制信息(a)、以及函数的指纹(S)
--extra=+q      : 为标签增加类修饰符。注意,如果没有此选项,将不能对类成员补全 

现在,进入vim,设置好tag选项(我在前面的文章中介绍过)。好极了,vim能够对C++自动补全了!

我写了一个简单的例子,来演示C++的自动补全功能,如下图所示,在输入”t.“后,OmniCppComplete插件会自动弹出struct test1的成员供选择,而在输入”b->“后,又会自动弹出class base的成员供选择,非常方便,连”CTRL-X CTRL-O“都不必输入。OmniCppComplete插件的缺省设置比较符合我的习惯,因此不须对其设置进行调整,如果你需要调整,参阅OmniCppComplete的帮助页。

下表是我的vimrc中设置的键绑定,使用pumvisible()来判断下拉菜单是否显示,如果下拉菜单显示了,键映射为了一个值,如果未显示,又会映射为另一个值。

" mapping
inoremap <expr> <CR>       pumvisible()?"\<C-Y>":"\<CR>"
inoremap <expr> <C-J>      pumvisible()?"\<PageDown>\<C-N>\<C-P>":"\<C-X><C-O>"
inoremap <expr> <C-K>      pumvisible()?"\<PageUp>\<C-P>\<C-N>":"\<C-K>"
inoremap <expr> <C-U>      pumvisible()?"\<C-E>":"\<C-U>" 

上面的映射都是在插入模式下的映射,解释如下:

  • 如果下拉菜单弹出,回车映射为接受当前所选项目,否则,仍映射为回车;
  • 如果下拉菜单弹出,CTRL-J映射为在下拉菜单中向下翻页。否则映射为CTRL-X CTRL-O
  • 如果下拉菜单弹出,CTRL-K映射为在下拉菜单中向上翻页,否则仍映射为CTRL-K
  • 如果下拉菜单弹出,CTRL-U映射为CTRL-E,即停止补全,否则,仍映射为CTRL-U

在下一篇文章中,将继续介绍vim提供的其它补全方式

[参考文档]

<< 返回vim使用进阶: 目录

原创文章,请阅读页脚的许可方式,转载请注明:转载自易水博客 [ http://easwy.com/blog/ ]

本文链接地址: http://easwy.com/blog/archives/advanced-vim-skills-omin-complete/

文章的脚注信息由WordPress的wp-posturl插件自动生成

《vi/vim使用进阶: 智能补全》有66个想法

  1. 请教下,我使用全能补全PHP函数的时候, 如果关闭预览窗口,也就是设置为
    set completeopt=longest,menu
    那么,我就不能看见函数的参数了.
    弹出的菜单只显示了函数名, 和返回值.
    是不是弹出菜单宽度的原因?
    看了下帮助文档,好像只能调整弹出菜单的高度啊.
    求解~~
    对了,全能补全调用的是phpcomplete.vim

  2. 你好,我现在有个问题请教下,我使用vim编辑好html后,想按一个快捷键立即启动浏览器查看当前html的效果,不知道这个功能vim能不能实现?

    1. @半支烟, 直接映射快捷键即可,例如,在windows下,可以这样:

      :map ,aa :!start “c:\Program Files\Mozilla Firefox\firefox.exe” %<cr>

      按”,aa”即可在浏览器中打开当前文件。

      1. @Easwy,
        我在配置文件中添加了如下语句
        :map :!start “C:\Users\Administrator\AppData\Roaming\360se\bin\360se.exe” %
        但是运行不起来,当我按键的时候 提示:E371:Command not found

        1. @半支烟, 这个错误应该是找不到360se.exe文件,把”\”全部替换成”/”试一下,或者替换成”\\”。
          另外,用:map命令查看一下你所映射的键,看是不是你想要的结果。

          1. @Easwy,
            THX,易水。把”\”全部替换成”/”后连接360的浏览器还是不行,不过现在我连接的是火狐,一切正常,THX这两天你的帮助。
            我的映射::map :!start “D:/Program Files (x86)/Mozilla Firefox/firefox.exe” %
            遗憾的是,我映射谷歌浏览器时候,启动了浏览器,却不能打开当前文件。浏览器地址里面的路径貌似不对。THX

  3. hi Easwy ,
    在windows里面使用gvim,全屏的时候会发现底部和右边有白边,调整字体的大小白边的大小也会调整,你碰到过类似的情况么?你是怎么处理的?

    1. @stam, 我仔细观察了一下,我的windows gvim也有白边,不过白边很窄,不影响使用,所以我一直没注意到,不知道是不是你所说的情况。

  4. 恩 应该是的,如果主题换成黑色系的话那个白边比较刺眼,网上也看到有这方面的问题,但是没有比较好的解决办法

  5. 您好,因为课业原因,需要在Linux下面编程。正愁Linux下面无法使用像VC6.0一样的C语言编程工具,就幸运的看到了您的这篇文章。
    我用的是Ubuntu desktop 系统。VIM也是新版的7.4。按照这篇文章讲的,打开了文件检测。下载并make install了Exuberant ctags。接下来就不知道怎么办了,转区您的另一篇tags文章去看,也是一头雾水……自己尝试了去设置最后还是不行。
    可以请您告诉我接下来怎么做么?
    非常感谢!

    1. 1. 用下面的命令先生成一个tag文件:

      cd your-source-code-directory
      ctags -R

      2. 让vim使用这个tag文件,如果你是在 your-source-code-directory 下输入 vim 命令的话,那么 vim 缺省就能找到tag文件了。

      3. 接着你就可以用CTRL-]、CTRL-P来在tag间跳转了。这是vim的基本应用,网上可以找到很多类似的教程。

发表评论

电子邮件地址不会被公开。 必填项已用*标注