value_init.hpp 5.96 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// (C) Copyright 2002-2008, Fernando Luis Cacciola Carballal.
//
// 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)
//
// 21 Ago 2002 (Created) Fernando Cacciola
// 24 Dec 2007 (Refactored and worked around various compiler bugs) Fernando Cacciola, Niels Dekker
// 23 May 2008 (Fixed operator= const issue, added initialized_value) Niels Dekker, Fernando Cacciola
// 21 Ago 2008 (Added swap) Niels Dekker, Fernando Cacciola
// 20 Feb 2009 (Fixed logical const-ness issues) Niels Dekker, Fernando Cacciola
12 13
// 03 Apr 2010 (Added initialized<T>, suggested by Jeffrey Hellrung, fixing #3472) Niels Dekker
// 30 May 2010 (Made memset call conditional, fixing #3869) Niels Dekker
14 15 16 17 18 19 20 21 22 23 24
//
#ifndef BOOST_UTILITY_VALUE_INIT_21AGO2002_HPP
#define BOOST_UTILITY_VALUE_INIT_21AGO2002_HPP

// Note: The implementation of boost::value_initialized had to deal with the
// fact that various compilers haven't fully implemented value-initialization.
// The constructor of boost::value_initialized<T> works around these compiler
// issues, by clearing the bytes of T, before constructing the T object it
// contains. More details on these issues are at libs/utility/value_init.htm

#include <boost/aligned_storage.hpp>
25
#include <boost/config.hpp> // For BOOST_NO_COMPLETE_VALUE_INITIALIZATION.
26 27 28 29 30 31 32 33
#include <boost/detail/workaround.hpp>
#include <boost/static_assert.hpp>
#include <boost/type_traits/cv_traits.hpp>
#include <boost/type_traits/alignment_of.hpp>
#include <boost/swap.hpp>
#include <cstring>
#include <new>

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#ifdef BOOST_MSVC
#pragma warning(push)
#if _MSC_VER >= 1310
// It is safe to ignore the following warning from MSVC 7.1 or higher:
// "warning C4351: new behavior: elements of array will be default initialized"
#pragma warning(disable: 4351)
// It is safe to ignore the following MSVC warning, which may pop up when T is 
// a const type: "warning C4512: assignment operator could not be generated".
#pragma warning(disable: 4512)
#endif
#endif

#ifdef BOOST_NO_COMPLETE_VALUE_INITIALIZATION
  // Implementation detail: The macro BOOST_DETAIL_VALUE_INIT_WORKAROUND_SUGGESTED 
  // suggests that a workaround should be applied, because of compiler issues 
  // regarding value-initialization.
  #define BOOST_DETAIL_VALUE_INIT_WORKAROUND_SUGGESTED
#endif

// Implementation detail: The macro BOOST_DETAIL_VALUE_INIT_WORKAROUND
// switches the value-initialization workaround either on or off.
#ifndef BOOST_DETAIL_VALUE_INIT_WORKAROUND
  #ifdef BOOST_DETAIL_VALUE_INIT_WORKAROUND_SUGGESTED
  #define BOOST_DETAIL_VALUE_INIT_WORKAROUND 1
  #else
  #define BOOST_DETAIL_VALUE_INIT_WORKAROUND 0
  #endif
#endif

63 64 65
namespace boost {

template<class T>
66
class initialized
67 68 69 70 71 72 73 74
{
  private :
    struct wrapper
    {
#if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x592))
      typename
#endif 
      remove_const<T>::type data;
75 76 77 78 79 80 81 82 83 84 85 86

      wrapper()
      :
      data()
      {
      }

      wrapper(T const & arg)
      :
      data(arg)
      {
      }
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    };

    mutable
#if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x592))
      typename
#endif 
      aligned_storage<sizeof(wrapper), alignment_of<wrapper>::value>::type x;

    wrapper * wrapper_address() const
    {
      return static_cast<wrapper *>( static_cast<void*>(&x));
    }

  public :

102
    initialized()
103
    {
104
#if BOOST_DETAIL_VALUE_INIT_WORKAROUND
105 106 107 108 109
      std::memset(&x, 0, sizeof(x));
#endif
      new (wrapper_address()) wrapper();
    }

110
    initialized(initialized const & arg)
111 112 113 114
    {
      new (wrapper_address()) wrapper( static_cast<wrapper const &>(*(arg.wrapper_address())));
    }

115 116 117 118 119 120
    explicit initialized(T const & arg)
    {
      new (wrapper_address()) wrapper(arg);
    }

    initialized & operator=(initialized const & arg)
121 122 123 124 125 126 127
    {
      // Assignment is only allowed when T is non-const.
      BOOST_STATIC_ASSERT( ! is_const<T>::value );
      *wrapper_address() = static_cast<wrapper const &>(*(arg.wrapper_address()));
      return *this;
    }

128
    ~initialized()
129 130 131 132 133 134 135 136 137 138 139 140 141 142
    {
      wrapper_address()->wrapper::~wrapper();
    }

    T const & data() const
    {
      return wrapper_address()->data;
    }

    T& data()
    {
      return wrapper_address()->data;
    }

143
    void swap(initialized & arg)
144 145 146 147
    {
      ::boost::swap( this->data(), arg.data() );
    }

148 149 150 151
    operator T const &() const
    {
      return wrapper_address()->data;
    }
152

153 154 155 156
    operator T&()
    {
      return wrapper_address()->data;
    }
157 158 159

} ;

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
template<class T>
T const& get ( initialized<T> const& x )
{
  return x.data() ;
}

template<class T>
T& get ( initialized<T>& x )
{
  return x.data() ;
}

template<class T>
void swap ( initialized<T> & lhs, initialized<T> & rhs )
{
  lhs.swap(rhs) ;
}

template<class T>
class value_initialized
{
  private :

    // initialized<T> does value-initialization by default.
    initialized<T> m_data;

  public :
    
    value_initialized()
    :
    m_data()
    { }
    
    T const & data() const
    {
      return m_data.data();
    }

    T& data()
    {
      return m_data.data();
    }

    void swap(value_initialized & arg)
    {
      m_data.swap(arg.m_data);
    }

    operator T const &() const
    {
      return m_data;
    }

    operator T&()
    {
      return m_data;
    }
} ;
218 219 220 221 222 223 224


template<class T>
T const& get ( value_initialized<T> const& x )
{
  return x.data() ;
}
225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
template<class T>
T& get ( value_initialized<T>& x )
{
  return x.data() ;
}

template<class T>
void swap ( value_initialized<T> & lhs, value_initialized<T> & rhs )
{
  lhs.swap(rhs) ;
}


class initialized_value_t
{
  public :
    
    template <class T> operator T() const
    {
245
      return initialized<T>().data();
246 247 248 249 250 251 252 253
    }
};

initialized_value_t const initialized_value = {} ;


} // namespace boost

254 255 256
#ifdef BOOST_MSVC
#pragma warning(pop)
#endif
257 258

#endif