FindBoost

Поиск каталогов заголовочных файлов и библиотек Boost

Используйте этот модуль, вызвав find_package() в следующем формате:

find_package(Boost
  [version] [EXACT]      # Minimum or EXACT version e.g. 1.67.0
  [REQUIRED]             # Fail with error if Boost is not found
  [COMPONENTS <libs>...] # Boost libraries by their canonical name
                         # e.g. "date_time" for "libboost_date_time"
  [OPTIONAL_COMPONENTS <libs>...]
                         # Optional Boost libraries by their canonical name)
  )                      # e.g. "date_time" for "libboost_date_time"

Этот модуль находит заголовочные файлы и запрошенные библиотеки компонентов ИЛИ файл конфигурации пакета CMake, предоставляемый сборкой "Boost CMake". В последнем случае перейдите к разделу Boost CMake ниже.

Переменные результатов

Этот модуль определяет следующие переменные:

Boost_FOUND

Истина, если заголовочные файлы и запрошенные библиотеки были найдены.

Boost_INCLUDE_DIRS

Каталоги заголовочных файлов Boost.

Boost_LIBRARY_DIRS

Каталоги для ссылок на библиотеки Boost.

Boost_LIBRARIES

Библиотеки компонентов Boost, которые будут подключены.

Boost_<COMPONENT>_FOUND

Истина, если компонент <COMPONENT> был найден (имя <COMPONENT> в верхнем регистре).

Boost_<COMPONENT>_LIBRARY

Библиотеки для подключения к компоненту <COMPONENT> (могут включать target_link_libraries() ключевые слова debug/optimized).

Boost_VERSION_MACRO

Значение BOOST_VERSION из boost/version.hpp.

Boost_VERSION_STRING

Номер версии Boost в формате X.Y.Z.

Boost_VERSION

Номер версии Boost в формате X.Y.Z (такой же, как Boost_VERSION_STRING).

Изменено в версии 3.15: В предыдущих версиях CMake эта переменная использовала исходную строку версии из заголовочного файла Boost (такую же, как Boost_VERSION_MACRO). См. политику CMP0093.

Boost_LIB_VERSION

Строка версии, добавляемая к именам файлов библиотек.

Boost_VERSION_MAJOR, Boost_MAJOR_VERSION

Основной номер версии Boost (X в X.Y.Z).

Boost_VERSION_MINOR, Boost_MINOR_VERSION

Дополнительный номер версии Boost (Y в X.Y.Z).

Boost_VERSION_PATCH, Boost_SUBMINOR_VERSION

Номер поддополнительной версии Boost (Z в X.Y.Z).

Boost_VERSION_COUNT

Количество компонент версии (3).

Boost_LIB_DIAGNOSTIC_DEFINITIONS (Windows-specific)

Передается в add_definitions(), чтобы отобразить диагностическую информацию о автоматическом подключении Boost во время компиляции.

Переменные кэша

Результаты поиска сохраняются в записях кэша CMake:

Boost_INCLUDE_DIR

Каталог, содержащий заголовочные файлы Boost.

Boost_LIBRARY_DIR_RELEASE

Каталог, содержащий релизные библиотеки Boost.

Boost_LIBRARY_DIR_DEBUG

Каталог, содержащий отладочные библиотеки Boost.

Boost_<COMPONENT>_LIBRARY_DEBUG

Отладочная версия библиотеки компонента <COMPONENT>.

Boost_<COMPONENT>_LIBRARY_RELEASE

Релизная версия библиотеки компонента <COMPONENT>.

Подсказки

Этот модуль считывает подсказки о местоположении поиска из переменных:

BOOST_ROOT, BOOSTROOT

Предпочитаемый префикс установки.

BOOST_INCLUDEDIR

Предпочитаемый каталог заголовочных файлов, например <prefix>/include.

BOOST_LIBRARYDIR

Предпочитаемый каталог библиотек, например <prefix>/lib.

Boost_NO_SYSTEM_PATHS

Установите в ON, чтобы отключить поиск в расположениях, не указанных в этих переменных подсказок. Значение по умолчанию OFF.

Boost_ADDITIONAL_VERSIONS

Список версий Boost, неизвестных этому модулю. (Расположения установки Boost могут содержать версию).

Пользователи могут задать эти подсказки или результаты как записи CACHE. Проекты не должны напрямую считывать эти записи, а вместо этого использовать вышеуказанные переменные результатов. Обратите внимание, что некоторые имена подсказок начинаются с заглавной буквы BOOST. Эти значения можно указать в качестве переменных среды, если они не указаны как переменные CMake или записи кэша.

Этот модуль сначала ищет заголовочные файлы Boost, используя вышеперечисленные переменные подсказок (исключая BOOST_LIBRARYDIR) и сохраняет результат в Boost_INCLUDE_DIR. Затем он ищет запрошенные библиотеки компонентов, используя вышеперечисленные подсказки (исключая BOOST_INCLUDEDIR и Boost_ADDITIONAL_VERSIONS), каталоги "lib" рядом с Boost_INCLUDE_DIR, и настройки конфигурации имен библиотек ниже. Он сохраняет каталоги библиотек в Boost_LIBRARY_DIR_DEBUG и Boost_LIBRARY_DIR_RELEASE и отдельные расположения библиотек в Boost_<COMPONENT>_LIBRARY_DEBUG и Boost_<COMPONENT>_LIBRARY_RELEASE. При изменении настроек, используемых предыдущими поисками в одном дереве проекта (за исключением переменных среды), этот модуль отбрасывает предыдущие результаты поиска, зависящие от изменений, и снова выполняет поиск.

Импортированные цели

Этот модуль определяет следующие цели IMPORTED:

Boost::boost

Цель для зависимостей только заголовочных файлов. (Каталог заголовочных файлов Boost).

Boost::headers

Новая в версии 3.15: Псевдоним для Boost::boost.

Boost::<component>

Цель для зависимости от конкретного компонента (раздельная или статическая библиотека); имя <component> в нижнем регистре.

Boost::diagnostic_definitions

Интерфейсная цель для отображения диагностической информации о автоматическом подключении Boost во время компиляции (добавляет -DBOOST_LIB_DIAGNOSTIC).

Boost::disable_autolinking

Интерфейсная цель для отключения автоматического подключения с MSVC (добавляет -DBOOST_ALL_NO_LIB).

Boost::dynamic_linking

Интерфейсная цель для включения динамической связи с MSVC (добавляет -DBOOST_ALL_DYN_LINK).

Неявные зависимости, такие как Boost::filesystem, требующие Boost::system, будут автоматически обнаружены и удовлетворены, даже если система не указана при использовании find_package() и если Boost::system не добавлен в target_link_libraries(). При использовании Boost::thread, Threads::Threads также будет автоматически добавлен.

Важно отметить, что импортированные цели ведут себя иначе, чем переменные, созданные этим модулем: несколько вызовов find_package(Boost) в одном каталоге или подкаталогах с разными параметрами (например, статическая или раздельная) не переопределят значения целей, созданных первым вызовом.

Другие переменные

Библиотеки Boost поставляются во многих вариантах, закодированных в их имени файла. Пользователи или проекты могут сообщить этому модулю, какой вариант найти, задав переменные:

Boost_USE_DEBUG_LIBS

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

Установите значение в ON или OFF для указания, нужно ли искать и использовать библиотеки отладки. По умолчанию ON.

Boost_USE_RELEASE_LIBS

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

Установите значение в ON или OFF для указания, нужно ли искать и использовать релизные библиотеки. По умолчанию ON.

Boost_USE_MULTITHREADED

Установите значение в OFF для использования не многопоточных библиотек ("mt" тег). По умолчанию ON.

Boost_USE_STATIC_LIBS

Установите значение в ON для принудительного использования статических библиотек. По умолчанию OFF.

Boost_USE_STATIC_RUNTIME

Установите значение в ON или OFF для указания, нужно ли использовать библиотеки, статически связанные с C++ runtime ("s" тег). По умолчанию зависит от платформы.

Boost_USE_DEBUG_RUNTIME

Установите значение в ON или OFF для указания, нужно ли использовать библиотеки, связанные с MS отладочной C++ runtime ("g" тег). По умолчанию ON.

Boost_USE_DEBUG_PYTHON

Установите значение в ON для использования библиотек, скомпилированных с отладочной сборкой Python ("y" тег). По умолчанию OFF.

Boost_USE_STLPORT

Установите значение в ON для использования библиотек, скомпилированных с STLPort ("p" тег). По умолчанию OFF.

Boost_USE_STLPORT_DEPRECATED_NATIVE_IOSTREAMS

Установите значение в ON для использования библиотек, скомпилированных с устаревшими "родными iostreams" STLPort ("n" тег). По умолчанию OFF.

Boost_COMPILER

Установите значение в суффикс библиотеки, специфичный для компилятора (например, -gcc43). По умолчанию автоматически вычисляется для используемого C++ компилятора.

Изменено в версии 3.9: Можно использовать список, если необходимо протестировать несколько совместимых суффиксов, в порядке убывания предпочтения.

Boost_LIB_PREFIX

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

Установите значение в префикс имени платформенно-специфичной библиотеки (например, lib) используемый Boost статическими библиотеками. Это необходимо только на платформах, где CMake по умолчанию не знает префикс.

Boost_ARCHITECTURE

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

Установите значение в суффикс библиотеки, специфичный для архитектуры (например, -x64). По умолчанию автоматически вычисляется для используемого C++ компилятора.

Boost_THREADAPI

Суффикс для имени библиотеки компонента thread, такого как pthread или win32. Имена с этим суффиксом и без него будут проверены.

Boost_NAMESPACE

Альтернативное имя пространства имён, используемое для построения boost, например, если установлено myboost, будет происходить поиск myboost_thread вместо boost_thread.

Другие переменные, которые можно установить для управления этим модулем:

Boost_DEBUG

Установите значение в ON для включения отладочного вывода от FindBoost. Пожалуйста, включите это перед отправкой отчета об ошибке.

Boost_REALPATH

Установите значение в ON для разрешения символьных ссылок для обнаруженных библиотек для помощи в упаковке. Например, библиотека компонента "system" может быть разрешена до /usr/lib/libboost_system.so.1.67.0 вместо /usr/lib/libboost_system.so. Это не влияет на компоновку и не должно быть включено, если пользователь не нуждается в этой информации.

Boost_LIBRARY_DIR

Значение по умолчанию для Boost_LIBRARY_DIR_RELEASE и Boost_LIBRARY_DIR_DEBUG.

Boost_NO_WARN_NEW_VERSIONS

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

Установите значение в ON для подавления предупреждения о неизвестных зависимостях для новых версий Boost.

В компиляторах Visual Studio и Borland заголовки Boost запрашивают автоматическую привязку к соответствующим библиотекам. Это требует явной привязки или наличия соответствующих библиотек в пути поиска библиотек. В этом случае установка Boost_USE_STATIC_LIBS в OFF может не привести к динамической компоновке. Автоматическая компоновка Boost обычно запрашивает статические библиотеки за несколькими исключениями (такими как Boost.Python). Используйте:

add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS})

чтобы попросить Boost сообщить информацию об автоматических запросах компоновки.

Примеры

Поиск только заголовков Boost:

find_package(Boost 1.36.0)
if(Boost_FOUND)
  include_directories(${Boost_INCLUDE_DIRS})
  add_executable(foo foo.cc)
endif()

Поиск библиотек Boost и использование импортированных целей:

find_package(Boost 1.56 REQUIRED COMPONENTS
             date_time filesystem iostreams)
add_executable(foo foo.cc)
target_link_libraries(foo Boost::date_time Boost::filesystem
                          Boost::iostreams)

Поиск библиотек Boost Python 3.6 и использование импортированных целей:

find_package(Boost 1.67 REQUIRED COMPONENTS
             python36 numpy36)
add_executable(foo foo.cc)
target_link_libraries(foo Boost::python36 Boost::numpy36)

Поиск заголовков Boost и некоторых статических (только релизные) библиотек:

set(Boost_USE_STATIC_LIBS        ON)  # only find static libs
set(Boost_USE_DEBUG_LIBS        OFF)  # ignore debug libs and
set(Boost_USE_RELEASE_LIBS       ON)  # only find release libs
set(Boost_USE_MULTITHREADED      ON)
set(Boost_USE_STATIC_RUNTIME    OFF)
find_package(Boost 1.66.0 COMPONENTS date_time filesystem system ...)
if(Boost_FOUND)
  include_directories(${Boost_INCLUDE_DIRS})
  add_executable(foo foo.cc)
  target_link_libraries(foo ${Boost_LIBRARIES})
endif()

Boost CMake

Если Boost был построен с использованием проекта boost-cmake или с Boost 1.70.0, он предоставляет файл конфигурации пакета для использования с режимом конфигурации find_package. Этот модуль ищет файл конфигурации пакета, называемый BoostConfig.cmake или boost-config.cmake и сохраняет результат в записи CACHE entry Boost_DIR. Если найден, файл конфигурации пакета загружается, и этот модуль возвращается без дальнейших действий. Подробнее о том, что предоставляет файл конфигурации пакета Boost CMake, см. в документации.

Установите Boost_NO_BOOST_CMAKE в ON, чтобы отключить поиск boost-cmake.