YCM的安裝和配置

• • Mac OS X 上面安裝
    • 首先安裝最新版本的MacVim
    • 然後使用Vundle安裝YouCompleteMe其實是用Vundle下載下傳YCM因為下載下傳下來還需要編譯
    • 安裝CMake 推薦使用Homebrew安裝 也可以使用獨立的CMake安裝包
    • 編譯YCM支援C語言族的補全
    • 編譯YCM 不帶C語言族補全
    • 以下是支援的其他語言
    • ycm檔案的例子
    • 我的vimrc

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 )[  ]
      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 )[  ]
        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=
set ts=
"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 = 

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