|
|
| (8 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| '''[http://www.gnu.org/software/emacs GNU Emacs]''' is the king of text editors, it has been around since the mid-1970:s and it still actively being developed. It is available on multiple platforms, including Microsoft Windows, [http://www.emacsformacosx.com Mac OS X], and Linux. It runs either as a modern windows-based application or you can use it in a terminal to edit on a remote machine. It can be extended using it's built-in programming language Emacs Lisp and there are literarily thousands of extensions available.
| | {{CMake/Template/Moved}} |
|
| |
|
| See the page [[CMake Editors Support]] for CMake support in other editors.
| | This page has moved [https://gitlab.kitware.com/cmake/community/wikis/doc/editors/Emacs here]. |
| | |
| = Modes =
| |
| | |
| == cmake-mode ==
| |
| | |
| See the [http://cmake.org/gitweb?p=cmake.git;a=blob_plain;hb=master;f=Auxiliary/cmake-mode.el combined syntax highlighting and indentation mode] in the CMake source tree. To enable it, add the following to your ''.emacs'' file:
| |
| | |
| <pre>
| |
| ; Add cmake listfile names to the mode list.
| |
| (setq auto-mode-alist
| |
| (append
| |
| '(("CMakeLists\\.txt\\'" . cmake-mode))
| |
| '(("\\.cmake\\'" . cmake-mode))
| |
| auto-mode-alist))
| |
| | |
| (autoload 'cmake-mode "~/CMake/Auxiliary/cmake-mode.el" t)
| |
| </pre>
| |
| | |
| == andersl-cmake-font-lock ==
| |
| | |
| The package [https://github.com/Lindydancer/cmake-font-lock andersl-cmake-font-lock] provides advanced font-lock support for CMake scripts.
| |
| | |
| Although the standard package have some syntax coloring support, this package raises the bar quite a bit. The main new feature is that arguments are colored according what type they are (the package is aware of all standard CMake functions, and can easily be extended with other functions).
| |
| | |
| The following is a list of things that are colored (taken from the
| |
| documentation):
| |
| | |
| * Comments and quoted strings.
| |
| * Special functions like <code>if</code>, <code>while</code>, <code>function</code>, and <code>include</code> are colored as font-lock <em>keywords</em> (not to be confused with keywords in the CMake sense).
| |
| * Other function name are colored as, well, <em>functions</em>.
| |
| * The arguments of functions are colored according to the type, as specified by the function <em>signature</em>. The built-in signatures can color an arguments as a <em>variable</em>, a <em>function</em>, a <em>property</em>, a <em>target</em>, a <em>policy</em>, and finally a CMake keyword is colored as a <em>type</em>.
| |
| * The constants <code>true</code>, <code>false</code>, <code>yes</code>, <code>no</code>, <code>y</code>, <code>n</code>, <code>on</code>, and <code>off</code> are colored as <em>constants</em>.
| |
| * <code>${...}</code> constructs are fontified as <em>variables</em>. Nested constructs are supported.
| |
| * For <code>$ENV{...}</code>, <code>ENV</code> is fontified as a <em>variable</em> and the content as a <em>constant</em>.
| |
| * For <code>$<name:...></code> constructs, <code>name</code> is colored as a <em>constant</em>.
| |
| * For preprocessor definitions like <code>-DNAME</code>, <code>NAME</code> is colored as a <em>constant</em>.
| |
| | |
| == company-mode (code completion in Emacs) ==
| |
| See [http://company-mode.github.io/ company-mode] , company-cmake.el is incorporated into company-mode since v0.6.12
| |
| | |
| == Jump focus between tags (if/else/endif, foreach/endforeach, ...) ==
| |
| See [https://github.com/redguardtoo/evil-matchit evil-matchit], install evil and evil-matchit, then just press %
| |
| | |
| == syntax check and other handy utilities ==
| |
| Install [https://github.com/redguardtoo/cpputils-cmake cpputils-cmake], then you can:
| |
| - open C++ header file at correct location,
| |
| - open gdb and append the full path of executable automatically
| |
| - set up include directories automatically for flymake
| |
| - set up include directories for code completion
| |
| | |
| = User Suggestions =
| |
| | |
| == Buffer Names ==
| |
| | |
| I've been long irritated with having to deal with multiple buffers all name CMakeLists.txt. Emacs by default will call them CMakeLists.txt, CMakeLists.txt<2>, CMakeLists.txt<3>, etc.. This is really hard to switch back and forth when the buffer names are difficult to associate with location.
| |
| | |
| I've found a couple of solutions to this problem.
| |
| | |
| <ol><li>Use uniquify emacs package. This gives several options to automatically rename buffers based on their location on disk.
| |
| | |
| <pre>
| |
| ;; uniquify.el is a helper routine to help give buffer names a better unique name.
| |
| (when (load "uniquify" 'NOERROR)
| |
| (require 'uniquify)
| |
| (setq uniquify-buffer-name-style 'forward)
| |
| ;(setq uniquify-buffer-name-style 'post-forward)
| |
| )
| |
| </pre>
| |
| </li>
| |
| | |
| <li>Rename the buffer as part of the cmake-mode
| |
| | |
| <pre>
| |
| (defun cmake-rename-buffer ()
| |
| "Renames a CMakeLists.txt buffer to cmake-<directory name>."
| |
| (interactive)
| |
| ;(print (concat "buffer-filename = " (buffer-file-name)))
| |
| ;(print (concat "buffer-name = " (buffer-name)))
| |
| (when (and (buffer-file-name) (string-match "CMakeLists.txt" (buffer-name)))
| |
| ;(setq file-name (file-name-nondirectory (buffer-file-name)))
| |
| (setq parent-dir (file-name-nondirectory (directory-file-name (file-name-directory (buffer-file-name)))))
| |
| ;(print (concat "parent-dir = " parent-dir))
| |
| (setq new-buffer-name (concat "cmake-" parent-dir))
| |
| ;(print (concat "new-buffer-name= " new-buffer-name))
| |
| (rename-buffer new-buffer-name t)
| |
| )
| |
| )
| |
| | |
| (add-hook 'cmake-mode-hook (function cmake-rename-buffer))
| |
| </pre>
| |
| </li></ol>
| |
| | |
| I actually prefer renaming my buffers with my cmake-rename-buffer function, because the buffer names start with a lower case letter. :)
| |
| | |
| == Better handling of _ for movement commands ==
| |
| | |
| The following will make <code>M-right</code> and <code>M-left</code> stop after each word of a multiword identifier like <code>add_custom_target</code>. Unfortunately, this breaks the font-lock support of the standard CMake package. However, it is compatible with the andersl-cmake-font-lock package.
| |
| | |
| (defun my-cmake-fix-underscrore ()
| |
| (modify-syntax-entry ?_ "_" cmake-mode-syntax-table))
| |
| (add-hook 'cmake-mode-hook 'my-cmake-fix-underscrore)
| |
