Vim 自动补全神器:YouCompleteMe

  1. 云栖社区>
  2. 博客>
  3. 正文

Vim 自动补全神器:YouCompleteMe

寒凝雪 2017-05-02 14:58:00 浏览1354
展开阅读全文

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

那这个插件有何不同? 

YouCompleteMe的特别之处

基于语义补全

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

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

基于文本

我们常用的omnicppcompleteracp,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来匹配,因此同样支持phpruby等语言。

已知的有

使用效果图

使用感受

  • 和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中添加下列代码


  1. Bundle 'Valloric/YouCompleteMe'

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


  1. :BundleInstall

等待vundle将YouCompleteMe安装完成

而后进行编译安装:


  1. cd ~/.vim/bundle/YouCompleteMe
  2. ./install --clang-completer

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

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

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

手动编译安装

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

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


  1. git clone --recursive https://github.com/Valloric/YouCompleteMe.git

获取最新的仓库,而后使用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. 编译

    
    
    1. cd ~
    2. mkdir ycm_build
    3. cd ycm_build
    4. cmake -G "Unix Makefiles"-DPATH_TO_LLVM_ROOT=~/ycm_temp/llvm_root_dir .~/.vim/bundle/YouCompleteMe/cpp
    5. make ycm_support_libs

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

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

配置

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

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


  1. # This file is NOT licensed under the GPLv3, which is the license for the rest
  2. # of YouCompleteMe.
  3. #
  4. # Here's the license text for this file:
  5. #
  6. # This is free and unencumbered software released into the public domain.
  7. #
  8. # Anyone is free to copy, modify, publish, use, compile, sell, or
  9. # distribute this software, either in source code form or as a compiled
  10. # binary, for any purpose, commercial or non-commercial, and by any
  11. # means.
  12. #
  13. # In jurisdictions that recognize copyright laws, the author or authors
  14. # of this software dedicate any and all copyright interest in the
  15. # software to the public domain. We make this dedication for the benefit
  16. # of the public at large and to the detriment of our heirs and
  17. # successors. We intend this dedication to be an overt act of
  18. # relinquishment in perpetuity of all present and future rights to this
  19. # software under copyright law.
  20. #
  21. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22. # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23. # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  24. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  25. # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  26. # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  27. # OTHER DEALINGS IN THE SOFTWARE.
  28. #
  29. # For more information, please refer to <http://unlicense.org/>
  30. import os
  31. import ycm_core
  32. # These are the compilation flags that will be used in case there's no
  33. # compilation database set (by default, one is not set).
  34. # CHANGE THIS LIST OF FLAGS. YES, THIS IS THE DROID YOU HAVE BEEN LOOKING FOR.
  35. flags = [
  36. '-Wall',
  37. '-Wextra',
  38. #'-Werror',
  39. #'-Wc++98-compat',
  40. '-Wno-long-long',
  41. '-Wno-variadic-macros',
  42. '-fexceptions',
  43. '-stdlib=libc++',
  44. # THIS IS IMPORTANT! Without a "-std=<something>" flag, clang won't know which
  45. # language to use when compiling headers. So it will guess. Badly. So C++
  46. # headers will be compiled as C headers. You don't want that so ALWAYS specify
  47. # a "-std=<something>".
  48. # For a C project, you would set this to something like 'c99' instead of
  49. # 'c++11'.
  50. '-std=c++11',
  51. # ...and the same thing goes for the magic -x option which specifies the
  52. # language that the files to be compiled are written in. This is mostly
  53. # relevant for c++ headers.
  54. # For a C project, you would set this to 'c' instead of 'c++'.
  55. '-x',
  56. 'c++',
  57. '-I',
  58. '.',
  59. '-isystem',
  60. '/usr/include',
  61. '-isystem',
  62. '/usr/local/include',
  63. '-isystem',
  64. '/Library/Developer/CommandLineTools/usr/include',
  65. '-isystem',
  66. '/Library/Developer/CommandLineTools/usr/bin/../lib/c++/v1',
  67. ]
  68. # Set this to the absolute path to the folder (NOT the file!) containing the
  69. # compile_commands.json file to use that instead of 'flags'. See here for
  70. # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html
  71. #
  72. # Most projects will NOT need to set this to anything; you can just change the
  73. # 'flags' list of compilation flags. Notice that YCM itself uses that approach.
  74. compilation_database_folder = ''
  75. if os.path.exists( compilation_database_folder ):
  76. database = ycm_core.CompilationDatabase( compilation_database_folder )
  77. else:
  78. database = None
  79. SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]
  80. def DirectoryOfThisScript():
  81. return os.path.dirname( os.path.abspath( __file__ ) )
  82. def MakeRelativePathsInFlagsAbsolute( flags, working_directory ):
  83. if not working_directory:
  84. return list( flags )
  85. new_flags = []
  86. make_next_absolute = False
  87. path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ]
  88. for flag in flags:
  89. new_flag = flag
  90. if make_next_absolute:
  91. make_next_absolute = False
  92. if not flag.startswith( '/' ):
  93. new_flag = os.path.join( working_directory, flag )
  94. for path_flag in path_flags:
  95. if flag == path_flag:
  96. make_next_absolute = True
  97. break
  98. if flag.startswith( path_flag ):
  99. path = flag[ len( path_flag ): ]
  100. new_flag = path_flag + os.path.join( working_directory, path )
  101. break
  102. if new_flag:
  103. new_flags.append( new_flag )
  104. return new_flags
  105. def IsHeaderFile( filename ):
  106. extension = os.path.splitext( filename )[ 1 ]
  107. return extension in [ '.h', '.hxx', '.hpp', '.hh' ]
  108. def GetCompilationInfoForFile( filename ):
  109. # The compilation_commands.json file generated by CMake does not have entries
  110. # for header files. So we do our best by asking the db for flags for a
  111. # corresponding source file, if any. If one exists, the flags for that file
  112. # should be good enough.
  113. if IsHeaderFile( filename ):
  114. basename = os.path.splitext( filename )[ 0 ]
  115. for extension in SOURCE_EXTENSIONS:
  116. replacement_file = basename + extension
  117. if os.path.exists( replacement_file ):
  118. compilation_info = database.GetCompilationInfoForFile(
  119. replacement_file )
  120. if compilation_info.compiler_flags_:
  121. return compilation_info
  122. return None
  123. return database.GetCompilationInfoForFile( filename )
  124. def FlagsForFile( filename, **kwargs ):
  125. if database:
  126. # Bear in mind that compilation_info.compiler_flags_ does NOT return a
  127. # python list, but a "list-like" StringVec object
  128. compilation_info = GetCompilationInfoForFile( filename )
  129. if not compilation_info:
  130. return None
  131. final_flags = MakeRelativePathsInFlagsAbsolute(
  132. compilation_info.compiler_flags_,
  133. compilation_info.compiler_working_dir_ )
  134. # NOTE: This is just for YouCompleteMe; it's highly likely that your project
  135. # does NOT need to remove the stdlib flag. DO NOT USE THIS IN YOUR
  136. # ycm_extra_conf IF YOU'RE NOT 100% SURE YOU NEED IT.
  137. #try:
  138. # final_flags.remove( '-stdlib=libc++' )
  139. #except ValueError:
  140. # pass
  141. else:
  142. relative_to = DirectoryOfThisScript()
  143. final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )
  144. return {
  145. 'flags': final_flags,
  146. 'do_cache': True
  147. }

YouCompleteMe提供的其他功能

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

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

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


  1. nnoremap <leader>gl :YcmCompleterGoToDeclaration<CR>
  2. nnoremap <leader>gf :YcmCompleterGoToDefinition<CR>
  3. nnoremap <leader>gg :YcmCompleterGoToDefinitionElseDeclaration<CR>

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


  1. let g:ycm_error_symbol ='>>'let g:ycm_warning_symbol ='>*'

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


  1. " for ycm
  2. let g:ycm_error_symbol = '>>'
  3. let g:ycm_warning_symbol = '>*'
  4. nnoremap <leader>gl :YcmCompleter GoToDeclaration<CR>
  5. nnoremap <leader>gf :YcmCompleter GoToDefinition<CR>
  6. nnoremap <leader>gg :YcmCompleter GoToDefinitionElseDeclaration<CR>
  7. nmap <F4> :YcmDiags<CR>

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

总结

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

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

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

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

本文来自云栖社区合作伙伴“Linux中国”,原文发布日期:2015-09-29   

网友评论

登录后评论
0/500
评论
寒凝雪
+ 关注