1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Macro BOOST_TTI_HAS_UNION</title> 5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="Chapter 1. The Type Traits Introspection Library"> 8<link rel="up" href="header/boost/tti/has_union_hpp.html" title="Header <boost/tti/has_union.hpp>"> 9<link rel="prev" href="BOOST_TTI_TRAIT_HAS_UNION.html" title="Macro BOOST_TTI_TRAIT_HAS_UNION"> 10<link rel="next" href="header/boost/tti/member_type_hpp.html" title="Header <boost/tti/member_type.hpp>"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 15<td align="center"><a href="../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="BOOST_TTI_TRAIT_HAS_UNION.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_union_hpp.html"><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="header/boost/tti/member_type_hpp.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="BOOST_TTI_HAS_UNION"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Macro BOOST_TTI_HAS_UNION</span></h2> 29<p>BOOST_TTI_HAS_UNION — A macro which expands to a metafunction which tests whether an inner union with a particular name exists. </p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="header/boost/tti/has_union_hpp.html" title="Header <boost/tti/has_union.hpp>">boost/tti/has_union.hpp</a>> 33 34</span>BOOST_TTI_HAS_UNION(name)</pre></div> 35<div class="refsect1"> 36<a name="idm45658022376336"></a><h2>Description</h2> 37<p>BOOST_TTI_HAS_UNION is a macro which expands to a metafunction. The metafunction tests whether an inner union with a particular name exists and, optionally, whether an MPL lambda expression invoked with the inner union is true or not. The macro takes the form of BOOST_TTI_HAS_UNION(name) where</p> 38<p>name = the name of the inner union.</p> 39<p>BOOST_TTI_HAS_UNION generates a metafunction called "has_union_'name'" where 'name' is the macro parameter.</p> 40<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TP_T</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TP_U</span><span class="special">></span> 41<span class="keyword">struct</span> <span class="identifier">has_union_</span><span class="char">'name'</span> 42 <span class="special">{</span> 43 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">value</span> <span class="special">=</span> <span class="identifier">unspecified</span><span class="special">;</span> 44 <span class="keyword">typedef</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">bool_</span><span class="special"><</span><span class="keyword">true</span><span class="special">-</span><span class="identifier">or</span><span class="special">-</span><span class="keyword">false</span><span class="special">></span> <span class="identifier">type</span><span class="special">;</span> 45 <span class="special">}</span><span class="special">;</span> 46 47<span class="identifier">The</span> <span class="identifier">metafunction</span> <span class="identifier">types</span> <span class="identifier">and</span> <span class="keyword">return</span><span class="special">:</span> 48 49 <span class="identifier">BOOST_TTI_TP_T</span> <span class="special">=</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">in</span> <span class="identifier">which</span> <span class="identifier">to</span> <span class="identifier">look</span> <span class="keyword">for</span> <span class="identifier">our</span> <span class="char">'name'</span><span class="special">.</span> 50 51 <span class="identifier">BOOST_TTI_TP_U</span> <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">An</span> <span class="identifier">optional</span> <span class="keyword">template</span> <span class="identifier">parameter</span><span class="special">,</span> <span class="identifier">defaulting</span> <span class="identifier">to</span> <span class="identifier">a</span> <span class="identifier">marker</span> <span class="identifier">type</span><span class="special">.</span> 52 <span class="identifier">If</span> <span class="identifier">specified</span> <span class="identifier">it</span> <span class="identifier">is</span> <span class="identifier">an</span> <span class="identifier">MPL</span> <span class="identifier">lambda</span> <span class="identifier">expression</span> <span class="identifier">which</span> <span class="identifier">is</span> <span class="identifier">invoked</span> 53 <span class="identifier">with</span> <span class="identifier">the</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">found</span> <span class="identifier">and</span> <span class="identifier">must</span> <span class="keyword">return</span> <span class="identifier">a</span> <span class="identifier">constant</span> <span class="identifier">boolean</span> 54 <span class="identifier">value</span><span class="special">.</span> 55 56 <span class="identifier">returns</span> <span class="special">=</span> <span class="char">'value'</span> <span class="identifier">depends</span> <span class="identifier">on</span> <span class="identifier">whether</span> <span class="identifier">or</span> <span class="identifier">not</span> <span class="identifier">the</span> <span class="identifier">optional</span> <span class="identifier">BOOST_TTI_TP_U</span> <span class="identifier">is</span> <span class="identifier">specified</span><span class="special">.</span> 57 58 <span class="identifier">If</span> <span class="identifier">BOOST_TTI_TP_U</span> <span class="identifier">is</span> <span class="identifier">not</span> <span class="identifier">specified</span><span class="special">,</span> <span class="identifier">then</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">the</span> <span class="char">'name'</span> <span class="keyword">union</span> 59 <span class="identifier">exists</span> <span class="identifier">within</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">BOOST_TTI_TP_T</span><span class="special">;</span> <span class="identifier">otherwise</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">false</span><span class="special">.</span> 60 61 <span class="identifier">If</span> <span class="identifier">BOOST_TTI_TP_U</span> <span class="identifier">is</span> <span class="identifier">specified</span><span class="special">,</span> <span class="identifier">then</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">the</span> <span class="char">'name'</span> <span class="keyword">union</span> <span class="identifier">exists</span> 62 <span class="identifier">within</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">BOOST_TTI_TP_T</span> <span class="identifier">and</span> <span class="identifier">the</span> <span class="identifier">MPL</span> <span class="identifier">lambda</span> <span class="identifier">expression</span> <span class="identifier">as</span> <span class="identifier">specified</span> 63 <span class="identifier">by</span> <span class="identifier">BOOST_TTI_TP_U</span><span class="special">,</span> <span class="identifier">invoked</span> <span class="identifier">by</span> <span class="identifier">passing</span> <span class="identifier">the</span> <span class="identifier">actual</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">of</span> <span class="char">'name'</span><span class="special">,</span> <span class="identifier">returns</span> 64 <span class="identifier">a</span> <span class="char">'value'</span> <span class="identifier">of</span> <span class="keyword">true</span><span class="special">;</span> <span class="identifier">otherwise</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">false</span><span class="special">.</span> 65 66 <span class="identifier">The</span> <span class="identifier">action</span> <span class="identifier">taken</span> <span class="identifier">with</span> <span class="identifier">BOOST_TTI_TP_U</span> <span class="identifier">occurs</span> <span class="identifier">only</span> <span class="identifier">when</span> <span class="identifier">the</span> <span class="char">'name'</span> <span class="keyword">union</span> <span class="identifier">exists</span> 67 <span class="identifier">within</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">BOOST_TTI_TP_T</span><span class="special">.</span> 68</pre> 69<p>Example usage:</p> 70<pre class="programlisting"><span class="identifier">BOOST_TTI_HAS_UNION</span><span class="special">(</span><span class="identifier">MyType</span><span class="special">)</span> <span class="identifier">generates</span> <span class="identifier">the</span> <span class="identifier">metafunction</span> <span class="identifier">has_union_MyType</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">current</span> <span class="identifier">scope</span> 71<span class="identifier">to</span> <span class="identifier">look</span> <span class="keyword">for</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">called</span> <span class="identifier">MyType</span><span class="special">.</span> 72 73<span class="identifier">has_union_MyType</span><span class="special"><</span><span class="identifier">EnclosingType</span><span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">MyType</span> <span class="identifier">is</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">of</span> <span class="identifier">EnclosingType</span><span class="special">,</span> <span class="identifier">otherwise</span> <span class="keyword">false</span><span class="special">.</span> 74 75<span class="identifier">has_class_MyType</span><span class="special"><</span><span class="identifier">EnclosingType</span><span class="special">,</span><span class="identifier">ALambdaExpression</span><span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">MyType</span> <span class="identifier">is</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">of</span> <span class="identifier">EnclosingType</span> 76 <span class="identifier">and</span> <span class="identifier">invoking</span> <span class="identifier">ALambdaExpression</span> <span class="identifier">with</span> <span class="identifier">the</span> <span class="identifier">inner</span> <span class="keyword">union</span> <span class="identifier">returns</span> <span class="identifier">a</span> <span class="identifier">value</span> <span class="identifier">of</span> <span class="keyword">true</span><span class="special">,</span> <span class="identifier">otherwise</span> <span class="keyword">false</span><span class="special">.</span> 77 78<span class="identifier">A</span> <span class="identifier">popular</span> <span class="identifier">use</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">optional</span> <span class="identifier">MPL</span> <span class="identifier">lambda</span> <span class="identifier">expression</span> <span class="identifier">is</span> <span class="identifier">to</span> <span class="identifier">check</span> <span class="identifier">whether</span> <span class="identifier">the</span> <span class="keyword">union</span> <span class="identifier">found</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">same</span> 79<span class="identifier">as</span> <span class="identifier">another</span> <span class="identifier">type</span><span class="special">,</span> <span class="identifier">when</span> <span class="identifier">the</span> <span class="keyword">union</span> <span class="identifier">found</span> <span class="identifier">is</span> <span class="identifier">a</span> <span class="keyword">typedef</span><span class="special">.</span> <span class="identifier">In</span> <span class="identifier">that</span> <span class="keyword">case</span> <span class="identifier">our</span> <span class="identifier">example</span> <span class="identifier">would</span> <span class="identifier">be</span><span class="special">:</span> 80 81<span class="identifier">has_union_MyType</span><span class="special"><</span><span class="identifier">EnclosingType</span><span class="special">,</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special"><</span><span class="identifier">_</span><span class="special">,</span><span class="identifier">SomeOtherType</span><span class="special">></span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">MyType</span> <span class="identifier">is</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">union</span> 82 <span class="identifier">of</span> <span class="identifier">EnclosingType</span> <span class="identifier">and</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">same</span> <span class="identifier">type</span> <span class="identifier">as</span> <span class="identifier">SomeOtherType</span><span class="special">.</span> 83</pre> 84<p> </p> 85</div> 86</div> 87<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 88<td align="left"></td> 89<td align="right"><div class="copyright-footer">Copyright © 2011-2013 Tropic Software 90 East Inc<p> 91 Distributed under the Boost Software License, Version 1.0. (See accompanying 92 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>) 93 </p> 94</div></td> 95</tr></table> 96<hr> 97<div class="spirit-nav"> 98<a accesskey="p" href="BOOST_TTI_TRAIT_HAS_UNION.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_union_hpp.html"><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="header/boost/tti/member_type_hpp.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 99</div> 100</body> 101</html> 102
