Update copyright in libstdc++-v3.
[official-gcc.git] / libstdc++-v3 / include / ext / memory
blobb19b0d7a76f9f3009fec7e1a3e1c66152fcd2839
1 // Memory extensions -*- C++ -*-
3 // Copyright (C) 2002-2013 Free Software Foundation, Inc.
4 //
5 // This file is part of the GNU ISO C++ Library.  This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
9 // any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
23 // <http://www.gnu.org/licenses/>.
26  *
27  * Copyright (c) 1994
28  * Hewlett-Packard Company
29  *
30  * Permission to use, copy, modify, distribute and sell this software
31  * and its documentation for any purpose is hereby granted without fee,
32  * provided that the above copyright notice appear in all copies and
33  * that both that copyright notice and this permission notice appear
34  * in supporting documentation.  Hewlett-Packard Company makes no
35  * representations about the suitability of this software for any
36  * purpose.  It is provided "as is" without express or implied warranty.
37  *
38  *
39  * Copyright (c) 1996
40  * Silicon Graphics Computer Systems, Inc.
41  *
42  * Permission to use, copy, modify, distribute and sell this software
43  * and its documentation for any purpose is hereby granted without fee,
44  * provided that the above copyright notice appear in all copies and
45  * that both that copyright notice and this permission notice appear
46  * in supporting documentation.  Silicon Graphics makes no
47  * representations about the suitability of this software for any
48  * purpose.  It is provided "as is" without express or implied warranty.
49  */
51 /** @file ext/memory
52  *  This file is a GNU extension to the Standard C++ Library (possibly
53  *  containing extensions from the HP/SGI STL subset).
54  */
56 #ifndef _EXT_MEMORY
57 #define _EXT_MEMORY 1
59 #pragma GCC system_header
61 #include <memory>
62 #include <bits/stl_tempbuf.h>
64 namespace __gnu_cxx _GLIBCXX_VISIBILITY(default)
66 _GLIBCXX_BEGIN_NAMESPACE_VERSION
68   using std::ptrdiff_t;
69   using std::pair;
70   using std::__iterator_category;
71   using std::_Temporary_buffer;
73   template<typename _InputIter, typename _Size, typename _ForwardIter>
74     pair<_InputIter, _ForwardIter>
75     __uninitialized_copy_n(_InputIter __first, _Size __count,
76                            _ForwardIter __result, std::input_iterator_tag)
77     {
78       _ForwardIter __cur = __result;
79       __try
80         {
81           for (; __count > 0 ; --__count, ++__first, ++__cur)
82             std::_Construct(&*__cur, *__first);
83           return pair<_InputIter, _ForwardIter>(__first, __cur);
84         }
85       __catch(...)
86         {
87           std::_Destroy(__result, __cur);
88           __throw_exception_again;
89         }
90     }
92   template<typename _RandomAccessIter, typename _Size, typename _ForwardIter>
93     inline pair<_RandomAccessIter, _ForwardIter>
94     __uninitialized_copy_n(_RandomAccessIter __first, _Size __count,
95                            _ForwardIter __result,
96                            std::random_access_iterator_tag)
97     {
98       _RandomAccessIter __last = __first + __count;
99       return (pair<_RandomAccessIter, _ForwardIter>
100               (__last, std::uninitialized_copy(__first, __last, __result)));
101     }
103   template<typename _InputIter, typename _Size, typename _ForwardIter>
104     inline pair<_InputIter, _ForwardIter>
105     __uninitialized_copy_n(_InputIter __first, _Size __count,
106                            _ForwardIter __result)
107     { return __gnu_cxx::__uninitialized_copy_n(__first, __count, __result,
108                                                __iterator_category(__first)); }
110   /**
111    *  @brief Copies the range [first,last) into result.
112    *  @param  __first  An input iterator.
113    *  @param  __count  Length
114    *  @param  __result An output iterator.
115    *  @return   __result + (__first + __count)
116    *  @ingroup SGIextensions
117    *
118    *  Like copy(), but does not require an initialized output range.
119   */
120   template<typename _InputIter, typename _Size, typename _ForwardIter>
121     inline pair<_InputIter, _ForwardIter>
122     uninitialized_copy_n(_InputIter __first, _Size __count,
123                          _ForwardIter __result)
124     { return __gnu_cxx::__uninitialized_copy_n(__first, __count, __result,
125                                                __iterator_category(__first)); }
128   // An alternative version of uninitialized_copy_n that constructs
129   // and destroys objects with a user-provided allocator.
130   template<typename _InputIter, typename _Size, typename _ForwardIter,
131            typename _Allocator>
132     pair<_InputIter, _ForwardIter>
133     __uninitialized_copy_n_a(_InputIter __first, _Size __count,
134                              _ForwardIter __result,
135                              _Allocator __alloc)
136     {
137       _ForwardIter __cur = __result;
138       __try
139         {
140           for (; __count > 0 ; --__count, ++__first, ++__cur)
141             __alloc.construct(&*__cur, *__first);
142           return pair<_InputIter, _ForwardIter>(__first, __cur);
143         }
144       __catch(...)
145         {
146           std::_Destroy(__result, __cur, __alloc);
147           __throw_exception_again;
148         }
149     }
151   template<typename _InputIter, typename _Size, typename _ForwardIter,
152            typename _Tp>
153     inline pair<_InputIter, _ForwardIter>
154     __uninitialized_copy_n_a(_InputIter __first, _Size __count,
155                              _ForwardIter __result,
156                              std::allocator<_Tp>)
157     {
158       return __gnu_cxx::uninitialized_copy_n(__first, __count, __result);
159     }
161   /**
162    *  This class provides similar behavior and semantics of the standard
163    *  functions get_temporary_buffer() and return_temporary_buffer(), but
164    *  encapsulated in a type vaguely resembling a standard container.
165    *
166    *  By default, a temporary_buffer<Iter> stores space for objects of
167    *  whatever type the Iter iterator points to.  It is constructed from a
168    *  typical [first,last) range, and provides the begin(), end(), size()
169    *  functions, as well as requested_size().  For non-trivial types, copies
170    *  of *first will be used to initialize the storage.
171    *
172    *  @c malloc is used to obtain underlying storage.
173    *
174    *  Like get_temporary_buffer(), not all the requested memory may be
175    *  available.  Ideally, the created buffer will be large enough to hold a
176    *  copy of [first,last), but if size() is less than requested_size(),
177    *  then this didn't happen.
178    *
179    *  @ingroup SGIextensions
180   */
181   template <class _ForwardIterator, class _Tp
182             = typename std::iterator_traits<_ForwardIterator>::value_type >
183     struct temporary_buffer : public _Temporary_buffer<_ForwardIterator, _Tp>
184     {
185       /// Requests storage large enough to hold a copy of [first,last).
186       temporary_buffer(_ForwardIterator __first, _ForwardIterator __last)
187       : _Temporary_buffer<_ForwardIterator, _Tp>(__first, __last) { }
188       
189       /// Destroys objects and frees storage.
190       ~temporary_buffer() { }
191     };
193 _GLIBCXX_END_NAMESPACE_VERSION
194 } // namespace
196 #endif