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 или CUDA_STANDARD сгенерированного проекта.

<LANG>_STANDARD_REQUIRED <bool>

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

<LANG>_EXTENSIONS <bool>

Укажите свойство целевого объекта C_EXTENSIONS, CXX_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 try_compile для инициализации свойств целевых объектов компиляции значениями по умолчанию:

• CMAKE_ENABLE_EXPORTS
• CMAKE_LINK_SEARCH_START_STATIC
• CMAKE_LINK_SEARCH_END_STATIC
• 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 для указания переменных, которые должны быть переданы в тестовый проект. Эта переменная предназначена для использования только в файлах toolchain и поддерживается командой 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_CUDA_STANDARD
• CMAKE_CUDA_STANDARD_REQUIRED
• CMAKE_CUDA_EXTENSIONS

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

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