https://github.com/kzemek/cpp-rtags-layer
Add RTags support to c-c++ Spacemacs layer.
https://github.com/kzemek/cpp-rtags-layer
cpp emacs layer rtags spacemacs
Last synced: 3 months ago
JSON representation
Add RTags support to c-c++ Spacemacs layer.
- Host: GitHub
- URL: https://github.com/kzemek/cpp-rtags-layer
- Owner: kzemek
- Created: 2017-09-06T23:38:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-06T23:51:38.000Z (over 7 years ago)
- Last Synced: 2025-01-11T20:16:14.655Z (4 months ago)
- Topics: cpp, emacs, layer, rtags, spacemacs
- Language: Emacs Lisp
- Size: 3.91 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# c++-rtags Spacemacs layer
This layer augments C++ support provided by [Spacemacs` c-c++ layer](https://github.com/syl20bnr/spacemacs/tree/develop/layers/%2Blang/c-c%2B%2B).
## Features
* Adds `rtags` package for basic RTags support
* Adds `company-rtags` package for RTags-powered completion
* Adds `flycheck-rtags` for checking C++ code with RTags
* Adds `helm-rtags` for Helm integration
* Ensures RTags daemon (`rdm`) is started via `cmake-ide-maybe-start-rdm`
* Enables completion (via `company`) and linting (via adding a checker to and replacing `flycheck` highligher) in C/C++ modes
## Installation
Simply clone the repository into your emacs.d private directory:
```shell
git clone https://github.com/kzemek/cpp-rtags-layer ~/.emacs.d/private/c++-rtags
```
and enable the layer in `~/.spacemacs` along with `c-c++` (without clang support):
```lisp
...
dotspacemacs-configuration-layers
'( ...
c-c++
c++-rtags
...
)
...
```
If your `c-c++` layer doesn't include `cmake-ide` support you may additionally need to fetch it from `develop` branch:
```shell
cd ~/.emacs.d && git fetch && git checkout origin/develop layers/+lang/c-c++/
```
## Project setup
* Install [rtags](https://github.com/Andersbakken/rtags)
* on macOS this step is as simple as `brew install rtags`
* [Set up `.dir-locals.el`](https://github.com/syl20bnr/spacemacs/tree/develop/layers/%2Blang/c-c%2B%2B#cmake-configuratio)
* [Create `compile_commands.json`](https://github.com/Andersbakken/rtags#setup) in your build directory
* for CMake projects it's enough to add `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` to `cmake` invocation
## Key bindings
| Key Binding | Description |
|-------------|----------------|
| `C ` | Forces showing completions on current point (`company-complete`) |
| `, g g` | Jumps to symbol definition (using RTags) |
| `, g f` | Apply Clang fixit |
| `C-c r` | Various `rtags` functions |