try_compile

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

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

Попытка сборки целых проектов

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

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

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

Попытка сборки исходных файлов

try_compile(RESULT_VAR <bindir> <srcfile|SOURCES srcfile...>
            [CMAKE_FLAGS <flags>...]
            [COMPILE_DEFINITIONS <defs>...]
            [LINK_LIBRARIES <libs>...]
            [OUTPUT_VARIABLE <var>]
            [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]])

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

В этом формате пользователю нужно только указать один или несколько исходных файлов, которые содержат определение main. CMake создаст файл CMakeLists.txt для сборки исходных файлов как исполняемого файла, примерно такого вида:

add_definitions(<expanded COMPILE_DEFINITIONS from caller>)
include_directories(${INCLUDE_DIRECTORIES})
link_directories(${LINK_DIRECTORIES})
add_executable(cmTryCompileExec <srcfile>...)
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 будет проигнорировано.

OUTPUT_VARIABLE <var>

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

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

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

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

• CMAKE_ENABLE_EXPORTS
• CMAKE_LINK_SEARCH_START_STATIC
• CMAKE_LINK_SEARCH_END_STATIC
• CMAKE_POSITION_INDEPENDENT_CODE

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

Текущее значение CMP0065 устанавливается в сгенерированном проекте.

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

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

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