boost/libs/tti/doc/html/BOOST_TT_idm45635865922720.html
2021-10-05 21:37:46 +02:00

89 lines
11 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_HAS_FUNCTION_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_function_template_hpp.html" title="Header &lt;boost/tti/has_function_template.hpp&gt;">
<link rel="prev" href="BOOST_TT_idm45635865930736.html" title="Macro BOOST_TTI_TRAIT_HAS_FUNCTION_TEMPLATE">
<link rel="next" href="header/boost/tti/has_member_data_hpp.html" title="Header &lt;boost/tti/has_member_data.hpp&gt;">
</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_TT_idm45635865930736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_function_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="header/boost/tti/has_member_data_hpp.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="BOOST_TT_idm45635865922720"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Macro BOOST_TTI_HAS_FUNCTION_TEMPLATE</span></h2>
<p>BOOST_TTI_HAS_FUNCTION_TEMPLATE — A macro which expands to a metafunction which tests whether an inner member function template or static member function 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_function_template_hpp.html" title="Header &lt;boost/tti/has_function_template.hpp&gt;">boost/tti/has_function_template.hpp</a>&gt;
</span>BOOST_TTI_HAS_FUNCTION_TEMPLATE(name, ...)</pre></div>
<div class="refsect1">
<a name="idm46191514243392"></a><h2>Description</h2>
<p>BOOST_TTI__HAS_FUNCTION_TEMPLATE is a macro which expands to a metafunction. The metafunction tests whether an inner member function template or static member function template with a particular name exists. The macro takes the form of BOOST_TTI_HAS_FUNCTION_TEMPLATE(name,...) where</p>
<p>name = inner member function template or static member function template name <br>
... = variadic parameters.</p>
<p>The variadic parameter(s) are either:</p>
<p>A sequence of valid instantiations for the static member function template parameters ie. 'int,long,double' etc.</p>
<p>or</p>
<p>A single variadic parameter which is a Boost PP array whose elements are a sequence of valid instantiations for the static member function template parameters ie. '(3,(int,long,double))' etc. This form is allowed in order to be compatible with using the non-variadic form of this macro.</p>
<p>BOOST_TTI_HAS_FUNCTION_TEMPLATE generates a metafunction called "has_function_template_'name'" where 'name' 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">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_R</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_FS</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TAG</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">has_function_template_</span><span class="char">'name'</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">BOOST_TTI_TP_R</span> <span class="special">=</span> <span class="identifier">the</span> <span class="keyword">return</span> <span class="identifier">type</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span>
<span class="identifier">in</span> <span class="identifier">a</span> <span class="identifier">single</span> <span class="identifier">instantiation</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span>
<span class="identifier">BOOST_TTI_TP_FS</span> <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">the</span> <span class="identifier">parameters</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">as</span> <span class="identifier">a</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpl</span> <span class="identifier">forward</span> <span class="identifier">sequence</span>
<span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">parameters</span> <span class="identifier">are</span> <span class="identifier">not</span> <span class="identifier">empty</span><span class="special">.</span> <span class="identifier">These</span> <span class="identifier">parameters</span> <span class="identifier">are</span> <span class="identifier">a</span> <span class="identifier">single</span>
<span class="identifier">instantiation</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span><span class="special">.</span>
<span class="identifier">BOOST_TTI_TP_TAG</span> <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">a</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function_types</span> <span class="identifier">tag</span> <span class="identifier">to</span> <span class="identifier">apply</span> <span class="identifier">to</span> <span class="identifier">the</span> <span class="identifier">function</span> <span class="keyword">template</span>
<span class="keyword">if</span> <span class="identifier">a</span> <span class="identifier">tag</span> <span class="identifier">is</span> <span class="identifier">needed</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="identifier">exists</span><span class="special">,</span>
<span class="identifier">with</span> <span class="identifier">the</span> <span class="identifier">appropriate</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">or</span> <span class="keyword">static</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</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> </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="BOOST_TT_idm45635865930736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_function_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="header/boost/tti/has_member_data_hpp.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>