try_run

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

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

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

try_run(<runResultVar> <compileResultVar>
        [SOURCES_TYPE <type>]
        <SOURCES <srcfile...>                 |
         SOURCE_FROM_CONTENT <name> <content> |
         SOURCE_FROM_VAR <name> <var>         |
         SOURCE_FROM_FILE <name> <path>       >...
        [LOG_DESCRIPTION <text>]
        [NO_CACHE]
        [NO_LOG]
        [CMAKE_FLAGS <flags>...]
        [COMPILE_DEFINITIONS <defs>...]
        [LINK_OPTIONS <options>...]
        [LINK_LIBRARIES <libs>...]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
        [<LANG>_STANDARD <std>]
        [<LANG>_STANDARD_REQUIRED <bool>]
        [<LANG>_EXTENSIONS <bool>]
        [RUN_OUTPUT_VARIABLE <var>]
        [RUN_OUTPUT_STDOUT_VARIABLE <var>]
        [RUN_OUTPUT_STDERR_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

Попробуйте создать исполняемый файл из одного или нескольких исходных файлов. Успешная компиляция вернёт TRUE а неуспешная — FALSE в <compileResultVar>. Если компиляция прошла успешно, этот процесс запустит исполняемый файл и сохранит код завершения в <runResultVar>. Если исполняемый файл был создан, но не смог запуститься, тогда <runResultVar> будет установлено в FAILED_TO_RUN. См. команду try_compile() для документации об общих параметрах обеих команд, а также для информации о том, как построена тестовая проектная структура для компиляции исходного файла.

Должны быть указаны один или несколько исходных файлов. Кроме того, один из SOURCES и/или SOURCE_FROM_* должен предшествовать другим ключевым словам.

Эта команда поддерживает альтернативную сигнатуру для CMake, более раннего чем 3.25. Рекомендуется использовать указанную выше сигнатуру для ясности.

try_run(<runResultVar> <compileResultVar>
        <bindir> <srcfile|SOURCES srcfile...>
        [CMAKE_FLAGS <flags>...]
        [COMPILE_DEFINITIONS <defs>...]
        [LINK_OPTIONS <options>...]
        [LINK_LIBRARIES <libs>...]
        [LINKER_LANGUAGE <lang>]
        [COMPILE_OUTPUT_VARIABLE <var>]
        [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
        [<LANG>_STANDARD <std>]
        [<LANG>_STANDARD_REQUIRED <bool>]
        [<LANG>_EXTENSIONS <bool>]
        [RUN_OUTPUT_VARIABLE <var>]
        [OUTPUT_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

Параметры

Параметры, специфичные для try_run:

COMPILE_OUTPUT_VARIABLE <var>

Сообщить вывод шага компиляции в заданной переменной.

OUTPUT_VARIABLE <var>

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

RUN_OUTPUT_VARIABLE <var>

Сообщить вывод запущенного исполняемого файла в заданной переменной.

RUN_OUTPUT_STDOUT_VARIABLE <var>

Новая в версии 3.25.

Сообщить вывод stdout запущенного исполняемого файла в заданной переменной.

RUN_OUTPUT_STDERR_VARIABLE <var>

Новая в версии 3.25.

Сообщить вывод stderr запущенного исполняемого файла в заданной переменной.

WORKING_DIRECTORY <var>

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

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

ARGS <args>...

Дополнительные аргументы для передачи исполняемому файлу при его запуске.

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

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

• Для генераторов с несколькими конфигурациями это позволяет выбрать конфигурацию для сборки.
• Для генераторов с одной конфигурацией это устанавливает CMAKE_BUILD_TYPE в тестовом проекте.

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

При кросс-компиляции исполняемый файл, скомпилированный на первом шаге, обычно не может быть запущен на хосте сборки. Команда 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_STDOUT_VARIABLE, RUN_OUTPUT_STDERR_VARIABLE, RUN_OUTPUT_VARIABLE или OUTPUT_VARIABLE только в том случае, если это действительно необходимо. Их использование потребует ручного заполнения переменных кэша результатами работы исполняемого файла при кросс-компиляции. Вы также можете "защитить" вызовы try_run с помощью блока if(), проверяющего переменную CMAKE_CROSSCOMPILING и предоставить простую альтернативу для этого случая.