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

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

OUTPUT_VARIABLE <var>

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

<LANG>_STANDARD <std>

Укажите свойства цели C_STANDARD, CXX_STANDARD, OBJC_STANDARD, OBJCXX_STANDARD, или CUDA_STANDARD.

<LANG>_STANDARD_REQUIRED <bool>

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

<LANG>_EXTENSIONS <bool>

Укажите свойства цели 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.

Другие параметры поведения

Если установлены, следующие переменные передаются в сгенерированный файл CMakeLists.txt для инициализации свойств цели компиляции значениями по умолчанию:

• CMAKE_CUDA_RUNTIME_LIBRARY
• CMAKE_ENABLE_EXPORTS
• CMAKE_LINK_SEARCH_START_STATIC
• CMAKE_LINK_SEARCH_END_STATIC
• CMAKE_MSVC_RUNTIME_LIBRARY
• CMAKE_POSITION_INDEPENDENT_CODE

Если CMP0056 установлено в NEW, то CMAKE_EXE_LINKER_FLAGS также передаётся.

Если CMP0083 установлено в NEW, то для правильной работы при компоновке необходимо вызвать команду check_pie_supported() из модуля CheckPIESupported перед использованием команды try_compile().

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

Установите переменную CMAKE_TRY_COMPILE_CONFIGURATION для выбора конфигурации сборки.

Установите переменную CMAKE_TRY_COMPILE_TARGET_TYPE, чтобы указать тип целевого объекта, используемого для подписи исходного файла.

Установите переменную CMAKE_TRY_COMPILE_PLATFORM_VARIABLES, чтобы указать переменные, которые должны быть переданы в тестовый проект. Эта переменная предназначена только для использования в файлах инструментария и учитывается командой try_compile() для исходных файлов, но не при указании всего проекта.

Если CMP0067 установлено в значение NEW, или используются какие-либо из опций <LANG>_STANDARD, <LANG>_STANDARD_REQUIRED, или <LANG>_EXTENSIONS, то переменные стандарта языка будут учтены:

• CMAKE_C_STANDARD
• CMAKE_C_STANDARD_REQUIRED
• CMAKE_C_EXTENSIONS
• CMAKE_CXX_STANDARD
• CMAKE_CXX_STANDARD_REQUIRED
• CMAKE_CXX_EXTENSIONS
• CMAKE_OBJC_STANDARD
• CMAKE_OBJC_STANDARD_REQUIRED
• CMAKE_OBJC_EXTENSIONS
• CMAKE_OBJCXX_STANDARD
• CMAKE_OBJCXX_STANDARD_REQUIRED
• CMAKE_OBJCXX_EXTENSIONS
• CMAKE_CUDA_STANDARD
• CMAKE_CUDA_STANDARD_REQUIRED
• CMAKE_CUDA_EXTENSIONS

Их значения используются для установки соответствующих свойств целевого объекта в сгенерированном проекте (если они не переопределены явной опцией).

Для генератора Green Hills MULTI переменные кэша настройки набора инструментов и целевой системы GHS также передаются в тестовый проект.