forked from boostorg/static_assert
Compare commits
1 Commits
svn-branch
...
svn-branch
Author | SHA1 | Date | |
---|---|---|---|
dd82fb3118 |
@ -5,35 +5,16 @@
|
|||||||
|
|
||||||
using quickbook ;
|
using quickbook ;
|
||||||
|
|
||||||
path-constant boost-images : ../../../doc/src/images ;
|
|
||||||
|
|
||||||
xml static_assert : static_assert.qbk ;
|
xml static_assert : static_assert.qbk ;
|
||||||
boostbook standalone
|
boostbook standalone
|
||||||
:
|
:
|
||||||
static_assert
|
static_assert
|
||||||
:
|
:
|
||||||
<xsl:param>boost.root=../../../..
|
|
||||||
<xsl:param>nav.layout=none
|
<xsl:param>nav.layout=none
|
||||||
<xsl:param>navig.graphics=0
|
<xsl:param>navig.graphics=0
|
||||||
# PDF Options:
|
|
||||||
# TOC Generation: this is needed for FOP-0.9 and later:
|
|
||||||
<xsl:param>fop1.extensions=0
|
|
||||||
# Or enable this if you're using XEP:
|
|
||||||
<xsl:param>xep.extensions=1
|
|
||||||
# TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
|
|
||||||
<xsl:param>fop.extensions=0
|
|
||||||
# No indent on body text:
|
|
||||||
<xsl:param>body.start.indent=0pt
|
|
||||||
# Margin size:
|
|
||||||
<xsl:param>page.margin.inner=0.5in
|
|
||||||
# Margin size:
|
|
||||||
<xsl:param>page.margin.outer=0.5in
|
|
||||||
# Yes, we want graphics for admonishments:
|
|
||||||
<xsl:param>admon.graphics=1
|
|
||||||
# Set this one for PDF generation *only*:
|
|
||||||
# default pnd graphics are awful in PDF form,
|
|
||||||
# better use SVG's instead:
|
|
||||||
<format>pdf:<xsl:param>admon.graphics.extension=".svg"
|
|
||||||
<format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
|
|
||||||
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
|
|
||||||
;
|
;
|
||||||
|
|
||||||
|
install html : ../../../doc/html/boostbook.css ;
|
||||||
|
install ../ : ../../../boost.png ;
|
||||||
|
|
||||||
|
|
||||||
|
@ -16,34 +16,21 @@
|
|||||||
]
|
]
|
||||||
|
|
||||||
This manual is also available in
|
This manual is also available in
|
||||||
[@http://sourceforge.net/projects/boost/files/boost-docs/
|
[@http:svn.boost.org/svn/boost/sandbox/pdf/static_assert/release/static_assert.pdf
|
||||||
printer friendly PDF format].
|
printer friendly PDF format].
|
||||||
|
|
||||||
[section:intro Overview and Tutorial]
|
[section:intro Overview and Tutorial]
|
||||||
|
|
||||||
The header `<boost/static_assert.hpp>` supplies two macros:
|
The header `<boost/static_assert.hpp>` supplies a single macro `BOOST_STATIC_ASSERT(x)`,
|
||||||
|
which generates a compile time error message if the integral-constant-expression `x`
|
||||||
BOOST_STATIC_ASSERT(x)
|
is not true. In other words it is the compile time equivalent of the assert macro;
|
||||||
BOOST_STATIC_ASSERT_MSG(x, msg)
|
|
||||||
|
|
||||||
Both generate a compile time error message if the integral-constant-expression `x`
|
|
||||||
is not true. In other words, they are the compile time equivalent of the assert macro;
|
|
||||||
this is sometimes known as a "compile-time-assertion", but will be called a
|
this is sometimes known as a "compile-time-assertion", but will be called a
|
||||||
"static assertion" throughout these docs. Note that if the condition is `true`,
|
"static assertion" throughout these docs. Note that if the condition is `true`,
|
||||||
then the macros will generate neither code nor data - and the macros can also
|
then the macro will generate neither code nor data - and the macro can also
|
||||||
be used at either namespace, class or function scope. When used in a template,
|
be used at either namespace, class or function scope. When used in a template,
|
||||||
the static assertion will be evaluated at the time the template is instantiated;
|
the static assertion will be evaluated at the time the template is instantiated;
|
||||||
this is particularly useful for validating template parameters.
|
this is particularly useful for validating template parameters.
|
||||||
|
|
||||||
If the C++0x `static_assert` feature is available, both macros will use it.
|
|
||||||
For `BOOST_STATIC_ASSERT(x)`, the error message with be a stringized version of `x`.
|
|
||||||
For `BOOST_STATIC_ASSERT_MSG(x, msg)`, the error message will be the `msg` string.
|
|
||||||
|
|
||||||
If the C++0x `static_assert` feature is not available, `BOOST_STATIC_ASSERT_MSG(x, msg)`
|
|
||||||
will be treated as `BOOST_STATIC_ASSERT(x)`.
|
|
||||||
|
|
||||||
The material that follows assumes the C++0x `static_assert` feature is not available.
|
|
||||||
|
|
||||||
One of the aims of `BOOST_STATIC_ASSERT` is to generate readable error messages.
|
One of the aims of `BOOST_STATIC_ASSERT` is to generate readable error messages.
|
||||||
These immediately tell the user that a library is being used in a manner that
|
These immediately tell the user that a library is being used in a manner that
|
||||||
is not supported. While error messages obviously differ from compiler to compiler,
|
is not supported. While error messages obviously differ from compiler to compiler,
|
||||||
@ -144,7 +131,7 @@ Suppose we have a template-class that requires an unsigned integral type with
|
|||||||
at least 16-bits of precision as a template argument, we can achieve this
|
at least 16-bits of precision as a template argument, we can achieve this
|
||||||
using something like this:
|
using something like this:
|
||||||
|
|
||||||
#include <limits>
|
#include <climits>
|
||||||
#include <boost/static_assert.hpp>
|
#include <boost/static_assert.hpp>
|
||||||
|
|
||||||
template <class UnsignedInt>
|
template <class UnsignedInt>
|
||||||
|
@ -17,12 +17,6 @@
|
|||||||
#include <boost/config.hpp>
|
#include <boost/config.hpp>
|
||||||
#include <boost/detail/workaround.hpp>
|
#include <boost/detail/workaround.hpp>
|
||||||
|
|
||||||
#ifndef BOOST_NO_STATIC_ASSERT
|
|
||||||
# define BOOST_STATIC_ASSERT_MSG( B, Msg ) static_assert(B, Msg)
|
|
||||||
#else
|
|
||||||
# define BOOST_STATIC_ASSERT_MSG( B, Msg ) BOOST_STATIC_ASSERT( B )
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#ifdef __BORLANDC__
|
#ifdef __BORLANDC__
|
||||||
//
|
//
|
||||||
// workaround for buggy integral-constant expression support:
|
// workaround for buggy integral-constant expression support:
|
||||||
@ -44,7 +38,7 @@
|
|||||||
# define BOOST_STATIC_ASSERT_BOOL_CAST(x) (bool)(x)
|
# define BOOST_STATIC_ASSERT_BOOL_CAST(x) (bool)(x)
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef BOOST_NO_STATIC_ASSERT
|
#ifdef BOOST_HAS_STATIC_ASSERT
|
||||||
# define BOOST_STATIC_ASSERT( B ) static_assert(B, #B)
|
# define BOOST_STATIC_ASSERT( B ) static_assert(B, #B)
|
||||||
#else
|
#else
|
||||||
|
|
||||||
@ -131,7 +125,7 @@ template<int x> struct static_assert_test{};
|
|||||||
enum { BOOST_JOIN(boost_static_assert_enum_, __LINE__) \
|
enum { BOOST_JOIN(boost_static_assert_enum_, __LINE__) \
|
||||||
= sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( B ) >) }
|
= sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( B ) >) }
|
||||||
#endif
|
#endif
|
||||||
#endif // defined(BOOST_NO_STATIC_ASSERT)
|
#endif // ndef BOOST_HAS_STATIC_ASSERT
|
||||||
|
|
||||||
#endif // BOOST_STATIC_ASSERT_HPP
|
#endif // BOOST_STATIC_ASSERT_HPP
|
||||||
|
|
||||||
|
@ -12,7 +12,7 @@
|
|||||||
#include <boost/type_traits.hpp>
|
#include <boost/type_traits.hpp>
|
||||||
|
|
||||||
template <class RandomAccessIterator >
|
template <class RandomAccessIterator >
|
||||||
RandomAccessIterator foo(RandomAccessIterator from, RandomAccessIterator /*to*/)
|
RandomAccessIterator foo(RandomAccessIterator from, RandomAccessIterator to)
|
||||||
{
|
{
|
||||||
// this template can only be used with
|
// this template can only be used with
|
||||||
// random access iterators...
|
// random access iterators...
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
// See http://www.boost.org for most recent version including documentation.
|
// See http://www.boost.org for most recent version including documentation.
|
||||||
|
|
||||||
#include <limits>
|
#include <climits>
|
||||||
#include <boost/limits.hpp>
|
#include <boost/limits.hpp>
|
||||||
#include <boost/static_assert.hpp>
|
#include <boost/static_assert.hpp>
|
||||||
|
|
||||||
|
@ -16,16 +16,12 @@
|
|||||||
// Namespace scope
|
// Namespace scope
|
||||||
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
||||||
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(int) >= sizeof(short), "msg1");
|
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(char) == 1, "msg2");
|
|
||||||
|
|
||||||
// Function (block) scope
|
// Function (block) scope
|
||||||
void f()
|
void f()
|
||||||
{
|
{
|
||||||
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
||||||
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(int) >= sizeof(short), "msg3");
|
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(char) == 1, "msg4");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
struct Bob
|
struct Bob
|
||||||
@ -33,8 +29,6 @@ struct Bob
|
|||||||
private: // can be in private, to avoid namespace pollution
|
private: // can be in private, to avoid namespace pollution
|
||||||
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
|
||||||
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
BOOST_STATIC_ASSERT(sizeof(char) == 1);
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(int) >= sizeof(short), "msg5");
|
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(char) == 1, "msg6");
|
|
||||||
public:
|
public:
|
||||||
|
|
||||||
// Member function scope: provides access to member variables
|
// Member function scope: provides access to member variables
|
||||||
@ -42,11 +36,9 @@ struct Bob
|
|||||||
char c;
|
char c;
|
||||||
int f()
|
int f()
|
||||||
{
|
{
|
||||||
#if defined(_MSC_VER) && _MSC_VER < 1300 // broken sizeof in VC6
|
#ifndef _MSC_VER // broken sizeof in VC6
|
||||||
BOOST_STATIC_ASSERT(sizeof(x) >= sizeof(short));
|
BOOST_STATIC_ASSERT(sizeof(x) >= sizeof(short));
|
||||||
BOOST_STATIC_ASSERT(sizeof(c) == 1);
|
BOOST_STATIC_ASSERT(sizeof(c) == 1);
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(x) >= sizeof(short), "msg7");
|
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(c) == 1, "msg8");
|
|
||||||
#endif
|
#endif
|
||||||
return x;
|
return x;
|
||||||
}
|
}
|
||||||
@ -60,7 +52,6 @@ struct Bill
|
|||||||
{
|
{
|
||||||
private: // can be in private, to avoid namespace pollution
|
private: // can be in private, to avoid namespace pollution
|
||||||
BOOST_STATIC_ASSERT(sizeof(Int) > sizeof(char));
|
BOOST_STATIC_ASSERT(sizeof(Int) > sizeof(char));
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(Int) > sizeof(char), "msg9");
|
|
||||||
public:
|
public:
|
||||||
|
|
||||||
// Template member function scope: provides access to member variables
|
// Template member function scope: provides access to member variables
|
||||||
@ -71,12 +62,10 @@ struct Bill
|
|||||||
{
|
{
|
||||||
BOOST_STATIC_ASSERT(sizeof(Int) == sizeof(Int2));
|
BOOST_STATIC_ASSERT(sizeof(Int) == sizeof(Int2));
|
||||||
BOOST_STATIC_ASSERT(sizeof(Char) == sizeof(Char2));
|
BOOST_STATIC_ASSERT(sizeof(Char) == sizeof(Char2));
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(Int) == sizeof(Int2), "msg10");
|
|
||||||
BOOST_STATIC_ASSERT_MSG(sizeof(Char) == sizeof(Char2), "msg11");
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
void test_Bill() // BOOST_STATIC_ASSERTs are not triggerred until instantiated
|
void test_Bill() // BOOST_CT_ASSERTs are not triggerred until instantiated
|
||||||
{
|
{
|
||||||
Bill<int, char> z;
|
Bill<int, char> z;
|
||||||
//Bill<int, int> bad; // will not compile
|
//Bill<int, int> bad; // will not compile
|
||||||
|
Reference in New Issue
Block a user