# stl_construct.h

Go to the documentation of this file.

    00001 // nonstandard construct and destroy functions -*- C++ -*-
    00002
    00003 // Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
    00004 //
    00005 // This file is part of the GNU ISO C++ Library.  This library is free
    00006 // software; you can redistribute it and/or modify it under the
    00007 // terms of the GNU General Public License as published by the
    00008 // Free Software Foundation; either version 2, or (at your option)
    00009 // any later version.
    00010
    00011 // This library is distributed in the hope that it will be useful,
    00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
    00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    00014 // GNU General Public License for more details.
    00015
    00016 // You should have received a copy of the GNU General Public License along
    00017 // with this library; see the file COPYING.  If not, write to the Free
    00018 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
    00019 // USA.
    00020
    00021 // As a special exception, you may use this file as part of a free software
    00022 // library without restriction.  Specifically, if other files instantiate
    00023 // templates or use macros or inline functions from this file, or you compile
    00024 // this file and link it with other files to produce an executable, this
    00025 // file does not by itself cause the resulting executable to be covered by
    00026 // the GNU General Public License.  This exception does not however
    00027 // invalidate any other reasons why the executable file might be covered by
    00028 // the GNU General Public License.
    00029
    00030 /*
    00031  *
    00032  * Copyright (c) 1994
    00033  * Hewlett-Packard Company
    00034  *
    00035  * Permission to use, copy, modify, distribute and sell this software
    00036  * and its documentation for any purpose is hereby granted without fee,
    00037  * provided that the above copyright notice appear in all copies and
    00038  * that both that copyright notice and this permission notice appear
    00039  * in supporting documentation.  Hewlett-Packard Company makes no
    00040  * representations about the suitability of this software for any
    00041  * purpose.  It is provided "as is" without express or implied warranty.
    00042  *
    00043  *
    00044  * Copyright (c) 1996,1997
    00045  * Silicon Graphics Computer Systems, Inc.
    00046  *
    00047  * Permission to use, copy, modify, distribute and sell this software
    00048  * and its documentation for any purpose is hereby granted without fee,
    00049  * provided that the above copyright notice appear in all copies and
    00050  * that both that copyright notice and this permission notice appear
    00051  * in supporting documentation.  Silicon Graphics makes no
    00052  * representations about the suitability of this software for any
    00053  * purpose.  It is provided "as is" without express or implied warranty.
    00054  */
    00055
    00056 /** @file stl_construct.h
    00057  *  This is an internal header file, included by other library headers.
    00058  *  You should not attempt to use it directly.
    00059  */
    00060
    00061 #ifndef _STL_CONSTRUCT_H
    00062 #define _STL_CONSTRUCT_H 1
    00063
    00064 #include <bits/cpp_type_traits.h>
    00065 #include <new>
    00066
    00067 _GLIBCXX_BEGIN_NAMESPACE(std)
    00068
    00069   /**
    00070    * @if maint
    00071    * Constructs an object in existing memory by invoking an allocated
    00072    * object's constructor with an initializer.
    00073    * @endif
    00074    */
    00075   template<typename _T1, typename _T2>
    00076     inline void
    00077     _Construct(_T1* __p, const _T2& __value)
    00078     {
    00079       // _GLIBCXX_RESOLVE_LIB_DEFECTS
    00080       // 402. wrong new expression in [some_]allocator::construct
    00081       ::new(static_cast<void*>(__p)) _T1(__value);
    00082     }
    00083
    00084   /**
    00085    * @if maint
    00086    * Constructs an object in existing memory by invoking an allocated
    00087    * object's default constructor (no initializers).
    00088    * @endif
    00089    */
    00090   template<typename _T1>
    00091     inline void
    00092     _Construct(_T1* __p)
    00093     {
    00094       // _GLIBCXX_RESOLVE_LIB_DEFECTS
    00095       // 402. wrong new expression in [some_]allocator::construct
    00096       ::new(static_cast<void*>(__p)) _T1();
    00097     }
    00098
    00099   /**
    00100    * @if maint
    00101    * Destroy the object pointed to by a pointer type.
    00102    * @endif
    00103    */
    00104   template<typename _Tp>
    00105     inline void
    00106     _Destroy(_Tp* __pointer)
    00107     { __pointer->~_Tp(); }
    00108
    00109   /**
    00110    * @if maint
    00111    * Destroy a range of objects with nontrivial destructors.
    00112    *
    00113    * This is a helper function used only by _Destroy().
    00114    * @endif
    00115    */
    00116   template<typename _ForwardIterator>
    00117     inline void
    00118     __destroy_aux(_ForwardIterator __first, _ForwardIterator __last,
    00119           __false_type)
    00120     {
    00121       for (; __first != __last; ++__first)
    00122     std::_Destroy(&*__first);
    00123     }
    00124
    00125   /**
    00126    * @if maint
    00127    * Destroy a range of objects with trivial destructors.  Since the destructors
    00128    * are trivial, there's nothing to do and hopefully this function will be
    00129    * entirely optimized away.
    00130    *
    00131    * This is a helper function used only by _Destroy().
    00132    * @endif
    00133    */
    00134   template<typename _ForwardIterator>
    00135     inline void
    00136     __destroy_aux(_ForwardIterator, _ForwardIterator, __true_type)
    00137     { }
    00138
    00139   /**
    00140    * @if maint
    00141    * Destroy a range of objects.  If the value_type of the object has
    00142    * a trivial destructor, the compiler should optimize all of this
    00143    * away, otherwise the objects' destructors must be invoked.
    00144    * @endif
    00145    */
    00146   template<typename _ForwardIterator>
    00147     inline void
    00148     _Destroy(_ForwardIterator __first, _ForwardIterator __last)
    00149     {
    00150       typedef typename iterator_traits<_ForwardIterator>::value_type
    00151                        _Value_type;
    00152       typedef typename std::__is_scalar<_Value_type>::__type
    00153                    _Has_trivial_destructor;
    00154
    00155       std::__destroy_aux(__first, __last, _Has_trivial_destructor());
    00156     }
    00157
    00158   /**
    00159    * @if maint
    00160    * Destroy a range of objects using the supplied allocator.  For
    00161    * nondefault allocators we do not optimize away invocation of
    00162    * destroy() even if _Tp has a trivial destructor.
    00163    * @endif
    00164    */
    00165
    00166   template <typename _Tp> class allocator;
    00167
    00168   template<typename _ForwardIterator, typename _Allocator>
    00169     void
    00170     _Destroy(_ForwardIterator __first, _ForwardIterator __last,
    00171          _Allocator __alloc)
    00172     {
    00173       for (; __first != __last; ++__first)
    00174     __alloc.destroy(&*__first);
    00175     }
    00176
    00177   template<typename _ForwardIterator, typename _Tp>
    00178     inline void
    00179     _Destroy(_ForwardIterator __first, _ForwardIterator __last,
    00180          allocator<_Tp>)
    00181     {
    00182       _Destroy(__first, __last);
    00183     }
    00184
    00185 _GLIBCXX_END_NAMESPACE
    00186
    00187 #endif /* _STL_CONSTRUCT_H */
    00188