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 компилятора.

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 для выбора конфигурации сборки.