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() -командных строках.

Составные условия оцениваются в следующем порядке приоритетов:

1. Скобки.
2. Унарные тесты, такие как EXISTS, COMMAND и DEFINED.
3. Бинарные тесты, такие как 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, PATH_EQUAL и MATCHES.
4. Унарный логический оператор NOT.
5. Бинарные логические операторы 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> определена. Значение переменной не имеет значения. Имейте в виду следующие оговорки:

• Аргументы макросов не являются переменными.
• Невозможно напрямую проверить, является ли <name> переменной не из кэша. Выражение if(DEFINED someName) будет оцениваться как истинное, если существует переменная кэша или переменная не из кэша someName. В сравнении, выражение if(DEFINED CACHE{someName}) будет оцениваться как истинное только если существует переменная кэша someName. Оба выражения нужно проверять, если вам нужно узнать, существует ли переменная не из кэша: if(DEFINED someName AND NOT DEFINED CACHE{someName}).

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

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

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

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

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

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

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(<variable|string> PATH_EQUAL <variable|string>)

Новое в версии 3.24.

Сравнивает два пути покомпонентно. Два пути равны только в том случае, если все компоненты обоих путей совпадают. Несколько разделителей путей фактически сводятся к одному разделителю, но обратите внимание, что обратные слэши не преобразуются в косые. Другая нормализация путей не выполняется.

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

# comparison is TRUE
if ("/a//b/c" PATH_EQUAL "/a/b/c")
   ...
endif()

# comparison is FALSE
if ("/a//b/c" STREQUAL "/a/b/c")
   ...
endif()

Дополнительные сведения см. в разделе cmake_path(COMPARE).

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

Команда 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, независимо проверяются на наличие определенных переменных; если переменная определена, используется ее значение, в противном случае используется исходное значение.
• Оба аргумента слева и справа у STRLESS, STRGREATER, STREQUAL, STRLESS_EQUAL, и STRGREATER_EQUAL независимо проверяются на наличие определенных переменных; если переменная определена, используется ее значение, в противном случае используется исходное значение.
• Оба аргумента слева и справа у VERSION_LESS, VERSION_GREATER, VERSION_EQUAL, VERSION_LESS_EQUAL, и VERSION_GREATER_EQUAL независимо проверяются на наличие определенных переменных; если переменная определена, используется ее значение, в противном случае используется исходное значение.
• Аргумент справа проверяется на наличие булевых констант; если константа определена, используется ее значение, в противном случае предполагается, что это переменная, и она дереференцируется.
• Аргументы слева и справа у NOT и AND независимо проверяются на наличие булевых констант; если константа определена, она используется как есть, в противном случае предполагается, что это переменные, и они дереференцируются.

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

См. также

• else()
• elseif()
• endif()