首页 > 代码库 > 跟我一起学Vim补全神级插件--YouCompleteMe

跟我一起学Vim补全神级插件--YouCompleteMe

2024-07-09 08:14:47   233人阅读

   最近重拾Vim，编译部署来补全插件YCM,这个插件的补全效果和在写C代码的时候的自动提示错误信息等还是十分棒的，写点心得下来，也算给自己做个备忘。

    快速安装：

    首先参考我的.vimrc配置,用Vundle安装好之后,进入YCM的文件夹.vim/bundle/YouCompleteMe会找到install.sh脚本文件。这个时候如果你需要C语言系的语义补全你需要在运行install.sh脚本之后手动加入命令--clang-completer，即可进行自动安装，此时YCM会去Clang的官网去下载libclang.so来作为YCM语义补全的支持。

    完整安装：

    1.如果采用之前的方法不能进行安装的话可以进行自己的定制化安装，YCM是一个编译插件，因此需要进行手动编译。首先第一点就要确保你的Vim的最低版本必须是7.3.584,并且支持python2。如果不支持，你必须自己手动编译一份Vim。（查看是否支持python2可以在Vim中输入:echo has(‘python‘)如果输出1就表示支持，0就表示这个时候你需要重新编译了）

    2.下载libclang.so，YCM作者推荐下载官方预编译 之后的libclang.so而不是用你系统自带的libclang,如果你真的要用自己的sysytem中的libclang需要保证版本号大于等于3.3，否则会出现随机性的错误。

    3.编译ycm_support_libs库。首先确保自己安装了python-dev有python的头文件，然后建立临时文件夹ycm_build

cd ~
mkdir ycm_build
cd ycm_build
cmake -G "Unix Makefiles" . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp

    用CMake完成了生成Makefile的过程，注意这个过程是给那些不需要C语义补全的同学，如果你需要C的语义补全，步骤会稍微麻烦点。你需要自己下载二进制发行版的LLVM+Clang或者自己手动编译LLVM和Clang,然后保证bin,lib,inclulde在文件夹根目录下比如ycm_temp/llvm_clang下，然后运行
cmake -G "Unix Makefiles" -DPATH_TO_LLVM_ROOT=~/ycm_temp/llvm_root_dir . ~/.vim/bundle/YouCompleteMe/third_party/ycmd/cpp
    等待Makefile生成之后运行
make ycm_support_libs
    即完成了ycm_supprot_libs的编译，对于那些想用系统libclang的同学你需要传入-DUSE_SYSTEM_LIBCLANG=ON来替代-DPATH_TO_LLVM_ROOT的flag.如果你系统内有自定义的libclang你也可以定义采用自定义的libclang,-DEXTERNAL_LIBCLANG_PATH=/path/to/libclang.so.同时需要注意的是，如果你采用了Clang的语义补全支持，make命令也会把libclang复制一份放到YouCompleteMe/python下面来驱动YCM的运行。

    使用：
    完成了YCM的编译就可以享受它给你带来的方便了，如果你需要C语言的语义补全，除了刚刚编译多出来的步骤之外，你还需要提供编译的flag给YCM才能进行真正的补全。YCM查找.ycm_extra_conf.py来进行补全支持，你也可以手动提供一个全局的.ycm_extra_conf.py路径来给YCM做缺省处理（YCM查找路径是依次从里到外的向上，如果找不到会采取默认的全局路径，我选择放在主目录下面，这样不需要设置全局路径，因为YCM始终可以找到它）。
    此外说一下.ycm_extra_conf.py,对于一些简单的小项目，使用默认的文件即可，对于默认文件我选择关闭了-Werror因为这样会给Vim提示语义准确的Syntastic带来困扰，另外我多加了一句-isystem,/usr/include/c++/4.8，因为我发现默认的ycm_extra_conf似乎找不到C++头文件。对于复杂项目来说，这个时候又需要借用我们强大的CMake了。CMake中有一个命令可以导出编译flag，-DCMAKE_EXPORT_COMPILE_COMMANDS=ON，这个时候CMake会把当前的编译flag全部导出到一个json数据库-compilation_commands.json,之后 我们需要手动给ycm_extra_conf.py中的compilation_database_folder一行 添加你数据库的位置，比如你在src,ycm_ectra_conf在你目录下，而你的json在build中，所以你需要写floder=./build，这个时候打开Vim，你会发现你的项目已经可以进行补全，我在进行Qt开发的过程中就是将CMake脚本维护好之后通过json来让YCM找到Qt的头文件从而进行补全，十分方便。
    总结：都说Vim最强大的乐趣在于自由定制，我感觉从Vim定制的过程中也可以学习到很多东西，也会这就是定制给我带来的真正乐趣，迫使我去学习，迫使我去尝试各种情况。我相信喜欢Vim定制的人不在少数，此文就当抛砖引玉，希望我的这篇文章能够帮助到你，同时也希望志同道合的朋友可以留下你的脚印，毕竟有你们的支持才能让我更有写作的动力。
    






























        

            
                
                  
                
                

                    联系

                    我们