File: parser-cmake.rst

package info (click to toggle)
universal-ctags 0%2Bgit20181215-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 17,444 kB
  • sloc: ansic: 84,242; vhdl: 5,924; sh: 5,830; perl: 1,743; cpp: 1,599; cs: 1,193; python: 812; sql: 572; f90: 534; php: 479; yacc: 459; fortran: 341; makefile: 325; asm: 311; objc: 284; ruby: 261; xml: 245; java: 157; tcl: 133; cobol: 122; lisp: 113; erlang: 61; ada: 55; ml: 49; awk: 43
file content (36 lines) | stat: -rw-r--r-- 1,106 bytes parent folder | download | duplicates (7) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
.. _cmake:

======================================================================
CMake parser
======================================================================

The CMake parser is used for ``.cmake`` and ``CMakeLists.txt`` files.
It generates tags for the following items:

- User-defined functions
- User-defined macros
- User-defined options created by ``option()``
- Variables defined by ``set()``
- Targets created by ``add_custom_target()``, ``add_executable()`` and ``add_library()``

The parser uses the experimental multi-table regex ``ctags`` options to
perform the parsing and tag generation.

Caveats:

	Names that are ``${}`` references to variables are not tagged.

	For example, given the following::

	    set(PROJECT_NAME_STR ${PROJECT_NAME})
	    add_executable( ${PROJECT_NAME_STR} ... )
	    add_custom_target( ${PROJECT_NAME_STR}_tests ... )
	    add_library( sharedlib ... )

	...the variable ``PROJECT_NAME_STR`` and target ``sharedlib`` will both be tagged,
	but the other targets will not be.


References:

	https://cmake.org/cmake/help/latest/manual/cmake-language.7.html