欢迎使用CSDN-markdown编辑器

You Complete Me的理解与一些基本使用。

You Complete Me插件介绍

You Complete Me 简称YCM,是vim上一个结合基于Clang、Tag等多种方式的补全插件,功能非常强大,补全功能直追IDE。但要实现补全功能,需要对工程进行配置。

YCM配置文件理解:

YCM的安装我这里就不做介绍, 如果看官方文档和google还不能正确安装的话,YCM不适合你。
安装完成以后,你可以在vim插件目录下, YouCompleteMe/third_party/ycmd/examples 目录下找到文件:.ycm_extra_conf.py。该文件就是每个工程必须的配置文件,你的配置文件都可以从这个文件开始修改。
打开该文件,可以看到官方有详尽的注释。主要需要配置的就是里面的flag表:

flags = [
'-Wall',
'-std=c++11'
'-x'
'c++'
'-isystem'
'/usr/include'
'-I'
'include'
]

仔细看该文件的源码就知道,这个是在需要补全某个文件的时候,这个文件的函数会被YCM调用,并返回编译该文件所需要的相关参数。
可以理解为:
在你打开aa.c文件需要对其进行自动补全的时候,你补全的内容来自:
1. 当前文件的上下文
2. 当前文件引用的所有头文件
3. Tag内容,路径等其他内容
所以YCM的办法就是:用Clang先预编译你要补全文件 从而生成相关的语法树,再以此来做补全。
编译文件的参数就需要通过.ycm_extra_conf.py传递给YCM。
到此我相信大家已经基本来接YCM基于Clang补全的基本原理了。那接下来就是按照你的makefile来完善这个flag了。

YCM配置文件的维护

原理

然而,当你接手一个大大大大的工程的时候,比如linux kernel 很多依赖库的工程等,你维护这个flag就变得无比蛋疼,开源社区的大大永远不允许这样低效的事情发生。于是,维护.ycm_extra_conf.py的工具也就产生了。YCM官方推荐的工具有两个:
1. YCM-Generator
2. bear
3. cmake
其中YCM-Generator没怎么用,就不介绍了。
这里介绍后两种:
当你仔细阅读.ycm_extra_conf.py的源码的时候,你会发现一个配置:

complation_database_folder = ''

这个意思是,你可以通过一个编译命令表来配置flag,这个表是什么样的呢:

[
  { "directory": "/home/user/llvm/build",
    "command": "/usr/bin/clang++ -Irelative -DSOMEDEF=\"With spaces, quotes and \\-es.\" -c -o file.o file.cc",
    "file": "file.cc" },
  ...
]

就发现,这个表是记录编译所有文件编译的时候使用的参数,也就是Clang需要的东西。
这就好了,只要把这个表告诉YCM,补全就没问题了。于是就有了配置:

complation_database_folder = ''

只要把该目录指定到命令表所在的目录即可,命令表的文件名需要为:compile_commands.json

How To

对于这个表如果你的工程是cmake管理的,那就容易了:
官方文档说: You can get CMake to generate this file for you by adding set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )
只需要配置一下,cmake自动就能生成该文件。
如果你不幸用的是Makefile, 那么你需要安装一个工具:Bear
通过Bear来运行你的make 命令即可。
这里要注意的是,你需要在makefile中打开编译输出,确保make过程中,所有文件的编译参数都能显示出来,bear才能工作。

最后

要能够用好开源工具,最好能够对其进行深入一些的了解,这样遇到问题才能解决。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值