1 // Debugging vector implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
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 3, 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 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 /** @file debug/vector
27 * This file is a GNU debug extension to the Standard C++ Library.
30 #ifndef _GLIBCXX_DEBUG_VECTOR
31 #define _GLIBCXX_DEBUG_VECTOR 1
35 #include <debug/safe_sequence.h>
36 #include <debug/safe_iterator.h>
38 namespace std _GLIBCXX_VISIBILITY(default)
42 /// Class std::vector with safety/checking/debug instrumentation.
43 template<typename _Tp,
44 typename _Allocator = std::allocator<_Tp> >
46 : public _GLIBCXX_STD_C::vector<_Tp, _Allocator>,
47 public __gnu_debug::_Safe_sequence<vector<_Tp, _Allocator> >
49 typedef _GLIBCXX_STD_C::vector<_Tp, _Allocator> _Base;
51 typedef typename _Base::iterator _Base_iterator;
52 typedef typename _Base::const_iterator _Base_const_iterator;
53 typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
56 typedef typename _Base::reference reference;
57 typedef typename _Base::const_reference const_reference;
59 typedef __gnu_debug::_Safe_iterator<_Base_iterator,vector>
61 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator,vector>
64 typedef typename _Base::size_type size_type;
65 typedef typename _Base::difference_type difference_type;
67 typedef _Tp value_type;
68 typedef _Allocator allocator_type;
69 typedef typename _Base::pointer pointer;
70 typedef typename _Base::const_pointer const_pointer;
71 typedef std::reverse_iterator<iterator> reverse_iterator;
72 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
74 // 23.2.4.1 construct/copy/destroy:
76 vector(const _Allocator& __a = _Allocator())
77 : _Base(__a), _M_guaranteed_capacity(0) { }
79 #ifdef __GXX_EXPERIMENTAL_CXX0X__
82 : _Base(__n), _M_guaranteed_capacity(__n) { }
84 vector(size_type __n, const _Tp& __value,
85 const _Allocator& __a = _Allocator())
86 : _Base(__n, __value, __a), _M_guaranteed_capacity(__n) { }
89 vector(size_type __n, const _Tp& __value = _Tp(),
90 const _Allocator& __a = _Allocator())
91 : _Base(__n, __value, __a), _M_guaranteed_capacity(__n) { }
94 template<class _InputIterator>
95 vector(_InputIterator __first, _InputIterator __last,
96 const _Allocator& __a = _Allocator())
97 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
99 __gnu_debug::__base(__last), __a),
100 _M_guaranteed_capacity(0)
101 { _M_update_guaranteed_capacity(); }
103 vector(const vector& __x)
104 : _Base(__x), _M_guaranteed_capacity(__x.size()) { }
106 /// Construction from a release-mode vector
107 vector(const _Base& __x)
108 : _Base(__x), _M_guaranteed_capacity(__x.size()) { }
110 #ifdef __GXX_EXPERIMENTAL_CXX0X__
111 vector(vector&& __x) noexcept
112 : _Base(std::move(__x)),
113 _M_guaranteed_capacity(this->size())
116 __x._M_guaranteed_capacity = 0;
119 vector(initializer_list<value_type> __l,
120 const allocator_type& __a = allocator_type())
122 _M_guaranteed_capacity(__l.size()) { }
125 ~vector() _GLIBCXX_NOEXCEPT { }
128 operator=(const vector& __x)
130 static_cast<_Base&>(*this) = __x;
131 this->_M_invalidate_all();
132 _M_update_guaranteed_capacity();
136 #ifdef __GXX_EXPERIMENTAL_CXX0X__
138 operator=(vector&& __x)
148 operator=(initializer_list<value_type> __l)
150 static_cast<_Base&>(*this) = __l;
151 this->_M_invalidate_all();
152 _M_update_guaranteed_capacity();
157 template<typename _InputIterator>
159 assign(_InputIterator __first, _InputIterator __last)
161 __glibcxx_check_valid_range(__first, __last);
162 _Base::assign(__gnu_debug::__base(__first),
163 __gnu_debug::__base(__last));
164 this->_M_invalidate_all();
165 _M_update_guaranteed_capacity();
169 assign(size_type __n, const _Tp& __u)
171 _Base::assign(__n, __u);
172 this->_M_invalidate_all();
173 _M_update_guaranteed_capacity();
176 #ifdef __GXX_EXPERIMENTAL_CXX0X__
178 assign(initializer_list<value_type> __l)
181 this->_M_invalidate_all();
182 _M_update_guaranteed_capacity();
186 using _Base::get_allocator;
190 begin() _GLIBCXX_NOEXCEPT
191 { return iterator(_Base::begin(), this); }
194 begin() const _GLIBCXX_NOEXCEPT
195 { return const_iterator(_Base::begin(), this); }
198 end() _GLIBCXX_NOEXCEPT
199 { return iterator(_Base::end(), this); }
202 end() const _GLIBCXX_NOEXCEPT
203 { return const_iterator(_Base::end(), this); }
206 rbegin() _GLIBCXX_NOEXCEPT
207 { return reverse_iterator(end()); }
209 const_reverse_iterator
210 rbegin() const _GLIBCXX_NOEXCEPT
211 { return const_reverse_iterator(end()); }
214 rend() _GLIBCXX_NOEXCEPT
215 { return reverse_iterator(begin()); }
217 const_reverse_iterator
218 rend() const _GLIBCXX_NOEXCEPT
219 { return const_reverse_iterator(begin()); }
221 #ifdef __GXX_EXPERIMENTAL_CXX0X__
223 cbegin() const noexcept
224 { return const_iterator(_Base::begin(), this); }
227 cend() const noexcept
228 { return const_iterator(_Base::end(), this); }
230 const_reverse_iterator
231 crbegin() const noexcept
232 { return const_reverse_iterator(end()); }
234 const_reverse_iterator
235 crend() const noexcept
236 { return const_reverse_iterator(begin()); }
239 // 23.2.4.2 capacity:
241 using _Base::max_size;
243 #ifdef __GXX_EXPERIMENTAL_CXX0X__
245 resize(size_type __sz)
247 bool __realloc = _M_requires_reallocation(__sz);
248 if (__sz < this->size())
249 this->_M_invalidate_after_nth(__sz);
252 this->_M_invalidate_all();
253 _M_update_guaranteed_capacity();
257 resize(size_type __sz, const _Tp& __c)
259 bool __realloc = _M_requires_reallocation(__sz);
260 if (__sz < this->size())
261 this->_M_invalidate_after_nth(__sz);
262 _Base::resize(__sz, __c);
264 this->_M_invalidate_all();
265 _M_update_guaranteed_capacity();
269 resize(size_type __sz, _Tp __c = _Tp())
271 bool __realloc = _M_requires_reallocation(__sz);
272 if (__sz < this->size())
273 this->_M_invalidate_after_nth(__sz);
274 _Base::resize(__sz, __c);
276 this->_M_invalidate_all();
277 _M_update_guaranteed_capacity();
281 #ifdef __GXX_EXPERIMENTAL_CXX0X__
285 if (_Base::_M_shrink_to_fit())
287 _M_guaranteed_capacity = _Base::capacity();
288 this->_M_invalidate_all();
294 capacity() const _GLIBCXX_NOEXCEPT
296 #ifdef _GLIBCXX_DEBUG_PEDANTIC
297 return _M_guaranteed_capacity;
299 return _Base::capacity();
306 reserve(size_type __n)
308 bool __realloc = _M_requires_reallocation(__n);
310 if (__n > _M_guaranteed_capacity)
311 _M_guaranteed_capacity = __n;
313 this->_M_invalidate_all();
318 operator[](size_type __n)
320 __glibcxx_check_subscript(__n);
321 return _M_base()[__n];
325 operator[](size_type __n) const
327 __glibcxx_check_subscript(__n);
328 return _M_base()[__n];
336 __glibcxx_check_nonempty();
337 return _Base::front();
343 __glibcxx_check_nonempty();
344 return _Base::front();
350 __glibcxx_check_nonempty();
351 return _Base::back();
357 __glibcxx_check_nonempty();
358 return _Base::back();
361 // _GLIBCXX_RESOLVE_LIB_DEFECTS
362 // DR 464. Suggestion for new member functions in standard containers.
365 // 23.2.4.3 modifiers:
367 push_back(const _Tp& __x)
369 bool __realloc = _M_requires_reallocation(this->size() + 1);
370 _Base::push_back(__x);
372 this->_M_invalidate_all();
373 _M_update_guaranteed_capacity();
376 #ifdef __GXX_EXPERIMENTAL_CXX0X__
377 template<typename _Up = _Tp>
378 typename __gnu_cxx::__enable_if<!std::__are_same<_Up, bool>::__value,
381 { emplace_back(std::move(__x)); }
383 template<typename... _Args>
385 emplace_back(_Args&&... __args)
387 bool __realloc = _M_requires_reallocation(this->size() + 1);
388 _Base::emplace_back(std::forward<_Args>(__args)...);
390 this->_M_invalidate_all();
391 _M_update_guaranteed_capacity();
398 __glibcxx_check_nonempty();
399 this->_M_invalidate_if(_Equal(--_Base::end()));
403 #ifdef __GXX_EXPERIMENTAL_CXX0X__
404 template<typename... _Args>
406 emplace(iterator __position, _Args&&... __args)
408 __glibcxx_check_insert(__position);
409 bool __realloc = _M_requires_reallocation(this->size() + 1);
410 difference_type __offset = __position.base() - _Base::begin();
411 _Base_iterator __res = _Base::emplace(__position.base(),
412 std::forward<_Args>(__args)...);
414 this->_M_invalidate_all();
416 this->_M_invalidate_after_nth(__offset);
417 _M_update_guaranteed_capacity();
418 return iterator(__res, this);
423 insert(iterator __position, const _Tp& __x)
425 __glibcxx_check_insert(__position);
426 bool __realloc = _M_requires_reallocation(this->size() + 1);
427 difference_type __offset = __position.base() - _Base::begin();
428 _Base_iterator __res = _Base::insert(__position.base(), __x);
430 this->_M_invalidate_all();
432 this->_M_invalidate_after_nth(__offset);
433 _M_update_guaranteed_capacity();
434 return iterator(__res, this);
437 #ifdef __GXX_EXPERIMENTAL_CXX0X__
438 template<typename _Up = _Tp>
439 typename __gnu_cxx::__enable_if<!std::__are_same<_Up, bool>::__value,
441 insert(iterator __position, _Tp&& __x)
442 { return emplace(__position, std::move(__x)); }
445 insert(iterator __position, initializer_list<value_type> __l)
446 { this->insert(__position, __l.begin(), __l.end()); }
450 insert(iterator __position, size_type __n, const _Tp& __x)
452 __glibcxx_check_insert(__position);
453 bool __realloc = _M_requires_reallocation(this->size() + __n);
454 difference_type __offset = __position.base() - _Base::begin();
455 _Base::insert(__position.base(), __n, __x);
457 this->_M_invalidate_all();
459 this->_M_invalidate_after_nth(__offset);
460 _M_update_guaranteed_capacity();
463 template<class _InputIterator>
465 insert(iterator __position,
466 _InputIterator __first, _InputIterator __last)
468 __glibcxx_check_insert_range(__position, __first, __last);
470 /* Hard to guess if invalidation will occur, because __last
471 - __first can't be calculated in all cases, so we just
472 punt here by checking if it did occur. */
473 _Base_iterator __old_begin = _M_base().begin();
474 difference_type __offset = __position.base() - _Base::begin();
475 _Base::insert(__position.base(), __gnu_debug::__base(__first),
476 __gnu_debug::__base(__last));
478 if (_M_base().begin() != __old_begin)
479 this->_M_invalidate_all();
481 this->_M_invalidate_after_nth(__offset);
482 _M_update_guaranteed_capacity();
486 erase(iterator __position)
488 __glibcxx_check_erase(__position);
489 difference_type __offset = __position.base() - _Base::begin();
490 _Base_iterator __res = _Base::erase(__position.base());
491 this->_M_invalidate_after_nth(__offset);
492 return iterator(__res, this);
496 erase(iterator __first, iterator __last)
498 // _GLIBCXX_RESOLVE_LIB_DEFECTS
499 // 151. can't currently clear() empty container
500 __glibcxx_check_erase_range(__first, __last);
502 difference_type __offset = __first.base() - _Base::begin();
503 _Base_iterator __res = _Base::erase(__first.base(),
505 this->_M_invalidate_after_nth(__offset);
506 return iterator(__res, this);
514 std::swap(_M_guaranteed_capacity, __x._M_guaranteed_capacity);
518 clear() _GLIBCXX_NOEXCEPT
521 this->_M_invalidate_all();
522 _M_guaranteed_capacity = 0;
526 _M_base() _GLIBCXX_NOEXCEPT { return *this; }
529 _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
532 size_type _M_guaranteed_capacity;
535 _M_requires_reallocation(size_type __elements)
536 { return __elements > this->capacity(); }
539 _M_update_guaranteed_capacity()
541 if (this->size() > _M_guaranteed_capacity)
542 _M_guaranteed_capacity = this->size();
546 _M_invalidate_after_nth(difference_type __n)
548 typedef __gnu_debug::_After_nth_from<_Base_const_iterator> _After_nth;
549 this->_M_invalidate_if(_After_nth(__n, _Base::begin()));
553 template<typename _Tp, typename _Alloc>
555 operator==(const vector<_Tp, _Alloc>& __lhs,
556 const vector<_Tp, _Alloc>& __rhs)
557 { return __lhs._M_base() == __rhs._M_base(); }
559 template<typename _Tp, typename _Alloc>
561 operator!=(const vector<_Tp, _Alloc>& __lhs,
562 const vector<_Tp, _Alloc>& __rhs)
563 { return __lhs._M_base() != __rhs._M_base(); }
565 template<typename _Tp, typename _Alloc>
567 operator<(const vector<_Tp, _Alloc>& __lhs,
568 const vector<_Tp, _Alloc>& __rhs)
569 { return __lhs._M_base() < __rhs._M_base(); }
571 template<typename _Tp, typename _Alloc>
573 operator<=(const vector<_Tp, _Alloc>& __lhs,
574 const vector<_Tp, _Alloc>& __rhs)
575 { return __lhs._M_base() <= __rhs._M_base(); }
577 template<typename _Tp, typename _Alloc>
579 operator>=(const vector<_Tp, _Alloc>& __lhs,
580 const vector<_Tp, _Alloc>& __rhs)
581 { return __lhs._M_base() >= __rhs._M_base(); }
583 template<typename _Tp, typename _Alloc>
585 operator>(const vector<_Tp, _Alloc>& __lhs,
586 const vector<_Tp, _Alloc>& __rhs)
587 { return __lhs._M_base() > __rhs._M_base(); }
589 template<typename _Tp, typename _Alloc>
591 swap(vector<_Tp, _Alloc>& __lhs, vector<_Tp, _Alloc>& __rhs)
592 { __lhs.swap(__rhs); }
594 } // namespace __debug
596 #ifdef __GXX_EXPERIMENTAL_CXX0X__
598 /// std::hash specialization for vector<bool>.
599 template<typename _Alloc>
600 struct hash<__debug::vector<bool, _Alloc>>
601 : public __hash_base<size_t, __debug::vector<bool, _Alloc>>
604 operator()(const __debug::vector<bool, _Alloc>& __b) const
605 { return std::hash<_GLIBCXX_STD_C::vector<bool, _Alloc>>()