cmake-ide
is a package to enable IDE-like features on Emacs for
CMake projects. It also supports non-CMake
projects as long as a
compilation database
is generated out-of-band.This includes autocompletion and on-the-fly
syntax checking in Emacs for CMake projects with minimal
configuration. It uses other packages to do its heavy lifting, in a
combination of:
cmake-ide
will set variables and call functions for the installed
dependent packages.
It works by running CMake in Emacs in order to obtain the necessary compiler flags to pass to the other tools. Since all the dependencies are specified in the CMake scripts, there is no need to maintain a parallel dependency tracking system for Emacs. Just ask CMake.
auto-complete-clang
, flycheck
and others for a CMakecmake-ide-build-dir
to be set.cmake-ide-delete-file
allows you to have the same convenience whencmake-ide-build-dir
is set, it is considered to be the buildcmake-ide-compile
to compile the project there. It automaticallycmake-compile-command
variable.cmake-ide
can make usage of(require 'rtags)
is called beforecmake-ide-setup
, it will automatically start the rtags server (rdm
)rc -J
to index the project files for 0-config "jump tordm
and rc
and in the system path or if cmake-ide-rdm-executable
cmake-ide-rc-executable
are customized correctly.cmake-ide
can automatically create build directories for you -- either in the system's
tmp-directory or under cmake-ide-build-pool-dir
(if set). By default, all automatically
created build directories (no matter where created) will have temporary and unique names,
that will change with each new session and are thus not reusable. You can, however, by
setting cmake-ide-build-pool-use-persistent-naming
use a reproducible naming scheme that
is based on the project's path and will not change as long as the project's path is the
same. This way, you can reuse the build directory.
By using both cmake-ide-build-pool-dir
and cmake-ide-build-pool-use-persistent-naming
,
you can fully do away with the need to configure a build directory per project with directory
local variables (for example).
Use .dir-locals.el
to set the cmake-ide-project-dir
and cmake-ide-build-dir
variables
(use absolute paths).
.dir-locals.el: ((nil . ((cmake-ide-build-dir . "/path/to/build/dir") (cmake-ide-project-dir . "/path/to/project/dir"))))
If a file called compile_commands.json
exists in cmake-ide-build-dir
,
it will work just as well as for CMake projects. Bear (https://github.com/rizsotto/Bear)
can be used to generate a compile_commands.json from a make command.
Install from MELPA or MELPA Stable with:
M-x package-install RET cmake-ide.
Add this to your .emacs
/ init.el
:
(require 'rtags) ;; optional, must have rtags installed
(cmake-ide-setup)
If cmake-ide-flags-c
or cmake-ide-flags-c++
are set, they will be
added to ac-clang-flags
and company-clang-arguments
. These
variables should be set. Particularly, they should contain the system
include paths (e.g. '("-I/usr/include/c++/4.9.1" "...")
. For a
system with gcc, you can get this information by running gcc -v -xc++ /dev/null -fsyntax-only
(it's the same prerequisite for
auto-complete-clang
to work, since that's how clang itself works).
And... that's it. It works by calling cmake and parsing the resulting
JSON file with compiler flags. Set cmake-ide-build-dir
to where your
project is being built and you won't have to call CMake manually again (except
for the first time to specify options). Best done with
directory local variables.