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

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

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