1 // Debugging list implementation -*- C++ -*-
3 // Copyright (C) 2003-2013 Free Software Foundation, Inc.
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)
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 * This file is a GNU debug extension to the Standard C++ Library.
29 #ifndef _GLIBCXX_DEBUG_LIST
30 #define _GLIBCXX_DEBUG_LIST 1
33 #include <debug/safe_sequence.h>
34 #include <debug/safe_iterator.h>
36 namespace std _GLIBCXX_VISIBILITY(default)
40 /// Class std::list with safety/checking/debug instrumentation.
41 template<typename _Tp, typename _Allocator = std::allocator<_Tp> >
43 : public _GLIBCXX_STD_C::list<_Tp, _Allocator>,
44 public __gnu_debug::_Safe_sequence<list<_Tp, _Allocator> >
46 typedef _GLIBCXX_STD_C::list<_Tp, _Allocator> _Base;
48 typedef typename _Base::iterator _Base_iterator;
49 typedef typename _Base::const_iterator _Base_const_iterator;
50 typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
51 typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
53 typedef typename _Base::reference reference;
54 typedef typename _Base::const_reference const_reference;
56 typedef __gnu_debug::_Safe_iterator<_Base_iterator, list>
58 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator, list>
61 typedef typename _Base::size_type size_type;
62 typedef typename _Base::difference_type difference_type;
64 typedef _Tp value_type;
65 typedef _Allocator allocator_type;
66 typedef typename _Base::pointer pointer;
67 typedef typename _Base::const_pointer const_pointer;
68 typedef std::reverse_iterator<iterator> reverse_iterator;
69 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
71 // 23.2.2.1 construct/copy/destroy:
73 list(const _Allocator& __a = _Allocator()) _GLIBCXX_NOEXCEPT
76 #if __cplusplus >= 201103L
81 list(size_type __n, const _Tp& __value,
82 const _Allocator& __a = _Allocator())
83 : _Base(__n, __value, __a) { }
86 list(size_type __n, const _Tp& __value = _Tp(),
87 const _Allocator& __a = _Allocator())
88 : _Base(__n, __value, __a) { }
91 #if __cplusplus >= 201103L
92 template<class _InputIterator,
93 typename = std::_RequireInputIter<_InputIterator>>
95 template<class _InputIterator>
97 list(_InputIterator __first, _InputIterator __last,
98 const _Allocator& __a = _Allocator())
99 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
101 __gnu_debug::__base(__last), __a)
104 list(const list& __x)
107 list(const _Base& __x)
110 #if __cplusplus >= 201103L
111 list(list&& __x) noexcept
112 : _Base(std::move(__x))
113 { this->_M_swap(__x); }
115 list(initializer_list<value_type> __l,
116 const allocator_type& __a = allocator_type())
117 : _Base(__l, __a) { }
120 ~list() _GLIBCXX_NOEXCEPT { }
123 operator=(const list& __x)
125 static_cast<_Base&>(*this) = __x;
126 this->_M_invalidate_all();
130 #if __cplusplus >= 201103L
132 operator=(list&& __x)
136 __glibcxx_check_self_move_assign(__x);
143 operator=(initializer_list<value_type> __l)
145 static_cast<_Base&>(*this) = __l;
146 this->_M_invalidate_all();
151 assign(initializer_list<value_type> __l)
154 this->_M_invalidate_all();
158 #if __cplusplus >= 201103L
159 template<class _InputIterator,
160 typename = std::_RequireInputIter<_InputIterator>>
162 template<class _InputIterator>
165 assign(_InputIterator __first, _InputIterator __last)
167 __glibcxx_check_valid_range(__first, __last);
168 _Base::assign(__gnu_debug::__base(__first),
169 __gnu_debug::__base(__last));
170 this->_M_invalidate_all();
174 assign(size_type __n, const _Tp& __t)
176 _Base::assign(__n, __t);
177 this->_M_invalidate_all();
180 using _Base::get_allocator;
184 begin() _GLIBCXX_NOEXCEPT
185 { return iterator(_Base::begin(), this); }
188 begin() const _GLIBCXX_NOEXCEPT
189 { return const_iterator(_Base::begin(), this); }
192 end() _GLIBCXX_NOEXCEPT
193 { return iterator(_Base::end(), this); }
196 end() const _GLIBCXX_NOEXCEPT
197 { return const_iterator(_Base::end(), this); }
200 rbegin() _GLIBCXX_NOEXCEPT
201 { return reverse_iterator(end()); }
203 const_reverse_iterator
204 rbegin() const _GLIBCXX_NOEXCEPT
205 { return const_reverse_iterator(end()); }
208 rend() _GLIBCXX_NOEXCEPT
209 { return reverse_iterator(begin()); }
211 const_reverse_iterator
212 rend() const _GLIBCXX_NOEXCEPT
213 { return const_reverse_iterator(begin()); }
215 #if __cplusplus >= 201103L
217 cbegin() const noexcept
218 { return const_iterator(_Base::begin(), this); }
221 cend() const noexcept
222 { return const_iterator(_Base::end(), this); }
224 const_reverse_iterator
225 crbegin() const noexcept
226 { return const_reverse_iterator(end()); }
228 const_reverse_iterator
229 crend() const noexcept
230 { return const_reverse_iterator(begin()); }
233 // 23.2.2.2 capacity:
236 using _Base::max_size;
238 #if __cplusplus >= 201103L
240 resize(size_type __sz)
242 this->_M_detach_singular();
244 // if __sz < size(), invalidate all iterators in [begin+__sz, end())
245 _Base_iterator __victim = _Base::begin();
246 _Base_iterator __end = _Base::end();
247 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
250 for (; __victim != __end; ++__victim)
252 this->_M_invalidate_if(_Equal(__victim));
261 this->_M_revalidate_singular();
262 __throw_exception_again;
267 resize(size_type __sz, const _Tp& __c)
269 this->_M_detach_singular();
271 // if __sz < size(), invalidate all iterators in [begin+__sz, end())
272 _Base_iterator __victim = _Base::begin();
273 _Base_iterator __end = _Base::end();
274 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
277 for (; __victim != __end; ++__victim)
279 this->_M_invalidate_if(_Equal(__victim));
284 _Base::resize(__sz, __c);
288 this->_M_revalidate_singular();
289 __throw_exception_again;
294 resize(size_type __sz, _Tp __c = _Tp())
296 this->_M_detach_singular();
298 // if __sz < size(), invalidate all iterators in [begin+__sz, end())
299 _Base_iterator __victim = _Base::begin();
300 _Base_iterator __end = _Base::end();
301 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
304 for (; __victim != __end; ++__victim)
306 this->_M_invalidate_if(_Equal(__victim));
311 _Base::resize(__sz, __c);
315 this->_M_revalidate_singular();
316 __throw_exception_again;
323 front() _GLIBCXX_NOEXCEPT
325 __glibcxx_check_nonempty();
326 return _Base::front();
330 front() const _GLIBCXX_NOEXCEPT
332 __glibcxx_check_nonempty();
333 return _Base::front();
337 back() _GLIBCXX_NOEXCEPT
339 __glibcxx_check_nonempty();
340 return _Base::back();
344 back() const _GLIBCXX_NOEXCEPT
346 __glibcxx_check_nonempty();
347 return _Base::back();
350 // 23.2.2.3 modifiers:
351 using _Base::push_front;
353 #if __cplusplus >= 201103L
354 using _Base::emplace_front;
358 pop_front() _GLIBCXX_NOEXCEPT
360 __glibcxx_check_nonempty();
361 this->_M_invalidate_if(_Equal(_Base::begin()));
365 using _Base::push_back;
367 #if __cplusplus >= 201103L
368 using _Base::emplace_back;
372 pop_back() _GLIBCXX_NOEXCEPT
374 __glibcxx_check_nonempty();
375 this->_M_invalidate_if(_Equal(--_Base::end()));
379 #if __cplusplus >= 201103L
380 template<typename... _Args>
382 emplace(const_iterator __position, _Args&&... __args)
384 __glibcxx_check_insert(__position);
385 return iterator(_Base::emplace(__position.base(),
386 std::forward<_Args>(__args)...), this);
391 #if __cplusplus >= 201103L
392 insert(const_iterator __position, const _Tp& __x)
394 insert(iterator __position, const _Tp& __x)
397 __glibcxx_check_insert(__position);
398 return iterator(_Base::insert(__position.base(), __x), this);
401 #if __cplusplus >= 201103L
403 insert(const_iterator __position, _Tp&& __x)
404 { return emplace(__position, std::move(__x)); }
407 insert(const_iterator __p, initializer_list<value_type> __l)
409 __glibcxx_check_insert(__p);
410 return iterator(_Base::insert(__p.base(), __l), this);
414 #if __cplusplus >= 201103L
416 insert(const_iterator __position, size_type __n, const _Tp& __x)
418 __glibcxx_check_insert(__position);
419 return iterator(_Base::insert(__position.base(), __n, __x), this);
423 insert(iterator __position, size_type __n, const _Tp& __x)
425 __glibcxx_check_insert(__position);
426 _Base::insert(__position.base(), __n, __x);
430 #if __cplusplus >= 201103L
431 template<class _InputIterator,
432 typename = std::_RequireInputIter<_InputIterator>>
434 insert(const_iterator __position, _InputIterator __first,
435 _InputIterator __last)
437 __glibcxx_check_insert_range(__position, __first, __last);
438 return iterator(_Base::insert(__position.base(),
439 __gnu_debug::__base(__first),
440 __gnu_debug::__base(__last)),
444 template<class _InputIterator>
446 insert(iterator __position, _InputIterator __first,
447 _InputIterator __last)
449 __glibcxx_check_insert_range(__position, __first, __last);
450 _Base::insert(__position.base(), __gnu_debug::__base(__first),
451 __gnu_debug::__base(__last));
457 #if __cplusplus >= 201103L
458 _M_erase(_Base_const_iterator __position) noexcept
460 _M_erase(_Base_iterator __position)
463 this->_M_invalidate_if(_Equal(__position));
464 return _Base::erase(__position);
469 #if __cplusplus >= 201103L
470 erase(const_iterator __position) noexcept
472 erase(iterator __position)
475 __glibcxx_check_erase(__position);
476 return iterator(_M_erase(__position.base()), this);
480 #if __cplusplus >= 201103L
481 erase(const_iterator __first, const_iterator __last) noexcept
483 erase(iterator __first, iterator __last)
486 // _GLIBCXX_RESOLVE_LIB_DEFECTS
487 // 151. can't currently clear() empty container
488 __glibcxx_check_erase_range(__first, __last);
489 for (_Base_const_iterator __victim = __first.base();
490 __victim != __last.base(); ++__victim)
492 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
493 _M_message(__gnu_debug::__msg_valid_range)
494 ._M_iterator(__first, "position")
495 ._M_iterator(__last, "last"));
496 this->_M_invalidate_if(_Equal(__victim));
498 return iterator(_Base::erase(__first.base(), __last.base()), this);
509 clear() _GLIBCXX_NOEXCEPT
512 this->_M_invalidate_all();
515 // 23.2.2.4 list operations:
517 #if __cplusplus >= 201103L
518 splice(const_iterator __position, list&& __x) noexcept
520 splice(iterator __position, list& __x)
523 _GLIBCXX_DEBUG_VERIFY(&__x != this,
524 _M_message(__gnu_debug::__msg_self_splice)
525 ._M_sequence(*this, "this"));
526 this->_M_transfer_from_if(__x, _Not_equal(__x._M_base().end()));
527 _Base::splice(__position.base(), _GLIBCXX_MOVE(__x._M_base()));
530 #if __cplusplus >= 201103L
532 splice(const_iterator __position, list& __x) noexcept
533 { splice(__position, std::move(__x)); }
537 #if __cplusplus >= 201103L
538 splice(const_iterator __position, list&& __x, const_iterator __i) noexcept
540 splice(iterator __position, list& __x, iterator __i)
543 __glibcxx_check_insert(__position);
545 // We used to perform the splice_alloc check: not anymore, redundant
546 // after implementing the relevant bits of N1599.
548 _GLIBCXX_DEBUG_VERIFY(__i._M_dereferenceable(),
549 _M_message(__gnu_debug::__msg_splice_bad)
550 ._M_iterator(__i, "__i"));
551 _GLIBCXX_DEBUG_VERIFY(__i._M_attached_to(&__x),
552 _M_message(__gnu_debug::__msg_splice_other)
553 ._M_iterator(__i, "__i")._M_sequence(__x, "__x"));
555 // _GLIBCXX_RESOLVE_LIB_DEFECTS
556 // 250. splicing invalidates iterators
557 this->_M_transfer_from_if(__x, _Equal(__i.base()));
558 _Base::splice(__position.base(), _GLIBCXX_MOVE(__x._M_base()),
562 #if __cplusplus >= 201103L
564 splice(const_iterator __position, list& __x, const_iterator __i) noexcept
565 { splice(__position, std::move(__x), __i); }
569 #if __cplusplus >= 201103L
570 splice(const_iterator __position, list&& __x, const_iterator __first,
571 const_iterator __last) noexcept
573 splice(iterator __position, list& __x, iterator __first,
577 __glibcxx_check_insert(__position);
578 __glibcxx_check_valid_range(__first, __last);
579 _GLIBCXX_DEBUG_VERIFY(__first._M_attached_to(&__x),
580 _M_message(__gnu_debug::__msg_splice_other)
581 ._M_sequence(__x, "x")
582 ._M_iterator(__first, "first"));
584 // We used to perform the splice_alloc check: not anymore, redundant
585 // after implementing the relevant bits of N1599.
587 for (_Base_const_iterator __tmp = __first.base();
588 __tmp != __last.base(); ++__tmp)
590 _GLIBCXX_DEBUG_VERIFY(__tmp != _Base::end(),
591 _M_message(__gnu_debug::__msg_valid_range)
592 ._M_iterator(__first, "first")
593 ._M_iterator(__last, "last"));
594 _GLIBCXX_DEBUG_VERIFY(&__x != this || __tmp != __position.base(),
595 _M_message(__gnu_debug::__msg_splice_overlap)
596 ._M_iterator(__tmp, "position")
597 ._M_iterator(__first, "first")
598 ._M_iterator(__last, "last"));
599 // _GLIBCXX_RESOLVE_LIB_DEFECTS
600 // 250. splicing invalidates iterators
601 this->_M_transfer_from_if(__x, _Equal(__tmp));
604 _Base::splice(__position.base(), _GLIBCXX_MOVE(__x._M_base()),
605 __first.base(), __last.base());
608 #if __cplusplus >= 201103L
610 splice(const_iterator __position, list& __x,
611 const_iterator __first, const_iterator __last) noexcept
612 { splice(__position, std::move(__x), __first, __last); }
616 remove(const _Tp& __value)
618 for (_Base_iterator __x = _Base::begin(); __x != _Base::end(); )
627 template<class _Predicate>
629 remove_if(_Predicate __pred)
631 for (_Base_iterator __x = _Base::begin(); __x != _Base::end(); )
643 _Base_iterator __first = _Base::begin();
644 _Base_iterator __last = _Base::end();
645 if (__first == __last)
647 _Base_iterator __next = __first; ++__next;
648 while (__next != __last)
650 if (*__first == *__next)
651 __next = _M_erase(__next);
657 template<class _BinaryPredicate>
659 unique(_BinaryPredicate __binary_pred)
661 _Base_iterator __first = _Base::begin();
662 _Base_iterator __last = _Base::end();
663 if (__first == __last)
665 _Base_iterator __next = __first; ++__next;
666 while (__next != __last)
668 if (__binary_pred(*__first, *__next))
669 __next = _M_erase(__next);
676 #if __cplusplus >= 201103L
682 // _GLIBCXX_RESOLVE_LIB_DEFECTS
683 // 300. list::merge() specification incomplete
686 __glibcxx_check_sorted(_Base::begin(), _Base::end());
687 __glibcxx_check_sorted(__x.begin().base(), __x.end().base());
688 this->_M_transfer_from_if(__x, _Not_equal(__x._M_base().end()));
689 _Base::merge(_GLIBCXX_MOVE(__x._M_base()));
693 #if __cplusplus >= 201103L
696 { merge(std::move(__x)); }
699 template<class _Compare>
701 #if __cplusplus >= 201103L
702 merge(list&& __x, _Compare __comp)
704 merge(list& __x, _Compare __comp)
707 // _GLIBCXX_RESOLVE_LIB_DEFECTS
708 // 300. list::merge() specification incomplete
711 __glibcxx_check_sorted_pred(_Base::begin(), _Base::end(),
713 __glibcxx_check_sorted_pred(__x.begin().base(), __x.end().base(),
715 this->_M_transfer_from_if(__x, _Not_equal(__x._M_base().end()));
716 _Base::merge(_GLIBCXX_MOVE(__x._M_base()), __comp);
720 #if __cplusplus >= 201103L
721 template<typename _Compare>
723 merge(list& __x, _Compare __comp)
724 { merge(std::move(__x), __comp); }
728 sort() { _Base::sort(); }
730 template<typename _StrictWeakOrdering>
732 sort(_StrictWeakOrdering __pred) { _Base::sort(__pred); }
734 using _Base::reverse;
737 _M_base() _GLIBCXX_NOEXCEPT { return *this; }
740 _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
746 this->_M_invalidate_if(_Not_equal(_Base::end()));
750 template<typename _Tp, typename _Alloc>
752 operator==(const list<_Tp, _Alloc>& __lhs,
753 const list<_Tp, _Alloc>& __rhs)
754 { return __lhs._M_base() == __rhs._M_base(); }
756 template<typename _Tp, typename _Alloc>
758 operator!=(const list<_Tp, _Alloc>& __lhs,
759 const list<_Tp, _Alloc>& __rhs)
760 { return __lhs._M_base() != __rhs._M_base(); }
762 template<typename _Tp, typename _Alloc>
764 operator<(const list<_Tp, _Alloc>& __lhs,
765 const list<_Tp, _Alloc>& __rhs)
766 { return __lhs._M_base() < __rhs._M_base(); }
768 template<typename _Tp, typename _Alloc>
770 operator<=(const list<_Tp, _Alloc>& __lhs,
771 const list<_Tp, _Alloc>& __rhs)
772 { return __lhs._M_base() <= __rhs._M_base(); }
774 template<typename _Tp, typename _Alloc>
776 operator>=(const list<_Tp, _Alloc>& __lhs,
777 const list<_Tp, _Alloc>& __rhs)
778 { return __lhs._M_base() >= __rhs._M_base(); }
780 template<typename _Tp, typename _Alloc>
782 operator>(const list<_Tp, _Alloc>& __lhs,
783 const list<_Tp, _Alloc>& __rhs)
784 { return __lhs._M_base() > __rhs._M_base(); }
786 template<typename _Tp, typename _Alloc>
788 swap(list<_Tp, _Alloc>& __lhs, list<_Tp, _Alloc>& __rhs)
789 { __lhs.swap(__rhs); }
791 } // namespace __debug
794 #ifndef _GLIBCXX_DEBUG_PEDANTIC
795 namespace __gnu_debug
797 template<class _Tp, class _Alloc>
798 struct _Insert_range_from_self_is_safe<std::__debug::list<_Tp, _Alloc> >
799 { enum { __value = 1 }; };