3.8 检测Boost库

NOTE:此示例代码可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-03/recipe-08 中找到，包含一个C++的示例。该示例在CMake 3.5版(或更高版本)中是有效的，并且已经在GNU/Linux、macOS和Windows上进行过测试。

Boost是一组C++通用库。这些库提供了许多功能，这些功能在现代C++项目中不可或缺，但是还不能通过C++标准使用这些功能。例如，Boost为元编程、处理可选参数和文件系统操作等提供了相应的组件。这些库中有许多特性后来被C++11、C++14和C++17标准所采用，但是对于保持与旧编译器兼容性的代码库来说，许多Boost组件仍然是首选。

本示例将向您展示如何检测和链接Boost库的一些组件。

准备工作

我们将编译的源码是Boost提供的文件系统库与文件系统交互的示例。这个库可以跨平台使用，并将操作系统和文件系统之间的差异抽象为一致的API。下面的代码(path-info.cpp)将接受一个路径作为参数，并将其组件的报告打印到屏幕上:

  1. #include <iostream>
  3. #include <boost/filesystem.hpp>
  5. using namespace std;
  6. using namespace boost::filesystem;
  7. const char *say_what(bool b) { return b ? "true" : "false"; }
  8. int main(int argc, char *argv[])
  9. {
  10.   if (argc < 2)
  11.   {
  12.     cout
  13.         << "Usage: path_info path-element [path-element...]\n"
  14.            "Composes a path via operator/= from one or more path-element arguments\n"
  15.            "Example: path_info foo/bar baz\n"
  16. #ifdef BOOST_POSIX_API
  17.            " would report info about the composed path foo/bar/baz\n";
  18. #else // BOOST_WINDOWS_API
  19.            " would report info about the composed path foo/bar\\baz\n";
  20. #endif
  21.     return 1;
  22.   }
  23.   path p;
  24.   for (; argc > 1; --argc, ++argv)
  25.     p /= argv[1]; // compose path p from the command line arguments
  26.   cout << "\ncomposed path:\n";
  27.   cout << " operator<<()---------: " << p << "\n";
  28.   cout << " make_preferred()-----: " << p.make_preferred() << "\n";
  29.   cout << "\nelements:\n";
  30.   for (auto element : p)
  31.     cout << " " << element << '\n';
  32.   cout << "\nobservers, native format:" << endl;
  33. #ifdef BOOST_POSIX_API
  34.   cout << " native()-------------: " << p.native() << endl;
  35.   cout << " c_str()--------------: " << p.c_str() << endl;
  36. #else // BOOST_WINDOWS_API
  37.   wcout << L" native()-------------: " << p.native() << endl;
  38.   wcout << L" c_str()--------------: " << p.c_str() << endl;
  39. #endif
  40.   cout << " string()-------------: " << p.string() << endl;
  41.   wcout << L" wstring()------------: " << p.wstring() << endl;
  42.   cout << "\nobservers, generic format:\n";
  43.   cout << " generic_string()-----: " << p.generic_string() << endl;
  44.   wcout << L" generic_wstring()----: " << p.generic_wstring() << endl;
  45.   cout << "\ndecomposition:\n";
  46.   cout << " root_name()----------: " << p.root_name() << '\n';
  47.   cout << " root_directory()-----: " << p.root_directory() << '\n';
  48.   cout << " root_path()----------: " << p.root_path() << '\n';
  49.   cout << " relative_path()------: " << p.relative_path() << '\n';
  50.   cout << " parent_path()--------: " << p.parent_path() << '\n';
  51.   cout << " filename()-----------: " << p.filename() << '\n';
  52.   cout << " stem()---------------: " << p.stem() << '\n';
  53.   cout << " extension()----------: " << p.extension() << '\n';
  54.   cout << "\nquery:\n";
  55.   cout << " empty()--------------: " << say_what(p.empty()) << '\n';
  56.   cout << " is_absolute()--------: " << say_what(p.is_absolute()) << '\n';
  57.   cout << " has_root_name()------: " << say_what(p.has_root_name()) << '\n';
  58.   cout << " has_root_directory()-: " << say_what(p.has_root_directory()) << '\n';
  59.   cout << " has_root_path()------: " << say_what(p.has_root_path()) << '\n';
  60.   cout << " has_relative_path()--: " << say_what(p.has_relative_path()) << '\n';
  61.   cout << " has_parent_path()----: " << say_what(p.has_parent_path()) << '\n';
  62.   cout << " has_filename()-------: " << say_what(p.has_filename()) << '\n';
  63.   cout << " has_stem()-----------: " << say_what(p.has_stem()) << '\n';
  64.   cout << " has_extension()------: " << say_what(p.has_extension()) << '\n';
  65.   return 0;
  66. }

具体实施

Boost由许多不同的库组成，这些库可以独立使用。CMake可将这个库集合，表示为组件的集合。FindBoost.cmake模块不仅可以搜索库集合的完整安装，还可以搜索集合中的特定组件及其依赖项(如果有的话)。我们将逐步建立相应的CMakeLists.txt:

  1. 首先，声明CMake最低版本、项目名称、语言，并使用C++11标准:

    1. cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
    3. project(recipe-08 LANGUAGES CXX)
    5. set(CMAKE_CXX_STANDARD 11)
    6. set(CMAKE_CXX_EXTENSIONS OFF)
    7. set(CMAKE_CXX_STANDARD_REQUIRED ON)

  2. 然后，使用find_package搜索Boost。若需要对Boost强制性依赖，需要一个参数。这个例子中，只需要文件系统组件，所以将它作为参数传递给find_package:

    1. find_package(Boost 1.54 REQUIRED COMPONENTS filesystem)

  3. 添加可执行目标，编译源文件:

    1. add_executable(path-info path-info.cpp)

  4. 最后，将目标链接到Boost库组件。由于依赖项声明为PUBLIC，依赖于Boost的目标将自动获取依赖项:

    1. target_link_libraries(path-info
    2.   PUBLIC
    3.       Boost::filesystem
    4.     )

工作原理

FindBoost.cmake是本示例中所使用的CMake模块，其会在标准系统安装目录中找到Boost库。由于我们链接的是Boost::filesystem，CMake将自动设置包含目录并调整编译和链接标志。如果Boost库安装在非标准位置，可以在配置时使用BOOST_ROOT变量传递Boost安装的根目录，以便让CMake搜索非标准路径:

  1. $ cmake -D BOOST_ROOT=/custom/boost

或者，可以同时传递包含头文件的BOOST_INCLUDEDIR变量和库目录的BOOST_LIBRARYDIR变量:

  1. $ cmake -D BOOST_INCLUDEDIR=/custom/boost/include -DBOOST_LIBRARYDIR=/custom/boost/lib