Vim自动补全神器:YouCompleteMe

第一次听说这个插件还是在偶然的情况下看到别人的博客,听说了这个插件的大名。本来打算在实训期间来完成安装的,无奈网实在不给力,也就拖到了回家的时候。在开始准备工作的时候就了解到这个插件不是很容易安装,安装的时候果然名不虚传。(关于这方面的内容,请查看另一篇文章)不过,有付出总有回报,安装之后用上这个插件,真心为这个插件的强大所折服。

那这个插件有何不同?

YouCompleteMe的特别之处

基于语义补全

总所周知,Vim是一款文本编辑器。也就是说,其最基础的工作就是编辑文本,不管该文本的内容是什么。在Vim被程序员所使用后,其慢慢的被肩负了与IDE一样的工作,文本自动补全(ie.acp,omnicppcompleter),代码检查(Syntastic)等等工作。

针对文本自动补全这个功能来说,主要有两种实现方式。

  • 基于文本

我们常用的omnicppcompleter,acp,vim自带的c-x, c-n的实现方式就是基于文本。更通俗的说法,其实就是一个字:

其通过文本进行一些正则表达式的匹配,再根据生成的tags(利用ctags生成)来实现自动补全的效果。

  • 基于语义

顾名思义,其是通过分析源文件,经过语法分析以后进行补全。由于对源文件进行分析,基于语义的补全可以做到很精确。但是这显然是vim所不可能支持的。而且经过这么多年发展,由于语法分析有很高的难度,也一直没有合适的工具出现。直到,由apple支持的clang/llvm横空出世。YouCompleteMe也正是在clang/llvm的基础上进行构建的。

整合实现了多种插件

  • clang_complete
  • AutoComplPop
  • Supertab
  • neocomplcache
  • Syntastic(类似功能,仅仅针对c/c++/obj-c代码)

支持语言

  • c
  • c++
  • obj-c
  • c#
  • python

对于其他的语言,会调用vim设置的omnifunc来匹配,因此同样支持php,ruby等语言。

已知的有 * javascript —-tern_for_vim * ruby/java —-eclim

使用效果图

ycmsdfsdgeerg

使用感受

  • 和IDE一样,自动补全,
  • 根据include的文件进行补全
  • 不用再蹩脚的生成tags
  • 补全非常精准,而且速度很快,不会有延迟(以前在大项目上,acp用起来实在是很卡)
  • 支持类似tags的跳转,跳到定义处以及使用处
  • 出错提示很智能,并且用起来真的是如丝般柔滑,不用输入:w进行强制检测

安装

说完了那么多好处,就要说到安装了。不同于以往其他vim插件,YCM是一款编译型的插件。在下载完后,需要手动编译后才能使用。对应其他的插件来说,仅仅就是把.vim的文件丢到相应文件夹下就可以。而这也加大了使用YCM的难度。

安装准备

  • 最新版的Vim(7.3.584+),编译时添加+python标志(已经安装的可以通过vim --version查看)
  • cmake(mac可以通过homebrew安装,brew install cmake,ubuntu可以通过sudo apt-get install cmake)
  • 安装vundle插件,用于安装管理vim的插件

mac下快速安装

.vimrc中添加下列代码

保存退出后打开vim,在正常模式下输入

等待vundle将YouCompleteMe安装完成

而后进行编译安装:

如果不需要c-family的补全,可以去掉--clang-completer。如果需要c#的补全,请加上--omnisharp-completer。

正常来说,YCM会去下载clang的包,如果已经有,也可以用系统--system-libclang。

就这样,安装结束。打开vim,如果没有提示YCM未编译,则说明安装已经成功了。

手动编译安装

安装的脚本并不是什么时候都好用,至少对我来说是这样的。安装完之后出现了问题,参考issue#809

在用:BundleInstall安装完成或者使用

获取最新的仓库,而后使用git submodule update --init --recursive确认仓库的完整性后,开始安装流程。

  1. 下载最新的clang二进制文件 YCM要求clang版本 > 3.2,一般来说都是下载最新的
  2. 安装python-dev.(ubuntu下使用sudo apt-get install python-dev,mac下默认提供,否则请安装command line tools)
  3. 编译

    这里需要注意的是,~/ycm_temp/llvm_root_dir中包含的是根据第一步下载的压缩包解压出来的内容(包括includebin等等文件)。

这样就完成了,开始感受YCM提供的完全不逊色于大型IDE所提供的自动补全功能吧。

配置

不同于很多vim插件,YCM首先需要编译,另外还需要有配置。在vim启动后,YCM会找寻当前路径以及上层路径的.ycm_extra_conf.py.在~/.vim/bundle/YouCompleteMe/cpp/ycm/.ycm_extra_conf.py中提供了默认的模板。也可以参考我的(就在模板上改改而已)。不过这个解决了标准库提示找不到的问题。

一般来说,我会在~目录下放一个默认的模板,而后再根据不同的项目在当前目录下再拷贝个.ycm_extra_conf.py。

 

YouCompleteMe提供的其他功能

YCM除了提供了基本的补全功能,自动提示错误的功能外,还提供了类似tags的功能:

  • 跳转到定义GoToDefinition
  • 跳转到声明GoToDeclaration
  • 以及两者的合体GoToDefinitionElseDeclaration

可以在.vimrc中配置相应的快捷键。

另外,YCM也提供了丰富的配置选项,同样在.vimrc中配置。具体请参考

同时,YCM可以打开location-list来显示警告和错误的信息:YcmDiags。个人关于ycm的配置如下:

YCM提供的跳跃功能采用了vim的jumplist,往前跳和往后跳的快捷键为Ctrl+O以及Ctrl+I。

总结

YouCompleteMe是我用过的最爽的一个自动补全的插件了。之前使用acp时,遇到大文件基本上就卡死了,以至于都不怎么敢使用。由于YCM使用的时C/S结构,部分使用vim脚本编写,部分认为原生代码,使得跑起来速度飞快。

抛弃Vim自带的坑爹的补全吧,抛弃ctags吧,抛弃cscope吧,YCM才是终极补全神器。

在安装过程中,我也遇到了不少的坑。一会会发一篇解决这些坑的文章。

最后祝大家码年顺利,一码平川,码到功成。

2 14 收藏 13 评论

相关文章

可能感兴趣的话题



直接登录
最新评论
  • 不支持我大Java!!!!

  • 影行   2014/02/12

    用了下,跳转时总提示Runtime Error:Can't jump to declaration.

    #include 时也会提示error| 'string' file not found?

  •   2014/02/25

    请教windows下,mingw64编译,标准库提示找不到怎么解决?

  • 这个插件有没有编辑好的用在windows 的gvim下 并支持php javascript

  • fd5788   2014/07/31

    就是太占内存了,导致开了之后系统有点卡

  • santisy   2015/05/11

    请问一下,貌似这个好像不能支持自动补全成员函数?我安装成功之后貌似不可以啊,命名空间里面的也不能自动补全是吗?
    ********************************
    另外我提醒一下大家一些东西,按照Vundle官方里面的给的instruction,应该是直接把里面要求你写在.vimrc里面的东西复制到最前面。另外似乎按照标准的Vundle 使用方法,应该是在.vimrc里面的对应位置添加 Plugin '/path/to/yourPlugin' (前面这个地址如这里应该用'Valloric/YouCompleteMe'替换)保存后,退出来,再开一个vim之后命令行执行:PluginInstall
    详情请看 http://stackoverflow.com/questions/27750874/installing-vundle-for-vim
    另外需要提醒大家的是,如果你由于网络等原因导致你的插件安装不完整(这个可以由你在编译时出现问题暴露出来,往往是缺少文件)需要你删掉在.vimrc Plugin 'XXX' 然后再在新开的.vimrc里面用PluginClean 清除掉残损的插件,不然你反复安装的话,Vundle不会主动覆盖的
    最后在编译的时候记得取得根权限

  • santisy   2015/05/11

    还有就是我其实不太理解.ycm_extra_conf.py的用法。可能我的无法自动补全成员函数或者无法补全库函数的原因是因为Flags的配置不正确吗?另外YouCompleteMe的使用需要Clang编译器吗?另外.ycm_extra_conf.py是在 /third_party/ycmd/cpp/ycm/下面这个是吗?

  • cd ~/.vim/bundle/YouCompleteMe
    ./install.sh --clang-completer

    编译的命令应该是这个

  • 斯旺达克 C/C++爱好者 01/30

    能否写一个教程介绍一下如何配置conf,尤其是后面使用database是具体什么方法,好像喝LLVM还有关系。

跳到底部
返回顶部