try_run

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

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

Попытка компиляции и запуска исходных файлов

try_run(<runResultVar> <compileResultVar>
        <bindir> <srcfile> [CMAKE_FLAGS <flags>...]
        [COMPILE_DEFINITIONS <defs>...]
        [LINK_OPTIONS <options>...]
        [LINK_LIBRARIES <libs>...]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [RUN_OUTPUT_VARIABLE <var>]
        [OUTPUT_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...])

Попробуйте скомпилировать <srcfile>. Возвращает TRUE или FALSE для успешного или неудачного выполнения <compileResultVar>. Если компиляция прошла успешно, запустит исполняемый файл и вернёт его код возврата в <runResultVar>. Если исполняемый файл был создан, но не запущен, то <runResultVar> будет установлено значение 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>...

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

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

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

LINK_OPTIONS <options>...

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

Укажите параметры шага компоновки для передачи в target_link_options() в сгенерированном проекте.

OUTPUT_VARIABLE <var>

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

RUN_OUTPUT_VARIABLE <var>

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

WORKING_DIRECTORY <var>

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

Запустить исполняемый файл в указанной директории. Если WORKING_DIRECTORY не указан, исполняемый файл будет запущен в <bindir>.

Другие параметры поведения

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

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

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

<runResultVar>

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

<runResultVar>__TRYRUN_OUTPUT

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

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