CMakeMacroParseArguments: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
m (Reverted edit of Rd97918362, changed back to last version by Andy)
(Replace content with link to new CMake community wiki)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[CMake_User_Contributed_Macros|Back]]
{{CMake/Template/Moved}}


== Definition ==
This page has moved [https://gitlab.kitware.com/cmake/community/wikis/contrib/macros/ParseArguments here].
 
There is a general convention for CMake commands that take optional flags and/or variable arguments.  Optional flags are all caps and are added to the arguments to turn on.  Variable arguments have an all caps identifier to determine where each variable argument list starts.  The PARSE_ARGUMENTS macro, defined below, can be used by other macros to parse arguments defined in this way.  Note that this macro relies on the [[CMakeMacroListOperations#LIST_CONTAINS | LIST_CONTAINS]] command.
 
<pre>
MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
  SET(DEFAULT_ARGS)
  FOREACH(arg_name ${arg_names})
    SET(${prefix}_${arg_name})
  ENDFOREACH(arg_name)
  FOREACH(option ${option_names})
    SET(${prefix}_${option} FALSE)
  ENDFOREACH(option)
 
  SET(current_arg_name DEFAULT_ARGS)
  SET(current_arg_list)
  FOREACH(arg ${ARGN})
    LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
    IF (is_arg_name)
      SET(${prefix}_${current_arg_name} ${current_arg_list})
      SET(current_arg_name ${arg})
      SET(current_arg_list)
    ELSE (is_arg_name)
      LIST_CONTAINS(is_option ${arg} ${option_names})
      IF (is_option)
SET(${prefix}_${arg} TRUE)
      ELSE (is_option)
SET(current_arg_list ${current_arg_list} ${arg})
      ENDIF (is_option)
    ENDIF (is_arg_name)
  ENDFOREACH(arg)
  SET(${prefix}_${current_arg_name} ${current_arg_list})
ENDMACRO(PARSE_ARGUMENTS)
</pre>
 
== Usage ==
 
The PARSE_ARGUMENTS macro will take the arguments of another macro and define several variables.  The first argument to PARSE_ARGUMENTS is a prefix to put on all variables it creates.  The second argument is a list of names, and the third argument is a list of options.  Both of these lists should be quoted.  The rest of PARSE_ARGUMENTS are arguments from another macro to be parsed.
 
<tt>
:PARSE_ARGUMENTS(''prefix'' ''arg_names'' ''options'' ''arg1'' ''arg2''...)
</tt>
 
For each item in ''options'', PARSE_ARGUMENTS will create a variable with that name, prefixed with <tt>''prefix''_</tt>.  So, for example, if ''prefix'' is <tt>MY_MACRO</tt> and ''options'' is <tt>OPTION1;OPTION2</tt>, then PARSE_ARGUMENTS will create the variables MY_MACRO_OPTION1 and MY_MACRO_OPTION2. These variables will be set to true if the option exists in the command line or false otherwise.
 
For each item in ''arg_names'', PARSE_ARGUMENTS will create a variable with that name, prefixed with <tt>''prefix''_</tt>.  Each variable will be filled with the arguments that occur after the given arg_name is encountered up to the next arg_name or the end of the arguments.  All options are removed from these lists.  PARSE_ARGUMENTS also creates a <tt>''prefix''_DEFAULT_ARGS</tt> variable containing the list of all arguments up to the first arg_name encountered.
 
Here is a simple, albeit impractical, example of using PARSE_ARGUMENTS that demonstrates its behavior.
 
<pre>
SET(arguments
  hello OPTION3 world
  LIST3 foo bar
  OPTION2
  LIST1 fuz baz
  )
PARSE_ARGUMENTS(ARG "LIST1;LIST2;LIST3" "OPTION1;OPTION2;OPTION3" ${arguments})
</pre>
 
PARSE_ARGUMENTS creates 7 variables and sets them as follows:
*<tt>ARG_DEFAULT_ARGS</tt>: <tt>hello;world</tt>
*<tt>ARG_LIST1</tt>: <tt>fuz;baz</tt>
*<tt>ARG_LIST2</tt>: <tt></tt>
*<tt>ARG_LIST3</tt>: <tt>foo;bar</tt>
*<tt>ARG_OPTION1</tt>: <tt>FALSE</tt>
*<tt>ARG_OPTION2</tt>: <tt>TRUE</tt>
*<tt>ARG_OPTION3</tt>: <tt>TRUE</tt>
 
If you don't have any options, use an empty string in its place.
<pre>
PARSE_ARGUMENTS(ARG "LIST1;LIST2;LIST3" "" ${arguments})
</pre>
Likewise if you have no lists.
<pre>
PARSE_ARGUMENTS(ARG "" "OPTION1;OPTION2;OPTION3" ${arguments})
</pre>
 
== Example ==
 
-----
[[CMake_User_Contributed_Macros|Back]]
 
{{CMake/Template/Footer}}

Latest revision as of 15:41, 30 April 2018


The CMake community Wiki has moved to the Kitware GitLab Instance.

This page has moved here.