1 // <forward_list> -*- C++ -*-
3 // Copyright (C) 2010 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_iterator.h>
38 namespace std _GLIBCXX_VISIBILITY(default)
42 /// Class std::forward_list with safety/checking/debug instrumentation.
43 template<typename _Tp, typename _Alloc = std::allocator<_Tp> >
45 : public _GLIBCXX_STD_C::forward_list<_Tp, _Alloc>,
46 public __gnu_debug::_Safe_sequence<forward_list<_Tp, _Alloc> >
48 typedef _GLIBCXX_STD_C::forward_list<_Tp, _Alloc> _Base;
50 typedef typename _Base::iterator _Base_iterator;
51 typedef typename _Base::const_iterator _Base_const_iterator;
53 typedef typename _Base::reference reference;
54 typedef typename _Base::const_reference const_reference;
56 typedef __gnu_debug::_Safe_iterator<_Base_iterator,
57 forward_list> iterator;
58 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator,
59 forward_list> const_iterator;
61 typedef typename _Base::size_type size_type;
62 typedef typename _Base::difference_type difference_type;
64 typedef _Tp value_type;
65 typedef _Alloc allocator_type;
66 typedef typename _Base::pointer pointer;
67 typedef typename _Base::const_pointer const_pointer;
69 // 23.2.3.1 construct/copy/destroy:
71 forward_list(const _Alloc& __al = _Alloc())
74 forward_list(const forward_list& __list, const _Alloc& __al)
78 forward_list(forward_list&& __list, const _Alloc& __al)
79 : _Base(std::move(__list._M_base()), __al)
81 this->_M_swap(__list);
85 forward_list(size_type __n)
89 forward_list(size_type __n, const _Tp& __value,
90 const _Alloc& __al = _Alloc())
91 : _Base(__n, __value, __al)
94 template<typename _InputIterator>
95 forward_list(_InputIterator __first, _InputIterator __last,
96 const _Alloc& __al = _Alloc())
97 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
99 __gnu_debug::__base(__last), __al)
102 forward_list(const forward_list& __list)
106 forward_list(forward_list&& __list) noexcept
107 : _Base(std::move(__list._M_base()))
109 this->_M_swap(__list);
112 forward_list(std::initializer_list<_Tp> __il,
113 const _Alloc& __al = _Alloc())
117 ~forward_list() noexcept
121 operator=(const forward_list& __list)
123 static_cast<_Base&>(*this) = __list;
124 this->_M_invalidate_all();
129 operator=(forward_list&& __list)
139 operator=(std::initializer_list<_Tp> __il)
141 static_cast<_Base&>(*this) = __il;
142 this->_M_invalidate_all();
146 template<typename _InputIterator>
148 assign(_InputIterator __first, _InputIterator __last)
150 __glibcxx_check_valid_range(__first, __last);
151 _Base::assign(__gnu_debug::__base(__first),
152 __gnu_debug::__base(__last));
153 this->_M_invalidate_all();
157 assign(size_type __n, const _Tp& __val)
159 _Base::assign(__n, __val);
160 this->_M_invalidate_all();
164 assign(std::initializer_list<_Tp> __il)
167 this->_M_invalidate_all();
170 using _Base::get_allocator;
175 before_begin() noexcept
176 { return iterator(_Base::before_begin(), this); }
179 before_begin() const noexcept
180 { return const_iterator(_Base::before_begin(), this); }
184 { return iterator(_Base::begin(), this); }
187 begin() const noexcept
188 { return const_iterator(_Base::begin(), this); }
192 { return iterator(_Base::end(), this); }
196 { return const_iterator(_Base::end(), this); }
199 cbegin() const noexcept
200 { return const_iterator(_Base::cbegin(), this); }
203 cbefore_begin() const noexcept
204 { return const_iterator(_Base::cbefore_begin(), this); }
207 cend() const noexcept
208 { return const_iterator(_Base::cend(), this); }
211 using _Base::max_size;
218 __glibcxx_check_nonempty();
219 return _Base::front();
225 __glibcxx_check_nonempty();
226 return _Base::front();
231 using _Base::emplace_front;
232 using _Base::push_front;
237 __glibcxx_check_nonempty();
238 this->_M_invalidate_if([this](_Base_const_iterator __it)
239 { return __it == this->_M_base().cbegin(); });
243 template<typename... _Args>
245 emplace_after(const_iterator __pos, _Args&&... __args)
247 __glibcxx_check_insert_after(__pos);
248 return iterator(_Base::emplace_after(__pos.base(),
249 std::forward<_Args>(__args)...),
254 insert_after(const_iterator __pos, const _Tp& __val)
256 __glibcxx_check_insert_after(__pos);
257 return iterator(_Base::insert_after(__pos.base(), __val), this);
261 insert_after(const_iterator __pos, _Tp&& __val)
263 __glibcxx_check_insert_after(__pos);
264 return iterator(_Base::insert_after(__pos.base(), std::move(__val)),
269 insert_after(const_iterator __pos, size_type __n, const _Tp& __val)
271 __glibcxx_check_insert_after(__pos);
272 return iterator(_Base::insert_after(__pos.base(), __n, __val),
276 template<typename _InputIterator>
278 insert_after(const_iterator __pos,
279 _InputIterator __first, _InputIterator __last)
281 __glibcxx_check_insert_range_after(__pos, __first, __last);
282 return iterator(_Base::insert_after(__pos.base(),
283 __gnu_debug::__base(__first),
284 __gnu_debug::__base(__last)),
289 insert_after(const_iterator __pos, std::initializer_list<_Tp> __il)
291 __glibcxx_check_insert_after(__pos);
292 return iterator(_Base::insert_after(__pos.base(), __il), this);
297 _M_erase_after(_Base_const_iterator __pos)
299 _Base_const_iterator __next = std::next(__pos);
300 this->_M_invalidate_if([__next](_Base_const_iterator __it)
301 { return __it == __next; });
302 return _Base::erase_after(__pos);
306 erase_after(const_iterator __pos)
308 __glibcxx_check_erase_after(__pos);
309 return iterator(_M_erase_after(__pos.base()), this);
313 erase_after(const_iterator __pos, const_iterator __last)
315 __glibcxx_check_erase_range_after(__pos, __last);
316 for (_Base_const_iterator __victim = std::next(__pos.base());
317 __victim != __last.base(); ++__victim)
319 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
320 _M_message(__gnu_debug::__msg_valid_range2)
321 ._M_sequence(*this, "this")
322 ._M_iterator(__pos, "pos")
323 ._M_iterator(__last, "last"));
324 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
325 { return __it == __victim; });
327 return iterator(_Base::erase_after(__pos.base(), __last.base()), this);
331 swap(forward_list& __list)
334 this->_M_swap(__list);
338 resize(size_type __sz)
340 this->_M_detach_singular();
342 // if __sz < size(), invalidate all iterators in [begin+__sz, end()
343 _Base_iterator __victim = _Base::begin();
344 _Base_iterator __end = _Base::end();
345 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
348 for (; __victim != __end; ++__victim)
350 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
351 { return __it == __victim; });
360 this->_M_revalidate_singular();
361 __throw_exception_again;
366 resize(size_type __sz, const value_type& __val)
368 this->_M_detach_singular();
370 // if __sz < size(), invalidate all iterators in [begin+__sz, end())
371 _Base_iterator __victim = _Base::begin();
372 _Base_iterator __end = _Base::end();
373 for (size_type __i = __sz; __victim != __end && __i > 0; --__i)
376 for (; __victim != __end; ++__victim)
378 this->_M_invalidate_if([__victim](_Base_const_iterator __it)
379 { return __it == __victim; });
384 _Base::resize(__sz, __val);
388 this->_M_revalidate_singular();
389 __throw_exception_again;
397 this->_M_invalidate_all();
400 // 23.2.3.5 forward_list operations:
402 splice_after(const_iterator __pos, forward_list&& __list)
404 __glibcxx_check_insert_after(__pos);
405 _GLIBCXX_DEBUG_VERIFY(&__list != this,
406 _M_message(__gnu_debug::__msg_self_splice)
407 ._M_sequence(*this, "this"));
408 this->_M_transfer_from_if(__list, [&__list](_Base_const_iterator __it)
410 return __it != __list._M_base().cbefore_begin()
411 && __it != __list._M_base().end();
413 _Base::splice_after(__pos.base(), std::move(__list._M_base()));
417 splice_after(const_iterator __pos, forward_list& __list)
418 { splice_after(__pos, std::move(__list)); }
421 splice_after(const_iterator __pos, forward_list&& __list,
424 __glibcxx_check_insert_after(__pos);
425 _GLIBCXX_DEBUG_VERIFY(__i._M_before_dereferenceable(),
426 _M_message(__gnu_debug::__msg_splice_bad)
427 ._M_iterator(__i, "__i"));
428 _GLIBCXX_DEBUG_VERIFY(__i._M_attached_to(&__list),
429 _M_message(__gnu_debug::__msg_splice_other)
430 ._M_iterator(__i, "__i")
431 ._M_sequence(__list, "__list"));
433 // _GLIBCXX_RESOLVE_LIB_DEFECTS
434 // 250. splicing invalidates iterators
435 _Base_const_iterator __next = std::next(__i.base());
436 this->_M_transfer_from_if(__list, [__next](_Base_const_iterator __it)
437 { return __it == __next; });
438 _Base::splice_after(__pos.base(), std::move(__list._M_base()),
443 splice_after(const_iterator __pos, forward_list& __list,
445 { splice_after(__pos, std::move(__list), __i); }
448 splice_after(const_iterator __pos, forward_list&& __list,
449 const_iterator __before, const_iterator __last)
451 __glibcxx_check_insert_after(__pos);
452 __glibcxx_check_valid_range(__before, __last);
453 _GLIBCXX_DEBUG_VERIFY(__before._M_attached_to(&__list),
454 _M_message(__gnu_debug::__msg_splice_other)
455 ._M_sequence(__list, "list")
456 ._M_iterator(__before, "before"));
457 _GLIBCXX_DEBUG_VERIFY(__before._M_dereferenceable()
458 || __before._M_is_before_begin(),
459 _M_message(__gnu_debug::__msg_valid_range2)
460 ._M_sequence(__list, "list")
461 ._M_iterator(__before, "before")
462 ._M_iterator(__last, "last"));
463 _GLIBCXX_DEBUG_VERIFY(__before != __last,
464 _M_message(__gnu_debug::__msg_valid_range2)
465 ._M_sequence(__list, "list")
466 ._M_iterator(__before, "before")
467 ._M_iterator(__last, "last"));
469 for (_Base_const_iterator __tmp = std::next(__before.base());
470 __tmp != __last.base(); ++__tmp)
472 _GLIBCXX_DEBUG_VERIFY(__tmp != __list._M_base().end(),
473 _M_message(__gnu_debug::__msg_valid_range2)
474 ._M_sequence(__list, "list")
475 ._M_iterator(__before, "before")
476 ._M_iterator(__last, "last"));
477 _GLIBCXX_DEBUG_VERIFY(&__list != this || __tmp != __pos.base(),
478 _M_message(__gnu_debug::__msg_splice_overlap)
479 ._M_iterator(__tmp, "position")
480 ._M_iterator(__before, "before")
481 ._M_iterator(__last, "last"));
482 // _GLIBCXX_RESOLVE_LIB_DEFECTS
483 // 250. splicing invalidates iterators
484 this->_M_transfer_from_if(__list, [__tmp](_Base_const_iterator __it)
485 { return __it == __tmp; });
488 _Base::splice_after(__pos.base(), std::move(__list._M_base()),
489 __before.base(), __last.base());
493 splice_after(const_iterator __pos, forward_list& __list,
494 const_iterator __before, const_iterator __last)
495 { splice_after(__pos, std::move(__list), __before, __last); }
498 remove(const _Tp& __val)
500 _Base_iterator __x = _Base::before_begin();
501 _Base_iterator __old = __x++;
502 while (__x != _Base::end())
505 __x = _M_erase_after(__old);
511 template<typename _Pred>
513 remove_if(_Pred __pred)
515 _Base_iterator __x = _Base::before_begin();
516 _Base_iterator __old = __x++;
517 while (__x != _Base::end())
520 __x = _M_erase_after(__old);
529 _Base_iterator __first = _Base::begin();
530 _Base_iterator __last = _Base::end();
531 if (__first == __last)
533 _Base_iterator __next = std::next(__first);
534 while (__next != __last)
536 if (*__first == *__next)
537 __next = _M_erase_after(__first);
543 template<typename _BinPred>
545 unique(_BinPred __binary_pred)
547 _Base_iterator __first = _Base::begin();
548 _Base_iterator __last = _Base::end();
549 if (__first == __last)
551 _Base_iterator __next = std::next(__first);
552 while (__next != __last)
554 if (__binary_pred(*__first, *__next))
555 __next = _M_erase_after(__first);
562 merge(forward_list&& __list)
566 __glibcxx_check_sorted(_Base::begin(), _Base::end());
567 __glibcxx_check_sorted(__list._M_base().begin(),
568 __list._M_base().end());
569 this->_M_transfer_from_if(__list, [&__list](_Base_const_iterator __it)
571 return __it != __list._M_base().cbefore_begin()
572 && __it != __list._M_base().cend();
574 _Base::merge(std::move(__list._M_base()));
579 merge(forward_list& __list)
580 { merge(std::move(__list)); }
582 template<typename _Comp>
584 merge(forward_list&& __list, _Comp __comp)
588 __glibcxx_check_sorted_pred(_Base::begin(), _Base::end(), __comp);
589 __glibcxx_check_sorted_pred(__list._M_base().begin(),
590 __list._M_base().end(), __comp);
591 this->_M_transfer_from_if(__list,
592 [&__list](_Base_const_iterator __it)
594 return __it != __list._M_base().cbefore_begin()
595 && __it != __list._M_base().cend();
597 _Base::merge(std::move(__list._M_base()), __comp);
601 template<typename _Comp>
603 merge(forward_list& __list, _Comp __comp)
604 { merge(std::move(__list), __comp); }
607 using _Base::reverse;
610 _M_base() noexcept { return *this; }
613 _M_base() const noexcept { return *this; }
619 this->_M_invalidate_if([this](_Base_const_iterator __it)
621 return __it != this->_M_base().cbefore_begin()
622 && __it != this->_M_base().cend();
625 typedef __gnu_debug::_Safe_iterator_base _Safe_iterator_base;
627 _M_swap_aux(forward_list& __lhs,
628 _Safe_iterator_base*& __lhs_iterators,
630 _Safe_iterator_base*& __rhs_iterators);
631 void _M_swap(forward_list& __list);
634 template<typename _Tp, typename _Alloc>
636 forward_list<_Tp, _Alloc>::
637 _M_swap_aux(forward_list<_Tp, _Alloc>& __lhs,
638 __gnu_debug::_Safe_iterator_base*& __lhs_iterators,
639 forward_list<_Tp, _Alloc>& __rhs,
640 __gnu_debug::_Safe_iterator_base*& __rhs_iterators)
642 using __gnu_debug::_Safe_iterator_base;
643 _Safe_iterator_base* __bbegin_its = 0;
644 _Safe_iterator_base* __last_bbegin = 0;
645 for (_Safe_iterator_base* __iter = __lhs_iterators; __iter;)
647 // Even iterator are casted to const_iterator, not a problem.
648 const_iterator* __victim = static_cast<const_iterator*>(__iter);
649 __iter = __iter->_M_next;
650 if (__victim->base() == __rhs._M_base().cbefore_begin())
652 __victim->_M_unlink();
653 if (__lhs_iterators == __victim)
654 __lhs_iterators = __victim->_M_next;
657 __victim->_M_next = __bbegin_its;
658 __bbegin_its->_M_prior = __victim;
661 __last_bbegin = __victim;
662 __bbegin_its = __victim;
665 __victim->_M_sequence = &__lhs;
672 __rhs_iterators->_M_prior = __last_bbegin;
673 __last_bbegin->_M_next = __rhs_iterators;
675 __rhs_iterators = __bbegin_its;
679 /* Special forward_list _M_swap version that do not swap the
680 * before-begin ownership.*/
681 template<typename _Tp, typename _Alloc>
683 forward_list<_Tp, _Alloc>::
684 _M_swap(forward_list<_Tp, _Alloc>& __list)
686 __gnu_cxx::__scoped_lock sentry(this->_M_get_mutex());
687 std::swap(this->_M_iterators, __list._M_iterators);
688 std::swap(this->_M_const_iterators, __list._M_const_iterators);
689 // Useless, always 1 on forward_list
690 //std::swap(this->_M_version, __list._M_version);
691 _Safe_iterator_base* __this_its = this->_M_iterators;
692 _M_swap_aux(__list, __list._M_iterators, *this, this->_M_iterators);
693 _Safe_iterator_base* __this_const_its = this->_M_const_iterators;
694 _M_swap_aux(__list, __list._M_const_iterators, *this,
695 this->_M_const_iterators);
696 _M_swap_aux(*this, __this_its, __list, __list._M_iterators);
697 _M_swap_aux(*this, __this_const_its, __list, __list._M_const_iterators);
700 template<typename _Tp, typename _Alloc>
702 operator==(const forward_list<_Tp, _Alloc>& __lx,
703 const forward_list<_Tp, _Alloc>& __ly)
704 { return __lx._M_base() == __ly._M_base(); }
706 template<typename _Tp, typename _Alloc>
708 operator<(const forward_list<_Tp, _Alloc>& __lx,
709 const forward_list<_Tp, _Alloc>& __ly)
710 { return __lx._M_base() < __ly._M_base(); }
712 template<typename _Tp, typename _Alloc>
714 operator!=(const forward_list<_Tp, _Alloc>& __lx,
715 const forward_list<_Tp, _Alloc>& __ly)
716 { return !(__lx == __ly); }
718 /// Based on operator<
719 template<typename _Tp, typename _Alloc>
721 operator>(const forward_list<_Tp, _Alloc>& __lx,
722 const forward_list<_Tp, _Alloc>& __ly)
723 { return (__ly < __lx); }
725 /// Based on operator<
726 template<typename _Tp, typename _Alloc>
728 operator>=(const forward_list<_Tp, _Alloc>& __lx,
729 const forward_list<_Tp, _Alloc>& __ly)
730 { return !(__lx < __ly); }
732 /// Based on operator<
733 template<typename _Tp, typename _Alloc>
735 operator<=(const forward_list<_Tp, _Alloc>& __lx,
736 const forward_list<_Tp, _Alloc>& __ly)
737 { return !(__ly < __lx); }
739 /// See std::forward_list::swap().
740 template<typename _Tp, typename _Alloc>
742 swap(forward_list<_Tp, _Alloc>& __lx,
743 forward_list<_Tp, _Alloc>& __ly)
746 } // namespace __debug
749 namespace __gnu_debug
751 template<class _Tp, class _Alloc>
752 struct _BeforeBeginHelper<std::__debug::forward_list<_Tp, _Alloc> >
754 typedef std::__debug::forward_list<_Tp, _Alloc> _Sequence;
755 typedef typename _Sequence::const_iterator _It;
756 typedef typename _It::iterator_type _BaseIt;
759 _S_Is(_BaseIt __it, const _Sequence* __seq)
760 { return __it == __seq->_M_base().cbefore_begin(); }
763 _S_Is_Beginnest(_BaseIt __it, const _Sequence* __seq)
764 { return _S_Is(__it, __seq); }