Spec-Zone.ru › CMake 3.5

cmake_parse_arguments

cmake_parse_arguments предназначен для использования в макросах или функциях для обработки аргументов, переданных этому макросу или функции. Он обрабатывает аргументы и определяет набор переменных, содержащих значения соответствующих опций.

cmake_parse_arguments(<prefix> <options> <one_value_keywords>
                      <multi_value_keywords> args...)

Аргумент <options> содержит все опции для соответствующего макроса, то есть ключевые слова, которые могут быть использованы при вызове макроса без последующего значения, например, ключевое слово OPTIONAL команды install().

Аргумент <one_value_keywords> содержит все ключевые слова для этого макроса, за которыми следует одно значение, например, ключевое слово DESTINATION команды install().

Аргумент <multi_value_keywords> содержит все ключевые слова для этого макроса, за которыми могут следовать более одного значения, например, ключевые слова TARGETS или FILES команды install().

Примечание

Все ключевые слова должны быть уникальными. То есть каждое ключевое слово должно быть указано только один раз в <options>, <one_value_keywords> или <multi_value_keywords>. Будет выведено предупреждение, если уникальность нарушена.

По окончании работы, cmake_parse_arguments будет определено для каждого из ключевых слов, перечисленных в <options>, <one_value_keywords> и <multi_value_keywords>, переменная, составленная из заданного <prefix> и "_", и имени соответствующего ключевого слова. Эти переменные будут содержать соответствующее значение из списка аргументов. Для ключевых слов <options> это будет TRUE или FALSE.

Все оставшиеся аргументы собираются в переменную <prefix>_UNPARSED_ARGUMENTS, что позволяет проверить, был ли ваш макрос вызван с нераспознанными параметрами.

В качестве примера здесь приведен макрос my_install(), который принимает аналогичные аргументы, как и реальная команда install():

function(MY_INSTALL)
    set(options OPTIONAL FAST)
    set(oneValueArgs DESTINATION RENAME)
    set(multiValueArgs TARGETS CONFIGURATIONS)
    cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}"
                          "${multiValueArgs}" ${ARGN} )

    # ...

Предположим, что my_install() был вызван следующим образом:

my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub)

После вызова cmake_parse_arguments макрос установит следующие переменные:

MY_INSTALL_OPTIONAL = TRUE
MY_INSTALL_FAST = FALSE (was not used in call to my_install)
MY_INSTALL_DESTINATION = "bin"
MY_INSTALL_RENAME = "" (was not used)
MY_INSTALL_TARGETS = "foo;bar"
MY_INSTALL_CONFIGURATIONS = "" (was not used)
MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (nothing expected after "OPTIONAL")

Затем вы можете продолжить и обработать эти переменные.

Ключевые слова завершают списки значений, например, если непосредственно после one_value_keyword следует другое распознанное ключевое слово, это интерпретируется как начало новой опции. Например, my_install(TARGETS foo DESTINATION OPTIONAL) приведет к тому, что MY_INSTALL_DESTINATION будет установлено в "OPTIONAL", но поскольку OPTIONAL само является ключевым словом, MY_INSTALL_DESTINATION будет пустым, а MY_INSTALL_OPTIONAL будет установлено в TRUE.

© 2000–2019 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.5/command/cmake_parse_arguments.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API