123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 |
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
- <title>Naming conventions</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 Variadic Macro Data Library 1.9">
- <link rel="up" href="../index.html" title="Chapter 1. The Variadic Macro Data Library 1.9">
- <link rel="prev" href="../index.html" title="Chapter 1. The Variadic Macro Data Library 1.9">
- <link rel="next" href="vmd_whyhow.html" title="Why and how to use">
- </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="../index.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="vmd_whyhow.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="variadic_macro_data.vmd_naming"></a><a class="link" href="vmd_naming.html" title="Naming conventions">Naming conventions</a>
- </h2></div></div></div>
- <p>
- All of the macros in the library begin with the prefix BOOST_VMD_, where VMD
- stands for 'Variadic Macro Data'.
- </p>
- <p>
- Following the prefix, certain names in the macros refer to data types in this
- library or Boost PP. These names and their data types are:
- </p>
- <div class="orderedlist"><ol class="orderedlist" type="1">
- <li class="listitem">
- TUPLE = Boost PP tuple data type.
- </li>
- <li class="listitem">
- ARRAY = Boost PP array data type.
- </li>
- <li class="listitem">
- LIST = Boost PP list data type.
- </li>
- <li class="listitem">
- SEQ = Boost PP seq data type.
- </li>
- <li class="listitem">
- IDENTIFIER = A VMD identifier
- </li>
- <li class="listitem">
- NUMBER = A VMD number
- </li>
- <li class="listitem">
- TYPE = A VMD type
- </li>
- </ol></div>
- <p>
- I have used most of these names in order to mimic the naming of Boost PP as
- closely as possible. Subsequent use of the words 'array', 'list', 'seq', and
- 'tuple' refer to these Boost PP data types unless otherwise noted. See the
- help for Boost PP for any explanation of these data types.
- </p>
- <p>
- The term 'sequence' refers to a sequence of VMD data types and is not the same
- as a Boost PP sequence which is always referred to in this documentation as
- a 'seq'.
- </p>
- <p>
- The term 'return' refers to the expansion of a macro. I use the terminology
- of a macro "returning some data" rather than the terminology of a
- macro "expanding to some data", even if the latter is more accurate,
- because it more closely corresponds to the way I believe C++ programmers think
- about macro programming.
- </p>
- <p>
- The term 'emptiness' refers to no preprocessor data being passed to or returned
- from a macro. I have avoided the word 'nothing' because it has too vague a
- meaning.
- </p>
- <p>
- The term 'data type' refers to the various preprocessor input types which VMD
- can parse and which are listed above, also including emptiness.
- </p>
- <p>
- The term 'v-type' refers to a VMD type, the term 'number' returns to a VMD
- number and the term 'identifier' refers to a VMD identifier. All these will
- be explained in their proper place.
- </p>
- <p>
- The term "UB" stands for "undefined behavior" as it is
- specified in the C++ standard.
- </p>
- </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 © 2010-2017 Tropic Software
- East Inc</div></td>
- </tr></table>
- <hr>
- <div class="spirit-nav">
- <a accesskey="p" href="../index.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="vmd_whyhow.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
- </div>
- </body>
- </html>
|