devn00b
/
EQ2EMu


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
							<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Macro Metafunctions</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="Chapter&#160;1.&#160;The Type Traits Introspection Library">
<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;The Type Traits Introspection Library">
<link rel="prev" href="tti_functionality.html" title="General Functionality">
<link rel="next" href="tti_detail_has_type.html" title="Introspecting an inner type">
</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="tti_functionality.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="tti_detail_has_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="the_type_traits_introspection_library.tti_detail"></a><a class="link" href="tti_detail.html" title="Macro Metafunctions">Macro
    Metafunctions</a>
</h2></div></div></div>
<p>
      The TTI library uses macros to create metafunctions, in the current scope,
      for introspecting an inner element by name. Each macro for a particular type
      of inner element has two forms, the simple one where the first macro parameter
      designating the 'name' of the inner element is used to create the name of the
      metafunction, and the complex one where the first macro parameter, called 'trait',
      designates the name of the metafunction and the second macro parameter designates
      the 'name' to be introspected. Other than that difference, the two forms of
      the macro create metafunctions which have the exact same functionality.
    </p>
<p>
      To use these metafunctions you can include the main general header file 'boost/tti/tti.hpp',
      unless otherwise noted. Alternatively you can include a specific header file
      as given in the table below.
    </p>
<p>
      A table of these macros is given, based on the inner element whose existence
      the metaprogrammer is introspecting. More detailed explanations and examples
      for each of the macro metafunctions will follow this section in the documentation.
      The actual syntax for each macro metafunction can be found in the reference
      section, and examples of usage for all the macro metafunctions can be found
      in the <a class="link" href="tti_usingMM.html#sectti_usingMM">"Using the Macro Metafunctions"</a>
      section.
    </p>
<p>
      In the Template column only the name generated by the simple form of the template
      is given since the name generated by the complex form is always 'trait' where
      'trait' is the first parameter to the corresponding complex form macro.
    </p>
<p>
      All of the introspecting metafunctions in the table below return a boolean
      constant called 'value', which specifies whether or not the inner element exists.
      All of the metafunctions also have a nested type called 'type', which for each
      one is the type of the boolean constant value. This is always boost::mpl::bool_.
    </p>
<div class="table">
<a name="the_type_traits_introspection_library.tti_detail.tbmacros"></a><p class="title"><b>Table&#160;1.2.&#160;TTI Macro Metafunctions</b></p>
<div class="table-contents"><table class="table" summary="TTI Macro Metafunctions">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
              <p>
                Inner Element
              </p>
            </th>
<th>
              <p>
                Macro
              </p>
            </th>
<th>
              <p>
                Template
              </p>
            </th>
<th>
              <p>
                Specific Header File
              </p>
            </th>
</tr></thead>
<tbody>
<tr>
<td>
              <p>
                Type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TYPE.html" title="Macro BOOST_TTI_HAS_TYPE">BOOST_TTI_HAS_TYPE</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_type_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_type_hpp.html" title="Header &lt;boost/tti/has_type.hpp&gt;">has_type.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Type with lambda expression
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TYPE.html" title="Macro BOOST_TTI_HAS_TYPE">BOOST_TTI_HAS_TYPE</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_type_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                class TTI_U = lambda expression invoked with the inner type and returning
                a boolean constant
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_type_hpp.html" title="Header &lt;boost/tti/has_type.hpp&gt;">has_type.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Class Template ( using variadic macros )
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TEMPLATE.html" title="Macro BOOST_TTI_HAS_TEMPLATE">BOOST_TTI_HAS_TEMPLATE</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_template_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                All of the template parameters must be template type parameters (
                'class' or 'typename' parameters )
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">has_template.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Class Template ( not using variadic macros )
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TEMPLATE.html" title="Macro BOOST_TTI_HAS_TEMPLATE">BOOST_TTI_HAS_TEMPLATE</a></code>(name,BOOST_PP_NIL)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_template_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                All of the template parameters must be template type parameters (
                'class' or 'typename' parameters )
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">has_template.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Class Template with params ( using variadic macros )
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TEMPLATE.html" title="Macro BOOST_TTI_HAS_TEMPLATE">BOOST_TTI_HAS_TEMPLATE</a></code>(name,...<a href="#ftn.the_type_traits_introspection_library.tti_detail.f0" class="footnote" name="the_type_traits_introspection_library.tti_detail.f0"><sup class="footnote">[a]</sup></a>)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_template_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">has_template.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Class Template with params
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_TEMPLATE.html" title="Macro BOOST_TTI_HAS_TEMPLATE">BOOST_TTI_HAS_TEMPLATE</a></code>(name,ppArray<a href="#ftn.the_type_traits_introspection_library.tti_detail.f1" class="footnote" name="the_type_traits_introspection_library.tti_detail.f1"><sup class="footnote">[b]</sup></a>)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_template_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">has_template.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Member data
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_MEMBER_DATA.html" title="Macro BOOST_TTI_HAS_MEMBER_DATA">BOOST_TTI_HAS_MEMBER_DATA</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_member_data_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type OR pointer to member data ( 'MemberData_Type
                Enclosing_Type::*' )
              </p>
              <p>
                class TTI_R = (optional) data type. If the first parameter is the
                pointer to member data this must not be specified.
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_member_data_hpp.html" title="Header &lt;boost/tti/has_member_data.hpp&gt;">has_member_data.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Member function
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TT_idm46187185705488.html" title="Macro BOOST_TTI_HAS_MEMBER_FUNCTION">BOOST_TTI_HAS_MEMBER_FUNCTION</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_member_function_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type OR pointer to member function ( 'Return_Type
                Enclosing_Type::* ( Zero or more comma-separated parameter types
                )' )
              </p>
              <p>
                class TTI_R = (optional) return type if the first parameter is the
                enclosing type. If the first parameter is the pointer to member function
                this must not be specified.
              </p>
              <p>
                class TTI_FS = (optional) function parameter types as a Boost MPL
                forward sequence. If the first parameter is the pointer to member
                function this must not be specified. If there are no function parameters
                this does not have to be specified. Defaults to boost::mpl::vector&lt;&gt;.
              </p>
              <p>
                class TTI_TAG = (optional) Boost <code class="computeroutput"><span class="identifier">function_types</span></code>
                tag type. If the first parameter is the pointer to member function
                this must not be specified. Defaults to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">function_types</span><span class="special">::</span><span class="identifier">null_tag</span></code>.
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_member_function_hpp.html" title="Header &lt;boost/tti/has_member_function.hpp&gt;">has_member_function.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Static member data
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TT_idm46187185698016.html" title="Macro BOOST_TTI_HAS_STATIC_MEMBER_DATA">BOOST_TTI_HAS_STATIC_MEMBER_DATA</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_static_member_data_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                class TTI_Type = data type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_static_member_data_hpp.html" title="Header &lt;boost/tti/has_static_member_data.hpp&gt;">has_static_member_data.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Static member function
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TT_idm46187185690608.html" title="Macro BOOST_TTI_HAS_STATIC_MEMBER_FUNCTION">BOOST_TTI_HAS_STATIC_MEMBER_FUNCTION</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_static_member_function_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                class TTI_R = return type OR function type ( 'Return_Type (Zero or
                more comma-separated parameter types)' )
              </p>
              <p>
                class TTI_FS = (optional) function parameter types as a Boost MPL
                forward sequence. If the second parameter is the function type this
                must not be specified. If there are no function parameters, this
                does not have to be specified. Defaults to boost::mpl::vector&lt;&gt;.
              </p>
              <p>
                class TTI_TAG = (optional) Boost <code class="computeroutput"><span class="identifier">function_types</span></code>
                tag type. If the second parameter is the function type this must
                not be specified. Defaults to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">function_types</span><span class="special">::</span><span class="identifier">null_tag</span></code>.
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_static_member_function_hpp.html" title="Header &lt;boost/tti/has_static_member_function.hpp&gt;">has_static_member_function.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Data, either member data or static member data
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_DATA.html" title="Macro BOOST_TTI_HAS_DATA">BOOST_TTI_HAS_DATA</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_data_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                class TTI_Type = data type
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_data_hpp.html" title="Header &lt;boost/tti/has_data.hpp&gt;">has_data.hpp</a></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Function, either member function or static member function
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../BOOST_TTI_HAS_FUNCTION.html" title="Macro BOOST_TTI_HAS_FUNCTION">BOOST_TTI_HAS_FUNCTION</a></code>(name)
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><span class="identifier">has_function_</span><span class="char">'name'</span></code>
              </p>
              <p>
                class TTI_T = enclosing type
              </p>
              <p>
                class TTI_R = return type
              </p>
              <p>
                class TTI_FS = (optional) function parameter types as a Boost MPL
                forward sequence. If there are no function parameters, this does
                not have to be specified. Defaults to boost::mpl::vector&lt;&gt;.
              </p>
              <p>
                class TTI_TAG = (optional) Boost <code class="computeroutput"><span class="identifier">function_types</span></code>
                tag type. Defaults to <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">function_types</span><span class="special">::</span><span class="identifier">null_tag</span></code>.
              </p>
            </td>
<td>
              <p>
                <code class="computeroutput"><a class="link" href="../header/boost/tti/has_function_hpp.html" title="Header &lt;boost/tti/has_function.hpp&gt;">has_function.hpp</a></code>
              </p>
            </td>
</tr>
</tbody>
<tbody class="footnotes"><tr><td colspan="4">
<div id="ftn.the_type_traits_introspection_library.tti_detail.f0" class="footnote"><p><a href="#the_type_traits_introspection_library.tti_detail.f0" class="para"><sup class="para">[a] </sup></a>
                  The template parameters as variadic data.
                </p></div>
<div id="ftn.the_type_traits_introspection_library.tti_detail.f1" class="footnote"><p><a href="#the_type_traits_introspection_library.tti_detail.f1" class="para"><sup class="para">[b] </sup></a>
                  The template parameters as the tuple part of the PP array.
                </p></div>
</td></tr></tbody>
</table></div>
</div>
<br class="table-break">
</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; 2011-2013 Tropic Software
      East Inc<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="tti_functionality.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="tti_detail_has_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>