CMake Editors Support: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Replace content with link to new CMake community wiki)
 
(74 intermediate revisions by 28 users not shown)
Line 1: Line 1:
==CMake Editor Modes==
{{CMake/Template/Moved}}


There are [[CMake]] syntax highlighting and indentation supports for several editors:
This page has moved [https://gitlab.kitware.com/cmake/community/wikis/doc/Editors here].
 
* Emacs [http://www.cmake.org/CMakeDocs/cmake-mode.el combined syntax highlighting and indentation mode]. 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/Docs/cmake-mode.el" t)
</pre>
 
* VIM [http://www.cmake.org/CMakeDocs/cmake-syntax.vim syntax highlighting] and [http://www.cmake.org/CMakeDocs/cmake-indent.vim indentation mode]. To enable indentation, copy indentation file to your .vim/indent directory, syntax highlighting file to your .vim/syntax directory and add the following to your .vimrc:
 
<pre>
:autocmd BufRead,BufNewFile *.cmake,CMakeLists.txt,*.cmake.in runtime! indent/cmake.vim
:autocmd BufRead,BufNewFile *.cmake,CMakeLists.txt,*.cmake.in setf cmake
</pre>
 
* [http://kate.kde.org Kate], KWrite, [http://www.kdevelop.org KDevelop] and all other [http://www.kde.org KDE] applictions, which use the kate text-editing component support cmake syntax highlighting. Currently you have to open the settings dialog and choose download (Settings -> Configure Kate -> Editor -> Highlighting -> Download) and there select CMake in the listbox. Then the cmake syntax highlighting definition file for kate will be downloaded and installed. From KDE 3.4 and later cmake syntax highlighting will come with standard KDE.
 
* UltraEdit [wordfile.jpg syntaxhighlighting] (an approach)
[[Image:wordfile.jpg]]
 
==Creating New Editor Mode==
 
The best way to start is to check the logic in existing ones. Make sure to enable indentation for files that match the following file names:
 
* CMakeLists.txt
* *.cmake
* *.cmake.in
* *.ctest
* *.ctest.in

Latest revision as of 15:41, 30 April 2018


The CMake community Wiki has moved to the Kitware GitLab Instance.

This page has moved here.