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