try_compile

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

Попробуйте собрать некоторый код.

Попытка скомпилировать целые проекты

try_compile(<resultVar> <bindir> <srcdir>
            <projectName> [<targetName>] [CMAKE_FLAGS <flags>...]
            [OUTPUT_VARIABLE <var>])

Попробуйте собрать проект. Успех или неудача try_compile, т.е. TRUE или FALSE соответственно, возвращаются в <resultVar>.

В этом формате <srcdir> должен содержать полный проект CMake с файлом CMakeLists.txt и всеми исходными файлами. Файлы <bindir> и <srcdir> не будут удалены после выполнения этой команды. Укажите <targetName>, чтобы собрать определённую цель вместо all или ALL_BUILD цели. Значение других параметров см. ниже.

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

try_compile(<resultVar> <bindir> <srcfile|SOURCES srcfile...>
            [CMAKE_FLAGS <flags>...]
            [COMPILE_DEFINITIONS <defs>...]
            [LINK_OPTIONS <options>...]
            [LINK_LIBRARIES <libs>...]
            [OUTPUT_VARIABLE <var>]
            [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]
            [<LANG>_STANDARD <std>]
            [<LANG>_STANDARD_REQUIRED <bool>]
            [<LANG>_EXTENSIONS <bool>]
            )

Попробуйте собрать исполняемый файл или статическую библиотеку из одного или нескольких исходных файлов (который определяется переменной CMAKE_TRY_COMPILE_TARGET_TYPE). Успех или неудача try_compile, т.е. TRUE или FALSE соответственно, возвращается в <resultVar>.

В этом формате необходимо указать один или несколько исходных файлов. Если CMAKE_TRY_COMPILE_TARGET_TYPE не установлена или установлена в EXECUTABLE, исходные файлы должны включать определение для main, и CMake создаст файл CMakeLists.txt для сборки исходного файла(ов) как исполняемого файла. Если CMAKE_TRY_COMPILE_TARGET_TYPE установлена в STATIC_LIBRARY, вместо этого будет собрана статическая библиотека, и определение для main не требуется. Для исполняемого файла сгенерированный файл CMakeLists.txt будет содержать что-то вроде следующего:

add_definitions(<expanded COMPILE_DEFINITIONS from caller>)
include_directories(${INCLUDE_DIRECTORIES})
link_directories(${LINK_DIRECTORIES})
add_executable(cmTryCompileExec <srcfile>...)
target_link_options(cmTryCompileExec PRIVATE <LINK_OPTIONS from caller>)
target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})

Параметры:

CMAKE_FLAGS <flags>...

Укажите флаги вида -DVAR:TYPE=VALUE для передачи команде cmake командной строки, используемой для управления сборкой теста. Приведённый пример показывает, как используются значения для переменных INCLUDE_DIRECTORIES, LINK_DIRECTORIES и LINK_LIBRARIES.

COMPILE_DEFINITIONS <defs>...

Укажите аргументы -Ddefinition для передачи в add_definitions() в сгенерированном проекте теста.

COPY_FILE <fileName>

Скопировать созданный исполняемый файл или статическую библиотеку в указанную <fileName>.

COPY_FILE_ERROR <var>

Используется после COPY_FILE для записи в переменную <var> любого сообщения об ошибке, возникшей при попытке копирования файла.

LINK_LIBRARIES <libs>...

Укажите библиотеки, которые должны быть подключены в сгенерированный проект. Список библиотек может ссылаться на системные библиотеки и на Импортированные цели из вызывающего проекта.

Если этот параметр указан, любое значение -DLINK_LIBRARIES=... для параметра CMAKE_FLAGS будет проигнорировано.

LINK_OPTIONS <options>...

Введено в версии 3.14.

Укажите параметры шага компоновки, которые должны быть переданы в target_link_options() или для установки свойства цели STATIC_LIBRARY_OPTIONS в сгенерированном проекте, в зависимости от переменной CMAKE_TRY_COMPILE_TARGET_TYPE.

OUTPUT_VARIABLE <var>

Сохранить вывод процесса сборки в указанную переменную.

<LANG>_STANDARD <std>

Введено в версии 3.8.

Указать свойство цели C_STANDARD, CXX_STANDARD, OBJC_STANDARD, OBJCXX_STANDARD или CUDA_STANDARD сгенерированного проекта.

<LANG>_STANDARD_REQUIRED <bool>

Введено в версии 3.8.

Укажите свойство цели C_STANDARD_REQUIRED, CXX_STANDARD_REQUIRED, OBJC_STANDARD_REQUIRED, OBJCXX_STANDARD_REQUIRED или CUDA_STANDARD_REQUIRED сгенерированного проекта.

<LANG>_EXTENSIONS <bool>

Введено в версии 3.8.

Укажите свойство цели C_EXTENSIONS, CXX_EXTENSIONS, OBJC_EXTENSIONS, OBJCXX_EXTENSIONS или CUDA_EXTENSIONS сгенерированного проекта.

В этой версии все файлы в <bindir>/CMakeFiles/CMakeTmp будут автоматически очищены. Для отладки --debug-trycompile можно передать в cmake, чтобы избежать этой очистки. Однако несколько последовательных операций try_compile повторно используют этот единственный выходной каталог. Если вы используете --debug-trycompile, вы можете отлаживать только один вызов try_compile за раз. Рекомендуемая процедура состоит в том, чтобы защитить все вызовы try_compile в вашем проекте с помощью логики if(NOT DEFINED <resultVar>), выполнить конфигурацию с помощью cmake до конца один раз, затем удалить запись кэша, связанную с вызовом try_compile, который вас интересует, и затем снова запустить cmake с --debug-trycompile.

Другие настройки поведения

Текущие настройки CMP0065 и CMP0083 распространяются в сгенерированный тестовый проект.

Установите переменную CMAKE_TRY_COMPILE_CONFIGURATION, чтобы выбрать конфигурацию сборки.