summaryrefslogtreecommitdiff
path: root/doc/html/BOOST_INTRUSIVE_OPTION_TYPE.html
blob: 7518f594d49672148c39f4a1519bc5c1bde898db (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
<!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_INTRUSIVE_OPTION_TYPE</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="intrusive/reference.html#header.boost.intrusive.pack_options_hpp" title="Header &lt;boost/intrusive/pack_options.hpp&gt;">
<link rel="prev" href="boost/intrusive/pack_options.html" title="Struct template pack_options">
<link rel="next" href="BOOST_INTRUSIVE_OPTION_CONSTANT.html" title="Macro BOOST_INTRUSIVE_OPTION_CONSTANT">
</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/intrusive/pack_options.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="intrusive/reference.html#header.boost.intrusive.pack_options_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_INTRUSIVE_OPTION_CONSTANT.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_INTRUSIVE_OPTION_TYPE"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_INTRUSIVE_OPTION_TYPE</span></h2>
<p>BOOST_INTRUSIVE_OPTION_TYPE</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="intrusive/reference.html#header.boost.intrusive.pack_options_hpp" title="Header &lt;boost/intrusive/pack_options.hpp&gt;">boost/intrusive/pack_options.hpp</a>&gt;

</span>BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME)</pre></div>
<div class="refsect1">
<a name="idp421495232"></a><h2>Description</h2>
<p>Defines an option class of name OPTION_NAME that can be used to specify a type of type TYPE...</p>
<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">OPTION_NAME</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">TYPE</span><span class="special">&gt;</span>
<span class="special">{</span>  <span class="identifier">unspecified_content</span>  <span class="special">}</span><span class="special">;</span>
</pre>
<p>...that after being combined with <code class="computeroutput"><a class="link" href="boost/intrusive/pack_options.html" title="Struct template pack_options">boost::intrusive::pack_options</a></code>, will typedef TYPE as a typedef of name TYPEDEF_NAME. Example:</p>
<pre class="programlisting"><span class="comment">//[includes and namespaces omitted for brevity]</span>

<span class="comment">//This macro will create the following class:</span>
<span class="comment">//    template&lt;class VoidPointer&gt;</span>
<span class="comment">//    struct my_pointer</span>
<span class="comment">//    { unspecified_content };</span>
<span class="identifier">BOOST_INTRUSIVE_OPTION_TYPE</span><span class="special">(</span><span class="identifier">my_pointer</span><span class="special">,</span> <span class="identifier">VoidPointer</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">remove_pointer</span><span class="special">&lt;</span><span class="identifier">VoidPointer</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span><span class="special">,</span> <span class="identifier">my_pointer_type</span><span class="special">)</span>

<span class="keyword">struct</span> <span class="identifier">empty_default</span><span class="special">{</span><span class="special">}</span><span class="special">;</span>

<span class="keyword">typedef</span> <span class="identifier">pack_options</span><span class="special">&lt;</span> <span class="identifier">empty_default</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">my_pointer</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">*</span><span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span><span class="special">::</span><span class="identifier">my_pointer_type</span> <span class="identifier">type</span><span class="special">;</span>

<span class="identifier">BOOST_STATIC_ASSERT</span><span class="special">(</span><span class="special">(</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special">&lt;</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">void</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span> <span class="special">)</span><span class="special">)</span><span class="special">;</span>
</pre>
<p> </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; 2005 Olaf Krzikalla<br>Copyright &#169; 2006-2015 Ion Gaztanaga<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt 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/intrusive/pack_options.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="intrusive/reference.html#header.boost.intrusive.pack_options_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_INTRUSIVE_OPTION_CONSTANT.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>