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