[关闭]
@Dubyoo 2014-06-17T14:02:12.000000Z 字数 10611 阅读 9057

vim 配置 YouCompleteMe

Linux

一、前期准备

作为一个c++程序员，要想尽可能地发挥YCM的功能，推荐安装以下软件：

  1. sudo apt-get install vim
  1. sudo apt-get install git
  1. sudo apt-get install cmake
  1. sudo apt-get install pylint python-dev

二、Vundle的安装：

Vundle是vim的一款进行插件管理的插件。它需要git的支持，git可以在各发行版软件源内找到并安装。除了安装时的一个命令，日常vundle的使用并不需要了解git命令。

以下安装流程参考自vundle的github简介。

1.使用git下载vundle
运行命令： 

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

这样插件将被下载到 ~/.vim/bundle/vundle

2.编辑 .vimrc
在~/.vimrc末尾添加以下内容：

  1. """"""""""""""""""""" Vundle
  2. set nocompatible
  3. filetype off
  6. set rtp+=~/.vim/bundle/vundle
  7. call vundle#rc()
  10. Bundle 'gmarik/vundle'
  13. Bundle 'Valloric/YouCompleteMe'
  14. Bundle 'Valloric/ListToggle'
  15. Bundle 'scrooloose/syntastic'
  18. filetype plugin indent on
  19. """"""""""""""""""""" Vundle

其中以Bundle开头的行，每一个Bundle代表一个vim插件，这些省略完整URL插件都是托管在https://github.com上的。如果想要安装新的插件，在“call vundle#rc()" 和 ”filetype plugin indent on"之间添加新的Bundle ‘插件名称’即可。
编辑完成后，在vim下运行下面的命令进行插件安装，请确保你的网络连接正常。

  1. :BundleInstall

如果安装成功，你将看到Done!的提示字样。在本例中，插件：YouCompleteMe, syntastic和ListToggle被安装进你的vim中。

三、YCM语法补全模块的编译

为了让YCM实现语法补全，还需要编译语法补全模块和编辑一个配置文件。
在终端下执行以下命令：

  1. $HOME/.vim/bundle/YouCompleteMe         //切换到YCM主目录
  2. ./install.sh --clang-completer          //编译耗时比较久

即可安装语法补全模块。

四、配置文件.ycm_extra_conf.py [重要]

这个文件决定了YCM在进行c系语言(c,c++,etc.) 语法补全时的行为。默认的样板配置文件在

  1. $HOME/.vim/bundle/YouCompleteMe/cpp/ycm/.ycm_extra_conf.py

对于YCM来说，当打开一个代码文件时，插件将顺着文件所在的路径一直向上查找，如果搜索到第一个配置文件将立刻读入。如果一直搜索到根目录依旧无法找到配置文件，语法补全将不被启用。由此可知，文件所在目录的配置文件优先级最高，根目录的优先级最低。

  1. "一种比较好的使用方法是:
  2.         在每个项目中创建一个配置文件，
  3.         或者将项目根据语言进行分类，
  4.         在每个语言文件夹下建立一个配置文件。"

默认配置文件是支持c++的，但是需要修改一处地方。可以将该文件拷贝出来并编辑：

  1. cp $HOME/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp/ycm/.ycm_extra_conf.py ~
  2. vim ~/.ycm_extra_conf.py

找到以下内容：

  1. # NOTE: This is just for YouCompleteMe; it's highly likely that your project
  2. # does NOT need to remove the stdlib flag. DO NOT USE THIS IN YOUR
  3. # ycm_extra_conf IF YOU'RE NOT 100% YOU NEED IT.
  4. try:
  5.     final_flags.remove( '-stdlib=libc++' )
  6. except ValueError:
  7.     pass

将之删除后YCM才会补全c++标准库的内容。
这样，一个最小能用的配置文件就出炉了。

五、YCM变量配置：

在日常使用中，有一些建议修改的变量。本人的.vimrc中对YCM的配置如下：

  1. " YouCompleteMe
  2. nnoremap <leader>jd :YcmCompleter GoToDefinitionElseDeclaration<CR>
  3. nnoremap <F5> :YcmForceCompileAndDiagnostics<CR>
  4. "let g:ycm_global_ycm_extra_conf = '~/.ycm_extra_conf.py'
  5. "Do not ask when starting vim
  6. let g:ycm_confirm_extra_conf = 0
  7. let g:syntastic_always_populate_loc_list = 1

其中，g:ycm_global_ycm_extra_conf 定义了全局配置文件，对于懒人来说是个好用的功能。当YCM在向上搜索的路径中找不到配置文件后，YCM将导入全局配置文件。

g:ycm_confirm_extra_conf 决定了在导入配置时是否需要手动确认。设置为0后YCM就不会老是在启动vim的时候来烦你了。

本示例中安装了syntastic插件进行语法检查，因此g:syntastic_always_populate_loc_list设置为1将更方便地使用其功能。又因为本示例安装了ListToggle，打开错误/警告提示面板将变成简单的一个快捷键。

六、我的.vimrc配置备份

  1. """"""""""""""""""""" Vundle
  3. set nocompatible              " be iMproved
  4. filetype off                  " required!
  6. set rtp+=~/.vim/bundle/vundle/
  7. call vundle#rc()
  8. " let Vundle manage Vundle
  9. " required! 
  10. Bundle 'gmarik/vundle'
  12. " My bundles here:
  13. "
  14. " original repos on GitHub
  15. Bundle 'tpope/vim-fugitive'
  16. Bundle 'Lokaltog/vim-easymotion'
  17. Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}
  18. Bundle 'tpope/vim-rails.git'
  20. Bundle 'molokai'
  21. " vim-scripts repos
  23. Bundle 'Valloric/YouCompleteMe'
  24. Bundle 'Valloric/ListToggle'
  25. "Bundle 'scrooloose/syntastic'
  27. Bundle 'L9'
  28. Bundle 'FuzzyFinder'
  29. " non-GitHub repos
  30. Bundle 'git://git.wincent.com/command-t.git'
  31. " Git repos on your local machine (i.e. when working on your own plugin)
  32. " ...
  33. filetype plugin indent on     " required!
  35. """"""""""""""""""""" Vundle
  37. " YouCompleteMe
  38. nnoremap <leader>jd :YcmCompleter GoToDefinitionElseDeclaration<CR>
  39. " "nnoremap <F5> :YcmForceCompileAndDiagnostics<CR>
  40. let g:ycm_global_ycm_extra_conf = '~/.ycm_extra_conf.py'
  41. " "Do not ask when starting vim
  42. let g:ycm_confirm_extra_conf = 0
  43. let g:syntastic_always_populate_loc_list = 1
  47. map <F9> :call SaveInputData()<CR>
  48. func! SaveInputData()
  49.     exec "tabnew"
  50.     exec 'normal "+gP'
  51.     exec "w! /tmp/input_data"
  52. endfunc
  55. colorscheme desert 
  56. "colorscheme molokai
  58. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  59. " 显示相关  
  60. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  62. set go=             " 不要图形按钮 
  63. syntax on           " 语法高亮 
  64. autocmd InsertLeave * se nocul  " 用浅色高亮当前行  
  65. autocmd InsertEnter * se cul    " 用浅色高亮当前行  
  66. set showcmd         " 输入的命令显示出来，看的清楚些 
  67. set novisualbell    " 不要闪烁(不明白)  
  68. set statusline=%F%m%r%h%w\ [FORMAT=%{&ff}]\ [TYPE=%Y]\ [POS=%l,%v][%p%%]\ %{strftime(\"%d/%m/%y\ -\ %H:%M\")}   "状态行显示的内容  
  69. set laststatus=1    " 启动显示状态行(1),总是显示状态行(2)  
  70. set foldenable      " 允许折叠  
  71. set foldmethod=manual   " 手动折叠  
  72. set nocompatible  "去掉讨厌的有关vi一致性模式，避免以前版本的一些bug和局限
  74. " 显示中文帮助
  75. if version >= 603
  76.     set helplang=cn
  77.     set encoding=utf-8
  78. endif
  80. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  81. " 
  82. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  84. function! s:insert_gates()
  85.     let gatename = substitute(toupper(expand("%:t")), "\\.", "_", "g")
  86.     call setline(1, "/*************************************************************************") 
  87.     call append(line("."), "    > File Name: ".expand("%")) 
  88.     call append(line(".")+1, "  > Author: Dubyoo") 
  89.     call append(line(".")+2, "  > Mail:wangwei1543@gmail.com ") 
  90.     call append(line(".")+3, "  > Created Time: ".strftime("%c")) 
  91.     call append(line(".")+4, " ************************************************************************/") 
  92.     call append(line(".")+5, "")
  93.     execute "normal! Go__"
  94.     execute "normal! Gi#ifndef __" .gatename
  95.     execute "normal! Go__"
  96.     execute "normal! Gi#define __" .gatename
  97.     execute "normal! Go"
  98.     execute "normal! Go"
  99.     execute "normal! Go#endif"
  100.     normal! kk
  101. endfunction
  102. autocmd BufNewFile *.{h,hpp,H} call <SID>insert_gates()
  104. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  105. """""新文件标题
  106. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  107. "新建.c,.h,.sh,.java文件，自动插入文件头 
  108. "autocmd BufNewFile *.cpp,*.[ch],*.sh,*.java exec ":call SetTitle()" 
  109. autocmd BufNewFile *.cpp,*.c,*.sh,*.java exec ":call SetTitle()" 
  110. ""定义函数SetTitle，自动插入文件头 
  111. func SetTitle() 
  112.     "如果文件类型为.sh文件 
  113.     if &filetype == 'sh' 
  114.         call setline(1,"\#########################################################################") 
  115.         call append(line("."), "\# File Name: ".expand("%")) 
  116.         call append(line(".")+1, "\# Author: Dubyoo") 
  117.         call append(line(".")+2, "\# mail: wangwei1543@gmail.com") 
  118.         call append(line(".")+3, "\# Created Time: ".strftime("%c")) 
  119.         call append(line(".")+4, "\#########################################################################") 
  120.         call append(line(".")+5, "\#!/bin/bash") 
  121.         call append(line(".")+6, "") 
  122.     else 
  123.         call setline(1, "/*************************************************************************") 
  124.         call append(line("."), "    > File Name: ".expand("%")) 
  125.         call append(line(".")+1, "  > Author: Dubyoo") 
  126.         call append(line(".")+2, "  > Mail:wangwei1543@gmail.com ") 
  127.         call append(line(".")+3, "  > Created Time: ".strftime("%c")) 
  128.         call append(line(".")+4, " ************************************************************************/") 
  129.         call append(line(".")+5, "")
  130.     endif
  131.     if &filetype == 'cpp'
  132.         call append(line(".")+6, "#include <iostream>")
  133.         call append(line(".")+7, "using namespace std;")
  134.         call append(line(".")+8, "")
  135.     endif
  136.     if &filetype == 'c'
  137.         call append(line(".")+6, "#include <stdio.h>")
  138.         call append(line(".")+7, "")
  139.     endif
  140.     "   if &filetype == 'java'
  141.     "       call append(line(".")+6,"public class ".expand("%"))
  142.     "       call append(line(".")+7,"")
  143.     "   endif
  144.     "新建文件后，自动定位到文件末尾
  145.     autocmd BufNewFile * normal G
  146. endfunc 
  149. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  150. "键盘命令
  151. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  153. nmap <leader>w :w!<cr>
  154. nmap <leader>f :find<cr>
  156. " 映射全选+复制 ctrl+a
  157. map <C-A> ggVGY
  158. map! <C-A> <Esc>ggVGY
  159. map <F12> gg=G
  160. " 选中状态下 Ctrl+c 复制
  161. vmap <C-c> "+y
  162. "去空行  
  163. nnoremap <F2> :g/^\s*$/d<CR> 
  164. "比较文件  
  165. nnoremap <C-F2> :vert diffsplit 
  166. "新建标签  
  167. map <M-F2> :tabnew<CR>  
  168. "列出当前目录文件  
  169. map <F3> :tabnew .<CR>  
  170. "打开树状文件目录  
  171. map <C-F3> \be  
  172. "C，C++ 按F5编译运行
  173. map <F5> :call CompileRunGcc()<CR>
  174. func! CompileRunGcc()
  175.     exec "w"
  176.     if &filetype == 'c'
  177.         exec "!g++ % -o %<"
  178.         exec "! ./%<"
  179.     elseif &filetype == 'cpp'
  180.         exec "!g++ % -o %<"
  181.         exec "! ./%<"
  182.     elseif &filetype == 'java' 
  183.         exec "!javac %" 
  184.         exec "!java %<"
  185.     elseif &filetype == 'sh'
  186.         :!./%
  187.     elseif &filetype == 'py'
  188.         exec "!python %"
  189.         exec "!python %<"
  190.     endif
  191. endfunc
  192. "C,C++的调试
  193. map <F8> :call Rungdb()<CR>
  194. func! Rungdb()
  195.     exec "w"
  196.     exec "!g++ % -g -o %<"
  197.     exec "!gdb ./%<"
  198. endfunc
  202. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  203. ""实用设置
  204. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  205. " 设置当文件被改动时自动载入
  206. set autoread
  207. " quickfix模式
  208. autocmd FileType c,cpp map <buffer> <leader><space> :w<cr>:make<cr>
  209. "代码补全 
  210. set completeopt=preview,menu 
  211. "允许插件  
  212. filetype plugin on
  213. "共享剪贴板  
  214. set clipboard+=unnamed 
  215. "从不备份  
  216. set nobackup
  217. "make 运行
  218. :set makeprg=g++\ -Wall\ \ %
  219. "自动保存
  220. set autowrite
  221. set ruler                   " 打开状态栏标尺
  222. set cursorline              " 突出显示当前行
  223. set magic                   " 设置魔术
  224. set guioptions-=T           " 隐藏工具栏
  225. set guioptions-=m           " 隐藏菜单栏
  226. "set statusline=\ %<%F[%1*%M%*%n%R%H]%=\ %y\ %0(%{&fileformat}\ %{&encoding}\ %c:%l/%L%)\
  227. " 设置在状态行显示的信息
  231. set foldcolumn=0
  232. set foldmethod=indent 
  233. set foldlevel=3 
  234. set foldenable              " 开始折叠
  235. " 不要使用vi的键盘模式，而是vim自己的
  236. set nocompatible
  237. " 语法高亮
  238. set syntax=on
  239. " 去掉输入错误的提示声音
  240. set noeb
  241. " 在处理未保存或只读文件的时候，弹出确认
  242. set confirm
  243. " 自动缩进
  244. set autoindent
  245. set cindent
  246. " Tab键的宽度
  247. set tabstop=4
  248. " 统一缩进为4
  249. set softtabstop=4
  250. set shiftwidth=4
  251. " 不要用空格代替制表符
  252. set noexpandtab
  253. " 在行和段开始处使用制表符
  254. set smarttab
  255. " 显示行号
  256. set number
  257. " 历史记录数
  258. set history=1000
  259. "禁止生成临时文件
  260. set nobackup
  261. set noswapfile
  262. "搜索忽略大小写
  263. set ignorecase
  264. "搜索逐字符高亮
  265. set hlsearch
  266. set incsearch
  267. "行内替换
  268. set gdefault
  269. "编码设置
  270. set enc=utf-8
  271. set fencs=utf-8,ucs-bom,shift-jis,gb18030,gbk,gb2312,cp936
  272. "语言设置
  273. set langmenu=zh_CN.UTF-8
  274. set helplang=cn
  275. " 我的状态行显示的内容（包括文件类型和解码）
  276. "set statusline=%F%m%r%h%w\ [FORMAT=%{&ff}]\ [TYPE=%Y]\ [POS=%l,%v][%p%%]\ %{strftime(\"%d/%m/%y\ -\ %H:%M\")}
  277. "set statusline=[%F]%y%r%m%*%=[Line:%l/%L,Column:%c][%p%%]
  280. " 总是显示状态行
  281. set laststatus=2
  282. " 命令行（在状态行下）的高度，默认为1，这里是2
  283. set cmdheight=2
  284. " 侦测文件类型
  285. filetype on
  286. " 载入文件类型插件
  287. filetype plugin on
  288. " 为特定文件类型载入相关缩进文件
  289. filetype indent on
  290. " 保存全局变量
  291. set viminfo+=!
  292. " 带有如下符号的单词不要被换行分割
  293. set iskeyword+=_,$,@,%,#,-
  294. " 字符间插入的像素行数目
  295. set linespace=0
  296. " 增强模式中的命令行自动完成操作
  297. set wildmenu
  298. " 使回格键（backspace）正常处理indent, eol, start等
  299. set backspace=2
  300. " 允许backspace和光标键跨越行边界
  301. set whichwrap+=<,>,h,l
  302. " 可以在buffer的任何地方使用鼠标（类似office中在工作区双击鼠标定位）
  304. """""""""""""""""""??????????????
  305. "set mouse=a
  306. "set selection=exclusive
  307. "set selectmode=mouse,key
  308. """""""""""""""""""??????????????
  310. " 通过使用: commands命令，告诉我们文件的哪一行被改变过
  311. set report=0
  312. " 在被分割的窗口间显示空白，便于阅读
  313. set fillchars=vert:\ ,stl:\ ,stlnc:\
  314. " 高亮显示匹配的括号
  315. set showmatch
  316. " 匹配括号高亮的时间（单位是十分之一秒）
  317. set matchtime=1
  318. " 光标移动到buffer的顶部和底部时保持3行距离
  319. set scrolloff=3
  320. " 为C程序提供自动缩进
  321. set smartindent
  322. " 高亮显示普通txt文件（需要txt.vim脚本）
  323. au BufRead,BufNewFile *  setfiletype txt
  324. "自动补全
  325. :inoremap ( ()<ESC>i
  326. :inoremap ) <c-r>=ClosePair(')')<CR>
  327. ":inoremap { {<CR>}<ESC>O
  328. ":inoremap } <c-r>=ClosePair('}')<CR>
  329. :inoremap [ []<ESC>i
  330. :inoremap ] <c-r>=ClosePair(']')<CR>
  331. :inoremap " ""<ESC>i
  332. :inoremap ' ''<ESC>i
  333. function! ClosePair(char)
  334.     if getline('.')[col('.') - 1] == a:char
  335.         return "\<Right>"
  336.     else
  337.         return a:char
  338.     endif
  339. endfunction
  340. filetype plugin indent on 
  341. "打开文件类型检测, 加了这句才可以用智能补全
  342. set completeopt=longest,menu
  343. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  350. "NERDtee设定
  351. let NERDChristmasTree=1
  352. let NERDTreeAutoCenter=1
  353. let NERDTreeBookmarksFile=$VIM.'\Data\NerdBookmarks.txt'
  354. let NERDTreeMouseMode=2
  355. let NERDTreeShowBookmarks=1
  356. let NERDTreeShowFiles=1
  357. let NERDTreeShowHidden=1
  358. let NERDTreeShowLineNumbers=1
  359. let NERDTreeWinPos='left'
  360. let NERDTreeWinSize=31
  361. nnoremap f :NERDTreeToggle
  362. map <F7> :NERDTree<CR>
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注