BOOST_PP_ENUM

The BOOST_PP_ENUM macro generates a comma-separated list.

Usage

BOOST_PP_ENUM (count, macro, data)

Arguments

count The number of repetitious calls to macro. Valid values range from 0 to BOOST_PP_LIMIT_REPEAT. macro A ternary operation of the form macro(z, n, data). This macro is expanded by BOOST_PP_ENUM with the next available repetition depth, the current repetition number, and the auxiliary data argument. data Auxiliary data passed to macro.

Remarks

This macro expands to the comma-separated sequence: macro(z, 0, data), macro(z, 1, data), ... macro(z, count - 1, data)

The z value that is passed to macro represents the next available repetition dimension. Other macros that have _Z suffix variants internally use BOOST_PP_REPEAT --for example, BOOST_PP_ENUM_PARAMS and BOOST_PP_ENUM_PARAMS_Z. Using these _Z versions is not strictly necessary, but passing the z value (that is passed to macro) to these macros allows them to reenter BOOST_PP_REPEAT with maximum efficiency.

To directly use this z value, rather than simply passing it to another macro, see BOOST_PP_ENUM_z.

Previously, this macro could not be used recursively inside BOOST_PP_REPEAT. This limitation no longer exists, as the library can automatically detect the next available repetition depth.

See Also

• BOOST_PP_ENUM_z
• BOOST_PP_LIMIT_REPEAT

Requirements

Header: <boost/preprocessor/repetition/enum.hpp>

Sample Code

#include <[boost/preprocessor/repetition/enum.hpp](../headers/repetition/enum.html)>

#define TEXT(z, n, text) text[BOOST\_PP\_ENUM](enum.html)(4, TEXT, class) // expands to class, class, class, class

Copyright Housemarque Oy 2002 Copyright Paul Mensonides 2002

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)