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

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

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