Branch for 2nd try at V2 removal

[SVN r77497]

doc/array.xml

@@ -17,11 +17,11 @@
     </copyright>
    
     <legalnotice>
-      <para>Permission to copy, use, modify, sell and distribute this
+      <para>Distributed under the Boost Software License, Version 1.0.
-      software is granted provided this copyright notice appears in
+      (See accompanying file <filename>LICENSE_1_0.txt</filename> or copy at 
-      all copies. This software is provided "as is" without express or
+      <ulink
-      implied warranty, and with no claim as to its suitability for
+      url="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</ulink>)
-      any purpose.</para>
+      </para>
     </legalnotice>
 
     <librarypurpose>STL compliant container wrapper for arrays of constant size</librarypurpose>
@@ -68,7 +68,7 @@
 
     <para>Note that this class is suggested to be part of the next
     Technical Report, which will extend the C++ Standard (see
-    <ulink>http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</ulink>).</para>
+    <ulink url="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm">http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</ulink>).</para>
 
     <para>Class <code><classname>array</classname></code> fulfills most
     but not all of the requirements of "reversible containers" (see

include/boost/array.hpp

@@ -2,17 +2,22 @@
  * an STL container (as wrapper) for arrays of constant size.
  *
  * See
- *      http://www.josuttis.com/cppcode
+ *      http://www.boost.org/libs/array/
- * for details and the latest version.
- * See
- *      http://www.boost.org/libs/array for Documentation.
  * for documentation.
  *
+ * The original author site is at: http://www.josuttis.com/
+ *
  * (C) Copyright Nicolai M. Josuttis 2001.
+ *
  * 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)
  *
+ * 28 Dec 2010 - (mtc) Added cbegin and cend (and crbegin and crend) for C++Ox compatibility.
+ * 10 Mar 2010 - (mtc) fill method added, matching resolution of the standard library working group.
+ *      See <http://www.open-std.org/jtc1/sc22/wg21/docs/lwg-defects.html#776> or Trac issue #3168
+ *      Eventually, we should remove "assign" which is now a synonym for "fill" (Marshall Clow)
+ * 10 Mar 2010 - added workaround for SUNCC and !STLPort [trac #3893] (Marshall Clow)
  * 29 Jan 2004 - c_array() added, BOOST_NO_PRIVATE_IN_AGGREGATE removed (Nico Josuttis)
  * 23 Aug 2002 - fix for Non-MSVC compilers combined with MSVC libraries.
  * 05 Aug 2001 - minor update (Nico Josuttis)
@@ -24,12 +29,23 @@
 #ifndef BOOST_ARRAY_HPP
 #define BOOST_ARRAY_HPP
 
+#include <boost/detail/workaround.hpp>
+
+#if BOOST_WORKAROUND(BOOST_MSVC, >= 1400)  
+# pragma warning(push)  
+# pragma warning(disable:4996) // 'std::equal': Function call with parameters that may be unsafe
+# pragma warning(disable:4510) // boost::array<T,N>' : default constructor could not be generated 
+# pragma warning(disable:4610) // warning C4610: class 'boost::array<T,N>' can never be instantiated - user defined constructor required 
+#endif
+
 #include <cstddef>
 #include <stdexcept>
 #include <boost/assert.hpp>
+#include <boost/swap.hpp>
 
 // Handles broken standard libraries better than <iterator>
 #include <boost/detail/iterator.hpp>
+#include <boost/throw_exception.hpp>
 #include <algorithm>
 
 // FIXES for broken compilers
@@ -52,12 +68,15 @@ namespace boost {
         typedef const T&       const_reference;
         typedef std::size_t    size_type;
         typedef std::ptrdiff_t difference_type;
-    
+
         // iterator support
-        iterator begin() { return elems; }
+        iterator        begin()       { return elems; }
-        const_iterator begin() const { return elems; }
+        const_iterator  begin() const { return elems; }
-        iterator end() { return elems+N; }
+        const_iterator cbegin() const { return elems; }
-        const_iterator end() const { return elems+N; }
+        
+        iterator        end()       { return elems+N; }
+        const_iterator  end() const { return elems+N; }
+        const_iterator cend() const { return elems+N; }
 
         // reverse iterator support
 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
@@ -69,6 +88,11 @@ namespace boost {
                                       reference, iterator, reference> > reverse_iterator;
         typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
                                       const_reference, iterator, reference> > const_reverse_iterator;
+#elif defined(_RWSTD_NO_CLASS_PARTIAL_SPEC) 
+        typedef std::reverse_iterator<iterator, std::random_access_iterator_tag, 
+              value_type, reference, iterator, difference_type> reverse_iterator; 
+        typedef std::reverse_iterator<const_iterator, std::random_access_iterator_tag,
+              value_type, const_reference, const_iterator, difference_type> const_reverse_iterator;
 #else
         // workaround for broken reverse_iterator implementations
         typedef std::reverse_iterator<iterator,T> reverse_iterator;
@@ -79,21 +103,28 @@ namespace boost {
         const_reverse_iterator rbegin() const {
             return const_reverse_iterator(end());
         }
+        const_reverse_iterator crbegin() const {
+            return const_reverse_iterator(end());
+        }
+
         reverse_iterator rend() { return reverse_iterator(begin()); }
         const_reverse_iterator rend() const {
             return const_reverse_iterator(begin());
         }
+        const_reverse_iterator crend() const {
+            return const_reverse_iterator(begin());
+        }
 
         // operator[]
         reference operator[](size_type i) 
         { 
-            BOOST_ASSERT( i < N && "out of range" ); 
+            BOOST_ASSERT_MSG( i < N, "out of range" );
             return elems[i];
         }
         
         const_reference operator[](size_type i) const 
         {     
-            BOOST_ASSERT( i < N && "out of range" ); 
+            BOOST_ASSERT_MSG( i < N, "out of range" );
             return elems[i]; 
         }
 
@@ -130,11 +161,13 @@ namespace boost {
 
         // swap (note: linear complexity)
         void swap (array<T,N>& y) {
-            std::swap_ranges(begin(),end(),y.begin());
+            for (size_type i = 0; i < N; ++i)
+                boost::swap(elems[i],y.elems[i]);
         }
 
         // direct access to data (read-only)
         const T* data() const { return elems; }
+        T* data() { return elems; }
 
         // use array as C array (direct read/write access to data)
         T* c_array() { return elems; }
@@ -147,20 +180,161 @@ namespace boost {
         }
 
         // assign one value to all elements
-        void assign (const T& value)
+        void assign (const T& value) { fill ( value ); }    // A synonym for fill
+        void fill   (const T& value)
         {
             std::fill_n(begin(),size(),value);
         }
 
         // check range (may be private because it is static)
         static void rangecheck (size_type i) {
-            if (i >= size()) { 
+            if (i >= size()) {
-                throw std::range_error("array<>: index out of range");
+                std::out_of_range e("array<>: index out of range");
+                boost::throw_exception(e);
             }
         }
 
     };
 
+#if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION)
+    template< class T >
+    class array< T, 0 > {
+
+      public:
+        // type definitions
+        typedef T              value_type;
+        typedef T*             iterator;
+        typedef const T*       const_iterator;
+        typedef T&             reference;
+        typedef const T&       const_reference;
+        typedef std::size_t    size_type;
+        typedef std::ptrdiff_t difference_type;
+
+        // iterator support
+        iterator        begin()       { return       iterator( reinterpret_cast<       T * >( this ) ); }
+        const_iterator  begin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
+        const_iterator cbegin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
+
+        iterator        end()       { return  begin(); }
+        const_iterator  end() const { return  begin(); }
+        const_iterator cend() const { return cbegin(); }
+
+        // reverse iterator support
+#if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
+        typedef std::reverse_iterator<iterator> reverse_iterator;
+        typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
+#elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
+        // workaround for broken reverse_iterator in VC7
+        typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
+                                      reference, iterator, reference> > reverse_iterator;
+        typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
+                                      const_reference, iterator, reference> > const_reverse_iterator;
+#elif defined(_RWSTD_NO_CLASS_PARTIAL_SPEC) 
+        typedef std::reverse_iterator<iterator, std::random_access_iterator_tag, 
+              value_type, reference, iterator, difference_type> reverse_iterator; 
+        typedef std::reverse_iterator<const_iterator, std::random_access_iterator_tag,
+              value_type, const_reference, const_iterator, difference_type> const_reverse_iterator;
+#else
+        // workaround for broken reverse_iterator implementations
+        typedef std::reverse_iterator<iterator,T> reverse_iterator;
+        typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
+#endif
+
+        reverse_iterator rbegin() { return reverse_iterator(end()); }
+        const_reverse_iterator rbegin() const {
+            return const_reverse_iterator(end());
+        }
+        const_reverse_iterator crbegin() const {
+            return const_reverse_iterator(end());
+        }
+
+        reverse_iterator rend() { return reverse_iterator(begin()); }
+        const_reverse_iterator rend() const {
+            return const_reverse_iterator(begin());
+        }
+        const_reverse_iterator crend() const {
+            return const_reverse_iterator(begin());
+        }
+
+        // operator[]
+        reference operator[](size_type /*i*/)
+        {
+            return failed_rangecheck();
+        }
+
+        const_reference operator[](size_type /*i*/) const
+        {
+            return failed_rangecheck();
+        }
+
+        // at() with range check
+        reference at(size_type /*i*/)               {   return failed_rangecheck(); }
+        const_reference at(size_type /*i*/) const   {   return failed_rangecheck(); }
+
+        // front() and back()
+        reference front()
+        {
+            return failed_rangecheck();
+        }
+
+        const_reference front() const
+        {
+            return failed_rangecheck();
+        }
+
+        reference back()
+        {
+            return failed_rangecheck();
+        }
+
+        const_reference back() const
+        {
+            return failed_rangecheck();
+        }
+
+        // size is constant
+        static size_type size() { return 0; }
+        static bool empty() { return true; }
+        static size_type max_size() { return 0; }
+        enum { static_size = 0 };
+
+        void swap (array<T,0>& /*y*/) {
+        }
+
+        // direct access to data (read-only)
+        const T* data() const { return 0; }
+        T* data() { return 0; }
+
+        // use array as C array (direct read/write access to data)
+        T* c_array() { return 0; }
+
+        // assignment with type conversion
+        template <typename T2>
+        array<T,0>& operator= (const array<T2,0>& ) {
+            return *this;
+        }
+
+        // assign one value to all elements
+        void assign (const T& value) { fill ( value ); }
+        void fill   (const T& ) {}
+        
+        // check range (may be private because it is static)
+        static reference failed_rangecheck () {
+                std::out_of_range e("attempt to access element of an empty array");
+                boost::throw_exception(e);
+#if defined(BOOST_NO_EXCEPTIONS) || (!defined(BOOST_MSVC) && !defined(__PATHSCALE__))
+                //
+                // We need to return something here to keep
+                // some compilers happy: however we will never
+                // actually get here....
+                //
+                static T placeholder;
+                return placeholder;
+#endif
+            }
+    };
+#endif
+
     // comparisons
     template<class T, std::size_t N>
     bool operator== (const array<T,N>& x, const array<T,N>& y) {
@@ -193,6 +367,71 @@ namespace boost {
         x.swap(y);
     }
 
+#if defined(__SUNPRO_CC)
+//  Trac ticket #4757; the Sun Solaris compiler can't handle
+//  syntax like 'T(&get_c_array(boost::array<T,N>& arg))[N]'
+//  
+//  We can't just use this for all compilers, because the 
+//      borland compilers can't handle this form. 
+    namespace detail {
+       template <typename T, std::size_t N> struct c_array
+       {
+           typedef T type[N];
+       };
+    }
+    
+   // Specific for boost::array: simply returns its elems data member.
+   template <typename T, std::size_t N>
+   typename detail::c_array<T,N>::type& get_c_array(boost::array<T,N>& arg)
+   {
+       return arg.elems;
+   }
+
+   // Specific for boost::array: simply returns its elems data member.
+   template <typename T, std::size_t N>
+   typename const detail::c_array<T,N>::type& get_c_array(const boost::array<T,N>& arg)
+   {
+       return arg.elems;
+   }
+#else
+// Specific for boost::array: simply returns its elems data member.
+    template <typename T, std::size_t N>
+    T(&get_c_array(boost::array<T,N>& arg))[N]
+    {
+        return arg.elems;
+    }
+    
+    // Const version.
+    template <typename T, std::size_t N>
+    const T(&get_c_array(const boost::array<T,N>& arg))[N]
+    {
+        return arg.elems;
+    }
+#endif
+    
+#if 0
+    // Overload for std::array, assuming that std::array will have
+    // explicit conversion functions as discussed at the WG21 meeting
+    // in Summit, March 2009.
+    template <typename T, std::size_t N>
+    T(&get_c_array(std::array<T,N>& arg))[N]
+    {
+        return static_cast<T(&)[N]>(arg);
+    }
+    
+    // Const version.
+    template <typename T, std::size_t N>
+    const T(&get_c_array(const std::array<T,N>& arg))[N]
+    {
+        return static_cast<T(&)[N]>(arg);
+    }
+#endif
+
 } /* namespace boost */
 
+
+#if BOOST_WORKAROUND(BOOST_MSVC, >= 1400)  
+# pragma warning(pop)  
+#endif 
+
 #endif /*BOOST_ARRAY_HPP*/

index.html

@@ -4,6 +4,10 @@
 </head>
 <body>
 Automatic redirection failed, please go to
-<a href="../../doc/html/array.html">../../doc/html/array.html</a>
+<a href="../../doc/html/array.html">../../doc/html/array.html</a> &nbsp;<hr>
+<p><EFBFBD> Copyright Beman Dawes, 2001</p>
+<p>Distributed under the Boost Software License, Version 1.0. (See accompanying 
+file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy 
+at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p>
 </body>
-</html>
+</html>

test/Jamfile.v2

@@ -0,0 +1,15 @@
+#~ Copyright Rene Rivera 2008
+#~ 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)
+
+import testing ;
+
+test-suite array :
+    [ run array0.cpp ]
+    [ run array1.cpp ]
+    [ run array2.cpp ]
+    [ run array3.cpp ]
+    [ run array4.cpp ]
+    [ run array5.cpp ]
+    [ run array6.cpp ]
+    ;

test/array0.cpp

@@ -0,0 +1,115 @@
+/* tests for using class array<> specialization for size 0
+ * (C) Copyright Alisdair Meredith 2006.
+ * 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)
+ */
+
+#include <string>
+#include <iostream>
+#include <boost/array.hpp>
+
+namespace {
+unsigned int failed_tests = 0;
+
+void    fail_test( const char * reason ) {
+    ++failed_tests;
+    std::cerr << "Test failure " << failed_tests << ": " << reason << std::endl;
+}
+
+template< class T >
+void    BadValue( const T &  )
+{
+    fail_test( "Unexpected value" );
+}
+
+template< class T >
+void    RunTests()
+{
+    typedef boost::array< T, 0 >    test_type;
+
+    //  Test value and aggegrate initialization
+    test_type                   test_case   =   {};
+    const boost::array< T, 0 >  const_test_case = test_type();
+
+    test_case.fill ( T() );
+
+    //  front/back and operator[] must compile, but calling them is undefined
+    //  Likewise, all tests below should evaluate to false, avoiding undefined behaviour
+    if( !test_case.empty() ) {
+        BadValue( test_case.front() );
+    }
+
+    if( !const_test_case.empty() ) {
+        BadValue( const_test_case.back() );
+    }
+
+    if( test_case.size() > 0 ) {
+        BadValue( test_case[ 0 ] );
+    }
+
+    if( const_test_case.max_size() > 0 ) {
+        BadValue( const_test_case[ 0 ] );
+    }
+
+    //  Assert requirements of TR1 6.2.2.4
+    if( test_case.begin() != test_case.end() ) {
+        fail_test( "Not an empty range" );
+    }
+    if( test_case.cbegin() != test_case.cend() ) {
+        fail_test( "Not an empty range" );
+    }
+    if( const_test_case.begin() != const_test_case.end() ) {
+        fail_test( "Not an empty range" );
+    }
+    if( const_test_case.cbegin() != const_test_case.cend() ) {
+        fail_test( "Not an empty range" );
+    }
+
+    if( test_case.begin() == const_test_case.begin() ) {
+        fail_test( "iterators for different containers are not distinct" );
+    }
+
+    if( test_case.data() == const_test_case.data() ) {
+    //  Value of data is unspecified in TR1, so no requirement this test pass or fail
+    //  However, it must compile!
+    }
+
+
+    //  Check can safely use all iterator types with std algorithms
+    std::for_each( test_case.begin(), test_case.end(), BadValue< T > );
+    std::for_each( test_case.rbegin(), test_case.rend(), BadValue< T > );
+    std::for_each( test_case.cbegin(), test_case.cend(), BadValue< T > );
+    std::for_each( const_test_case.begin(), const_test_case.end(), BadValue< T > );
+    std::for_each( const_test_case.rbegin(), const_test_case.rend(), BadValue< T > );
+    std::for_each( const_test_case.cbegin(), const_test_case.cend(), BadValue< T > );
+
+    //  Check swap is well formed
+    std::swap( test_case, test_case );
+
+    //  Check assigment operator and overloads are well formed
+    test_case   =   const_test_case;
+
+    //  Confirm at() throws the std lib defined exception
+    try {
+        BadValue( test_case.at( 0 ) );
+    } catch ( const std::out_of_range & ) {
+    }
+
+    try {
+        BadValue( const_test_case.at( 0 ) );
+    } catch ( const std::out_of_range & ) {
+    }
+}
+
+}
+
+int main()
+{
+    RunTests< bool >();
+    RunTests< void * >();
+    RunTests< long double >();
+    RunTests< std::string >();
+    return failed_tests;
+}
+

test/array2.cpp

@@ -5,17 +5,21 @@
  * http://www.boost.org/LICENSE_1_0.txt)
  */
 
+#ifndef _SCL_SECURE_NO_WARNINGS
+// Suppress warnings from the std lib:
+#  define _SCL_SECURE_NO_WARNINGS
+#endif
+
 #include <algorithm>
 #include <functional>
 #include <boost/array.hpp>
 #include "print.hpp"
 using namespace std;
-using namespace boost;
 
 int main()
 {
     // create and initialize array
-    array<int,10> a = { { 1, 2, 3, 4, 5 } };
+    boost::array<int,10> a = { { 1, 2, 3, 4, 5 } };
 
     print_elements(a);
 

test/array3.cpp

@@ -21,7 +21,7 @@ int main()
 
     // copy and change order
     boost::array<std::string,4> seasons_orig = seasons;
-    for (unsigned i=seasons.size()-1; i>0; --i) {
+    for (std::size_t i=seasons.size()-1; i>0; --i) {
         std::swap(seasons.at(i),seasons.at((i+1)%seasons.size()));
     }
 
@@ -39,6 +39,13 @@ int main()
            =seasons.rbegin(); pos<seasons.rend(); ++pos) {
         std::cout << " " << *pos;
     }
+
+    // try constant reverse iterators
+    std::cout << "reverse:   ";
+    for (boost::array<std::string,4>::const_reverse_iterator pos
+           =seasons.crbegin(); pos<seasons.crend(); ++pos) {
+        std::cout << " " << *pos;
+    }
     std::cout << std::endl;
 
     return 0;  // makes Visual-C++ compiler happy

test/array5.cpp

@@ -27,7 +27,7 @@ int main()
     typedef boost::array<float,6> Array;
 
     // create and initialize an array
-    const Array a = { { 42.42 } };
+    const Array a = { { 42.42f } };
 
     // use some common STL container operations
     std::cout << "static_size: " << a.size() << std::endl;

test/array6.cpp

@@ -0,0 +1,48 @@
+/* tests for using class array<> specialization for size 0
+ * (C) Copyright Alisdair Meredith 2006.
+ * 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)
+ */
+
+#include <string>
+#include <iostream>
+#include <boost/array.hpp>
+#include <algorithm>
+
+namespace {
+unsigned int failed_tests = 0;
+
+void    fail_test( const char * reason ) {
+    ++failed_tests;
+    std::cerr << "Test failure " << failed_tests << ": " << reason << std::endl;
+}
+
+template< class T >
+void    RunTests()
+{
+    typedef boost::array< T, 5 >    test_type;
+    typedef T arr[5];
+    test_type           test_case; //   =   { 1, 1, 2, 3, 5 };
+    
+    arr &aRef = get_c_array ( test_case );
+    if ( &*test_case.begin () != &aRef[0] )
+        fail_test ( "Array6: Same thing not equal?(1)" );
+        
+    const arr &caRef = get_c_array ( test_case );
+    typename test_type::const_iterator iter = test_case.begin ();
+    if ( &*iter != &caRef[0] )
+        fail_test ( "Array6: Same thing not equal?(2)" );
+}
+
+}
+
+int main()
+{
+    RunTests< bool >();
+    RunTests< void * >();
+    RunTests< long double >();
+    RunTests< std::string >();
+    return failed_tests;
+}
+