Vim 中使用 OmniComplete 为 C/C++ 自动补全

OmniComplete 并不是插件的名字，而是 Vim 众多补全方式中的一种（全能补全）。说白了 OmniComplete 其实就是根据光标前的内容猜测光标后的内容，具体怎么猜取决于所采用的脚本。

而 OmniCppComplete 就是专为 C/C++ 编写的 OmniComplete 一个补全脚本。

那么经常和 OmniCppComplete 一起出没的 Ctags 又是什么呢？Ctags 全名 Exuberant Ctags，是一个独立的程序（也就是说，其实和 Vim 一点关系都没有）。它可以为各种语言的源代码生成语言元素（language object）索引文件。对于 C/C++ 来说，就是把源代码中的各种宏、函数、类、类成员等等元素和它们的相关信息生成索引文件，供其它程序使用。

OmniCppComplete 脚本就是根据 Ctags 生成的索引文件进行补全的。 好了，背景知识就是这样，安装步骤如下：

安装 Ctags

1. 从官网下载 Ctags 可执行文件，网站是 
2. 将下载到的文件（仅 EXE 文件即可）解压到一个目录，例如 D:/ctags
3. 将该目录加入环境变量 PATH

准备索引文件

以生成 C++ 标准库索引文件为例：

1. 下载专为 Ctags 修改过的 
2. 将其解压到一个目录，例如 D:/ctags/cpp_src
3. 使用命令行进入 D:/ctags/cpp_src 后执行：ctags -R --sort=1 --c++-kinds=+p --fields=+iaS --extra=+q --language-force=C++ -f cpp .
4. 建议将上一步生成的 D:/ctags/cpp_src/cpp 文件放到一个专门放置索引文件的目录以便后面的统一设置，例如放到 D:/ctags/tags

其它库的索引文件也可以依法炮制，只需切换到该库的 include 文件夹，执行：

ctags -R --sort=yes --c++-kinds=+p --fields=+iaS --extra=+q --language-force=C++ -f <文件名> . 安装 OmniCppComplete

1. 下载 
2. 将下载到的文件解压到 ~/.vim (unix) 或者 %HOMEPATH%\vimfiles (Windows) 文件夹
3. 在 vimrc 文件中加入
   " ctags 索引文件 (根据已经生成的索引文件添加即可, 这里我额外添加了 hge 和 curl 的索引文件) set tags+=D:/ctags/tags/cpp set tags+=D:/ctags/tags/hge set tags+=D:/ctags/tags/curl " OmniCppComplete let OmniCpp_NamespaceSearch = 1 let OmniCpp_GlobalScopeSearch = 1 let OmniCpp_ShowAccess = 1 let OmniCpp_ShowPrototypeInAbbr = 1 " 显示函数参数列表 let OmniCpp_MayCompleteDot = 1   " 输入 .  后自动补全 let OmniCpp_MayCompleteArrow = 1 " 输入 -> 后自动补全 let OmniCpp_MayCompleteScope = 1 " 输入 :: 后自动补全 let OmniCpp_DefaultNamespaces = ["std", "_GLIBCXX_STD"] " 自动关闭补全窗口 au CursorMovedI,InsertLeave * if pumvisible() == 0|silent! pclose|endif set completeopt=menuone,menu,longest

另外，还需确认在 vimrc 中开启了 filetype 选项，不然 OmniComplete 无法自动识别 C/C++ 文件类型进行补全。

这样，在插入模式编辑 C/C++ 源文件时按下 . 或 -> 或 ::，或者手动按下 Ctrl+X Ctrl+O 后就会弹出自动补全窗口，此时可以用 Ctrl+N 和 Ctrl+P 上下移动光标进行选择。

美化咩？

也许你也已经注意到了一个问题，那就是「自动补全窗口的配色非常之丑」，Vim 自带的几个配色方案中只有两三种配色改掉了自动补全窗口丑陋的紫色，其它的基本上都是很逆天的用灰色表示当前选中项、紫色表示其他项。

要改变自动补全窗口的配色可以在 vimrc 中加上：

highlight Pmenu guibg=darkgrey  guifg=black highlight PmenuSel guibg=lightgrey guifg=black

Pmenu 是所有项的配色，PmenuSel 是选中项的配色，guibg 和 guifg 分别对应背景色和前景色。

2. 使用ctags生成标签库

对于C++代码，ctags需要额外使用以下选项：

• --c++-kinds=+p : 为标签添加函数原型(prototype)信息
• --fields=+iaS : 为标签添加继承信息(inheritance)，访问控制(access)信息，函数特征(function Signature,如参数表或原型等)
• --extra=+q : 为类成员标签添加类标识

4. omnicppcomplete补全提示菜单

使用后，omnicppcomplete会弹出如下补全提示菜单

+-------------------------------------+
|method1(   f  +  MyNamespace::MyClass|
|_member1   m  +  MyNamespace::MyClass|
|_member2   m  #  MyNamespace::MyClass|
|_member3   m  -  MyNamespace::MyClass|
+-------------------------------------+
    ^       ^  ^          ^
   (1)     (2)(3)        (4)

其中1为符号名称；2为符号类型；3为访问控制标识；4为符号定义所在域(scope)。

4.1 符号名称

1为omnicppcomplete所查找到的可选符号(symbol)名称，如以'('结尾，则为函数。

4.2 符号类型

符号的类型，可能的值为

• c : 类(class)
• d : 宏(macro definition)
• e : 枚举值(enumeator)
• f : 函数(function)
• g : 枚举类型名称
• m : 类/结构/联合成员(member)
• n : 命名空间(namespace)
• p : 函数原型(function prototype)
• s : 结构体名称(structure name)
• t : 类型定义(typedef)
• u : 联合名(union name)
• v : 变量定义(variable defination)

4.3 访问控制

类成员访问控制，取值：

• + : 公共(public)
• # : 保护(protected)
• - : 私有(private)

4.4 符号定义所在域

符号在何处被定义。

5. omnicppcomplete选项设置

Vim中，可以通过以下选项控制omnicppcomplete查找/补全方式：

• OmniCpp_GlobalScopeSearch : 全局查找控制。0:禁止；1:允许(缺省)
• OmniCpp_NamespaceSearch : 命名空间查找控制。
  • 0 : 禁止查找命名空间
  • 1 : 查找当前文件缓冲区内的命名空间(缺省)
  • 2 : 查找当前文件缓冲区和包含文件中的命名空间
• OmniCpp_DisplayMode : 类成员显示控制(是否显示全部公有(public)私有(private)保护(protected)成员)。
  • 0 : 自动
  • 1 : 显示所有成员
• OmniCpp_ShowScopeInAbbr : 选项用来控制匹配项所在域的显示位置。缺省情况下，omni显示的补全提示菜单中总是将匹配项所在域信息显示在缩略信息最后一列。
  • 0 : 信息缩略中不显示匹配项所在域(缺省)
  • 1 : 显示匹配项所在域，并移除缩略信息中最后一列
• OmniCpp_ShowPrototypeInAbbr : 是否是补全提示缩略信息中显示函数原型。
  • 0 : 不显示(缺省)
  • 1 : 显示原型
• OmniCpp_ShowAccess : 是否显示访问控制信息('+', '-', '#')。0/1, 缺省为1(显示)
• OmniCpp_DefaultNamespaces : 默认命名空间列表，项目间使用','隔开。
  如：let OmniCpp_DefaultNamespaces = ["std', "MyNamespace"]
• OmniCpp_MayCompleteDot : 在'.'号后是否自动运行omnicppcomplete给出提示信息。0/1, 缺省为1
• OmniCpp_MayCompleteArray : 在"->"后是否自动运行omnicppcomplete给出提示信息。0/1, 缺省为1
• OmniCpp_MayCompleteScope : 在域标识符"::"后是否自动运行omnicppcomplete给出提示信息。0/1, 缺省为0
• OmniCpp_SelectFirstItem : 是否自动选择第一个匹配项。仅当"completeopt"不为"longest"时有效。
  • 0 : 不选择第一项(缺省)
  • 1 : 选择第一项并插入到光标位置
  • 2 : 选择第一项但不插入光标位置
• OmniCpp_LocalSearchDecl : 使用Vim标准查找函数/本地(local)查找函数。Vim内部用来在函数中查找变量定义的函数需要函数括号位于文本的第一列，而本地查找函数并不需要。