diff options
author | Brad King <brad.king@kitware.com> | 2020-05-21 17:25:13 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2020-05-21 17:36:52 (GMT) |
commit | 94c1e4fdb35c01ef5ad57ed3284b20d8d7fc3496 (patch) | |
tree | b2dd5a73b5839d50fa6f5fb0af2c356b69815db5 /Help/command/cmake_language.rst | |
parent | 3c5d52579b271e99475873cec953a1ecccbea585 (diff) | |
download | CMake-94c1e4fdb35c01ef5ad57ed3284b20d8d7fc3496.zip CMake-94c1e4fdb35c01ef5ad57ed3284b20d8d7fc3496.tar.gz CMake-94c1e4fdb35c01ef5ad57ed3284b20d8d7fc3496.tar.bz2 |
cmake_language: Rename command from cmake_command
Also rename the `INVOKE` signature to `CALL`.
Fixes: #20732
Diffstat (limited to 'Help/command/cmake_language.rst')
-rw-r--r-- | Help/command/cmake_language.rst | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/Help/command/cmake_language.rst b/Help/command/cmake_language.rst new file mode 100644 index 0000000..21f51a0 --- /dev/null +++ b/Help/command/cmake_language.rst @@ -0,0 +1,90 @@ +cmake_language +-------------- + +Call meta-operations on CMake commands. + +Synopsis +^^^^^^^^ + +.. parsed-literal:: + + cmake_language(`CALL`_ <command> [<args>...]) + cmake_language(`EVAL`_ CODE <code>...) + +Introduction +^^^^^^^^^^^^ + +This command will call meta-operations on built-in CMake commands or +those created via the :command:`macro` or :command:`function` commands. + +``cmake_language`` does not introduce a new variable or policy scope. + +Calling Commands +^^^^^^^^^^^^^^^^ + +.. _CALL: + +.. code-block:: cmake + + cmake_language(CALL <command> [<args>...]) + +Calls the named ``<command>`` with the given arguments (if any). +For example, the code: + +.. code-block:: cmake + + set(message_command "message") + cmake_language(CALL ${message_command} STATUS "Hello World!") + +is equivalent to + +.. code-block:: cmake + + message(STATUS "Hello World!") + +Evaluating Code +^^^^^^^^^^^^^^^ + +.. _EVAL: + +.. code-block:: cmake + + cmake_language(EVAL CODE <code>...) + +Evaluates the ``<code>...`` as CMake code. + +For example, the code: + +.. code-block:: cmake + + set(A TRUE) + set(B TRUE) + set(C TRUE) + set(condition "(A AND B) OR C") + + cmake_language(EVAL CODE " + if (${condition}) + message(STATUS TRUE) + else() + message(STATUS FALSE) + endif()" + ) + +is equivalent to + +.. code-block:: cmake + + set(A TRUE) + set(B TRUE) + set(C TRUE) + set(condition "(A AND B) OR C") + + file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/eval.cmake " + if (${condition}) + message(STATUS TRUE) + else() + message(STATUS FALSE) + endif()" + ) + + include(${CMAKE_CURRENT_BINARY_DIR}/eval.cmake) |