try_run

• Попробовать скомпилировать и запустить исходные файлы
• Другие настройки поведения
• Поведение при кросс-компиляции

Попробуйте скомпилировать и затем запустить некоторый код.

Попробовать скомпилировать и запустить исходные файлы

try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR
        bindir srcfile [CMAKE_FLAGS <flags>...]
        [COMPILE_DEFINITIONS <defs>...]
        [LINK_LIBRARIES <libs>...]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [RUN_OUTPUT_VARIABLE <var>]
        [OUTPUT_VARIABLE <var>]
        [ARGS <args>...])

Попробуйте скомпилировать <srcfile>. Возвращает TRUE или FALSE для успешного или неудачного завершения COMPILE_RESULT_VAR. Если компиляция прошла успешно, выполняет исполняемый файл и возвращает его код завершения в RUN_RESULT_VAR. Если исполняемый файл был построен, но не смог запуститься, то RUN_RESULT_VAR будет установлено в FAILED_TO_RUN. См. команду try_compile() для получения информации о том, как проект тестирования построен для сборки исходного файла.

Доступны следующие варианты:

CMAKE_FLAGS <flags>...

Укажите флаги вида -DVAR:TYPE=VALUE для передачи в командную строку cmake, используемую для управления сборкой теста. Пример в try_compile() демонстрирует, как используются значения для переменных INCLUDE_DIRECTORIES, LINK_DIRECTORIES, и LINK_LIBRARIES.

COMPILE_DEFINITIONS <defs>...

Укажите -Ddefinition аргументы для передачи в add_definitions в сгенерированном проекте теста.

COMPILE_OUTPUT_VARIABLE <var>

Выводите в заданной переменной результат сборки шага компиляции.

LINK_LIBRARIES <libs>...

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

Если этот параметр указан, любое значение -DLINK_LIBRARIES=... , заданное параметру CMAKE_FLAGS, будет проигнорировано.

OUTPUT_VARIABLE <var>

Выводите в заданной переменной результат сборки компиляции и вывод из запуска исполняемого файла. Этот параметр существует по историческим причинам. Предпочтите использовать COMPILE_OUTPUT_VARIABLE и RUN_OUTPUT_VARIABLE.

RUN_OUTPUT_VARIABLE <var>

Выводите в заданной переменной вывод от запуска исполняемого файла.

Другие настройки поведения

Установите переменную CMAKE_TRY_COMPILE_CONFIGURATION для выбора конфигурации сборки.

Поведение при кросс-компиляции

При кросс-компиляции исполняемый файл, скомпилированный на первом шаге, обычно не может быть запущен на хосте сборки. Команда try_run проверяет переменную CMAKE_CROSSCOMPILING, чтобы определить, находится ли CMake в режиме кросс-компиляции. В этом случае он всё ещё попытается скомпилировать исполняемый файл, но не будет пытаться запустить исполняемый файл, если не задана переменная CMAKE_CROSSCOMPILING_EMULATOR. Вместо этого он создаст переменные кэша, которые должны быть заполнены пользователем или заданы по умолчанию в скрипте CMake для значений, которые исполняемый файл произвёл бы, если бы был запущен на целевой платформе. Эти записи кэша:

<RUN_RESULT_VAR>

Код завершения, если исполняемый файл был бы запущен на целевой платформе.

<RUN_RESULT_VAR>__TRYRUN_OUTPUT

Вывод из stdout и stderr, если исполняемый файл был бы запущен на целевой платформе. Это создаётся только в случае использования параметра RUN_OUTPUT_VARIABLE или OUTPUT_VARIABLE.

Чтобы упростить кросс-компиляцию вашего проекта, используйте try_run только в случае крайней необходимости. Если вы используете try_run, используйте параметры RUN_OUTPUT_VARIABLE или OUTPUT_VARIABLE только в случае крайней необходимости. Их использование потребует, чтобы при кросс-компиляции переменные кэша были заданы вручную для вывода исполняемого файла. Вы также можете «защитить» вызовы try_run блоком if(), проверяющим переменную CMAKE_CROSSCOMPILING и предоставить удобную альтернативу для этого случая.