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