Spec-Zone.ru › CMake 3.22

if

Условно выполняет группу команд.

Синопсис

if(<condition>)
  <commands>
elseif(<condition>) # optional block, can be repeated
  <commands>
else()              # optional block
  <commands>
endif()

Оценивает аргумент condition в блоке if в соответствии с синтаксисом условия, описанным ниже. Если результат — истина, то выполняется commands в блоке if. В противном случае обрабатываются необязательные блоки elseif. Наконец, если ни одно условие condition не является истинным, выполняется commands в необязательном блоке else.

По унаследованному принципу, команды else() и endif() допускают необязательный аргумент <condition>. Если он используется, он должен быть точной копией аргумента открывающей команды if.

Синтаксис условия

Следующий синтаксис применяется к аргументу condition в блоках if, elseif и while().

Составные условия оцениваются в следующем порядке приоритетов: в первую очередь оцениваются вложенные скобки. Затем идут унарные проверки, такие как EXISTS, COMMAND и DEFINED. Затем бинарные проверки, такие как EQUAL, LESS, LESS_EQUAL, GREATER, GREATER_EQUAL, STREQUAL, STRLESS, STRLESS_EQUAL, STRGREATER, STRGREATER_EQUAL, VERSION_EQUAL, VERSION_LESS, VERSION_LESS_EQUAL, VERSION_GREATER, VERSION_GREATER_EQUAL и MATCHES. Затем логические операторы в порядке NOT, AND и, наконец, OR.

Основные выражения

if(<constant>)

Истина, если константа равна 1, ON, YES, TRUE, Y, или не равно нулю. Ложь, если константа равна 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, пустая строка или заканчивается на -NOTFOUND. Имена логических констант нечувствительны к регистру. Если аргумент не является одной из этих специфических констант, он обрабатывается как переменная или строка (см. расширение переменных ниже) и применяется одна из двух следующих форм.

if(<variable>)

Истина, если переменная определена со значением, которое не является ложной константой. Ложь в противном случае, в том числе если переменная не определена. Обратите внимание, что аргументы макросов не являются переменными. Переменные окружения также не могут быть проверены таким образом, например, if(ENV{some_var}) всегда будет оцениваться как ложь.

if(<string>)

Строка в кавычках всегда оценивается как ложь, если только:

  • Значение строки является одной из истинных констант, или
  • Политика CMP0054 не установлена в NEW и значение строки случайно является именем переменной, на которую влияет поведение CMP0054.

Логические операторы

if(NOT <condition>)

Истина, если условие не истинно.

if(<cond1> AND <cond2>)

Истина, если оба условия считаются истинными индивидуально.

if(<cond1> OR <cond2>)

Истина, если хотя бы одно условие считается истинным индивидуально.

if((condition) AND (condition OR (condition)))

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

Проверки существования

if(COMMAND command-name)

Истина, если данное имя является командой, макросом или функцией, которые можно вызвать.

if(POLICY policy-id)

Истина, если данное имя является существующей политикой (в формате CMP<NNNN>).

if(TARGET target-name)

Истина, если данное имя является существующим логическим именем цели, созданным вызовом команды add_executable(), add_library() или add_custom_target(), которая уже была вызвана (в любом каталоге).

if(TEST test-name)

Новое в версии 3.3: Истина, если данное имя является существующим именем теста, созданным командой add_test().

if(DEFINED <name>|CACHE{<name>}|ENV{<name>})

Истина, если переменная, переменная кэша или переменная окружения с заданным <name> определена. Значение переменной не имеет значения. Обратите внимание, что аргументы макросов не являются переменными.

Новое в версии 3.14: Добавлена поддержка переменных CACHE{<name>}.

if(<variable|string> IN_LIST <variable>)

Новое в версии 3.3: Истина, если данный элемент содержится в переменной списка с указанным именем.

Операции с файлами

if(EXISTS path-to-file-or-directory)

Истина, если указанный файл или каталог существует. Поведение определено только для явных полных путей (ведущий ~/ не расширяется как домашний каталог и рассматривается как относительный путь). Учитываются символические ссылки, т.е. если указанный файл или каталог является символической ссылкой, возвращается true, если целевой объект символической ссылки существует.

if(file1 IS_NEWER_THAN file2)

Истина, если file1 новее, чем file2, или если один из двух файлов не существует. Поведение определено только для полных путей. Если метки времени файлов точно совпадают, сравнение IS_NEWER_THAN возвращает истину, поэтому любые зависящие операции построения будут выполняться в случае ничьей. Это включает случай, когда для file1 и file2 передается одно и то же имя файла.

if(IS_DIRECTORY path-to-directory)

Истина, если указанное имя — это каталог. Поведение определено только для полных путей.

if(IS_SYMLINK file-name)

Истина, если указанное имя — это символическая ссылка. Поведение определено только для полных путей.

if(IS_ABSOLUTE path)

Истина, если указанный путь — абсолютный путь. Обратите внимание на следующие особые случаи:

  • Пустой path оценивается как ложь.
  • На хостах Windows любой path, начинающийся с буквы диска и двоеточия (например, C:), прямой слеш или обратный слеш, оценивается как истина. Это означает, что путь вроде C:no\base\dir оценивается как истина, даже если относительная часть пути не является буквой диска.
  • На хостах, отличных от Windows, любой path, начинающийся с тильды (~), оценивается как истина.

Сравнения

if(<variable|string> MATCHES regex)

Истина, если заданная строка или значение переменной соответствует заданному регулярному выражению. См. Спецификация регулярных выражений для формата регулярного выражения.

Новое в версии 3.9: Группы () захватываются в переменные CMAKE_MATCH_<n>.

if(<variable|string> LESS <variable|string>)

Истина, если заданное значение строки или переменной является допустимым числом и меньше, чем значение справа.

if(<variable|string> GREATER <variable|string>)

Истина, если заданное значение строки или переменной является допустимым числом и больше, чем значение справа.

if(<variable|string> EQUAL <variable|string>)

Истина, если заданное значение строки или переменной является допустимым числом и равно значению справа.

if(<variable|string> LESS_EQUAL <variable|string>)

Новое в версии 3.7: Истина, если заданное значение строки или переменной является допустимым числом и меньше или равно значению справа.

if(<variable|string> GREATER_EQUAL <variable|string>)

Новое в версии 3.7: Истина, если заданное значение строки или переменной является допустимым числом и больше или равно значению справа.

if(<variable|string> STRLESS <variable|string>)

Истина, если заданное значение строки или переменной лексикографически меньше, чем строка или переменная справа.

if(<variable|string> STRGREATER <variable|string>)

Истина, если заданное значение строки или переменной лексикографически больше, чем строка или переменная справа.

if(<variable|string> STREQUAL <variable|string>)

Истина, если заданное значение строки или переменной лексикографически равно строке или переменной справа.

if(<variable|string> STRLESS_EQUAL <variable|string>)

Новое в версии 3.7: Истина, если заданное значение строки или переменной лексикографически меньше или равно значению справа.

if(<variable|string> STRGREATER_EQUAL <variable|string>)

Новое в версии 3.7: Истинно, если значение заданной строки или переменной лексикографически больше или равно строке или переменной справа.

Сравнения версий

if(<variable|string> VERSION_LESS <variable|string>)

Покомпонентное сравнение целочисленных номеров версий (формат версии major[.minor[.patch[.tweak]]], пропущенные компоненты считаются нулём). Любой нецелочисленный компонент версии или нецелочисленная конечная часть компонента версии эффективно обрезает строку в этом месте.

if(<variable|string> VERSION_GREATER <variable|string>)

Покомпонентное сравнение целочисленных номеров версий (формат версии major[.minor[.patch[.tweak]]], пропущенные компоненты считаются нулём). Любой нецелочисленный компонент версии или нецелочисленная конечная часть компонента версии эффективно обрезает строку в этом месте.

if(<variable|string> VERSION_EQUAL <variable|string>)

Покомпонентное сравнение целочисленных номеров версий (формат версии major[.minor[.patch[.tweak]]], пропущенные компоненты считаются нулём). Любой нецелочисленный компонент версии или нецелочисленная конечная часть компонента версии эффективно обрезает строку в этом месте.

if(<variable|string> VERSION_LESS_EQUAL <variable|string>)

Новое в версии 3.7: Покомпонентное сравнение целочисленных номеров версий (формат версии major[.minor[.patch[.tweak]]], пропущенные компоненты считаются нулём). Любой нецелочисленный компонент версии или нецелочисленная конечная часть компонента версии эффективно обрезает строку в этом месте.

if(<variable|string> VERSION_GREATER_EQUAL <variable|string>)

Новое в версии 3.7: Покомпонентное сравнение целочисленных номеров версий (формат версии major[.minor[.patch[.tweak]]], пропущенные компоненты считаются нулём). Любой нецелочисленный компонент версии или нецелочисленная конечная часть компонента версии эффективно обрезает строку в этом месте.

Расширение переменных

Команда if была написана очень рано в истории CMake, до синтаксиса оценки переменных ${}, и для удобства оценивает переменные, именованные её аргументами, как показано в вышеуказанных подписях. Обратите внимание, что обычная оценка переменных с ${} применяется до того, как команда if даже получит аргументы. Поэтому код, подобный

set(var1 OFF)
set(var2 "var1")
if(${var2})

предстаёт перед командой if как

if(var1)

и оценивается в соответствии с описанным выше случаем if(<variable>). Результат — OFF, что ложно. Однако, если мы удалим ${} из примера, то команда увидит

if(var2)

что истинно, потому что var2 определено как var1, что не является ложным значением.

Автоматическая оценка применяется в других случаях, когда синтаксис условия, описанный выше, принимает <variable|string>:

  • Сначала проверяется левое аргумент к MATCHES, чтобы определить, является ли это определённой переменной; если да, используется значение переменной, в противном случае используется исходное значение.
  • Если левого аргумента к MATCHES нет, возвращается ложь без ошибки.
  • И левый, и правый аргументы к LESS, GREATER, EQUAL, LESS_EQUAL, и GREATER_EQUAL, независимо проверяются на наличие определённых переменных; если да, используются их определённые значения, в противном случае используются исходные значения.
  • И левый, и правый аргументы к STRLESS, STRGREATER, STREQUAL, STRLESS_EQUAL, и STRGREATER_EQUAL, независимо проверяются на наличие определённых переменных; если да, используются их определённые значения, в противном случае используются исходные значения.
  • И левый, и правый аргументы к VERSION_LESS, VERSION_GREATER, VERSION_EQUAL, VERSION_LESS_EQUAL, и VERSION_GREATER_EQUAL, независимо проверяются на наличие определённых переменных; если да, используются их определённые значения, в противном случае используются исходные значения.
  • Правый аргумент к NOT проверяется на то, является ли он булевым константой; если да, используется это значение, в противном случае предполагается, что это переменная, и она разыменовывается.
  • Левый и правый аргументы к AND и OR независимо проверяются на то, являются ли они булевыми константами; если да, они используются как таковые, в противном случае предполагается, что они являются переменными, и они разыменовываются.

Изменено в версии 3.1: Для предотвращения неоднозначности, потенциальные имена переменных или ключевых слов могут быть указаны в Цитата аргумента или Аргументе в скобках. Цитата или скобки переменной или ключевого слова будут интерпретироваться как строка и не разыменовываться и не интерпретироваться. См. политику CMP0054.

Автоматической оценки для переменных среды или кэша Ссылок на переменные нет. Их значения должны ссылаться как $ENV{<name>} или $CACHE{<name>} там, где синтаксис условия, описанный выше, принимает <variable|string>.

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

Spec-Zone.ru

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