…
|
||
---|---|---|
.. | ||
global_conf.py | ||
packages.el | ||
README.org |
YCMD layer
Description
This layer adds emacs-ycmd support, including its integrations with company, flycheck, and eldoc.
Install
Layer
To use this configuration layer, add it to your ~/.spacemacs
. You will need to
add ycmd
to the existing dotspacemacs-configuration-layers
list in this
file.
YCMD
- Install the
ycm
server. Installation instructions can be found here. -
Set the
ycmd-server-command
variable to reflect the path to the installation:(setq ycmd-server-command '("python" "/path/to/YouCompleteMe/third_party/ycmd/ycmd"))
Note that no filename expansions are done, so
~
-paths will not work out of the box. If you need expansions, you can use Emacs'sfile-truename
like this:(setq ycmd-server-command (list "python" (file-truename "~/some/path")))
- By default, spacemacs configures ycmd for getting the compilation flags from either a compile_commands.json or a .clang_complete file and get additionnal flags from a .ycm_extra_flags file. If you do not like this behaviour, you can write your own .ycm_extra_conf.py file. See Configuration for more details.
-
Whitelist the file by adding the following to
.spacemacs
:;; In this example we whitelist everything in the Develop folder (setq ycmd-extra-conf-whitelist '("~/Develop/*"))
-
The completion is not going to work automatically until we actually force it:
(setq ycmd-force-semantic-completion t)
Other Requirements
This package requires the auto-completion
layer in order to get actual
completion. The syntax-checking
layer is required for flycheck support.
Configuration
Activating ycmd in a major mode
By default this layer only activates ycmd for c++-mode
and c-mode
.
If you want ycmd support in other modes you might just want to add it for specific languages like:
(add-hook 'c++-mode-hook 'ycmd-mode)
Getting the compilation flags
Spacemacs uses its own ycmd global configuration file. If you prefer, you can write your own .ycm_extra_conf.py.
Spacemacs will search for a compile_command.json or fall back to a .clang_complete file in all parent directories of the current translation unit. Spacemacs will try to make up for missing files in the compile_commands.json using heuristics described in global_conf.py.
The user can provide additionnal flags by writing a .ycm_extra_flags in any parent directory of the current translation unit. This is particularly useful when cross-compiling.
Example .ycm_extra_flags:
# Additionnal flags for ycmd
--sysroot="/path/to/your/toolchain/libc" # if you are cross-compiling
If your build system doesn't handle the creation of a compile_commands.json, you can use tools such as Bear or scan-build to generate it, which both work with almost any build system.
Key Bindings
Adds SPC m g g
go to definition binding to c++-mode
as well as SPC m g G
for the more imprecise but faster version.