generic-library/boost
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
main
boost/libs/tti/doc/html/BOOST_TT_idm45635865837008.html
Edouard DUPIN d0115b733d [DEV] add v1.76.0
2021-10-05 21:37:46 +02:00

110 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Macro BOOST_TTI_TRAIT_HAS_TEMPLATE</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 1. The Type Traits Introspection Library">
<link rel="up" href="header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">
<link rel="prev" href="header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">
<link rel="next" href="BOOST_TTI_HAS_TEMPLATE.html" title="Macro BOOST_TTI_HAS_TEMPLATE">
</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="header/boost/tti/has_template_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_template_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="BOOST_TTI_HAS_TEMPLATE.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_TT_idm45635865837008"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_TTI_TRAIT_HAS_TEMPLATE</span></h2>
<p>BOOST_TTI_TRAIT_HAS_TEMPLATE — A macro which expands to a metafunction which tests whether an inner class template with a particular name exists. </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="header/boost/tti/has_template_hpp.html" title="Header &lt;boost/tti/has_template.hpp&gt;">boost/tti/has_template.hpp</a>&gt;
</span>BOOST_TTI_TRAIT_HAS_TEMPLATE(trait, ...)</pre></div>
<div class="refsect1">
<a name="idm46191512606304"></a><h2>Description</h2>
<p>BOOST_TTI_TRAIT_HAS_TEMPLATE is a macro which expands to a metafunction. The metafunction tests whether an inner class template with a particular name exists. The macro takes the form of BOOST_TTI_TRAIT_HAS_TEMPLATE(trait,...) where</p>
<p>trait = the name of the metafunction <br>
... = variadic parameters.</p>
<p>The first variadic parameter is the inner class template name.</p>
<p>Following variadic parameters are optional.</p>
<p>If no following variadic parameters exist, then the inner class template being introspected must be all template type parameters ( template parameters starting with <code class="computeroutput">class</code> or <code class="computeroutput">typename</code> ) and any number of template type parameters can occur.</p>
<p>If the second variadic parameter is BOOST_PP_NIL and no other variadic parameter is given, then just as in the previous case the inner class template being introspected must be all template type parameters ( template parameters starting with <code class="computeroutput">class</code> or <code class="computeroutput">typename</code> ) and any number of template type parameters can occur. This form is allowed in order to be consistent with using the non-variadic form of this macro.</p>
<p>If the second variadic parameter is a Boost preprocessor library array and no other variadic parameter is given, then the inner class template must have its template parameters matching the sequence in the tuple portion of the Boost PP array. This form is allowed in order to be consistent with using the non-variadic form of this macro.</p>
<p>Otherwise the inner class template must have its template parameters matching the sequence of the optional variadic parameters.</p>
<p>BOOST_TTI_TRAIT_HAS_TEMPLATE generates a metafunction called "trait" where 'trait' is the first macro parameter.</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TP_T</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">trait</span>
<span class="special">{</span>
<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>
<span class="keyword">typedef</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">bool_</span><span class="special">&lt;</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">&gt;</span> <span class="identifier">type</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span>
<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>
<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>
<span class="identifier">The</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">can</span> <span class="identifier">be</span> <span class="identifier">a</span> <span class="keyword">class</span><span class="special">,</span> <span class="keyword">struct</span><span class="special">,</span> <span class="identifier">or</span> <span class="keyword">union</span><span class="special">.</span>
<span class="identifier">returns</span> <span class="special">=</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">template</span> <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="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>
</pre>
<p>Examples:</p>
<pre class="programlisting"><span class="number">1</span><span class="special">)</span> <span class="identifier">Search</span> <span class="keyword">for</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">class</span> <span class="keyword">template</span> <span class="identifier">called</span> <span class="char">'MyTemplate'</span><span class="special">,</span> <span class="identifier">with</span> <span class="identifier">all</span> <span class="keyword">template</span> <span class="identifier">type</span> <span class="identifier">parameters</span><span class="special">,</span>
<span class="identifier">nested</span> <span class="identifier">within</span> <span class="identifier">the</span> <span class="keyword">class</span> <span class="char">'MyClass'</span> <span class="keyword">using</span> <span class="identifier">a</span> <span class="identifier">metafunction</span> <span class="identifier">name</span> <span class="identifier">of</span> <span class="char">'MyMeta'</span><span class="special">.</span>
<span class="identifier">BOOST_TTI_TRAIT_HAS_TEMPLATE</span><span class="special">(</span><span class="identifier">MyMeta</span><span class="special">,</span><span class="identifier">MyTemplate</span><span class="special">)</span>
<span class="identifier">or</span>
<span class="identifier">BOOST_TTI_TRAIT_HAS_TEMPLATE</span><span class="special">(</span><span class="identifier">MyMeta</span><span class="special">,</span><span class="identifier">MyTemplate</span><span class="special">,</span><span class="identifier">BOOST_PP_NIL</span><span class="special">)</span> <span class="comment">// Non-variadic macro form</span>
<span class="identifier">MyMeta</span><span class="special">&lt;</span><span class="identifier">MyClass</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span>
<span class="identifier">is</span> <span class="identifier">a</span> <span class="identifier">compile</span> <span class="identifier">time</span> <span class="identifier">boolean</span> <span class="identifier">constant</span> <span class="identifier">which</span> <span class="identifier">is</span> <span class="identifier">either</span> <span class="char">'true'</span> <span class="identifier">or</span> <span class="char">'false'</span>
<span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">nested</span> <span class="keyword">template</span> <span class="identifier">exists</span><span class="special">.</span>
<span class="number">2</span><span class="special">)</span> <span class="identifier">Search</span> <span class="keyword">for</span> <span class="identifier">an</span> <span class="identifier">inner</span> <span class="keyword">class</span> <span class="keyword">template</span> <span class="identifier">called</span> <span class="char">'MyTemplate'</span><span class="special">,</span> <span class="identifier">with</span> <span class="keyword">template</span> <span class="identifier">parameters</span>
<span class="identifier">of</span> <span class="char">'class T,int x,template&lt;class&gt; class U'</span><span class="special">,</span> <span class="identifier">nested</span> <span class="identifier">within</span> <span class="identifier">the</span> <span class="keyword">class</span> <span class="char">'MyClass'</span>
<span class="keyword">using</span> <span class="identifier">a</span> <span class="identifier">metafunction</span> <span class="identifier">name</span> <span class="identifier">of</span> <span class="char">'MyMeta'</span><span class="special">.</span>
<span class="identifier">BOOST_TTI_TRAIT_HAS_TEMPLATE</span><span class="special">(</span><span class="identifier">MyMeta</span><span class="special">,</span><span class="identifier">MyTemplate</span><span class="special">,</span><span class="keyword">class</span><span class="special">,</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">&gt;</span> <span class="keyword">class</span><span class="special">)</span>
<span class="identifier">or</span>
<span class="identifier">BOOST_TTI_TRAIT_HAS_TEMPLATE</span><span class="special">(</span><span class="identifier">MyMeta</span><span class="special">,</span><span class="identifier">MyTemplate</span><span class="special">,</span><span class="special">(</span><span class="number">3</span><span class="special">,</span><span class="special">(</span><span class="keyword">class</span><span class="special">,</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">&gt;</span> <span class="keyword">class</span><span class="special">)</span><span class="special">)</span><span class="special">)</span> <span class="comment">// Non-variadic macro form</span>
<span class="identifier">MyMeta</span><span class="special">&lt;</span><span class="identifier">MyClass</span><span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span>
<span class="identifier">is</span> <span class="identifier">a</span> <span class="identifier">compile</span> <span class="identifier">time</span> <span class="identifier">boolean</span> <span class="identifier">constant</span> <span class="identifier">which</span> <span class="identifier">is</span> <span class="identifier">either</span> <span class="char">'true'</span> <span class="identifier">or</span> <span class="char">'false'</span>
<span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">nested</span> <span class="keyword">template</span> <span class="identifier">exists</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 © 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="header/boost/tti/has_template_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_template_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="BOOST_TTI_HAS_TEMPLATE.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink