try_compile

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

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

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

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

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

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

Эта команда также поддерживает альтернативную подпись, которая присутствовала в более ранних версиях CMake:

try_compile(<resultVar> <bindir> <srcdir>
            <projectName> [<targetName>]
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [CMAKE_FLAGS <flags>...]
            [OUTPUT_VARIABLE <var>])

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

try_compile(<resultVar>
            <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>...]
            [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>.

В этом формате необходимо предоставить один или несколько исходных файлов. Кроме того, один из 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:

try_compile(<resultVar> <bindir> <srcfile|SOURCES srcfile...>
            [LOG_DESCRIPTION <text>]
            [NO_CACHE]
            [NO_LOG]
            [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 будет проигнорировано.

LINK_OPTIONS <options>...

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

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

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 может быть указано несколько раз.

<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, чтобы выбрать конфигурацию сборки.

См. также

• try_run()