VIM自动补全插件 - YouCompleteMe--"大神级vim补全插件"

VIM自动补全插件 - YouCompleteMe

序言

vim 之所以被称为编辑器之神多半归功于其丰富的可DIY的灵活插件功能,( 例如vim下的这款神级般的代码补全插件YouCompleteMe), 使用VIM的用户也多半感觉 IDE开发工具不够轻便，且IDE往往只支持特定的几种语言或者特定系统平台，多数人用来用去，还是觉得VIM最顺手,用起来最舒心.

下面这个VIM的自动补全插件——YouCompleteMe，为我们弥补了vim不能自动补全的缺憾。YCM不仅仅对C族语言的支持非常好，而且它是一个很强大的VIM自动补全框架，可以和Eclim、Jedi配合，对Java、Python等语言提供非常好的支持。

---

 YouCompleteMe 完整的安装步骤如下：

1. 升级VIM到7.3.584+，并且支持python内嵌脚本。584是补丁的编号，一般我们装的VIM都是不带补丁的。可以选择打补丁，不过这样比较麻烦，我选择了直接安装VIM 7.4（下载当前的 vim-7.4a ）。

   $ ./configure --with-features=huge --enable-perlinterp --enable-pythoninterp --enable-rubyinterp --enable-cscope --enable-multibyte --disable-gui --prefix=/usr
   $ make VIMRUNTIMEDIR=/usr/share/vim/vim74a
   # make install

   ---

2. 通过 Vundle 安装YCM。官方比较推荐使用Vundle做插件管理，不过我之前一直未使用。

   首先安装Vundle：

   $ git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle
   

   配置 ~/.vimrc：

   set nocompatible               " be iMproved
   filetype off                   " required!
   
   set rtp+=~/.vim/bundle/vundle/
   call vundle#rc()
   
   " let Vundle manage Vundle
   " required!
   Bundle 'gmarik/vundle'  (本句后面不要添加注释,否则会报错哦~奇葩~)
   
   Bundle 'Valloric/YouCompleteMe'   (本句后面也不要添加任何注释,否则也会报错~)
   
   filetype plugin indent on     " required!
   "
   " Brief help
   " :BundleList          - list configured bundles
   " :BundleInstall(!)    - install(update) bundles
   " :BundleSearch(!) foo - search(or refresh cache first) for foo
   " :BundleClean(!)      - confirm(or auto-approve) removal of unused bundles
   "
   " see :h vundle for more details or wiki for FAQ
   " NOTE: comments after Bundle command are not allowed..
   

   安装YCM：

   $ vim +BundleInstall +qall

   ---

3. 升级libclang到3.2以上版本，可以通过Xcode来升级。

   对于Debian系统，可以添加LLVM源，从源里安装。

   # LLVM source
   deb http://llvm.org/apt/wheezy/ llvm-toolchain-wheezy main
   deb-src http://llvm.org/apt/wheezy/ llvm-toolchain-wheezy main

   ---

4. 编译ycm_core。先去安装一个 cmake 工具。

   编译：

   $ cd ~/.vim/bundle/YouCompleteMe
   $ ./install.sh --clang-completer --system-libclang (直接用也是可以的~)
   

   注意

   如果不使用 --system-libclang 参数，则ycm会自己下载Ubuntu x64的clang+llvm-3.3的二进制包，这在一些平台会有兼容问题。

   编译过程也可以不使用install.sh脚本。则使用如下命令：

   $ mkdir ycm_build
   $ cd ycm_build
   $ cmake -G "Unix Makefiles" -DEXTERNAL_LIBCLANG_PATH=/path/to/libclang.so . ~/.vim/bundle/YouCompleteMe/cpp
   $ make ycm_core
   $ make ycm_support_libs

   ---

5. 安装Eclim来处理java。下载 Eclim 2.2.6 ，安装Eclim 2.2.x要求Eclipse 4.2.x。在Mac下直接双击在图形界面安装即可。

   ---

6. 在.vimrc中增加一些配置。

   let g:ycm_global_ycm_extra_conf = '~/.vim/bundle/YouCompleteMe/cpp/ycm/.ycm_extra_conf.py'
   let g:EclimCompletionMethod = 'omnifunc'
   

   修改.ycm_extra_conf.py文件，注释掉下面代码，开启对C++标准库的支持。

   #try:
   #  final_flags.remove( '-stdlib=libc++' )
   #except ValueError:
   #  pass

   ---

使用YCM (针对java用户配置)

对于类C语言和Python，YCM可以直接使用，对于Java，需要先启动Eclim。

下面主要说说用Eclim+YCM开发Java工程的方式。

1. 首先启动Eclim服务，执行/Users/yeolar/.eclipse/org.eclipse.platform_4.2.0_119745494/eclimd 。

   为了方便，可以在~/.bash_profile中添加别名：

   alias eclimd='/Users/yeolar/.eclipse/org.eclipse.platform_4.2.0_119745494/eclimd 2>&1 1>/dev/null &'
   

2. 可以验证一下Eclim的安装：

   :PingEclim       " 服务是否正常
   :EclimValidate   " 验证vim配置有效
   

3. 创建Java工程：

   :ProjectCreate /path/to/project -n java
   

   创建工程会自动创建.classpath、.project文件和src目录。可以使用 :ProjectList 查看工程列表。

   添加工程的源代码路径可以在.classpath文件中使用 :NewSrcEntry path/to/new/src 完成。默认在工程创建时已经添加了src目录。

4. 编写代码。正常编写即可，因为已经在YCM中添加了Eclim的相关配置，所以自动完成功能已经和YCM的一致。更多用法可以参考 http://eclim.org/vim/java/index.html 。