| 1 |
<!DOCTYPE html> |
| 2 |
<html><head> |
| 3 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| 4 |
<title>highlight.cmake</title> |
| 5 |
<meta name="generator" content="KF5::SyntaxHighlighting - Definition (CMake) - Theme (Breeze Light)"/> |
| 6 |
</head><body style="background-color:#ffffff;color:#1f1c1b"><pre> |
| 7 |
<span style="color:#898887;"># This CMakeLists.txt doesn't do anything useful,</span> |
| 8 |
<span style="color:#898887;"># but it shoudl demonstrate the cmake syntax highlighting</span> |
| 9 |
<span style="color:#898887;">#</span> |
| 10 |
<span style="color:#898887;"># Alex Turbov <[email protected]></span> |
| 11 |
<span style="color:#898887;">#</span> |
| 12 |
|
| 13 |
<span style="color:#0057ae;background-color:#e0e9f8;">#[[.rst:</span> |
| 14 |
<span style="color:#898887;">Demo</span> |
| 15 |
<span style="color:#898887;">----</span> |
| 16 |
|
| 17 |
<span style="color:#898887;">This is an </span><span style="font-weight:bold;">**RST**</span><span style="color:#898887;"> documentation.</span> |
| 18 |
|
| 19 |
<span style="color:#0057ae;">::</span> |
| 20 |
|
| 21 |
<span style="color:#0057ae;"> # Sample code block</span> |
| 22 |
<span style="color:#0057ae;"> blah-blah</span> |
| 23 |
|
| 24 |
<span style="color:#898887;">But we are about to test CMake here ;-)</span> |
| 25 |
|
| 26 |
<span style="color:#0057ae;background-color:#e0e9f8;">#]]</span> |
| 27 |
|
| 28 |
<span style="font-weight:bold;">cmake_policy</span>(<span style="color:#006e28;">VERSION</span> <span style="color:#0057ae;">3.11</span>) |
| 29 |
|
| 30 |
<span style="font-weight:bold;">project</span>( |
| 31 |
Demo <span style="color:#006e28;">VERSION</span> <span style="color:#0057ae;">1.0</span> |
| 32 |
<span style="color:#006e28;">DESCRIPTION</span> <span style="color:#bf0303;">"For unit testing purposes"</span> |
| 33 |
<span style="color:#898887;"># </span><span style="color:#81ca2d;background-color:#f7e6e6;font-weight:bold;">NOTE</span><span style="color:#898887;"> that particular languages is a separate style</span> |
| 34 |
<span style="color:#898887;"># to highlight "special" (well known values)</span> |
| 35 |
<span style="color:#006e28;">LANGUAGES</span> <span style="color:#006e28;">C</span> <span style="color:#006e28;">CXX</span> |
| 36 |
) |
| 37 |
|
| 38 |
<span style="font-weight:bold;">set</span>(SOME_TRUE_OPTION <span style="color:#30a030;">TRUE</span>) <span style="color:#898887;"># `true` value</span> |
| 39 |
<span style="color:#898887;"># `false` value and "internal" variable</span> |
| 40 |
<span style="font-weight:bold;">set</span>(<span style="color:#0057ae;">_ANOTHER_FALSE_OPTION</span> <span style="color:#e05050;">OFF</span> <span style="color:#006e28;">CACHE</span> <span style="color:#006e28;">INTERNAL</span> <span style="color:#bf0303;">"Internal option"</span>) |
| 41 |
|
| 42 |
<span style="color:#898887;">#BEGIN Message block</span> |
| 43 |
<span style="font-weight:bold;">message</span>(<span style="color:#006e28;">FATAL_ERROR</span> <span style="color:#bf0303;">"Ordinal message do </span><span style="color:#b08000;">${VARIABLE_EXPANSION}</span><span style="color:#bf0303;">"</span>) |
| 44 |
<span style="font-weight:bold;">message</span>(<span style="color:#006e28;">AUTHOR_WARNING</span> <span style="color:#bf0303;">"... standard variables have a dedicated style"</span>) |
| 45 |
<span style="font-weight:bold;">message</span>(<span style="color:#006e28;">SEND_ERROR</span> <span style="color:#bf0303;">"e.g. </span><span style="color:#b08000;">${</span><span style="color:#c09050;">PROJECT_DESCRIPTION</span><span style="color:#b08000;">}</span><span style="color:#bf0303;"> or </span><span style="color:#b08000;">${</span><span style="color:#c09050;">CMAKE_COMMAND</span><span style="color:#b08000;">}</span><span style="color:#bf0303;">"</span>) |
| 46 |
<span style="font-weight:bold;">message</span>( |
| 47 |
<span style="color:#006e28;">STATUS</span> <span style="color:#bf0303;">[=[</span> |
| 48 |
<span style="color:#bf0303;"> Raw messages do not do ${VARIABLES_EXPANSION} or \n</span> |
| 49 |
<span style="color:#bf0303;"> escape symbols highlighting...</span> |
| 50 |
<span style="color:#bf0303;"> ]=]</span> |
| 51 |
) |
| 52 |
<span style="color:#898887;">#END Message block</span> |
| 53 |
|
| 54 |
<span style="color:#898887;"># </span><span style="color:#e85848;background-color:#451e1a;font-weight:bold;">ATTENTION</span><span style="color:#898887;"> Every command highlight only its own named keywords...</span> |
| 55 |
<span style="color:#898887;"># Also, note aliased (most of the time imported) targets higlighted as well</span> |
| 56 |
<span style="font-weight:bold;">add_library</span>(<span style="color:#b08000;">Foo::foo</span> <span style="color:#006e28;">IMPORTED</span> <span style="color:#006e28;">GLOBAL</span>) |
| 57 |
<span style="font-weight:bold;">set</span>(KW_HL IMPORTED GLOBAL) <span style="color:#898887;"># `IMPORTED` and `GLOBAL` are not highlighted here!</span> |
| 58 |
|
| 59 |
<span style="color:#898887;"># Properties are separate ("special value") style</span> |
| 60 |
<span style="font-weight:bold;">set_target_properties</span>(<span style="color:#b08000;">Foo::foo</span> <span style="color:#006e28;">PROPERTIES</span> <span style="color:#006e28;">LOCATION</span> <span style="color:#bf0303;">"</span><span style="color:#b08000;">${FOO_LIBRARY}</span><span style="color:#bf0303;">"</span>) |
| 61 |
|
| 62 |
<span style="color:#898887;"># Generator expressions</span> |
| 63 |
<span style="font-weight:bold;">target_compile_definitions</span>( |
| 64 |
<span style="color:#898887;"># </span><span style="color:#81ca2d;background-color:#f7e6e6;font-weight:bold;">NOTE</span><span style="color:#898887;"> Ok w/ CMake >= 3.11</span> |
| 65 |
<span style="color:#b08000;">Foo::foo</span> |
| 66 |
<span style="color:#b86050;">$<$<</span><span style="color:#b84040;font-weight:bold;">PLATFORM_ID</span><span style="color:#b86050;">:Windows>:WINDOWS_FOO></span> |
| 67 |
<span style="color:#b86050;">$<$<</span><span style="color:#b84040;font-weight:bold;">PLATFORM_ID</span><span style="color:#b86050;">:Linux>:</span> |
| 68 |
<span style="color:#b86050;"> LINUX_FOO</span> |
| 69 |
<span style="color:#b86050;"> $<$<</span><span style="color:#b84040;font-weight:bold;">BOOL</span><span style="color:#b86050;">:</span><span style="color:#b08000;">${</span><span style="color:#0057ae;">_has_foo</span><span style="color:#b08000;">}</span><span style="color:#b86050;">>:SOME_FOO_PATH=</span><span style="color:#b08000;">${</span><span style="color:#c09050;">PROJECT_BINARY_DIR</span><span style="color:#b08000;">}</span><span style="color:#b86050;">/foo></span> |
| 70 |
<span style="color:#b86050;"> ></span> |
| 71 |
) |
| 72 |
|
| 73 |
<span style="color:#0057ae;background-color:#e0e9f8;">#[=======================================================================[.rst:</span> |
| 74 |
<span style="color:#0057ae;">.. cmake:command:: </span><span style="color:#898887;">my_fun</span> |
| 75 |
|
| 76 |
<span style="font-style:italic;">*RST*</span><span style="color:#898887;"> documentation </span><span style="color:#0057ae;">``can``</span><span style="color:#898887;"> refer to </span><span style="font-weight:bold;">:cmake:command:</span><span style="color:#b08000;">`any_commands`</span><span style="color:#898887;"> or</span> |
| 77 |
<span style="font-weight:bold;">:cmake:variable:</span><span style="color:#b08000;">`variables`</span><span style="color:#898887;">...</span> |
| 78 |
|
| 79 |
<span style="color:#0057ae;">.. code-block:: cmake</span> |
| 80 |
<span style="color:#0057ae;"> :caption: **Synopsys**</span> |
| 81 |
|
| 82 |
<span style="color:#0057ae;"> my_fun([ANYTHING...])</span> |
| 83 |
|
| 84 |
<span style="color:#0057ae;background-color:#e0e9f8;">#]=======================================================================]</span> |
| 85 |
<span style="font-weight:bold;">function</span>(my_fun) |
| 86 |
<span style="color:#898887;"># </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold;">TODO</span><span style="color:#898887;"> Add implementation</span> |
| 87 |
<span style="font-weight:bold;">endfunction</span>() |
| 88 |
|
| 89 |
<span style="color:#644a9b;">my_fun</span>( |
| 90 |
<span style="color:#898887;"># Custom functions do not highlight "standard" named args ...</span> |
| 91 |
PUBLIC LOCATION PARENT_SCOPE |
| 92 |
<span style="color:#898887;"># only some well-known values ...</span> |
| 93 |
<span style="color:#e05050;">smth-NOTFOUND</span> <span style="color:#30a030;">ON</span> |
| 94 |
<span style="color:#898887;"># and standard variables</span> |
| 95 |
<span style="color:#c09050;">PROJECT_VERSION</span> |
| 96 |
<span style="color:#898887;"># or substitutions</span> |
| 97 |
<span style="color:#b08000;">$ENV{HOME}</span> OR <span style="color:#b08000;">${</span><span style="color:#0057ae;">_internal_var_is_grey</span><span style="color:#b08000;">}</span> |
| 98 |
) |
| 99 |
|
| 100 |
<span style="color:#898887;"># I dont'recall exactly, but there was some bug with `if`...</span> |
| 101 |
<span style="font-weight:bold;">if</span>((A <span style="color:#006e28;">AND</span> <span style="color:#bf0303;">"</span><span style="color:#b08000;">${B}</span><span style="color:#bf0303;">"</span>) <span style="color:#006e28;">OR</span> C <span style="color:#006e28;">OR</span> (var <span style="color:#006e28;">MATCHES</span> <span style="color:#bf0303;">"regex"</span>)) |
| 102 |
<span style="color:#898887;"># Anyway... it is Ok nowadays ;-)</span> |
| 103 |
|
| 104 |
<span style="font-weight:bold;">elseif</span>(<span style="color:#006e28;">POLICY</span> CMP066) |
| 105 |
<span style="font-weight:bold;">add_executable</span>(<span style="color:#b08000;">${</span><span style="color:#c09050;">PROJECT_NAME</span><span style="color:#b08000;">}</span> <span style="color:#b08000;">${</span><span style="color:#c09050;">PROJECT_NAME</span><span style="color:#b08000;">}</span><span style="color:#b08000;">.cc</span>) |
| 106 |
<span style="font-weight:bold;">target_link_libraries</span>( |
| 107 |
<span style="color:#b08000;">${</span><span style="color:#c09050;">PROJECT_NAME</span><span style="color:#b08000;">}</span> |
| 108 |
<span style="color:#b08000;">PRIVATE</span> |
| 109 |
<span style="color:#b08000;">Qt5::Core</span> |
| 110 |
<span style="color:#b86050;">$<$<</span><span style="color:#b84040;font-weight:bold;">BOOL</span><span style="color:#b86050;">:</span><span style="color:#b08000;">${HAS_FOO}</span><span style="color:#b86050;">>:</span><span style="color:#b08000;">Foo::foo</span><span style="color:#b86050;">></span> |
| 111 |
) |
| 112 |
|
| 113 |
<span style="font-weight:bold;">endif</span>() |
| 114 |
|
| 115 |
<span style="color:#898887;"># In each function call below, all 3 named parameter lines should apply the same highlighting.</span> |
| 116 |
<span style="font-weight:bold;">add_custom_command</span>( |
| 117 |
<span style="color:#006e28;">COMMAND</span> <span style="color:#30a030;">true</span> |
| 118 |
<span style="color:#006e28;">COMMAND</span> (<span style="color:#30a030;">true</span>) |
| 119 |
<span style="color:#006e28;">COMMAND</span> <span style="color:#30a030;">true</span> |
| 120 |
) |
| 121 |
<span style="font-weight:bold;">add_custom_target</span>(<span style="color:#b08000;">TargetName</span> |
| 122 |
<span style="color:#006e28;">WORKING_DIRECTORY</span> somedir |
| 123 |
<span style="color:#006e28;">COMMAND</span> (<span style="color:#30a030;">true</span>) |
| 124 |
<span style="color:#006e28;">BYPRODUCTS</span> somefile |
| 125 |
) |
| 126 |
<span style="font-weight:bold;">execute_process</span>( |
| 127 |
<span style="color:#006e28;">COMMAND</span> <span style="color:#30a030;">true</span> |
| 128 |
<span style="color:#006e28;">COMMAND</span> (<span style="color:#30a030;">true</span>) |
| 129 |
<span style="color:#006e28;">COMMAND</span> <span style="color:#30a030;">true</span> |
| 130 |
) |
| 131 |
<span style="font-weight:bold;">add_test</span>( |
| 132 |
<span style="color:#006e28;">NAME</span> sometest |
| 133 |
<span style="color:#006e28;">COMMAND</span> (<span style="color:#30a030;">true</span>) |
| 134 |
<span style="color:#006e28;">WORKING_DIRECTORY</span> somedir |
| 135 |
) |
| 136 |
|
| 137 |
<span style="color:#898887;"># nested parentheses</span> |
| 138 |
<span style="font-weight:bold;">if</span>( <span style="color:#30a030;">true</span> <span style="color:#006e28;">AND</span> ( <span style="color:#e05050;">false</span> <span style="color:#006e28;">OR</span> (<span style="color:#bf0303;">"</span><span style="color:#b08000;">${</span><span style="color:#c09050;">CMAKE_CXX_COMPILER_ID</span><span style="color:#b08000;">}</span><span style="color:#bf0303;">"</span> <span style="color:#006e28;">STREQUAL</span> <span style="color:#bf0303;">"Clang"</span>) ) ) |
| 139 |
<span style="font-weight:bold;">endif</span>() |
| 140 |
</pre></body></html> |