summaryrefslogtreecommitdiff
path: root/doc/html/BOOST_VARIANT_ENUM_PARAMS.html
blob: ef05a5f31903eefbd4995eaebb44cc53d220dcea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Macro BOOST_VARIANT_ENUM_PARAMS</title>
<link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="variant/reference.html#header.boost.variant.variant_fwd_hpp" title="Header &lt;boost/variant/variant_fwd.hpp&gt;">
<link rel="prev" href="BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES.html" title="Macro BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES">
<link rel="next" href="BOOST_VARIANT_ENUM_SHIFTED_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_SHIFTED_PARAMS">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.html">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#header.boost.variant.variant_fwd_hpp"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_VARIANT_ENUM_SHIFTED_PARAMS.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_VARIANT_ENUM_PARAMS"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_VARIANT_ENUM_PARAMS</span></h2>
<p>BOOST_VARIANT_ENUM_PARAMS &#8212; Enumerate parameters for use with
        <code class="computeroutput"><a class="link" href="boost/variant.html" title="Class template variant">variant</a></code>.</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="variant/reference.html#header.boost.variant.variant_fwd_hpp" title="Header &lt;boost/variant/variant_fwd.hpp&gt;">boost/variant/variant_fwd.hpp</a>&gt;

</span>BOOST_VARIANT_ENUM_PARAMS(param)</pre></div>
<div class="refsect1">
<a name="idp613741792"></a><h2>Description</h2>
<p> When variadic templates are available and
        <code class="computeroutput"><a class="link" href="BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES.html" title="Macro BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES">BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES</a></code>
        is not defined, expands to variadic template list in the following manner:
        <code class="computeroutput"><pre class="programlisting">
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span>                    <span class="special">=</span><span class="special">&gt;</span> <span class="identifier">T0</span><span class="special">,</span> <span class="identifier">TN</span><span class="special">...</span>
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">)</span>              <span class="special">=</span><span class="special">&gt;</span> <span class="keyword">class</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> <span class="identifier">TN</span>
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="keyword">class</span> <span class="identifier">Something</span><span class="special">)</span>      <span class="special">=</span><span class="special">&gt;</span> <span class="keyword">class</span> <span class="identifier">Something0</span><span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> <span class="identifier">SomethingN</span>
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">Something</span><span class="special">)</span>   <span class="special">=</span><span class="special">&gt;</span> <span class="keyword">typename</span> <span class="identifier">Something0</span><span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> <span class="identifier">SomethingN</span>
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="identifier">Something</span><span class="special">)</span>            <span class="special">=</span><span class="special">&gt;</span> <span class="identifier">Something0</span><span class="special">,</span> <span class="identifier">SomethingN</span><span class="special">...</span>
            <span class="identifier">BOOST_VARIANT_ENUM_PARAMS</span><span class="special">(</span><span class="identifier">Something</span><span class="special">)</span>            <span class="special">=</span><span class="special">&gt;</span> <span class="identifier">Something0</span><span class="special">,</span> <span class="identifier">SomethingN</span><span class="special">...</span>
        </pre></code>
      </p>
<p>
        Otherwise expands to a comma-separated sequence of length
        <code class="computeroutput"><a class="link" href="BOOST_VARIANT_LIMIT_TYPES.html" title="Macro BOOST_VARIANT_LIMIT_TYPES">BOOST_VARIANT_LIMIT_TYPES</a></code>, where
        each element in the sequence consists of the concatenation of
        <span class="emphasis"><em>param</em></span> with its zero-based index into the
        sequence. That is,
        <code class="computeroutput">param ## 0, param ## 1, ..., param ## BOOST_VARIANT_LIMIT_TYPES - 1</code>.</p>
<p><span class="bold"><strong>Rationale</strong></span>: This macro greatly
        simplifies for the user the process of declaring
        <code class="computeroutput"><a class="link" href="boost/variant.html" title="Class template variant">variant</a></code> types
        in function templates or explicit partial specializations of class
        templates, as shown in the
        <a class="link" href="variant/tutorial.html#variant.tutorial.preprocessor" title="Preprocessor macros">tutorial</a>.</p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2002, 2003 Eric Friedman, Itay Maman<p>Distributed under the Boost Software License, Version 1.0.
    (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
    <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="BOOST_VARIANT_DO_NOT_USE_VARIADIC_TEMPLATES.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="variant/reference.html#header.boost.variant.variant_fwd_hpp"><img src="../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="BOOST_VARIANT_ENUM_SHIFTED_PARAMS.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>