YCM的安装和配置

Mac OS X 上面安装

请依照下面的引导进行安装,这是在mac上安装的最佳方式,但也有可能不适合您的情况.

1 首先安装最新版本的MacVim.

如果你不需要使用mvim的图形界面, 推荐将MacVim.app包中的Vim进行软链接出来使用. 为了保证正常工作, 请先拷贝MacVim中的mvim脚本到你的本地目录(例如:/usr/local/bin/mvim), 然后用下述命令创建符号链接.

ln -s /usr/local/bin/mvim vim

2 然后使用Vundle安装YouCompleteMe(其实是用Vundle下载YCM,因为下载下来还需要编译)

记住: YCM是一个编译型插件. 如果你使用Vundle升级YCM, 而此时ycm_core这个库的API有改动(虽然很少发生), 则YCM会提示你重新编译它自身. 那么你就要回到这个安装教程中, 按引导重新编译.

注意: 如果需要C语言或类C语言的补全功能, 则必须安装有最新版本的Xcode, 并且安装了Xcode最新的命令行工具.(命令行工具当你第一次使用clang命令时会自动安装, 也可以使用xcode-select –install手动安装)

3 安装CMake, 推荐使用Homebrew安装, 也可以使用独立的CMake安装包.

如果安装过Homebrew Python 或 Homebrew MacVim, 请参加FAQ.

4 编译YCM支持C语言族的补全:

cd ~/.vim/bundle/YouCompleteMe
./install.py --clang-completer

5 编译YCM, 不带C语言族补全:

cd ~/.vim/bundle/YouCompleteMe
./install.py

6 以下是支持的其他语言:

• C# support: install Mono with Homebrew or by downloading the Mono Mac package and add –omnisharp-completerwhen calling ./install.py.
• Go support: install Go and add –gocode-completer when calling ./install.py.
• TypeScript support: install Node.js and npm then install the TypeScript SDK with npm install -g typescript.
• JavaScript support: install Node.js and npm and add –tern-completer when calling ./install.py.
• Rust support: install Rust and add –racer-completer when calling ./install.py.

为了简化编译过程, 可以使用–all 参数将所有支持打开. 需要保证xbuild,go, tsserver, node, npm, rustc, 以及cargo 工具都已经安装到用户目录. 然后就可以使用下列命令:

cd ~/.vim/bundle/YouCompleteMe
./install.py --all

这就是全部的安装过程, 为保证C族补全正常工作, 你需要提供一些额外的编译标记给YCM, 这些都在用户向导中.

另外可以设置一些自定义参数,详见用户向导.

7 .ycm文件的例子:

    # This file is NOT licensed under the GPLv3, which is the license for the rest
    # of YouCompleteMe.
    #
    # Here's the license text for this file:
    #
    # This is free and unencumbered software released into the public domain.
    #
    # Anyone is free to copy, modify, publish, use, compile, sell, or
    # distribute this software, either in source code form or as a compiled
    # binary, for any purpose, commercial or non-commercial, and by any
    # means.
    #
    # In jurisdictions that recognize copyright laws, the author or authors
    # of this software dedicate any and all copyright interest in the
    # software to the public domain. We make this dedication for the benefit
    # of the public at large and to the detriment of our heirs and
    # successors. We intend this dedication to be an overt act of
    # relinquishment in perpetuity of all present and future rights to this
    # software under copyright law.
    #
    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
    # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
    # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    # OTHER DEALINGS IN THE SOFTWARE.
    #
    # For more information, please refer to <http://unlicense.org/>

    import os
    import ycm_core

    # These are the compilation flags that will be used in case there's no
    # compilation database set (by default, one is not set).
    # CHANGE THIS LIST OF FLAGS. YES, THIS IS THE DROID YOU HAVE BEEN LOOKING FOR.
    flags = [
    '-Wall',
    '-Wextra',
    '-Werror',
    '-Wc++98-compat',
    '-Wno-long-long',
    '-Wno-variadic-macros',
    '-fexceptions',
    '-DNDEBUG',
    # You 100% do NOT need -DUSE_CLANG_COMPLETER in your flags; only the YCM
    # source code needs it.
    '-DUSE_CLANG_COMPLETER',
    # THIS IS IMPORTANT! Without a "-std=<something>" flag, clang won't know which
    # language to use when compiling headers. So it will guess. Badly. So C++
    # headers will be compiled as C headers. You don't want that so ALWAYS specify
    # a "-std=<something>".
    # For a C project, you would set this to something like 'c99' instead of
    # 'c++11'.
    '-std=c++11',
    # ...and the same thing goes for the magic -x option which specifies the
    # language that the files to be compiled are written in. This is mostly
    # relevant for c++ headers.
    # For a C project, you would set this to 'c' instead of 'c++'.
    '-x',
    'c++',
    '-isystem',
    '../BoostParts',
    '-isystem',
    # This path will only work on OS X, but extra paths that don't exist are not
    # harmful
    '/System/Library/Frameworks/Python.framework/Headers',
    '-isystem',
    '../llvm/include',
    '-isystem',
    '../llvm/tools/clang/include',
    '-I',
    '.',
    '-I',
    './ClangCompleter',
    '-isystem',
    './tests/gmock/gtest',
    '-isystem',
    './tests/gmock/gtest/include',
    '-isystem',
    './tests/gmock',
    '-isystem',
    './tests/gmock/include',
    ]


    # Set this to the absolute path to the folder (NOT the file!) containing the
    # compile_commands.json file to use that instead of 'flags'. See here for
    # more details: http://clang.llvm.org/docs/JSONCompilationDatabase.html
    #
    # You can get CMake to generate this file for you by adding:
    # set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
    # to your CMakeLists.txt file.
    #
    # Most projects will NOT need to set this to anything; you can just change the
    # 'flags' list of compilation flags. Notice that YCM itself uses that approach.
    compilation_database_folder = ''

    if os.path.exists( compilation_database_folder ):
      database = ycm_core.CompilationDatabase( compilation_database_folder )
    else:
      database = None

    SOURCE_EXTENSIONS = [ '.cpp', '.cxx', '.cc', '.c', '.m', '.mm' ]

    def DirectoryOfThisScript():
      return os.path.dirname( os.path.abspath( __file__ ) )


    def MakeRelativePathsInFlagsAbsolute( flags, working_directory ):
      if not working_directory:
        return list( flags )
      new_flags = []
      make_next_absolute = False
      path_flags = [ '-isystem', '-I', '-iquote', '--sysroot=' ]
      for flag in flags:
        new_flag = flag

        if make_next_absolute:
          make_next_absolute = False
          if not flag.startswith( '/' ):
            new_flag = os.path.join( working_directory, flag )

        for path_flag in path_flags:
          if flag == path_flag:
            make_next_absolute = True
            break

          if flag.startswith( path_flag ):
            path = flag[ len( path_flag ): ]
            new_flag = path_flag + os.path.join( working_directory, path )
            break

        if new_flag:
          new_flags.append( new_flag )
      return new_flags


    def IsHeaderFile( filename ):
      extension = os.path.splitext( filename )[ 1 ]
      return extension in [ '.h', '.hxx', '.hpp', '.hh' ]


    def GetCompilationInfoForFile( filename ):
      # The compilation_commands.json file generated by CMake does not have entries
      # for header files. So we do our best by asking the db for flags for a
      # corresponding source file, if any. If one exists, the flags for that file
      # should be good enough.
      if IsHeaderFile( filename ):
        basename = os.path.splitext( filename )[ 0 ]
        for extension in SOURCE_EXTENSIONS:
          replacement_file = basename + extension
          if os.path.exists( replacement_file ):
            compilation_info = database.GetCompilationInfoForFile(
              replacement_file )
            if compilation_info.compiler_flags_:
              return compilation_info
        return None
      return database.GetCompilationInfoForFile( filename )


    def FlagsForFile( filename, **kwargs ):
      if database:
        # Bear in mind that compilation_info.compiler_flags_ does NOT return a
        # python list, but a "list-like" StringVec object
        compilation_info = GetCompilationInfoForFile( filename )
        if not compilation_info:
          return None

        final_flags = MakeRelativePathsInFlagsAbsolute(
          compilation_info.compiler_flags_,
          compilation_info.compiler_working_dir_ )

        # NOTE: This is just for YouCompleteMe; it's highly likely that your project
        # does NOT need to remove the stdlib flag. DO NOT USE THIS IN YOUR
        # ycm_extra_conf IF YOU'RE NOT 100% SURE YOU NEED IT.
        try:
          final_flags.remove( '-stdlib=libc++' )
        except ValueError:
          pass
      else:
        relative_to = DirectoryOfThisScript()
        final_flags = MakeRelativePathsInFlagsAbsolute( flags, relative_to )

      return {
        'flags': final_flags,
        'do_cache': True
      }

8 我的.vimrc

set nocompatible              " be iMproved, required filetype off " required

" set the runtime path to include Vundle and initialize set rtp+=~/.vim/bundle/Vundle.vim call vundle#begin() " alternatively, pass a path where Vundle should install plugins
"call vundle#begin('~/some/path/here') " let Vundle manage Vundle, required
Plugin 'VundleVim/Vundle.vim'

" The following are examples of different formats supported. " Keep Plugin commands between vundle#begin/end.
" plugin on GitHub repo Plugin 'Valloric/YouCompleteMe' " git repos on your local machine (i.e. when working on your own plugin)
Plugin 'file:///home/gmarik/path/to/plugin'
" The sparkup vim script is in a subdirectory of this repo called vim. " Pass the path to set the runtimepath properly.
Plugin 'rstacruz/sparkup', {'rtp': 'vim/'}

" All of your Plugins must be added before the following line call vundle#end() " required
filetype plugin indent on    " required " To ignore plugin indent changes, instead use:
"filetype plugin on "
" Brief help " :PluginList       - lists configured plugins
" :PluginInstall - installs plugins; append `!` to update or just :PluginUpdate " :PluginSearch foo - searches for foo; append `!` to refresh local cache
" :PluginClean - confirms removal of unused plugins; append `!` to auto-approve removal "
" see :h vundle for more details or wiki for FAQ " Put your non-Plugin stuff after this line
set nu
set sw=4
set ts=4
"set showmatch set autoindent "set smartindent
"set expandtab set smarttab syntax enable set encoding=utf8 set nobackup set nowb set noswapfile set guifont=Menlo:h16 "leader映射为逗号
let mapleader = ","    
set completeopt-=preview 

"配置默认的ycm_extra_conf.py let g:ycm_global_ycm_extra_conf = '~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp/ycm/.ycm_extra_conf.py' "按,jd 会跳转到定义  
nnoremap <leader>jd :YcmCompleter GoToDefinitionElseDeclaration<CR>     

"打开vim时不再询问是否加载ycm_extra_conf.py配置 let g:ycm_confirm_extra_conf=0 "let g:ycm_autoclose_preview_window_after_completion = 1

let g:ycm_error_symbol = '!'
let g:ycm_warning_symbol = '?'
"autocmd InsertLeave * if pumvisible() == 0|pclose|endif