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>...

Укажите параметры этапа компоновки для передачи в 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.

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

Если установлены, следующие переменные передаются в сгенерированный try_compile 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 toolset и целевой системы также распространяются на тестовый проект.