try_compile

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

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

Попытка компиляции целых проектов

try_compile(<compileResultVar> PROJECT <projectName>
            SOURCE_DIR <srcdir>
            [BINARY_DIR <bindir>]
            [TARGET <targetName>]
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [CMAKE_FLAGS <flags>...]
            [OUTPUT_VARIABLE <var>])

Попробуйте скомпилировать проект. Успешная компиляция возвращает TRUE , а неудачная — FALSE в <compileResultVar>.

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

Эта команда поддерживает альтернативную подпись для CMake, более старого, чем 3.25. Рекомендуется использовать вышеприведенную подпись для большей ясности.

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

Попытка компиляции исходных файлов

try_compile(<compileResultVar>
            [SOURCES_TYPE <type>]
            <SOURCES <srcfile...>                 |
             SOURCE_FROM_CONTENT <name> <content> |
             SOURCE_FROM_VAR <name> <var>         |
             SOURCE_FROM_FILE <name> <path>       >...
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [CMAKE_FLAGS <flags>...]
            [COMPILE_DEFINITIONS <defs>...]
            [LINK_OPTIONS <options>...]
            [LINK_LIBRARIES <libs>...]
            [LINKER_LANGUAGE <lang>]
            [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). Успешная компиляция возвращает TRUE, а неудачная — FALSE в <compileResultVar>.

В данном формате необходимо указать один или несколько исходных файлов. Кроме того, один из SOURCES и/или SOURCE_FROM_* должен предшествовать другим ключевым словам.

Если 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 автоматически генерирует для каждой операции try_compile уникальную директорию в ${CMAKE_BINARY_DIR}/CMakeFiles/CMakeScratch с неопределённым именем. Эти директории очищаются автоматически, если параметр --debug-trycompile не передаётся в cmake. Такие директории из предыдущих запусков также безусловно очищаются в начале любого выполнения cmake.

Эта команда поддерживает альтернативную подпись для CMake, более старого, чем 3.25. Рекомендуется использовать вышеприведенную подпись для большей ясности.

try_compile(<compileResultVar> <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>]
            )

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

Параметры

Параметры для указанных выше подписей:

CMAKE_FLAGS <flags>...

Укажите флаги в формате -DVAR:TYPE=VALUE, которые будут переданы команде cmake(1) командной строки, используемой для управления тестовым сборкой. Приведённый выше пример показывает, как используются значения для переменных 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 будет проигнорировано.

Новое в версии 3.29: Поддерживаются также псевдонимы целей для импортированных библиотек.

LINK_OPTIONS <options>...

Новое в версии 3.14.

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

LINKER_LANGUAGE <lang>

Новое в версии 3.29.

Укажите свойство цели LINKER_LANGUAGE сгенерированного проекта. При использовании нескольких файлов исходного кода с разными языками, установите это свойство в язык файла исходного кода, содержащего точку входа программы, например, main.

LOG_DESCRIPTION <text>

Новое в версии 3.26.

Укажите непустое текстовое описание цели проверки. Это записывается в запись cmake-configure-log(7).

NO_CACHE

Новое в версии 3.25.

Результат будет сохранён в обычной переменной, а не в записи кэша.

Переменная с результатом обычно кэшируется, чтобы можно было использовать простой шаблон, чтобы избежать повторения проверки при последующих выполнениях CMake:

if(NOT DEFINED RESULTVAR)
  # ...(check-specific setup code)...
  try_compile(RESULTVAR ...)
  # ...(check-specific logging and cleanup code)...
endif()

Если переменная-защита и переменная-результат не совпадают (например, если проверка является частью более крупного анализа), NO_CACHE может быть полезным, чтобы избежать утечки промежуточной переменной результата в кэш.

NO_LOG

Новое в версии 3.26.

Не записывать запись cmake-configure-log(7) для этого вызова.

OUTPUT_VARIABLE <var>

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

SOURCE_FROM_CONTENT <name> <content>

Новое в версии 3.25.

Записать <content> в файл с именем <name> в каталоге операции. Это можно использовать, чтобы обойти необходимость отдельно писать файл, когда содержимое файла динамически задано. Указанное <name> не должно содержать компонент пути.

SOURCE_FROM_CONTENT может быть указано несколько раз.

SOURCE_FROM_FILE <name> <path>

Новое в версии 3.25.

Скопировать <path> в файл с именем <name> в каталоге операции. Это можно использовать для объединения файлов в каталог операции, что может быть полезно, если исходник, который уже существует (например, как отдельный файл в хранилище исходного кода проекта), должен ссылаться на другие файлы, созданные SOURCE_FROM_*. (В противном случае, SOURCES обычно более удобно.) Указанное <name> не должно содержать компонент пути.

SOURCE_FROM_VAR <name> <var>

Новое в версии 3.25.

Записать содержимое <var> в файл с именем <name> в каталоге операции. Это то же, что и SOURCE_FROM_CONTENT, но берёт содержимое из указанной переменной CMake, а не напрямую, что может быть полезно при передаче аргументов через функцию, которая обертывает try_compile. Указанное <name> не должно содержать компонент пути.

SOURCE_FROM_VAR может быть указано несколько раз.

SOURCES_TYPE <type>

Новое в версии 3.28.

Источники могут быть классифицированы, используя аргумент SOURCES_TYPE. После указания все последующие указанные источники будут обрабатываться как такого типа, пока не будет указан другой SOURCES_TYPE. Доступные типы:

NORMAL

Источники не добавляются ни к одной FILE_SET в сгенерированном проекте.

CXX_MODULE

Новое в версии 3.28.

Источники добавляются к FILE_SET типа CXX_MODULES в сгенерированном проекте.

По умолчанию тип источников — NORMAL.

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

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

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

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

• Для генераторов с множеством конфигураций, это выбирает конфигурацию для сборки.
• Для генераторов с одной конфигурацией, это устанавливает CMAKE_BUILD_TYPE в проекте тестирования.

См. также

• try_run()