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>)

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

Ложь, если заданный путь — пустая строка.

if(IS_SYMLINK <path>)

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

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.

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

Сравнение по компонентам предпочтительнее сравнения по строкам из-за обработки нескольких символов-разделителей путей. В приведенном ниже примере выражение вычисляет значение true с помощью PATH_EQUAL, но false с 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 нет, он возвращает false без ошибки
• Оба аргумента слева и справа от 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 независимо проверяются на наличие булевых констант. Если да, они используются как таковые, иначе предполагается, что это переменные, и они дезагрегируются.

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

См. также

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