boost_preprocessor 0.1.0

Boost C++ library boost_preprocessor packaged using Zanbil
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <meta content="text/html; charset=windows-1252"
      http-equiv="content-type">
    <title>BOOST_PP_OVERLOAD</title>
    <link rel="stylesheet" type="text/css" href="../styles.css">
  </head>
  <body>
    <div style="margin-left: 0px;"> The <b>BOOST_PP_OVERLOAD</b>
      variadic macro expands to the name of a non-variadic macro having
      a given number of parameters.<br>
    </div>
    <h4>Usage</h4>
    <div class="code"> <b>BOOST_PP_OVERLOAD</b>(<i>prefix</i>,...) <a
        href="../topics/variadic_macros.html#VNotation" target="_self"><sup>(v)</sup></a><br>
    </div>
    <h4>Arguments</h4>
    <dl>
      <dt>prefix<br>
      </dt>
      <dd> The prefix of the non-variadic macro name. </dd>
      <dt>...<br>
      </dt>
      <dd><i> Variadic data</i>. The number of variadic data elements,
        as determined by BOOST_PP_VARIADIC_SIZE, is appended to the
        prefix to form the output non-variadic macro name.<br>
      </dd>
    </dl>
    <h4>Remarks</h4>
    <div> This macro creates a macro name which depends on the number of
      elements of variadic data. It should be used in the form of <br>
      BOOST_PP_OVERLOAD(MACRO_NAME_,__VA_ARGS__)(__VA_ARGS__) in order
      to call a non-variadic macro taking a given number of variadic
      data elements as non-variadic arguments. In this way one can
      invoke a variadic macro with a variable number of parameters which
      calls one of a series of non-variadic macros doing very similar
      things.<br>
      <br>
      In <a
href="file:///E:/Programming/VersionControl/modular-boost/libs/preprocessor/doc/topics/variadic_macros.html#C20_Support_For_Variadic_Macros">C++

        20</a> mode the <i>variadic</i> <i>data</i> can be empty and
      the given number of parameters will be 0.<br>
    </div>
    <b>Requirements</b>
    <div> <b>Header:</b> &nbsp;<a
        href="../headers/facilities/overload.html">&lt;boost/preprocessor/facilities/overload.hpp&gt;</a>
    </div>
    <h4>Sample Code</h4>
    <div>
      <pre>#include &lt;<a href="../headers/facilities/overload.html">boost/preprocessor/facilities/overload.hpp</a>&gt;<br>#include &lt;<a href="../headers/cat.html">boost/preprocessor/cat.hpp</a>&gt;<br>#include &lt;<a href="../headers/facilities/empty.html">boost/preprocessor/facilities/empty.hpp</a>&gt;<br>#include &lt;<a href="../headers/arithmetic/add.html">boost/preprocessor/arithmetic/add.hpp</a>&gt;<br><br>#define MACRO_1(number) MACRO_2(number,10)<br>#define MACRO_2(number1,number2) <a href="add.html">BOOST_PP_ADD</a>(number1,number2)<br><br>#if !BOOST_PP_VARIADICS_MSVC<br><br>#define MACRO_ADD_NUMBERS(...) <a href="overload.html">BOOST_PP_OVERLOAD</a>(MACRO_,__VA_ARGS__)(__VA_ARGS__)<br><br>#else<br><br>// or for Visual C++'s default preprocessor<br><br>#define MACRO_ADD_NUMBERS(...) \<br>  <a href="cat.html">BOOST_PP_CAT</a>(<a href="overload.html">BOOST_PP_OVERLOAD</a>(MACRO_,__VA_ARGS__)(__VA_ARGS__),<a href="empty.html">BOOST_PP_EMPTY</a>())<br><br>#endif<br><br>MACRO_ADD_NUMBERS(5) // output is 15<br>MACRO_ADD_NUMBERS(3,6) // output is 9</pre>
    </div>
    <hr size="1">
    <div style="margin-left: 0px;"> <i></i><i>� Copyright Edward Diener
        2011,2013,2016</i> </div>
    <div style="margin-left: 0px;">
      <p><small>Distributed under the Boost Software License, Version
          1.0.
          (See accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
          or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
    </div>
  </body>
</html>