1 // <forward_list> -*- C++ -*-
3 // Copyright (C) 2010-2014 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/>.
25 /** @file debug/forward_list
26 * This file is a GNU debug extension to the Standard C++ Library.
29 #ifndef _GLIBCXX_DEBUG_FORWARD_LIST
30 #define _GLIBCXX_DEBUG_FORWARD_LIST 1
32 #pragma GCC system_header
34 #include <forward_list>
35 #include <debug/safe_sequence.h>
36 #include <debug/safe_container.h>
37 #include <debug/safe_iterator.h>
41 /// Special iterators swap and invalidation for forward_list because of the
42 /// before_begin iterator.
43 template<typename _SafeSequence>
44 class _Safe_forward_list
45 : public _Safe_sequence<_SafeSequence>
49 { return *static_cast<_SafeSequence*>(this); }
52 _M_swap_aux(_Safe_sequence_base& __lhs,
53 _Safe_iterator_base*& __lhs_iterators,
54 _Safe_sequence_base& __rhs,
55 _Safe_iterator_base*& __rhs_iterators);
57 void _M_swap_single(_Safe_sequence_base&) noexcept;
63 using _Base_const_iterator = __decltype(_M_this()._M_base().cend());
64 this->_M_invalidate_if([this](_Base_const_iterator __it)
66 return __it != _M_this()._M_base().cbefore_begin()
67 && __it != _M_this()._M_base().cend(); });
70 void _M_swap(_Safe_sequence_base&) noexcept;
73 template<typename _SafeSequence>
75 _Safe_forward_list<_SafeSequence>::
76 _M_swap_aux(_Safe_sequence_base& __lhs,
77 _Safe_iterator_base*& __lhs_iterators,
78 _Safe_sequence_base& __rhs,
79 _Safe_iterator_base*& __rhs_iterators)
81 using const_iterator = typename _SafeSequence::const_iterator;
82 _Safe_iterator_base* __bbegin_its = 0;
83 _Safe_iterator_base* __last_bbegin = 0;
84 _SafeSequence& __rseq = static_cast<_SafeSequence&>(__rhs);
86 for (_Safe_iterator_base* __iter = __lhs_iterators; __iter;)
88 // Even iterator is cast to const_iterator, not a problem.
89 const_iterator* __victim = static_cast<const_iterator*>(__iter);
90 __iter = __iter->_M_next;
91 if (__victim->base() == __rseq._M_base().cbefore_begin())
93 __victim->_M_unlink();
94 if (__lhs_iterators == __victim)
95 __lhs_iterators = __victim->_M_next;
98 __victim->_M_next = __bbegin_its;
99 __bbegin_its->_M_prior = __victim;
102 __last_bbegin = __victim;
103 __bbegin_its = __victim;
106 __victim->_M_sequence = &__lhs;
113 __rhs_iterators->_M_prior = __last_bbegin;
114 __last_bbegin->_M_next = __rhs_iterators;
116 __rhs_iterators = __bbegin_its;
120 template<typename _SafeSequence>
122 _Safe_forward_list<_SafeSequence>::
123 _M_swap_single(_Safe_sequence_base& __other) noexcept
125 std::swap(_M_this()._M_iterators, __other._M_iterators);
126 std::swap(_M_this()._M_const_iterators, __other._M_const_iterators);
127 // Useless, always 1 on forward_list
128 //std::swap(_M_this()_M_version, __other._M_version);
129 _Safe_iterator_base* __this_its = _M_this()._M_iterators;
130 _M_swap_aux(__other, __other._M_iterators,
131 _M_this(), _M_this()._M_iterators);
132 _Safe_iterator_base* __this_const_its = _M_this()._M_const_iterators;
133 _M_swap_aux(__other, __other._M_const_iterators,
134 _M_this(), _M_this()._M_const_iterators);
135 _M_swap_aux(_M_this(), __this_its,
136 __other, __other._M_iterators);
137 _M_swap_aux(_M_this(), __this_const_its,
138 __other, __other._M_const_iterators);
141 /* Special forward_list _M_swap version that does not swap the
142 * before-begin ownership.*/
143 template<typename _SafeSequence>
145 _Safe_forward_list<_SafeSequence>::
146 _M_swap(_Safe_sequence_base& __other) noexcept
148 // We need to lock both sequences to swap
149 using namespace __gnu_cxx;
150 __mutex *__this_mutex = &_M_this()._M_get_mutex();
151 __mutex *__other_mutex =
152 &static_cast<_SafeSequence&>(__other)._M_get_mutex();
153 if (__this_mutex == __other_mutex)
155 __scoped_lock __lock(*__this_mutex);
156 _M_swap_single(__other);
160 __scoped_lock __l1(__this_mutex < __other_mutex
161 ? *__this_mutex : *__other_mutex);
162 __scoped_lock __l2(__this_mutex < __other_mutex
163 ? *__other_mutex : *__this_mutex);
164 _M_swap_single(__other);
169 namespace std _GLIBCXX_VISIBILITY(default)
173 /// Class std::forward_list with safety/checking/debug instrumentation.
174 template<typename _Tp, typename _Alloc = std::allocator<_Tp> >
176 : public __gnu_debug::_Safe_container<
177 forward_list<_Tp, _Alloc>, _Alloc, __gnu_debug::_Safe_forward_list>,
178 public _GLIBCXX_STD_C::forward_list<_Tp, _Alloc>
180 typedef _GLIBCXX_STD_C::forward_list<_Tp, _Alloc> _Base;
181 typedef __gnu_debug::_Safe_container<
182 forward_list, _Alloc, __gnu_debug::_Safe_forward_list> _Safe;
184 typedef typename _Base::iterator _Base_iterator;
185 typedef typename _Base::const_iterator _Base_const_iterator;
188 typedef typename _Base::reference reference;
189 typedef typename _Base::const_reference const_reference;
191 typedef __gnu_debug::_Safe_iterator<
192 _Base_iterator, forward_list> iterator;
193 typedef __gnu_debug::_Safe_iterator<
194 _Base_const_iterator, forward_list> const_iterator;
196 typedef typename _Base::size_type size_type;
197 typedef typename _Base::difference_type difference_type;
199 typedef _Tp value_type;
200 typedef typename _Base::allocator_type allocator_type;
201 typedef typename _Base::pointer pointer;
202 typedef typename _Base::const_pointer const_pointer;
204 // 23.2.3.1 construct/copy/destroy:
206 forward_list(const allocator_type& __al = allocator_type())
209 forward_list(const forward_list& __list, const allocator_type& __al)
210 : _Base(__list, __al)
213 forward_list(forward_list&& __list, const allocator_type& __al)
214 : _Safe(std::move(__list._M_safe()), __al),
215 _Base(std::move(__list._M_base()), __al)
219 forward_list(size_type __n, const allocator_type& __al = allocator_type())
223 forward_list(size_type __n, const _Tp& __value,
224 const allocator_type& __al = allocator_type())
225 : _Base(__n, __value, __al)
228 template<typename _InputIterator,
229 typename = std::_RequireInputIter<_InputIterator>>
230 forward_list(_InputIterator __first, _InputIterator __last,
231 const allocator_type& __al = allocator_type())
232 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
234 __gnu_debug::__base(__last), __al)
237 forward_list(const forward_list&) = default;
239 forward_list(forward_list&&) = default;
241 forward_list(std::initializer_list<_Tp> __il,
242 const allocator_type& __al = allocator_type())
246 ~forward_list() = default;
249 operator=(const forward_list&) = default;
252 operator=(forward_list&&) = default;
255 operator=(std::initializer_list<_Tp> __il)
258 this->_M_invalidate_all();
262 template<typename _InputIterator,
263 typename = std::_RequireInputIter<_InputIterator>>
265 assign(_InputIterator __first, _InputIterator __last)
267 __glibcxx_check_valid_range(__first, __last);
268 _Base::assign(__gnu_debug::__base(__first),
269 __gnu_debug::__base(__last));
270 this->_M_invalidate_all();
274 assign(size_type __n, const _Tp& __val)
276 _Base::assign(__n, __val);
277 this->_M_invalidate_all();
281 assign(std::initializer_list<_Tp> __il)
284 this->_M_invalidate_all();
287 using _Base::get_allocator;
292 before_begin() noexcept
293 { return iterator(_Base::before_begin(), this); }
296 before_begin() const noexcept
297 { return const_iterator(_Base::before_begin(), this); }
301 { return iterator(_Base::begin(), this); }
304 begin() const noexcept
305 { return const_iterator(_Base::begin(), this); }
309 { return iterator(_Base::end(), this); }
313 { return const_iterator(_Base::end(), this); }
316 cbegin() const noexcept
317 { return const_iterator(_Base::cbegin(), this); }
320 cbefore_begin() const noexcept
321 { return const_iterator(_Base::cbefore_begin(), this); }
324 cend() const noexcept
325 { return const_iterator(_Base::cend(), this); }
328 using _Base::max_size;
335 __glibcxx_check_nonempty();
336 return _Base::front();
342 __glibcxx_check_nonempty();
343 return _Base::front();
348 using _Base::emplace_front;
349 using _Base::push_front;
354 __glibcxx_check_nonempty();
355 this->_M_invalidate_if([this](_Base_const_iterator __it)
356 { return __it == this->_M_base().cbegin(); });
360 template<typename... _Args>
362 emplace_after(const_iterator __pos, _Args&&... __args)
364 __glibcxx_check_insert_after(__pos);
365 return iterator(_Base::emplace_after(__pos.base(),
366 std::forward<_Args>(__args)...),
371 insert_after(const_iterator __pos, const _Tp& __val)
373 __glibcxx_check_insert_after(__pos);
374 return iterator(_Base::insert_after(__pos.base(), __val), this);
378 insert_after(const_iterator __pos, _Tp&& __val)
380 __glibcxx_check_insert_after(__pos);
381 return iterator(_Base::insert_after(__pos.base(), std::move(__val)),
386 insert_after(const_iterator __pos, size_type __n, const _Tp& __val)
388 __glibcxx_check_insert_after(__pos);
389 return iterator(_Base::insert_after(__pos.base(), __n, __val),
393 template<typename _InputIterator,
394 typename = std::_RequireInputIter<_InputIterator>>
396 insert_after(const_iterator __pos,
397 _InputIterator __first, _InputIterator __last)
399 __glibcxx_check_insert_range_after(__pos, __first, __last);
400 return iterator(_Base::insert_after(__pos.base(),
401 __gnu_debug::__base(__first),
402 __gnu_debug::__base(__last)),
407 insert_after(const_iterator __pos, std::initializer_list<_Tp> __il)
409 __glibcxx_check_insert_after(__pos);
410 return iterator(_Base::insert_after(__pos.base(), __il), this);
415 _M_erase_after(_Base_const_iterator __pos)
417 _Base_const_iterator __next = std::next(__pos);
418 this->_M_invalidate_if([__next](_Base_const_iterator __it)
419 { return __it == __next; });
420 return _Base::erase_after(__pos);
424 erase_after(const_iterator __pos)
426 __glibcxx_check_erase_after(__pos);
427 return iterator(_M_erase_after(__pos.base()), this);
431 erase_after(const_iterator __pos, const_iterator __last)
433 __glibcxx_check_erase_range_after(__pos, __last);
434 for (_Base_const_iterator __victim = std::next(__pos.base());
435 __victim != __last.base(); ++__victim)
437 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
438 _M_message(__gnu_debug::__msg_valid_range2)
439 ._M_sequence(*this, "this")
440 ._M_iterator(__pos, "pos")
441 ._M_iterator(__last, "last"));
442 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
443 { return __it == __victim; });
445 return iterator(_Base::erase_after(__pos.base(), __last.base()), this);
449 swap(forward_list& __list)
450 noexcept( noexcept(declval<_Base>().swap(__list)) )
452 _Safe::_M_swap(__list);
457 resize(size_type __sz)
459 this->_M_detach_singular();
461 // if __sz < size(), invalidate all iterators in [begin+__sz, end()
462 _Base_iterator __victim = _Base::begin();
463 _Base_iterator __end = _Base::end();
464 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
467 for (; __victim != __end; ++__victim)
469 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
470 { return __it == __victim; });
479 this->_M_revalidate_singular();
480 __throw_exception_again;
485 resize(size_type __sz, const value_type& __val)
487 this->_M_detach_singular();
489 // if __sz < size(), invalidate all iterators in [begin+__sz, end())
490 _Base_iterator __victim = _Base::begin();
491 _Base_iterator __end = _Base::end();
492 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
495 for (; __victim != __end; ++__victim)
497 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
498 { return __it == __victim; });
503 _Base::resize(__sz, __val);
507 this->_M_revalidate_singular();
508 __throw_exception_again;
516 this->_M_invalidate_all();
519 // 23.2.3.5 forward_list operations:
521 splice_after(const_iterator __pos, forward_list&& __list)
523 __glibcxx_check_insert_after(__pos);
524 _GLIBCXX_DEBUG_VERIFY(&__list != this,
525 _M_message(__gnu_debug::__msg_self_splice)
526 ._M_sequence(*this, "this"));
527 _GLIBCXX_DEBUG_VERIFY(__list.get_allocator() == this->get_allocator(),
528 _M_message(__gnu_debug::__msg_splice_alloc)
530 ._M_sequence(__list, "__list"));
531 this->_M_transfer_from_if(__list, [&__list](_Base_const_iterator __it)
533 return __it != __list._M_base().cbefore_begin()
534 && __it != __list._M_base().end();
536 _Base::splice_after(__pos.base(), std::move(__list._M_base()));
540 splice_after(const_iterator __pos, forward_list& __list)
541 { splice_after(__pos, std::move(__list)); }
544 splice_after(const_iterator __pos, forward_list&& __list,
547 __glibcxx_check_insert_after(__pos);
548 _GLIBCXX_DEBUG_VERIFY(__i._M_before_dereferenceable(),
549 _M_message(__gnu_debug::__msg_splice_bad)
550 ._M_iterator(__i, "__i"));
551 _GLIBCXX_DEBUG_VERIFY(__i._M_attached_to(&__list),
552 _M_message(__gnu_debug::__msg_splice_other)
553 ._M_iterator(__i, "__i")
554 ._M_sequence(__list, "__list"));
555 _GLIBCXX_DEBUG_VERIFY(__list.get_allocator() == this->get_allocator(),
556 _M_message(__gnu_debug::__msg_splice_alloc)
558 ._M_sequence(__list, "__list"));
560 // _GLIBCXX_RESOLVE_LIB_DEFECTS
561 // 250. splicing invalidates iterators
562 _Base_const_iterator __next = std::next(__i.base());
563 this->_M_transfer_from_if(__list, [__next](_Base_const_iterator __it)
564 { return __it == __next; });
565 _Base::splice_after(__pos.base(), std::move(__list._M_base()),
570 splice_after(const_iterator __pos, forward_list& __list,
572 { splice_after(__pos, std::move(__list), __i); }
575 splice_after(const_iterator __pos, forward_list&& __list,
576 const_iterator __before, const_iterator __last)
578 __glibcxx_check_insert_after(__pos);
579 __glibcxx_check_valid_range(__before, __last);
580 _GLIBCXX_DEBUG_VERIFY(__before._M_attached_to(&__list),
581 _M_message(__gnu_debug::__msg_splice_other)
582 ._M_sequence(__list, "list")
583 ._M_iterator(__before, "before"));
584 _GLIBCXX_DEBUG_VERIFY(__before._M_dereferenceable()
585 || __before._M_is_before_begin(),
586 _M_message(__gnu_debug::__msg_valid_range2)
587 ._M_sequence(__list, "list")
588 ._M_iterator(__before, "before")
589 ._M_iterator(__last, "last"));
590 _GLIBCXX_DEBUG_VERIFY(__before != __last,
591 _M_message(__gnu_debug::__msg_valid_range2)
592 ._M_sequence(__list, "list")
593 ._M_iterator(__before, "before")
594 ._M_iterator(__last, "last"));
595 _GLIBCXX_DEBUG_VERIFY(__list.get_allocator() == this->get_allocator(),
596 _M_message(__gnu_debug::__msg_splice_alloc)
598 ._M_sequence(__list, "__list"));
600 for (_Base_const_iterator __tmp = std::next(__before.base());
601 __tmp != __last.base(); ++__tmp)
603 _GLIBCXX_DEBUG_VERIFY(__tmp != __list._M_base().end(),
604 _M_message(__gnu_debug::__msg_valid_range2)
605 ._M_sequence(__list, "list")
606 ._M_iterator(__before, "before")
607 ._M_iterator(__last, "last"));
608 _GLIBCXX_DEBUG_VERIFY(&__list != this || __tmp != __pos.base(),
609 _M_message(__gnu_debug::__msg_splice_overlap)
610 ._M_iterator(__tmp, "position")
611 ._M_iterator(__before, "before")
612 ._M_iterator(__last, "last"));
613 // _GLIBCXX_RESOLVE_LIB_DEFECTS
614 // 250. splicing invalidates iterators
615 this->_M_transfer_from_if(__list, [__tmp](_Base_const_iterator __it)
616 { return __it == __tmp; });
619 _Base::splice_after(__pos.base(), std::move(__list._M_base()),
620 __before.base(), __last.base());
624 splice_after(const_iterator __pos, forward_list& __list,
625 const_iterator __before, const_iterator __last)
626 { splice_after(__pos, std::move(__list), __before, __last); }
629 remove(const _Tp& __val)
631 _Base_iterator __x = _Base::before_begin();
632 _Base_iterator __old = __x++;
633 while (__x != _Base::end())
636 __x = _M_erase_after(__old);
642 template<typename _Pred>
644 remove_if(_Pred __pred)
646 _Base_iterator __x = _Base::before_begin();
647 _Base_iterator __old = __x++;
648 while (__x != _Base::end())
651 __x = _M_erase_after(__old);
660 _Base_iterator __first = _Base::begin();
661 _Base_iterator __last = _Base::end();
662 if (__first == __last)
664 _Base_iterator __next = std::next(__first);
665 while (__next != __last)
667 if (*__first == *__next)
668 __next = _M_erase_after(__first);
674 template<typename _BinPred>
676 unique(_BinPred __binary_pred)
678 _Base_iterator __first = _Base::begin();
679 _Base_iterator __last = _Base::end();
680 if (__first == __last)
682 _Base_iterator __next = std::next(__first);
683 while (__next != __last)
685 if (__binary_pred(*__first, *__next))
686 __next = _M_erase_after(__first);
693 merge(forward_list&& __list)
697 __glibcxx_check_sorted(_Base::begin(), _Base::end());
698 __glibcxx_check_sorted(__list._M_base().begin(),
699 __list._M_base().end());
700 this->_M_transfer_from_if(__list, [&__list](_Base_const_iterator __it)
702 return __it != __list._M_base().cbefore_begin()
703 && __it != __list._M_base().cend();
705 _Base::merge(std::move(__list._M_base()));
710 merge(forward_list& __list)
711 { merge(std::move(__list)); }
713 template<typename _Comp>
715 merge(forward_list&& __list, _Comp __comp)
719 __glibcxx_check_sorted_pred(_Base::begin(), _Base::end(), __comp);
720 __glibcxx_check_sorted_pred(__list._M_base().begin(),
721 __list._M_base().end(), __comp);
722 this->_M_transfer_from_if(__list,
723 [&__list](_Base_const_iterator __it)
725 return __it != __list._M_base().cbefore_begin()
726 && __it != __list._M_base().cend();
728 _Base::merge(std::move(__list._M_base()), __comp);
732 template<typename _Comp>
734 merge(forward_list& __list, _Comp __comp)
735 { merge(std::move(__list), __comp); }
738 using _Base::reverse;
741 _M_base() noexcept { return *this; }
744 _M_base() const noexcept { return *this; }
747 template<typename _Tp, typename _Alloc>
749 operator==(const forward_list<_Tp, _Alloc>& __lx,
750 const forward_list<_Tp, _Alloc>& __ly)
751 { return __lx._M_base() == __ly._M_base(); }
753 template<typename _Tp, typename _Alloc>
755 operator<(const forward_list<_Tp, _Alloc>& __lx,
756 const forward_list<_Tp, _Alloc>& __ly)
757 { return __lx._M_base() < __ly._M_base(); }
759 template<typename _Tp, typename _Alloc>
761 operator!=(const forward_list<_Tp, _Alloc>& __lx,
762 const forward_list<_Tp, _Alloc>& __ly)
763 { return !(__lx == __ly); }
765 /// Based on operator<
766 template<typename _Tp, typename _Alloc>
768 operator>(const forward_list<_Tp, _Alloc>& __lx,
769 const forward_list<_Tp, _Alloc>& __ly)
770 { return (__ly < __lx); }
772 /// Based on operator<
773 template<typename _Tp, typename _Alloc>
775 operator>=(const forward_list<_Tp, _Alloc>& __lx,
776 const forward_list<_Tp, _Alloc>& __ly)
777 { return !(__lx < __ly); }
779 /// Based on operator<
780 template<typename _Tp, typename _Alloc>
782 operator<=(const forward_list<_Tp, _Alloc>& __lx,
783 const forward_list<_Tp, _Alloc>& __ly)
784 { return !(__ly < __lx); }
786 /// See std::forward_list::swap().
787 template<typename _Tp, typename _Alloc>
789 swap(forward_list<_Tp, _Alloc>& __lx,
790 forward_list<_Tp, _Alloc>& __ly)
793 } // namespace __debug
796 namespace __gnu_debug
798 template<class _Tp, class _Alloc>
799 struct _BeforeBeginHelper<std::__debug::forward_list<_Tp, _Alloc> >
801 typedef std::__debug::forward_list<_Tp, _Alloc> _Sequence;
803 template<typename _Iterator>
805 _S_Is(const _Safe_iterator<_Iterator, _Sequence>& __it)
808 __it.base() == __it._M_get_sequence()->_M_base().before_begin();
811 template<typename _Iterator>
813 _S_Is_Beginnest(const _Safe_iterator<_Iterator, _Sequence>& __it)
814 { return _S_Is(__it); }
817 #ifndef _GLIBCXX_DEBUG_PEDANTIC
818 template<class _Tp, class _Alloc>
819 struct _Insert_range_from_self_is_safe<
820 std::__debug::forward_list<_Tp, _Alloc> >
821 { enum { __value = 1 }; };