add and document BOOST_MPL_LIMIT_STRING_SIZE and mpl/limits/string.hpp

[SVN r52317]
This commit is contained in:
Eric Niebler committed 2009-04-11 06:30:53 +00:00
1 parent 2cf51a12f1
commit 5cac79c3e6
4 files changed
+82 -11

No files matched your search

+52
View File
@@ -0,0 +1,52 @@
.. Macros/Configuration//BOOST_MPL_LIMIT_STRING_SIZE |65
.. Copyright Eric Niebler 2009.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
BOOST_MPL_LIMIT_STRING_SIZE
===========================
Synopsis
--------
.. parsed-literal::
#if !defined(BOOST_MPL_LIMIT_STRING_SIZE)
# define BOOST_MPL_LIMIT_STRING_SIZE \\
|idic| \\
/\*\*/
#endif
Description
-----------
``BOOST_MPL_LIMIT_STRING_SIZE`` is an overridable configuration macro regulating
the maximum arity of the ``string``\ 's |variadic forms|. In this
implementation of the library, ``BOOST_MPL_LIMIT_STRING_SIZE`` has a default value
of 32. To override the default limit, define ``BOOST_MPL_LIMIT_STRING_SIZE`` to
the desired maximum arity before including any library header.
Example
-------
.. parsed-literal::
#define BOOST_MPL_LIMIT_STRING_SIZE 8
``#``\ include <boost/mpl/string.hpp>
using namespace boost::mpl;
typedef string<'a'> s_1;
typedef string<'abcd','efgh'> s_8;
// typedef string<'abcd','efgh','i'> s_9; // error!
See also
--------
|Configuration|, |BOOST_MPL_LIMIT_VECTOR_SIZE|
+2 -2
View File
@@ -12,8 +12,8 @@ Description
-----------
``string`` is a |variadic|, `bidirectional`__, `extensible`__ |Integral Sequence Wrapper| of
characters that supports constant-time insertion and removal of elements at both ends, and
linear-time insertion and removal of elements in the middle. The parameters to ``string``
characters that supports amortized constant-time insertion and removal of elements at both ends,
and linear-time insertion and removal of elements in the middle. The parameters to ``string``
are multi-character literals, giving a somewhat readable syntax for compile-time strings.
``string`` can also be an argument to the ``c_str`` metafunction, which generates a
null-terminated character array that facilitates interoperability with runtime string