1 // Debugging vector implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
31 /** @file debug/vector
32 * This file is a GNU debug extension to the Standard C++ Library.
35 #ifndef _GLIBCXX_DEBUG_VECTOR
36 #define _GLIBCXX_DEBUG_VECTOR 1
40 #include <debug/safe_sequence.h>
41 #include <debug/safe_iterator.h>
47 template<typename _Tp,
48 typename _Allocator = std::allocator<_Tp> >
50 : public _GLIBCXX_STD_D::vector<_Tp, _Allocator>,
51 public __gnu_debug::_Safe_sequence<vector<_Tp, _Allocator> >
53 typedef _GLIBCXX_STD_D::vector<_Tp, _Allocator> _Base;
54 typedef __gnu_debug::_Safe_sequence<vector> _Safe_base;
56 typedef typename _Base::const_iterator _Base_const_iterator;
57 typedef __gnu_debug::_After_nth_from<_Base_const_iterator> _After_nth;
60 typedef typename _Base::reference reference;
61 typedef typename _Base::const_reference const_reference;
63 typedef __gnu_debug::_Safe_iterator<typename _Base::iterator,vector>
65 typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,vector>
68 typedef typename _Base::size_type size_type;
69 typedef typename _Base::difference_type difference_type;
71 typedef _Tp value_type;
72 typedef _Allocator allocator_type;
73 typedef typename _Base::pointer pointer;
74 typedef typename _Base::const_pointer const_pointer;
75 typedef std::reverse_iterator<iterator> reverse_iterator;
76 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
78 // 23.2.4.1 construct/copy/destroy:
79 explicit vector(const _Allocator& __a = _Allocator())
80 : _Base(__a), _M_guaranteed_capacity(0) { }
82 explicit vector(size_type __n, const _Tp& __value = _Tp(),
83 const _Allocator& __a = _Allocator())
84 : _Base(__n, __value, __a), _M_guaranteed_capacity(__n) { }
86 template<class _InputIterator>
87 vector(_InputIterator __first, _InputIterator __last,
88 const _Allocator& __a = _Allocator())
89 : _Base(__gnu_debug::__check_valid_range(__first, __last),
91 _M_guaranteed_capacity(0)
92 { _M_update_guaranteed_capacity(); }
94 vector(const vector<_Tp,_Allocator>& __x)
95 : _Base(__x), _Safe_base(), _M_guaranteed_capacity(__x.size()) { }
97 /// Construction from a release-mode vector
98 vector(const _Base& __x)
99 : _Base(__x), _Safe_base(), _M_guaranteed_capacity(__x.size()) { }
103 vector<_Tp,_Allocator>&
104 operator=(const vector<_Tp,_Allocator>& __x)
106 static_cast<_Base&>(*this) = __x;
107 this->_M_invalidate_all();
108 _M_update_guaranteed_capacity();
112 template<typename _InputIterator>
114 assign(_InputIterator __first, _InputIterator __last)
116 __glibcxx_check_valid_range(__first, __last);
117 _Base::assign(__first, __last);
118 this->_M_invalidate_all();
119 _M_update_guaranteed_capacity();
123 assign(size_type __n, const _Tp& __u)
125 _Base::assign(__n, __u);
126 this->_M_invalidate_all();
127 _M_update_guaranteed_capacity();
130 using _Base::get_allocator;
135 { return iterator(_Base::begin(), this); }
139 { return const_iterator(_Base::begin(), this); }
143 { return iterator(_Base::end(), this); }
147 { return const_iterator(_Base::end(), this); }
151 { return reverse_iterator(end()); }
153 const_reverse_iterator
155 { return const_reverse_iterator(end()); }
159 { return reverse_iterator(begin()); }
161 const_reverse_iterator
163 { return const_reverse_iterator(begin()); }
165 // 23.2.4.2 capacity:
167 using _Base::max_size;
170 resize(size_type __sz, _Tp __c = _Tp())
172 bool __realloc = _M_requires_reallocation(__sz);
173 if (__sz < this->size())
174 this->_M_invalidate_if(_After_nth(__sz, _M_base().begin()));
175 _Base::resize(__sz, __c);
177 this->_M_invalidate_all();
180 using _Base::capacity;
184 reserve(size_type __n)
186 bool __realloc = _M_requires_reallocation(__n);
188 if (__n > _M_guaranteed_capacity)
189 _M_guaranteed_capacity = __n;
191 this->_M_invalidate_all();
196 operator[](size_type __n)
198 __glibcxx_check_subscript(__n);
199 return _M_base()[__n];
203 operator[](size_type __n) const
205 __glibcxx_check_subscript(__n);
206 return _M_base()[__n];
214 __glibcxx_check_nonempty();
215 return _Base::front();
221 __glibcxx_check_nonempty();
222 return _Base::front();
228 __glibcxx_check_nonempty();
229 return _Base::back();
235 __glibcxx_check_nonempty();
236 return _Base::back();
239 // _GLIBCXX_RESOLVE_LIB_DEFECTS
240 // DR 464. Suggestion for new member functions in standard containers.
243 // 23.2.4.3 modifiers:
245 push_back(const _Tp& __x)
247 bool __realloc = _M_requires_reallocation(this->size() + 1);
248 _Base::push_back(__x);
250 this->_M_invalidate_all();
251 _M_update_guaranteed_capacity();
257 __glibcxx_check_nonempty();
258 iterator __victim = end() - 1;
259 __victim._M_invalidate();
264 insert(iterator __position, const _Tp& __x)
266 __glibcxx_check_insert(__position);
267 bool __realloc = _M_requires_reallocation(this->size() + 1);
268 difference_type __offset = __position - begin();
269 typename _Base::iterator __res = _Base::insert(__position.base(),__x);
271 this->_M_invalidate_all();
273 this->_M_invalidate_if(_After_nth(__offset, _M_base().begin()));
274 _M_update_guaranteed_capacity();
275 return iterator(__res, this);
279 insert(iterator __position, size_type __n, const _Tp& __x)
281 __glibcxx_check_insert(__position);
282 bool __realloc = _M_requires_reallocation(this->size() + __n);
283 difference_type __offset = __position - begin();
284 _Base::insert(__position.base(), __n, __x);
286 this->_M_invalidate_all();
288 this->_M_invalidate_if(_After_nth(__offset, _M_base().begin()));
289 _M_update_guaranteed_capacity();
292 template<class _InputIterator>
294 insert(iterator __position,
295 _InputIterator __first, _InputIterator __last)
297 __glibcxx_check_insert_range(__position, __first, __last);
299 /* Hard to guess if invalidation will occur, because __last
300 - __first can't be calculated in all cases, so we just
301 punt here by checking if it did occur. */
302 typename _Base::iterator __old_begin = _M_base().begin();
303 difference_type __offset = __position - begin();
304 _Base::insert(__position.base(), __first, __last);
306 if (_M_base().begin() != __old_begin)
307 this->_M_invalidate_all();
309 this->_M_invalidate_if(_After_nth(__offset, _M_base().begin()));
310 _M_update_guaranteed_capacity();
314 erase(iterator __position)
316 __glibcxx_check_erase(__position);
317 difference_type __offset = __position - begin();
318 typename _Base::iterator __res = _Base::erase(__position.base());
319 this->_M_invalidate_if(_After_nth(__offset, _M_base().begin()));
320 return iterator(__res, this);
324 erase(iterator __first, iterator __last)
326 // _GLIBCXX_RESOLVE_LIB_DEFECTS
327 // 151. can't currently clear() empty container
328 __glibcxx_check_erase_range(__first, __last);
330 difference_type __offset = __first - begin();
331 typename _Base::iterator __res = _Base::erase(__first.base(),
333 this->_M_invalidate_if(_After_nth(__offset, _M_base().begin()));
334 return iterator(__res, this);
338 swap(vector<_Tp,_Allocator>& __x)
342 std::swap(_M_guaranteed_capacity, __x._M_guaranteed_capacity);
349 this->_M_invalidate_all();
350 _M_guaranteed_capacity = 0;
354 _M_base() { return *this; }
357 _M_base() const { return *this; }
360 size_type _M_guaranteed_capacity;
363 _M_requires_reallocation(size_type __elements)
365 #ifdef _GLIBCXX_DEBUG_PEDANTIC
366 return __elements > this->capacity();
368 return __elements > _M_guaranteed_capacity;
373 _M_update_guaranteed_capacity()
375 if (this->size() > _M_guaranteed_capacity)
376 _M_guaranteed_capacity = this->size();
380 template<typename _Tp, typename _Alloc>
382 operator==(const vector<_Tp, _Alloc>& __lhs,
383 const vector<_Tp, _Alloc>& __rhs)
384 { return __lhs._M_base() == __rhs._M_base(); }
386 template<typename _Tp, typename _Alloc>
388 operator!=(const vector<_Tp, _Alloc>& __lhs,
389 const vector<_Tp, _Alloc>& __rhs)
390 { return __lhs._M_base() != __rhs._M_base(); }
392 template<typename _Tp, typename _Alloc>
394 operator<(const vector<_Tp, _Alloc>& __lhs,
395 const vector<_Tp, _Alloc>& __rhs)
396 { return __lhs._M_base() < __rhs._M_base(); }
398 template<typename _Tp, typename _Alloc>
400 operator<=(const vector<_Tp, _Alloc>& __lhs,
401 const vector<_Tp, _Alloc>& __rhs)
402 { return __lhs._M_base() <= __rhs._M_base(); }
404 template<typename _Tp, typename _Alloc>
406 operator>=(const vector<_Tp, _Alloc>& __lhs,
407 const vector<_Tp, _Alloc>& __rhs)
408 { return __lhs._M_base() >= __rhs._M_base(); }
410 template<typename _Tp, typename _Alloc>
412 operator>(const vector<_Tp, _Alloc>& __lhs,
413 const vector<_Tp, _Alloc>& __rhs)
414 { return __lhs._M_base() > __rhs._M_base(); }
416 template<typename _Tp, typename _Alloc>
418 swap(vector<_Tp, _Alloc>& __lhs, vector<_Tp, _Alloc>& __rhs)
419 { __lhs.swap(__rhs); }
420 } // namespace __debug