1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 02:10:05 +08:00
SpaceVim/docs/layers/lang/c.md
Wang Shidong 0ae0cd55f4
Add option for clang based syntax highlight (#2744)
* Add option for clang based syntax highlight

* Update cn doc
2019-04-13 13:56:41 +08:00

91 lines
1.9 KiB
Markdown

---
title: "SpaceVim lang#c layer"
description: "C/C++/Object-C language support for SpaceVim, include code completion, jump to definition, quick runner."
---
# [Available Layers](../../) >> lang#c
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Install](#install)
- [Features](#features)
- [Configuration](#configuration)
- [Key bindings](#key-bindings)
<!-- vim-markdown-toc -->
## Description
`lang#c` layer provides c/c++/object-c language support for SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
```toml
[[layers]]
name = "lang#c"
```
## Features
- code completion
- syntax checking
- formatting
## Configuration
- `enable_clang_syntax_highlight` (boolean)
Enable/Disable clang based syntax highlighting.
- `clang_executable` (string)
Set the path to the clang executable
- `libclang_path` (string)
The libclang shared object (dynamic library) file path. By default it is empty.
- `clang_std` (dict)
A dict containing the standards you want to use. The default is:
```json
{
"c": "c11",
"cpp": "c++1z",
"objc": "c11",
"objcpp": "c++1z",
}
```
- `clang_flag`
Create a `.clang` file at your project root. You should be able to just paste most of your compile flags in there. You can also use a list ['-Iwhatever', ...] when loadding this layer.
Here is an example how to use above options:
```toml
[[layers]]
name = "lang#c"
clang_executable = "/usr/bin/clang"
[layer.clang_std]
c = "c11"
cpp = "c++1z"
objc = "c11"
objcpp = "c++1z"
```
## Key bindings
| key bindings | Descriptions |
| ------------ | ---------------------------- |
| `SPC l d` | show documentation |
| `SPC l e` | rename symbol |
| `SPC l f` | references |
| `SPC l r` | compile and run current file |
| `g d` | defintion preview |