# clighter8

**Repository Path**: space-vim/clighter8

## Basic Information

- **Project Name**: clighter8
- **Description**: mirror from github
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-01-28
- **Last Updated**: 2024-09-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Clighter8: Vim C++ syntax highlight plugin by libclang

# Intro

Clighter8 is a server-client Vim syntax highlight plugin, provides following
features:

* On-the-fly, highly customized semantic syntax highlight
* Compilation database supporting
* An awesome color scheme

# Requirements
Clighter8 requires the following things:

* Vim with +job and +channel features
* [libclang][libclang] and compatible [clang python bindings][cpb]

# Installation

Use a plugin manager, for example

* Vundle Install:
```vim
Bundle 'bbchung/clighter8'
```

# Usage

Clighter8 provides following commands.

## ClStart

Start Clighter8, highlight the code.

## ClStop

Stop Clighter8.

## ClRestart

Restart Clighter8.

## ClShowCursorInfo

Show cursor informations from libclang. It's useful when debugging.

## ClShowCompileInfo

Show compiler args of current buffer.

## ClEnableLog

Enable log, the path of log file is '/tmp/clighter8.log'.

## ClDisableLog

Disable log.

## ClLoadCdb (Experimental)

It will start clighter8 and open source files described in compilation
database and all referenced header files under current working folder of Vim.
Notice that it may take long time if the compilation database is big.

## Compilation Database

Clighter8 supports compilation database, and it will load the compilation
database in the current working directory. It's strongly recommended to
provide a compilation database for Clighter8 to get the better result of
syntax highlight. For more information about compilation
database, please reference [Compilation Database][cdb].

## FAQ

## Highlight feature doesn't work?
Check the [Requirements](#requirements) and [Installation](#installation), and
check if a valid libclang path is given, also, you can check
/tmp/clighter8.log. Remember to set g:clighter8_global_compile_args or provide
the compilation database to get the better highlight result.

## How to set compile args?
Clighter8 sets the compile args for each file with
(g:clighter8_global_compile_args + "compilation database"). Compile args will
affect the correctness of highlight.

# LICENSE

This software is licensed under the [GPL v3 license][gpl].

Note: This license does not cover the files that come from the LLVM or other
third party libraries.

[libclang]: http://llvm.org/apt/
[gpl]: http://www.gnu.org/copyleft/gpl.html
[ycm]: https://github.com/Valloric/YouCompleteMe
[cdb]: http://clang.llvm.org/docs/JSONCompilationDatabase.html
[clang]: http://clang.llvm.org/
[GNU Global]: https://www.gnu.org/software/global/download.html
[cpb]: https://github.com/llvm-mirror/clang/tree/master/bindings/python