[Boost-commit] svn:boost r71486 - in branches/release: boost libs/static_assert libs/static_assert/doc

Subject: [Boost-commit] svn:boost r71486 - in branches/release: boost libs/static_assert libs/static_assert/doc
From: john_at_[hidden]
Date: 2011-04-25 13:27:05

Author: johnmaddock
Date: 2011-04-25 13:27:05 EDT (Mon, 25 Apr 2011)
New Revision: 71486
URL: http://svn.boost.org/trac/boost/changeset/71486

Log:
Merge documentation and property change fixes from Trunk.
Properties modified: 
   branches/release/boost/static_assert.hpp   (props changed)
   branches/release/libs/static_assert/   (props changed)
Text files modified: 
   branches/release/libs/static_assert/doc/static_assert.qbk  |    23 ++++++++++++++++++-----                 
   branches/release/libs/static_assert/static_assert_test.cpp |    15 +++++++++++++--                         
   2 files changed, 31 insertions(+), 7 deletions(-)

Modified: branches/release/libs/static_assert/doc/static_assert.qbk
==============================================================================
--- branches/release/libs/static_assert/doc/static_assert.qbk	(original)
+++ branches/release/libs/static_assert/doc/static_assert.qbk	2011-04-25 13:27:05 EDT (Mon, 25 Apr 2011)
@@ -21,15 +21,28 @@
 
 [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 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. 
 These immediately tell the user that a library is being used in a manner that 

Modified: branches/release/libs/static_assert/static_assert_test.cpp
==============================================================================
--- branches/release/libs/static_assert/static_assert_test.cpp	(original)
+++ branches/release/libs/static_assert/static_assert_test.cpp	2011-04-25 13:27:05 EDT (Mon, 25 Apr 2011)
@@ -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 @@
   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 @@
   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;
   }
@@ -52,6 +60,7 @@
 {
   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 +71,12 @@
   {
     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