try_run

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

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

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

try_run(<runResultVar> <compileResultVar>
        <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>]
        [OUTPUT_VARIABLE <var>]
        [WORKING_DIRECTORY <var>]
        [ARGS <args>...]
        )

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

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

Эта команда также поддерживает альтернативную сигнатуру, которая присутствовала в более старых версиях CMake:

try_run(<runResultVar> <compileResultVar>
        <bindir> <srcfile|SOURCES srcfile...>
        [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>]
        [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, чтобы выбрать конфигурацию сборки.

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

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