Add, and update, documentation build targets.

Use Boost.Config's BOOST_ATTRIBUTE_UNUSED

doc/Jamfile.v2

@@ -5,16 +5,45 @@
 
 using quickbook ;
 
+path-constant boost-images : ../../../doc/src/images ;
+
 xml static_assert : static_assert.qbk ;
 boostbook standalone
     :
         static_assert
     :
+        <xsl:param>boost.root=../../../..
         <xsl:param>nav.layout=none
         <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 ;
-
-
+###############################################################################
+alias boostdoc
+    : static_assert
+    :
+    :
+    : ;
+explicit boostdoc ;
+alias boostrelease ;
+explicit boostrelease ;

doc/static_assert.qbk

@@ -16,20 +16,33 @@
 ]
 
 This manual is also available in 
-[@http:svn.boost.org/svn/boost/sandbox/pdf/static_assert/release/static_assert.pdf 
+[@http://sourceforge.net/projects/boost/files/boost-docs/ 
 printer friendly PDF format].
 
 [section:intro Overview and Tutorial]
 
-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`
-is not true. In other words it is the compile time equivalent of the assert macro; 
+The header `<boost/static_assert.hpp>` supplies two macros:
+
+   BOOST_STATIC_ASSERT(x)
+   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 
 "static assertion" throughout these docs. Note that if the condition is `true`, 
-then the macro will generate neither code nor data - and the macro can also 
+then the macros will generate neither code nor data - and the macros can also 
 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; 
-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 will 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. 
 These immediately tell the user that a library is being used in a manner that 
@@ -131,17 +144,17 @@ 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 
 using something like this:
 
-   #include <climits>
+   #include <limits>
    #include <boost/static_assert.hpp>
 
    template <class UnsignedInt>
    class myclass
    {
    private:
-      BOOST_STATIC_ASSERT((std::numeric_limits<UnsignedInt>::digits >= 16)
-                           && std::numeric_limits<UnsignedInt>::is_specialized
-                           && std::numeric_limits<UnsignedInt>::is_integer
-                           && !std::numeric_limits<UnsignedInt>::is_signed);
+      BOOST_STATIC_ASSERT_MSG(std::numeric_limits<UnsignedInt>::is_specialized, "myclass can only be specialized for types with numeric_limits support.");
+      BOOST_STATIC_ASSERT_MSG(std::numeric_limits<UnsignedInt>::digits >= 16, "Template argument UnsignedInt must have at least 16 bits precision.")
+      BOOST_STATIC_ASSERT_MSG(std::numeric_limits<UnsignedInt>::is_integer, "Template argument UnsignedInt must be an integer.");
+      BOOST_STATIC_ASSERT_MSG(!std::numeric_limits<UnsignedInt>::is_signed, "Template argument UnsignedInt must not be signed.");
    public:
       /* details here */
    };

include/boost/static_assert.hpp

@@ -17,6 +17,25 @@
 #include <boost/config.hpp>
 #include <boost/detail/workaround.hpp>
 
+#if defined(__GNUC__) && !defined(__GXX_EXPERIMENTAL_CXX0X__)
+//
+// This is horrible, but it seems to be the only we can shut up the
+// "anonymous variadic macros were introduced in C99 [-Wvariadic-macros]"
+// warning that get spewed out otherwise in non-C++11 mode.
+//
+#pragma GCC system_header
+#endif
+
+#ifndef BOOST_NO_CXX11_STATIC_ASSERT
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#     define BOOST_STATIC_ASSERT_MSG( ... ) static_assert(__VA_ARGS__)
+#  else
+#     define BOOST_STATIC_ASSERT_MSG( B, Msg ) static_assert( B, Msg )
+#  endif
+#else
+#     define BOOST_STATIC_ASSERT_MSG( B, Msg ) BOOST_STATIC_ASSERT( B )
+#endif
+
 #ifdef __BORLANDC__
 //
 // workaround for buggy integral-constant expression support:
@@ -33,13 +52,25 @@
 // then enable this:
 //
 #if defined(__GNUC__) && ((__GNUC__ > 3) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 4)))
-#  define BOOST_STATIC_ASSERT_BOOL_CAST( x ) ((x) == 0 ? false : true)
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#     define BOOST_STATIC_ASSERT_BOOL_CAST( ... ) ((__VA_ARGS__) == 0 ? false : true)
+#  else
+#     define BOOST_STATIC_ASSERT_BOOL_CAST( x ) ((x) == 0 ? false : true)
+#  endif
 #else
-#  define BOOST_STATIC_ASSERT_BOOL_CAST(x) (bool)(x)
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#     define BOOST_STATIC_ASSERT_BOOL_CAST( ... ) (bool)(__VA_ARGS__)
+#  else
+#     define BOOST_STATIC_ASSERT_BOOL_CAST(x) (bool)(x)
+#  endif
 #endif
 
-#ifdef BOOST_HAS_STATIC_ASSERT
-#  define BOOST_STATIC_ASSERT( B ) static_assert(B, #B)
+#ifndef BOOST_NO_CXX11_STATIC_ASSERT
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#     define BOOST_STATIC_ASSERT( ... ) static_assert(__VA_ARGS__, #__VA_ARGS__)
+#  else
+#     define BOOST_STATIC_ASSERT( B ) static_assert(B, #B)
+#  endif
 #else
 
 namespace boost{
@@ -78,24 +109,28 @@ template<int x> struct static_assert_test{};
 //
 #if !defined(BOOST_BUGGY_INTEGRAL_CONSTANT_EXPRESSIONS)
 
-#if defined(BOOST_MSVC) && (BOOST_MSVC < 1300)
-// __LINE__ macro broken when -ZI is used see Q199057
-// fortunately MSVC ignores duplicate typedef's.
-#define BOOST_STATIC_ASSERT( B ) \
-   typedef ::boost::static_assert_test<\
-      sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( B ) >)\
-      > boost_static_assert_typedef_
-#elif defined(BOOST_MSVC)
+#if defined(BOOST_MSVC) && defined(BOOST_NO_CXX11_VARIADIC_MACROS)
 #define BOOST_STATIC_ASSERT( B ) \
    typedef ::boost::static_assert_test<\
       sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST ( B ) >)>\
          BOOST_JOIN(boost_static_assert_typedef_, __COUNTER__)
-#elif defined(BOOST_INTEL_CXX_VERSION) || defined(BOOST_SA_GCC_WORKAROUND)
+#elif defined(BOOST_MSVC)
+#define BOOST_STATIC_ASSERT(...) \
+   typedef ::boost::static_assert_test<\
+      sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST (__VA_ARGS__) >)>\
+         BOOST_JOIN(boost_static_assert_typedef_, __COUNTER__)
+#elif (defined(BOOST_INTEL_CXX_VERSION) || defined(BOOST_SA_GCC_WORKAROUND))  && defined(BOOST_NO_CXX11_VARIADIC_MACROS)
 // agurt 15/sep/02: a special care is needed to force Intel C++ issue an error 
 // instead of warning in case of failure
 # define BOOST_STATIC_ASSERT( B ) \
     typedef char BOOST_JOIN(boost_static_assert_typedef_, __LINE__) \
         [ ::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( B ) >::value ]
+#elif (defined(BOOST_INTEL_CXX_VERSION) || defined(BOOST_SA_GCC_WORKAROUND))  && !defined(BOOST_NO_CXX11_VARIADIC_MACROS)
+// agurt 15/sep/02: a special care is needed to force Intel C++ issue an error 
+// instead of warning in case of failure
+# define BOOST_STATIC_ASSERT(...) \
+    typedef char BOOST_JOIN(boost_static_assert_typedef_, __LINE__) \
+        [ ::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( __VA_ARGS__ ) >::value ]
 #elif defined(__sgi)
 // special version for SGI MIPSpro compiler
 #define BOOST_STATIC_ASSERT( B ) \
@@ -113,19 +148,32 @@ template<int x> struct static_assert_test{};
        sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( B ) >) )
 #else
 // generic version
-#define BOOST_STATIC_ASSERT( B ) \
-   typedef ::boost::static_assert_test<\
-      sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( B ) >)>\
-         BOOST_JOIN(boost_static_assert_typedef_, __LINE__)
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#     define BOOST_STATIC_ASSERT( ... ) \
+         typedef ::boost::static_assert_test<\
+            sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( __VA_ARGS__ ) >)>\
+               BOOST_JOIN(boost_static_assert_typedef_, __LINE__) BOOST_ATTRIBUTE_UNUSED
+#  else
+#     define BOOST_STATIC_ASSERT( B ) \
+         typedef ::boost::static_assert_test<\
+            sizeof(::boost::STATIC_ASSERTION_FAILURE< BOOST_STATIC_ASSERT_BOOL_CAST( B ) >)>\
+               BOOST_JOIN(boost_static_assert_typedef_, __LINE__) BOOST_ATTRIBUTE_UNUSED
+#  endif
 #endif
 
 #else
 // alternative enum based implementation:
-#define BOOST_STATIC_ASSERT( B ) \
-   enum { BOOST_JOIN(boost_static_assert_enum_, __LINE__) \
-      = sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( B ) >) }
+#  ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+#    define BOOST_STATIC_ASSERT( ... ) \
+         enum { BOOST_JOIN(boost_static_assert_enum_, __LINE__) \
+            = sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( __VA_ARGS__ ) >) }
+#  else
+#    define BOOST_STATIC_ASSERT(B) \
+         enum { BOOST_JOIN(boost_static_assert_enum_, __LINE__) \
+            = sizeof(::boost::STATIC_ASSERTION_FAILURE< (bool)( B ) >) }
+#  endif
 #endif
-#endif // ndef BOOST_HAS_STATIC_ASSERT
+#endif // defined(BOOST_NO_CXX11_STATIC_ASSERT)
 
 #endif // BOOST_STATIC_ASSERT_HPP
 

meta/libraries.json

@@ -0,0 +1,16 @@
+{
+    "key": "static_assert",
+    "name": "Static Assert",
+    "authors": [
+        "John Maddock"
+    ],
+    "description": "Static assertions (compile time assertions).",
+    "category": [
+        "Correctness",
+        "Generic",
+        "Metaprogramming"
+    ],
+    "maintainers": [
+        "John Maddock <john -at- johnmaddock.co.uk>"
+    ]
+}

static_assert_example_2.cpp

@@ -12,7 +12,7 @@
 #include <boost/type_traits.hpp>
 
 template <class RandomAccessIterator >
-RandomAccessIterator foo(RandomAccessIterator from, RandomAccessIterator to)
+RandomAccessIterator foo(RandomAccessIterator from, RandomAccessIterator /*to*/)
 {
    // this template can only be used with
    // random access iterators...

static_assert_example_3.cpp

@@ -5,7 +5,7 @@
 
 //  See http://www.boost.org for most recent version including documentation.
 
-#include <climits>
+#include <limits>
 #include <boost/limits.hpp>
 #include <boost/static_assert.hpp>
 

static_assert_test.cpp

@@ -16,12 +16,16 @@
 // Namespace scope
 BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
 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
 void f()
 {
   BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
   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
@@ -29,6 +33,8 @@ struct Bob
   private:  // can be in private, to avoid namespace pollution
     BOOST_STATIC_ASSERT(sizeof(int) >= sizeof(short));
     BOOST_STATIC_ASSERT(sizeof(char) == 1);
+    BOOST_STATIC_ASSERT_MSG(sizeof(int) >= sizeof(short), "msg5");
+    BOOST_STATIC_ASSERT_MSG(sizeof(char) == 1, "msg6");
   public:
 
   // Member function scope: provides access to member variables
@@ -36,9 +42,11 @@ struct Bob
   char c;
   int f()
   {
-#ifndef _MSC_VER // broken sizeof in VC6
+#if defined(_MSC_VER) && _MSC_VER < 1300 // broken sizeof in VC6
     BOOST_STATIC_ASSERT(sizeof(x) >= sizeof(short));
     BOOST_STATIC_ASSERT(sizeof(c) == 1);
+    BOOST_STATIC_ASSERT_MSG(sizeof(x) >= sizeof(short), "msg7");
+    BOOST_STATIC_ASSERT_MSG(sizeof(c) == 1, "msg8");
 #endif
     return x;
   }
@@ -50,8 +58,10 @@ struct Bob
 template <class Int, class Char>
 struct Bill
 {
+   BOOST_STATIC_CONSTANT(int, value = 1);
   private:  // can be in private, to avoid namespace pollution
     BOOST_STATIC_ASSERT(sizeof(Int) > sizeof(char));
+    BOOST_STATIC_ASSERT_MSG(sizeof(Int) > sizeof(char), "msg9");
   public:
 
   // Template member function scope: provides access to member variables
@@ -62,10 +72,12 @@ struct Bill
   {
     BOOST_STATIC_ASSERT(sizeof(Int) == sizeof(Int2));
     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_CT_ASSERTs are not triggerred until instantiated
+void test_Bill() // BOOST_STATIC_ASSERTs are not triggerred until instantiated
 {
   Bill<int, char> z;
   //Bill<int, int> bad; // will not compile
@@ -78,6 +90,15 @@ void test_Bill() // BOOST_CT_ASSERTs are not triggerred until instantiated
 int main()
 { 
    test_Bill();
+   //
+   // Test variadic macro support:
+   //
+#ifndef BOOST_NO_CXX11_VARIADIC_MACROS
+   BOOST_STATIC_ASSERT(Bill<int, char>::value);
+#ifndef BOOST_NO_CXX11_STATIC_ASSERT
+   BOOST_STATIC_ASSERT_MSG(Bill<int, char>::value, "This is a message");
+#endif
+#endif
    return 0; 
 }