boost/boost/utility.hpp

   1 //  boost utility.hpp header file  -------------------------------------------//
   2
   3 //  (C) Copyright boost.org 1999. Permission to copy, use, modify, sell
   4 //  and distribute this software is granted provided this copyright
   5 //  notice appears in all copies. This software is provided "as is" without
   6 //  express or implied warranty, and with no claim as to its suitability for
   7 //  any purpose.
   8
   9 //  See http://www.boost.org for most recent version including documentation.
  10
  11 //  Classes appear in alphabetical order
  12
  13 //  Revision History
  14 //  21 May 01  checked_delete() and checked_array_delete() added (Beman Dawes,
  15 //             suggested by Dave Abrahams, generalizing idea from Vladimir Prus)
  16 //  21 May 01  made next() and prior() inline (Beman Dawes)
  17 //  26 Jan 00  protected noncopyable destructor added (Miki Jovanovic)
  18 //  10 Dec 99  next() and prior() templates added (Dave Abrahams)
  19 //  30 Aug 99  moved cast templates to cast.hpp (Beman Dawes)
  20 //   3 Aug 99  cast templates added
  21 //  20 Jul 99  name changed to utility.hpp
  22 //   9 Jun 99  protected noncopyable default ctor
  23 //   2 Jun 99  Initial Version. Class noncopyable only contents (Dave Abrahams)
  24
  25 #ifndef BOOST_UTILITY_HPP
  26 #define BOOST_UTILITY_HPP
  27
  28 #include <boost/config.hpp>        // broken compiler workarounds
  29 #include <boost/static_assert.hpp>
  30 #include <cstddef>                 // for size_t
  31 #include <utility>                 // for std::pair
  32
  33 namespace boost
  34 {
  35 //  checked_delete() and checked_array_delete()  -----------------------------//
  36
  37     // verify that types are complete for increased safety
  38
  39     template< typename T >
  40     inline void checked_delete(T * x)
  41     {
  42         BOOST_STATIC_ASSERT( sizeof(T) != 0 ); // assert type complete at point
  43                                                // of instantiation
  44         delete x;
  45     }
  46
  47     template< typename T >
  48     inline void checked_array_delete(T  * x)
  49     {
  50         BOOST_STATIC_ASSERT( sizeof(T) != 0 ); // assert type complete at point
  51                                                // of instantiation
  52         delete [] x;
  53     }
  54
  55 //  next() and prior() template functions  -----------------------------------//
  56
  57     //  Helper functions for classes like bidirectional iterators not supporting
  58     //  operator+ and operator-.
  59     //
  60     //  Usage:
  61     //    const std::list<T>::iterator p = get_some_iterator();
  62     //    const std::list<T>::iterator prev = boost::prior(p);
  63
  64     //  Contributed by Dave Abrahams
  65
  66     template <class T>
  67     inline T next(T x) { return ++x; }
  68
  69     template <class T>
  70     inline T prior(T x) { return --x; }
  71
  72
  73 //  class noncopyable  -------------------------------------------------------//
  74
  75     //  Private copy constructor and copy assignment ensure classes derived from
  76     //  class noncopyable cannot be copied.
  77
  78     //  Contributed by Dave Abrahams
  79
  80     class noncopyable
  81     {
  82     protected:
  83         noncopyable(){}
  84         ~noncopyable(){}
  85     private:  // emphasize the following members are private
  86         noncopyable( const noncopyable& );
  87         const noncopyable& operator=( const noncopyable& );
  88     }; // noncopyable
  89
  90
  91 } // namespace boost
  92
  93 #endif  // BOOST_UTILITY_HPP
  94