CMake 系列(十五):检测 Boost 库

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

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

注意:本示例在 CMake 3.5 或更高版本中有效,并且已经在 GNU/Linux、macOS 和 Windows 上进行过测试。

准备工作

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

#include <iostream>

#include <boost/filesystem.hpp>

using namespace std;
using namespace boost::filesystem;

const char *say_what(bool b) { return b ? "true" : "false"; }

int main(int argc, char *argv[])
{
  if (argc < 2)
  {
    cout
        << "Usage: path_info path-element [path-element...]\n"
           "Composes a path via operator/= from one or more path-element arguments\n"
           "Example: path_info foo/bar baz\n"
#ifdef BOOST_POSIX_API
           " would report info about the composed path foo/bar/baz\n";
#else // BOOST_WINDOWS_API
           " would report info about the composed path foo/bar\\baz\n";
#endif
    return 1;
  }

  path p;
  for (; argc > 1; --argc, ++argv)
    p /= argv[1]; // compose path p from the command line arguments

  cout << "\ncomposed path:\n";
  cout << " operator<<()---------: " << p << "\n";
  cout << " make_preferred()-----: " << p.make_preferred() << "\n";

  cout << "\nelements:\n";
  for (auto element : p)
    cout << " " << element << '\n';

  cout << "\nobservers, native format:" << endl;
#ifdef BOOST_POSIX_API
  cout << " native()-------------: " << p.native() << endl;
  cout << " c_str()--------------: " << p.c_str() << endl;
#else // BOOST_WINDOWS_API
  wcout << L" native()-------------: " << p.native() << endl;
  wcout << L" c_str()--------------: " << p.c_str() << endl;
#endif
  cout << " string()-------------: " << p.string() << endl;
  wcout << L" wstring()------------: " << p.wstring() << endl;

  cout << "\nobservers, generic format:\n";
  cout << " generic_string()-----: " << p.generic_string() << endl;
  wcout << L" generic_wstring()----: " << p.generic_wstring() << endl;

  cout << "\ndecomposition:\n";
  cout << " root_name()----------: " << p.root_name() << '\n';
  cout << " root_directory()-----: " << p.root_directory() << '\n';
  cout << " root_path()----------: " << p.root_path() << '\n';
  cout << " relative_path()------: " << p.relative_path() << '\n';
  cout << " parent_path()--------: " << p.parent_path() << '\n';
  cout << " filename()-----------: " << p.filename() << '\n';
  cout << " stem()---------------: " << p.stem() << '\n';
  cout << " extension()----------: " << p.extension() << '\n';

  cout << "\nquery:\n";
  cout << " empty()--------------: " << say_what(p.empty()) << '\n';
  cout << " is_absolute()--------: " << say_what(p.is_absolute()) << '\n';
  cout << " has_root_name()------: " << say_what(p.has_root_name()) << '\n';
  cout << " has_root_directory()-: " << say_what(p.has_root_directory()) << '\n';
  cout << " has_root_path()------: " << say_what(p.has_root_path()) << '\n';
  cout << " has_relative_path()--: " << say_what(p.has_relative_path()) << '\n';
  cout << " has_parent_path()----: " << say_what(p.has_parent_path()) << '\n';
  cout << " has_filename()-------: " << say_what(p.has_filename()) << '\n';
  cout << " has_stem()-----------: " << say_what(p.has_stem()) << '\n';
  cout << " has_extension()------: " << say_what(p.has_extension()) << '\n';

  return 0;
}

具体实施

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

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

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)

project(recipe-08 LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

然后,使用 find_package 搜索 Boost,并给出对 Boost 的强制性最低版本要求。本例中只需要文件系统组件,所以将它作为参数传递给 find_package:

find_package(Boost 1.54 REQUIRED COMPONENTS filesystem)

接着添加可执行目标,编译源文件:

add_executable(path-info path-info.cpp)

最后,将目标链接到 Boost 库组件。由于依赖项声明为 PUBLIC,依赖于 Boost 的目标将自动获得该依赖项:

target_link_libraries(path-info
  PUBLIC
    Boost::filesystem
  )

工作原理

FindBoost.cmake 是本示例中所使用的 CMake 模块,它会在标准系统安装目录中找到 Boost 库。由于我们链接的是 Boost::filesystem 这个导入目标,CMake 将自动设置包含目录并调整编译和链接标志。

如果 Boost 库安装在非标准位置,可以在配置时使用 BOOST_ROOT 变量传递 Boost 安装的根目录,以便让 CMake 搜索非标准路径:

$ cmake -D BOOST_ROOT=/custom/boost

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

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

检测到 Boost 之后,拿它做点什么?本站《Boost 系列导读》以 Boost.Asio 为主线,从入门到多线程网络编程走了一条完整的实战路径。

系列导航


   转载规则


《CMake 系列(十五):检测 Boost 库》 由 吴杭沉 采用 知识共享署名 4.0 国际许可协议 进行许可。
 上一篇
CMake 系列(十六):用 Google Test 做单元测试 CMake 系列(十六):用 Google Test 做单元测试
本篇演示如何在 CMake 的帮助下使用 Google Test 框架实现单元测试。Google Test 不仅仅是一个头文件,更是一个库,包含需要构建和链接的源文件。可以把它们与我们的代码项目放在一起,但为了使代码项目更加轻量级,我们选择
2022-06-28
下一篇 
CMake 系列(十四):检测 Eigen 库 CMake 系列(十四):检测 Eigen 库
BLAS 库为矩阵和向量操作提供了标准化接口,不过这个接口是用 Fortran 语言书写的。虽然已经展示过如何在 C++ 中直接使用这些库,但在现代 C++ 程序中,我们希望有更高级的接口。 纯头文件实现的 Eigen 库使用模板编程来提供
2022-06-14
  目录