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 и предоставляя лёгкий способ предварительной установки альтернативы для этого случая.