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>]
        [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>...

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

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

LINK_OPTIONS <options>...

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

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 значения, которые исполняемый файл выдал бы, если бы он был запущен на целевой платформе. Эти записи кэша:

<runResultVar>

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

<runResultVar>__TRYRUN_OUTPUT

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

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