libs/vmd/doc/html/BOOST_VMD_IS_IDENTIFIER.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_VMD_IS_IDENTIFIER</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&#160;1.&#160;The Variadic Macro Data Library 1.9">
   8 <link rel="up" href="header/boost/vmd/is_identifier_hpp.html" title="Header &lt;boost/vmd/is_identifier.hpp&gt;">
   9 <link rel="prev" href="header/boost/vmd/is_identifier_hpp.html" title="Header &lt;boost/vmd/is_identifier.hpp&gt;">
  10 <link rel="next" href="BOOST_VMD_IS_IDENTIFIER_D.html" title="Macro BOOST_VMD_IS_IDENTIFIER_D">
  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="header/boost/vmd/is_identifier_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/is_identifier_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_VMD_IS_IDENTIFIER_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_VMD_IS_IDENTIFIER"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_VMD_IS_IDENTIFIER</span></h2>
  29 <p>BOOST_VMD_IS_IDENTIFIER &#8212; Tests whether a parameter is an identifier. </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: &lt;<a class="link" href="header/boost/vmd/is_identifier_hpp.html" title="Header &lt;boost/vmd/is_identifier.hpp&gt;">boost/vmd/is_identifier.hpp</a>&gt;
  33
  34 </span>BOOST_VMD_IS_IDENTIFIER(...)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45529680740048"></a><h2>Description</h2>
  37 <p>... = variadic parameters</p>
  38 <p>The first variadic parameter is required and it is the input to test.</p>
  39 <p>Further variadic parameters are optional and are identifiers to match. The data may take one of two forms; it is either one or more single identifiers or a single Boost PP tuple of identifiers.</p>
  40 <p>returns = 1 if the parameter is an identifier, otherwise 0.         If the parameter is not an identifier,
  41         or if optional identifiers are specified and the identifier
  42         does not match any of the optional identifiers, the macro returns 0.
  43 </p>
  44 <p>Identifiers are registered in VMD with: #define BOOST_VMD_REG_XXX (XXX) where XXX is a v-identifier.
  45 </p>
  46 <p>The identifier must be registered to be found.</p>
  47 <p>Identifiers are pre-detected in VMD with: #define BOOST_VMD_DETECT_XXX_XXX where XXX is an identifier.
  48 </p>
  49 <p>If you specify optional identifiers and have not specified the detection of an optional identifier, that optional identifier will never match the input.</p>
  50 <p>If the input is not a VMD data type this macro could lead to a preprocessor error. This is because the macro uses preprocessor concatenation to determine if the input is an identifier once it is determined that the input does not start with parenthesis. If the data being concatenated would lead to an invalid preprocessor token the compiler can issue a preprocessor error. </p>
  51 </div>
  52 </div>
  53 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  54 <td align="left"></td>
  55 <td align="right"><div class="copyright-footer">Copyright &#169; 2010-2017 Tropic Software
  56       East Inc</div></td>
  57 </tr></table>
  58 <hr>
  59 <div class="spirit-nav">
  60 <a accesskey="p" href="header/boost/vmd/is_identifier_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/vmd/is_identifier_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_VMD_IS_IDENTIFIER_D.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  61 </div>
  62 </body>
  63 </html>