color_coded is a vim plugin that provides realtime (fast), tagless code highlighting using libclang.
- Fast compilation, using native C++14
- Exhaustive customization possibilities
NOTE: color_coded is currently alpha software; use it knowing shit may break (but it'll be colorfully broken).
Installation has been tested using vundle, but should also be compatible with pathogen. To install using vundle (add the line to your ~/.vimrc, restart vim, run :BundleInstall):
Bundle 'jeaye/color_coded'NOTE: Cloning color_coded (or, more specifically, its submodules) may take quite a bit of time on slow connections. If your :BundleInstall command is blocking for some time, maybe go grab a beverage.
Since color_coded has a compiled component, you'll need to manually compile when installing and updating. Compilation works as follows, assuming usage of vundle:
cd ~/.vim/bundle/color_coded
./configure && makeFor various compatibility reasons, color_coded will attempt to download a known version of clang. This may add time to your configuration process, but it offers more stability across multiple platforms.
NOTE: color_coded, to my knowledge, has not been tested on Windows.
Once color_coded is installed and compiled, it will automatically begin working the next time you start vim. In order for color_coded to know how your code must be compiled, you may need to create a file describing the required compiler options. Note, color_coded assumes sane defaults and tries to allow for immediate usage (it favors C++ in this regard).
That said, in any non-trivial case, you'll find yourself needing to supply a .color_coded file for your project. color_coded will search from the current working directory all the way up to the root of the filesystem looking for a .color_coded file. This makes it possible for you to have one in your home directory, for example, and then in each of your projects' directories. If you don't specify one in a project directory, the one in your home directory is used. Again, if no such files are found, sane defaults will be applied.
color_coded will try its hardest to highlight your code for you, even if there are errors in the translation unit. This allows for better highlighting while typing and highlighting of valid code when color_coded doesn't know everything about your project.
The contents of a .color_coded file is simply a line-separated list of compiler options. For example, the .color_coded file for color_coded is:
-std=c++1y
-Iinclude
NOTE: Out of simplicity, no other data is permitted in the .color_coded file. That is to say, comments are not supported.
This option controls the filetypes for which color_coded will try to compile.
Default:
let g:color_coded_filetypes = ['c', 'h', 'cpp', 'hpp', 'cc', 'm', 'mm']There are many new highlighting groups which color_coded adds. They are designed to follow libclang's internals as closely as possible. To tie things together, some wrapper groups have been created that will allow more sweeping changes. The clang groups, by default, are mapped to use these, along with vim's normal groups (Function, Macro, Number, etc).
hi Member # Any non-static member variable
hi Variable # Any non-member variable
hi Namespace
hi EnumConstanthi link StructDecl Type
hi link UnionDecl Type
hi link ClassDecl Type
hi link EnumDecl Type
For more information on all of the supported groups, see after/syntax/color_coded.vim and the clang documentation.
This command outputs the last compilation error message from libclang. If your highlighting is not working properly, you may have a misconfigured .color_coded file or you may have syntax errors in your source. When in doubt, check here first.
Compilation of color_coded requires a modern compiler:
- GCC ≥ 4.9
- Clang ≥ 3.4
Usage of color_coded requires vim:
- Version: 7.4p330+
- Compiled with Lua support
color_coded is under the MIT open-source license.
See the LICENSE file or http://opensource.org/licenses/MIT