kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Clarify that ARGV# beyond ARGC will have an undefined behavior (#15380)

This commit is contained in:
Daniele E. Domenichelli 2015-02-06 16:53:44 +01:00
parent e3363bfbec
commit 4efef3f775
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Help/command/function.rst
View File

@ -24,6 +24,10 @@ This facilitates creating functions with optional arguments.
Additionally ``ARGV`` holds the list of all arguments given to the Additionally ``ARGV`` holds the list of all arguments given to the
function and ``ARGN`` holds the list of arguments past the last expected function and ``ARGN`` holds the list of arguments past the last expected
argument. 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.
A function opens a new scope: see :command:`set(var PARENT_SCOPE)` for A function opens a new scope: see :command:`set(var PARENT_SCOPE)` for
details. details.

13
Help/command/macro.rst
View File

@ -24,6 +24,10 @@ This facilitates creating macros with optional arguments.
Additionally ``${ARGV}`` holds the list of all arguments given to the Additionally ``${ARGV}`` holds the list of all arguments given to the
macro and ``${ARGN}`` holds the list of arguments past the last expected macro and ``${ARGN}`` holds the list of arguments past the last expected
argument. 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.
See the :command:`cmake_policy()` command documentation for the behavior See the :command:`cmake_policy()` command documentation for the behavior
of policies inside macros. of policies inside macros.
@ -37,10 +41,15 @@ replacements much like the C preprocessor would do with a macro.
Therefore you will NOT be able to use commands like:: Therefore you will NOT be able to use commands like::
if(ARGV1) # ARGV1 is not a variable 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 foreach(loop_var IN LISTS ARGN) # ARGN is not a variable
In the first case you can use ``if(${ARGV1})``, in the second case, you can In the first case, you can use ``if(${ARGV1})``.
use ``foreach(loop_var ${ARGN})`` but this will skip empty arguments. 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:: If you need to include them, you can use::
set(list_var "${ARGN}") set(list_var "${ARGN}")