第 13 章. Boost.Foreach

Eric Niebler

根据 Boost 软件许可证，版本 1.0 分发。（请参阅随附文件 LICENSE_1_0.txt 或复制于 https://boost.ac.cn/LICENSE_1_0.txt)

简介
可扩展性
可移植性
陷阱
历史和致谢

在 C++ 中，编写迭代序列的循环非常繁琐。我们可以使用迭代器，这需要大量的样板代码，或者我们可以使用 std::for_each() 算法并将循环体移动到谓词中，这需要的样板代码不少，并且迫使我们将逻辑移动到远离使用位置的地方。相反，其他一些语言，如 Perl，提供了一个专用的“foreach”结构来自动化这个过程。BOOST_FOREACH 正是 C++ 的这样一个结构。它为我们迭代序列，使我们不必直接处理迭代器或编写谓词。

BOOST_FOREACH 旨在易于使用和高效。它不进行动态分配，不进行虚函数调用或通过函数指针调用，也不进行编译器优化器不透明的调用。这导致接近最优的代码生成；BOOST_FOREACH 的性能通常与等效的手写循环相差几个百分点。虽然 BOOST_FOREACH 是一个宏，但它是一个表现非常好的宏。它只对其参数求值一次，不会导致任何意外。

你好，世界！

下面是一个示例程序，它使用 BOOST_FOREACH 循环遍历 std::string 的内容。

#include <string>
#include <iostream>
#include <boost/foreach.hpp>

int main()
{
    std::string hello( "Hello, world!" );

    BOOST_FOREACH( char ch, hello )
    {
        std::cout << ch;
    }

    return 0;
}

此程序输出以下内容

Hello, world!

支持的序列类型

BOOST_FOREACH 迭代序列。但究竟什么才算是序列呢？由于 BOOST_FOREACH 建立在 Boost.Range 之上，它自动支持 Boost.Range 识别为序列的类型。具体来说，BOOST_FOREACH 适用于满足单遍范围概念的类型。例如，我们可以将 BOOST_FOREACH 用于

STL 容器
数组
以空字符结尾的字符串（char 和 wchar_t）
迭代器 std::pair

	注意
	对 STL 容器的支持非常通用；任何看起来像 STL 容器的东西都算数。如果它具有嵌套的 `iterator` 和 `const_iterator` 类型以及 `begin()` 和 `end()` 成员函数，`BOOST_FOREACH` 将自动知道如何对其进行迭代。正是通过这种方式，`boost::iterator_range<>` 和 `boost::sub_range<>` 可以与 `BOOST_FOREACH` 一起使用。

请参阅关于可扩展性的部分，了解如何使 BOOST_FOREACH 与其他类型一起使用。

示例

以下是一些示例，展示了我们可以使用 BOOST_FOREACH 的所有不同方式。

迭代 STL 容器

std::list<int> list_int( /*...*/ );
BOOST_FOREACH( int i, list_int )
{
    // do something with i
}

迭代数组，具有协变性（即，迭代变量的类型与容器的元素类型不完全相同）

short array_short[] = {1,2,3};
BOOST_FOREACH( int i, array_short )
{
    // The short was implicitly converted to an int
}

预先声明循环变量，并在循环体中使用 break、continue 和 return

std::deque<int> deque_int( /*...*/ );
int i = 0;
BOOST_FOREACH( i, deque_int )
{
    if( i == 0 ) return;
    if( i == 1 ) continue;
    if( i == 2 ) break;
}

通过引用迭代序列，并修改底层序列

short array_short[] = { 1, 2, 3 };
BOOST_FOREACH( short & i, array_short )
{
    ++i;
}
// array_short contains {2,3,4} here

使用嵌套的 BOOST_FOREACH 循环迭代向量向量。在此示例中，请注意循环体周围的大括号不是必需的

std::vector<std::vector<int> > matrix_int;
BOOST_FOREACH( std::vector<int> & row, matrix_int )
    BOOST_FOREACH( int & i, row )
        ++i;

迭代按值（即右值）返回序列的表达式

extern std::vector<float> get_vector_float();
BOOST_FOREACH( float f, get_vector_float() )
{
    // Note: get_vector_float() will be called exactly once
}

反向迭代

std::list<int> list_int( /*...*/ );
BOOST_REVERSE_FOREACH( int i, list_int )
{
    // do something with i
}

在某些较旧的编译器上，对右值的迭代不起作用。检查可移植性部分以查看您的编译器是否支持此功能。

使 `BOOST_FOREACH` 更美观

人们抱怨名称 BOOST_FOREACH。它太长了。全大写 看起来很烦人。这可能是真的，但 BOOST_FOREACH 只是遵循 Boost 命名约定。但这并不意味着您必须坚持使用它。如果您想使用不同的标识符（例如 foreach_），您可以简单地执行以下操作

#define foreach_         BOOST_FOREACH
#define foreach_r_       BOOST_REVERSE_FOREACH

仅当您确定所选标识符不会在代码中导致名称冲突时才执行此操作。

	注意
	不要使用 `#define foreach_(x,y) BOOST_FOREACH(x,y)`。如果参数本身是宏，这可能会出现问题。这将导致这些宏的额外扩展。请改用上面显示的形式。

最后，一个警告。许多人使用 foreach 宏作为 BOOST_FOREACH 的简写形式。我不鼓励这样做。这会导致 BOOST_FOREACH 宏本身内部的名称冲突，其中 foreach 是命名空间的名称。此外，foreach 是一个足够常见的标识符；甚至 Qt 也将其定义为宏。如果您坚持使用 foreach，您可以尝试以下操作

#include <boost/foreach.hpp>

namespace boost
{
    // Suggested work-around for https://svn.boost.org/trac/boost/ticket/6131
    namespace BOOST_FOREACH = foreach;
}

#define foreach   BOOST_FOREACH

这将解决您可能遇到的一些问题，但不是所有问题。最好使用不同的标识符。

Boost C++ 库