Boost C++ 库

...世界上最受推崇和设计精良的 C++ 库项目之一。 Herb SutterAndrei Alexandrescu, C++ 编码标准

Next

Boost.Config

Vesa Karvonen, John Maddock Beman Dawes

根据 Boost 软件许可协议 1.0 版分发。(请参阅随附的 LICENSE_1_0.txt 文件或在 https://boost.ac.cn/LICENSE_1_0.txt 复制)


目录

为你的平台配置 Boost
使用默认的 boost 配置
<boost/config.hpp> 头文件
使用配置脚本
用户可设置的选项
高级配置用法
测试 boost 配置
Boost 宏参考
广泛的 C++ 标准级别检查
描述 C++03 缺陷的宏
描述可选功能的宏
描述不支持的 C++11 功能的宏
允许使用 C++03 编译器使用 C++11 功能的宏
描述不支持的 C++14 功能的宏
允许使用 C++11 或更早版本编译器使用 C++14 功能的宏
描述不支持的 C++17 功能的宏
允许使用 C++14 或更早版本编译器使用 C++17 功能的宏
描述不支持的 C++20 功能的宏
描述不支持的 C++23 功能的宏
描述已从标准中删除的功能的宏。
Boost 辅助宏
Boost 信息宏
Boost 弃用宏
用于具有单独源代码的库的宏
构建时配置
标准整数类型
概述
原理
买者自慎
精确宽度整数类型
最小宽度整数类型
最快最小宽度整数类型
最大宽度整数类型
整数常量宏
用于存储指针的整数
Boost 作者指南
禁用编译器警告
添加新的缺陷宏
添加新的功能测试宏
修改 Boost 配置头文件
原理
问题
解决方案
致谢

Boost 已经为大多数常见的编译器和平台配置好;你应该能够“按原样”使用 boost。由于编译器与标准库是分开配置的,即使您将编译器的标准库替换为第三方标准库(如 STLport),默认配置也应该可以工作。

使用 boost “按原样”,而不尝试重新配置,是推荐的 boost 使用方法。但是,如果您愿意,可以运行配置脚本,并且提供了回归测试,允许您使用特定的编译器设置测试当前的 boost 配置。

Boost 库用户可以通过访问我们的 Github 并提交支持请求来请求对其他编译器或平台的支持。

Boost 库实现通过以下方式访问配置宏

#include <boost/config.hpp>

虽然 Boost 库用户不需要直接包含该文件或使用这些配置宏,但这种使用是可接受的。配置宏记录了其用途、用法和限制,这使得它们可以被 Boost 库和用户代码使用。

Boost 信息辅助 宏旨在供 Boost 用户以及我们自己的内部使用。但是请注意,功能测试缺陷测试 宏是为 Boost 库的内部使用而设计的,而不是用户代码,因此它们可以随时更改(尽管不会对它们进行无端的更改)。由配置宏的更改导致的 Boost 库问题会被 Boost 回归测试捕获,因此 Boost 库会更新以适应这些更改。相比之下,Boost 库用户代码可能会在没有警告的情况下受到宏更改的不利影响。了解用户代码中使用的宏更改的最佳方法是关注 Boost 开发人员列表中的讨论。

[Important] 重要提示

此配置脚本仅设置 Boost 头文件以供特定编译器使用。它对 Boost.Build 或库的构建方式没有影响。

如果您知道 boost 为您的特定设置配置不正确,并且您在类似 UNIX 的平台上,那么您可能想通过运行 boost 配置脚本来尝试改进。从 shell 命令提示符,您需要 cd 进入 <boost-root>/libs/config/ 并输入

sh ./configure

您将看到脚本通过回归测试时正在检查的项目列表。请注意,只有在调用 g++、c++ 或 CC 时,配置脚本才会真正自动检测您的编译器。如果您使用其他编译器,您将需要设置以下一个或多个环境变量

变量

描述

CXX

编译器的名称,例如 c++

CXXFLAGS

要使用的编译器标志,例如 -O2

LDFLAGS

要使用的链接器标志,例如 -L/mypath

LIBS

要链接的任何库,例如 -lpthread

例如,要使用 HP aCC 运行配置脚本,您可以使用类似以下内容

export CXX="aCC"
export CXXFLAGS="-Aa -DAportable -D__HPACC_THREAD_SAFE_RB_TREE \
   -DRWSTD_MULTI_THREAD -DRW_MULTI_THREAD -D_REENTRANT -D_THREAD_SAFE"
export LDFLAGS="-DAportable"
export LIBS="-lpthread"
sh ./configure

无论您如何运行配置脚本,当它完成时,您都会发现一个新的头文件 - user.hpp - 位于 <boost-root>/libs/config/ 目录中。 请注意,默认情况下,配置不会将此头文件安装到您的 boost 包含路径中。此头文件包含配置脚本生成的所有选项,以及一个头文件部分,其中包含来自默认版本的 <boost/config/user.hpp>(位于 <boost-root>/boost/config/ 下)的用户可设置选项。您可以通过两种方式使用此头文件

  • 选项 1: 将头文件复制到 <boost-root>/boost/config/ 中,以便它替换 boost 提供的默认 user.hpp。此选项仅允许一个配置生成的设置;boost 开发人员应避免使用此选项,因为它存在意外将配置修改的 <boost/config/user.hpp> 提交到 svn 存储库的风险(您将不会因此受到感谢!)。
  • 选项 2: 给头文件起一个更容易记住的名称,并将其放在方便的位置;然后,定义宏 BOOST_USER_CONFIG 以指向它。例如,创建一个新的子目录 <boost-root>/boost/config/ user/,并将头文件复制到那里;例如,作为 multithread-gcc-config.hpp。然后,在编译时添加命令行选项: -DBOOST_USER_CONFIG="<boost/config/user/multithread-gcc-config.hpp>",boost 将使用新的配置头文件。此选项允许您生成多个配置头文件,并将它们与 boost 源代码分开 - 这样对源代码的更新就不会干扰您的配置。

有一些配置选项代表用户选择,而不是编译器缺陷或平台特定选项。这些选项在 <boost/config/user.hpp> 中以及配置生成的 user.hpp 头文件的开头列出。您可以在命令行上定义这些选项,或者通过编辑 <boost/config/user.hpp> 来定义它们,它们在下表中列出

描述

BOOST_USER_CONFIG

定义时,它应指向要在任何 boost 配置文件之前包含的用户配置文件的名称。未定义时,默认为 <boost/config/user.hpp>

BOOST_COMPILER_CONFIG

定义时,它应指向要使用的编译器配置文件的名称。定义此选项会切断编译器选择逻辑,并消除对包含该逻辑的头文件的依赖。例如,如果您使用 gcc,则可以将 BOOST_COMPILER_CONFIG 定义为 <boost/config/compiler/gcc.hpp>

BOOST_STDLIB_CONFIG

如果已定义,则应指向要使用的标准库配置文件的名称。定义此项会切断标准库选择逻辑,并消除对包含该逻辑的头文件的依赖。例如,如果您正在使用 STLport,则可以将 BOOST_STDLIB_CONFIG 定义为 <boost/config/stdlib/stlport.hpp>

BOOST_PLATFORM_CONFIG

如果已定义,则应指向要使用的平台配置文件的名称。定义此项会切断平台选择逻辑,并消除对包含该逻辑的头文件的依赖。例如,如果您在 Linux 上编译,则可以将 BOOST_PLATFORM_CONFIG 定义为 <boost/config/platform/linux.hpp>

BOOST_NO_COMPILER_CONFIG

如果已定义,则不会选择或包含任何编译器配置文件。当编译器完全符合标准时,或者当用户头文件(请参阅 BOOST_USER_CONFIG)已添加任何必要的选项时(例如通过 autoconf 生成的配置脚本),请定义此项。

BOOST_NO_STDLIB_CONFIG

如果已定义,则不会选择或包含任何标准库配置文件。当标准库完全符合标准时,或者当用户头文件(请参阅 BOOST_USER_CONFIG)已添加任何必要的选项时(例如通过 autoconf 生成的配置脚本),请定义此项。

BOOST_NO_PLATFORM_CONFIG

如果已定义,则不会选择或包含任何平台配置文件。当平台完全符合标准(并且没有有用的额外功能)时,或者当用户头文件(请参阅 BOOST_USER_CONFIG)已添加任何必要的选项时(例如通过 autoconf 生成的配置脚本),请定义此项。

BOOST_NO_CONFIG

等效于定义所有 BOOST_NO_COMPILER_CONFIGBOOST_NO_STDLIB_CONFIGBOOST_NO_PLATFORM_CONFIG

BOOST_STRICT_CONFIG

对于比上次已知版本更新的编译器版本,通常的行为是假设它们与上次已知版本具有相同的缺陷。通过设置此定义,则假设比上次已知版本更新的编译器版本完全符合标准。这可能对 boost 开发人员或测试人员,以及那些想要使用 boost 测试 beta 编译器版本的人最有用。

BOOST_ASSERT_CONFIG

如果设置了此标志,则如果配置发现任何未知内容,它将停止并显示 #error 而不是继续。Boost 回归测试人员应设置此定义,任何想要快速检查其平台上是否支持 boost 的人也应设置此定义。

BOOST_DISABLE_THREADS

如果已定义,则禁用线程支持,即使编译器在其当前转换模式下支持多线程。

BOOST_DISABLE_WIN32

如果已定义,则禁用 Win32 特定 API 的使用,即使这些 API 可用。除非设置了 BOOST_HAS_PTHREADS,否则也会产生设置 BOOST_DISABLE_THREADS 的效果。当配置系统检测到编译器处于“严格模式”时,可能会自动设置此选项。

BOOST_DISABLE_ABI_HEADERS

阻止 boost 头文件包含任何通常控制结构体打包和对齐等内容的前缀/后缀头文件。

BOOST_ABI_PREFIX

要包含的替代 boost.config 通常选择的前缀头文件,任何替换都应根据需要设置结构体打包和对齐选项。

BOOST_ABI_SUFFIX

要包含的替代 boost.config 通常选择的后缀头文件,任何替换都应撤消前缀头文件的效果。

BOOST_ALL_DYN_LINK

强制将所有具有单独源的库在 Microsoft Windows 上链接为 dll 而不是静态库(此宏用于打开 __declspec(dllimport) 修饰符,以便编译器知道在 dll 中而不是在静态库中查找哪些符号)。请注意,可能有一些库只能静态链接(例如 Boost.Test),而另一些库可能只能动态链接(例如 Boost.Thread),在这些情况下,此宏无效。

BOOST_WHATEVER_DYN_LINK

强制将库“whatever”在 Microsoft Windows 上链接为 dll 而不是静态库:将宏名称的 WHATEVER 部分替换为您要动态链接的库的名称,例如使用 BOOST_DATE_TIME_DYN_LINKBOOST_REGEX_DYN_LINK 等(此宏用于打开 __declspec(dllimport) 修饰符,以便编译器知道在 dll 中而不是在静态库中查找哪些符号)。请注意,可能有一些库只能静态链接(例如 Boost.Test),而另一些库可能只能动态链接(例如 Boost.Thread),在这些情况下,不支持此宏。

BOOST_ALL_NO_LIB

告诉配置系统不要自动选择要链接的库。通常,如果编译器支持 #pragma lib,则只需包含该库的头文件之一,就会自动选择并链接正确的库构建变体。此宏会关闭该功能。

BOOST_WHATEVER_NO_LIB

告诉配置系统不要自动为库“whatever”选择要链接的库,将宏名称中的 WHATEVER 替换为库的名称;例如 BOOST_DATE_TIME_NO_LIBBOOST_REGEX_NO_LIB。通常,如果编译器支持 #pragma lib,则只需包含该库的头文件之一,就会自动选择并链接正确的库构建变体。此宏会关闭该功能。

BOOST_LIB_DIAGNOSTIC

使自动链接代码输出指示所选用于链接的库名称的诊断消息。

BOOST_LIB_BUILDID

如果您使用 --buildid 选项构建 Boost,则将此宏设置为您传递给 bjam 的相同值。例如,如果您使用 bjam address-model=64 --buildid=amd64 构建,则使用 -DBOOST_LIB_BUILDID=amd64 编译您的代码,以确保在链接时选择正确的库。

BOOST_LIB_TOOLSET

覆盖链接的库名称的工具集部分的名称;请注意,如果定义,则必须将其定义为带引号的字符串文字,例如 "abc"。

通过在编译器命令行上设置各种宏或编辑 <boost/config/user.hpp>,可以以多种方式优化 boost 配置设置。

Boost 的配置结构为首先包含用户配置(如果未定义 BOOST_USER_CONFIG,则默认为 <boost/config/user.hpp>)。这将设置任何用户定义的策略,并让用户配置有机会影响下一步发生的事情。

接下来,包含编译器、标准库和平台配置文件。这些文件通过宏包含(BOOST_COMPILER_CONFIG 等,请参阅用户可设置的宏),如果相应的宏未定义,则会包含一个单独的头文件,该头文件会检测正在使用的编译器/标准库/平台,以便设置这些文件。如果设置了相应的 BOOST_NO_XXX 宏(例如 BOOST_NO_COMPILER_CONFIG 来禁用包含任何编译器配置文件 - 请参阅用户可设置的宏),则可以告知配置完全忽略这些头文件。

最后,boost 配置文件包含 <boost/config/detail/suffix.hpp>;此头文件包含任何样板配置代码 - 例如,其中一个 boost 宏的设置意味着还必须设置另一个宏。

以下用法示例仅代表其中的一部分可能性

假设我们正在使用 Visual C++ 6 和 STLport 4.0 构建 boost。假设我们也不打算很快更新我们的编译器或标准库。为了避免在更新 boost 时破坏依赖关系,我们可能希望“冻结”我们的配置文件,这样我们只需要在 boost 代码本身发生更改时才需要重建我们的项目,而不是因为 boost 配置已针对更新版本的 Visual C++ 或 STLport 进行了更新。我们将首先意识到正在使用的配置文件是:<boost/config/compiler/visualc.hpp> 用于编译器,<boost/config/stdlib/stlport.hpp> 用于标准库,以及 <boost/config/platform/win32.hpp> 用于平台。接下来,我们将创建我们自己的私有配置目录:boost/config/mysetup/,并将配置文件复制到其中。最后,打开 <boost/config/user.hpp> 并编辑以下定义

#define BOOST_COMPILER_CONFIG "boost/config/mysetup/visualc.hpp"
#define BOOST_STDLIB_CONFIG "boost/config/mysetup/stlport.hpp"
#define BOOST_USER_CONFIG "boost/config/mysetup/win32.hpp"

现在当您使用 boost 时,其配置文件将直接转到我们的“冻结”版本,并忽略默认版本,您现在将免受更新 boost 时任何配置更改的影响。如果您想修改某些 boost 配置文件,此技术也很有用;例如,如果您正在使用 boost 尚不支持的 beta 编译器版本。

假设您正在使用一个完全符合标准的编译器来使用 Boost;您不关心您的编译器的旧版本可能存在错误的事实,因为您知道当前版本不需要任何配置宏设置。在这种情况下,您可以在命令行中或在 <boost/config/user.hpp> 中定义 BOOST_NO_COMPILER_CONFIG,并完全忽略编译器配置头文件(实际上您忽略了两个头文件,一个用于确定编译器是什么,另一个用于为它配置 Boost)。这会产生两个后果:第一个是需要编译的代码更少,第二个是您删除了对两个 Boost 头文件的依赖。

如果您正在使用类似 Unix 的平台,则可以使用配置脚本来生成基于您当前编译器设置的“冻结”配置 - 有关更多详细信息,请参阅使用配置脚本

Boost 配置库在 <boost-root>/boost/config/ test/ 子目录下提供了一整套回归测试程序

文件

描述

config_info.cpp

打印出有关您的编译器/标准库/平台设置以及您当前的 Boost 配置的详细描述。此程序提供的信息有助于设置 Boost 配置文件。如果您报告说 Boost 为您的编译器/库/平台配置不正确,请在报告所需的更改时包括此程序的输出。

config_test.cpp

包含大多数单个测试用例的单体测试程序。这提供了一个快速检查,以查看 Boost 是否为您的编译器/库/平台正确配置。

limits_test.cpp

测试您的标准库的 std::numeric_limits 实现(或者如果定义了 BOOST_NO_LIMITS,则测试 Boost 提供的替换)。此测试文件在大多数版本的 numeric_limits 上都会失败,主要是由于某些编译器处理 NAN 和无穷大的方式。

no_*pass.cpp

单独的编译器缺陷测试文件。这些文件中的每一个都应该编译,如果有一个未编译,则需要定义相应的 BOOST_NO_XXX 宏 - 有关具体细节,请参阅每个测试文件。

no_*fail.cpp

单独的编译器缺陷测试文件。这些文件中的每一个都不应该编译,如果有一个编译了,则在不需要时定义了相应的 BOOST_NO_XXX 宏 - 有关具体细节,请参阅每个测试文件。

has_*pass.cpp

单独的功能测试文件。如果其中一个未编译,则在不应该定义时定义了相应的 BOOST_HAS_XXX 宏 - 有关具体细节,请参阅每个测试文件。

has_*fail.cpp

单独的功能测试文件。如果其中一个编译了,则可以安全地定义相应的 BOOST_HAS_XXX 宏 - 有关具体细节,请参阅每个测试文件。

虽然您可以将配置回归测试作为单独的测试文件运行,但它们相当多,因此有一些快捷方式可以帮助您

或者,您可以像这样运行配置脚本

./configure --enable-test

在这种情况下,脚本将测试当前配置,而不是从头开始创建新配置。

如果您要报告这些测试针对新平台/库/编译器的结果,请包括完整编译器输出的日志、config_info.cpp 的输出以及通过/失败测试结果。


Next