1// Debugging deque implementation -*- C++ -*-
3// Copyright (C) 2003-2025 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_DEQUE
30#define _GLIBCXX_DEBUG_DEQUE 1
33#pragma GCC system_header
36#include <bits/c++config.h>
37namespace std _GLIBCXX_VISIBILITY(default) { namespace __debug {
38 template<typename _Tp, typename _Allocator> class deque;
39} } // namespace std::__debug
42#include <debug/safe_sequence.h>
43#include <debug/safe_container.h>
44#include <debug/safe_iterator.h>
46namespace std _GLIBCXX_VISIBILITY(default)
50 /// Class std::deque with safety/checking/debug instrumentation.
51 template<typename _Tp, typename _Allocator = std::allocator<_Tp> >
53 : public __gnu_debug::_Safe_container<
54 deque<_Tp, _Allocator>, _Allocator,
55 __gnu_debug::_Safe_sequence>,
56 public _GLIBCXX_STD_C::deque<_Tp, _Allocator>
58 typedef _GLIBCXX_STD_C::deque<_Tp, _Allocator> _Base;
59 typedef __gnu_debug::_Safe_container<
60 deque, _Allocator, __gnu_debug::_Safe_sequence> _Safe;
62 typedef typename _Base::const_iterator _Base_const_iterator;
63 typedef typename _Base::iterator _Base_iterator;
64 typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
66 template<typename _ItT, typename _SeqT, typename _CatT>
67 friend class ::__gnu_debug::_Safe_iterator;
69 // Reference wrapper for base class. Disambiguates deque(const _Base&)
70 // from copy constructor by requiring a user-defined conversion.
71 // See PR libstdc++/90102.
74 _Base_ref(const _Base& __r) : _M_ref(__r) { }
80 typedef typename _Base::reference reference;
81 typedef typename _Base::const_reference const_reference;
83 typedef __gnu_debug::_Safe_iterator<_Base_iterator, deque>
85 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator, deque>
88 typedef typename _Base::size_type size_type;
89 typedef typename _Base::difference_type difference_type;
91 typedef _Tp value_type;
92 typedef _Allocator allocator_type;
93 typedef typename _Base::pointer pointer;
94 typedef typename _Base::const_pointer const_pointer;
95 typedef std::reverse_iterator<iterator> reverse_iterator;
96 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
98 // 23.2.1.1 construct/copy/destroy:
100#if __cplusplus < 201103L
104 deque(const deque& __x)
110 deque(const deque&) = default;
111 deque(deque&&) = default;
113 deque(const deque& __d, const __type_identity_t<_Allocator>& __a)
114 : _Base(__d, __a) { }
116 deque(deque&& __d, const __type_identity_t<_Allocator>& __a)
117 : _Safe(std::move(__d)), _Base(std::move(__d), __a) { }
119 deque(initializer_list<value_type> __l,
120 const allocator_type& __a = allocator_type())
121 : _Base(__l, __a) { }
127 deque(const _Allocator& __a)
130#if __cplusplus >= 201103L
132 deque(size_type __n, const _Allocator& __a = _Allocator())
133 : _Base(__n, __a) { }
135 deque(size_type __n, const __type_identity_t<_Tp>& __value,
136 const _Allocator& __a = _Allocator())
137 : _Base(__n, __value, __a) { }
140 deque(size_type __n, const _Tp& __value = _Tp(),
141 const _Allocator& __a = _Allocator())
142 : _Base(__n, __value, __a) { }
145#if __cplusplus >= 201103L
146 template<class _InputIterator,
147 typename = std::_RequireInputIter<_InputIterator>>
149 template<class _InputIterator>
151 deque(_InputIterator __first, _InputIterator __last,
152 const _Allocator& __a = _Allocator())
153 : _Base(__gnu_debug::__base(
154 __glibcxx_check_valid_constructor_range(__first, __last)),
155 __gnu_debug::__base(__last), __a)
158#if __glibcxx_containers_ranges // C++ >= 23
159 template<__detail::__container_compatible_range<_Tp> _Rg>
160 deque(from_range_t, _Rg&& __rg, const _Allocator& __a = _Allocator())
161 : _Base(from_range, std::forward<_Rg>(__rg), __a)
166 : _Base(__x._M_ref) { }
168#if __cplusplus >= 201103L
170 operator=(const deque&) = default;
173 operator=(deque&&) = default;
176 operator=(initializer_list<value_type> __l)
178 _Base::operator=(__l);
179 this->_M_invalidate_all();
184#if __cplusplus >= 201103L
185 template<class _InputIterator,
186 typename = std::_RequireInputIter<_InputIterator>>
188 template<class _InputIterator>
191 assign(_InputIterator __first, _InputIterator __last)
193 typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
194 __glibcxx_check_valid_range2(__first, __last, __dist);
195 if (__dist.second >= __gnu_debug::__dp_sign)
196 _Base::assign(__gnu_debug::__unsafe(__first),
197 __gnu_debug::__unsafe(__last));
199 _Base::assign(__first, __last);
201 this->_M_invalidate_all();
205 assign(size_type __n, const _Tp& __t)
207 _Base::assign(__n, __t);
208 this->_M_invalidate_all();
211#if __cplusplus >= 201103L
213 assign(initializer_list<value_type> __l)
216 this->_M_invalidate_all();
220#if __glibcxx_containers_ranges // C++ >= 23
221 template<std::__detail::__container_compatible_range<_Tp> _Rg>
223 assign_range(_Rg&& __rg)
225 _Base::assign_range(std::forward<_Rg>(__rg));
226 this->_M_invalidate_all();
230 using _Base::get_allocator;
235 begin() _GLIBCXX_NOEXCEPT
236 { return iterator(_Base::begin(), this); }
240 begin() const _GLIBCXX_NOEXCEPT
241 { return const_iterator(_Base::begin(), this); }
245 end() _GLIBCXX_NOEXCEPT
246 { return iterator(_Base::end(), this); }
250 end() const _GLIBCXX_NOEXCEPT
251 { return const_iterator(_Base::end(), this); }
255 rbegin() _GLIBCXX_NOEXCEPT
256 { return reverse_iterator(end()); }
259 const_reverse_iterator
260 rbegin() const _GLIBCXX_NOEXCEPT
261 { return const_reverse_iterator(end()); }
265 rend() _GLIBCXX_NOEXCEPT
266 { return reverse_iterator(begin()); }
269 const_reverse_iterator
270 rend() const _GLIBCXX_NOEXCEPT
271 { return const_reverse_iterator(begin()); }
273#if __cplusplus >= 201103L
276 cbegin() const noexcept
277 { return const_iterator(_Base::begin(), this); }
281 cend() const noexcept
282 { return const_iterator(_Base::end(), this); }
285 const_reverse_iterator
286 crbegin() const noexcept
287 { return const_reverse_iterator(end()); }
290 const_reverse_iterator
291 crend() const noexcept
292 { return const_reverse_iterator(begin()); }
297 _M_invalidate_after_nth(difference_type __n)
299 typedef __gnu_debug::_After_nth_from<_Base_const_iterator> _After_nth;
300 this->_M_invalidate_if(_After_nth(__n, _Base::begin()));
304 // 23.2.1.2 capacity:
306 using _Base::max_size;
308#if __cplusplus >= 201103L
310 resize(size_type __sz)
312 bool __invalidate_all = __sz > this->size();
313 if (__sz < this->size())
314 this->_M_invalidate_after_nth(__sz);
318 if (__invalidate_all)
319 this->_M_invalidate_all();
323 resize(size_type __sz, const _Tp& __c)
325 bool __invalidate_all = __sz > this->size();
326 if (__sz < this->size())
327 this->_M_invalidate_after_nth(__sz);
329 _Base::resize(__sz, __c);
331 if (__invalidate_all)
332 this->_M_invalidate_all();
336 resize(size_type __sz, _Tp __c = _Tp())
338 bool __invalidate_all = __sz > this->size();
339 if (__sz < this->size())
340 this->_M_invalidate_after_nth(__sz);
342 _Base::resize(__sz, __c);
344 if (__invalidate_all)
345 this->_M_invalidate_all();
349#if __cplusplus >= 201103L
351 shrink_to_fit() noexcept
353 if (_Base::_M_shrink_to_fit())
354 this->_M_invalidate_all();
363 operator[](size_type __n) _GLIBCXX_NOEXCEPT
365 __glibcxx_check_subscript(__n);
366 return _Base::operator[](__n);
371 operator[](size_type __n) const _GLIBCXX_NOEXCEPT
373 __glibcxx_check_subscript(__n);
374 return _Base::operator[](__n);
381 front() _GLIBCXX_NOEXCEPT
383 __glibcxx_check_nonempty();
384 return _Base::front();
389 front() const _GLIBCXX_NOEXCEPT
391 __glibcxx_check_nonempty();
392 return _Base::front();
397 back() _GLIBCXX_NOEXCEPT
399 __glibcxx_check_nonempty();
400 return _Base::back();
405 back() const _GLIBCXX_NOEXCEPT
407 __glibcxx_check_nonempty();
408 return _Base::back();
411 // 23.2.1.3 modifiers:
413 push_front(const _Tp& __x)
415 _Base::push_front(__x);
416 this->_M_invalidate_all();
420 push_back(const _Tp& __x)
422 _Base::push_back(__x);
423 this->_M_invalidate_all();
426#if __cplusplus >= 201103L
428 push_front(_Tp&& __x)
429 { emplace_front(std::move(__x)); }
433 { emplace_back(std::move(__x)); }
435 template<typename... _Args>
436#if __cplusplus > 201402L
441 emplace_front(_Args&&... __args)
443 _Base::emplace_front(std::forward<_Args>(__args)...);
444 this->_M_invalidate_all();
445#if __cplusplus > 201402L
450 template<typename... _Args>
451#if __cplusplus > 201402L
456 emplace_back(_Args&&... __args)
458 _Base::emplace_back(std::forward<_Args>(__args)...);
459 this->_M_invalidate_all();
460#if __cplusplus > 201402L
465 template<typename... _Args>
467 emplace(const_iterator __position, _Args&&... __args)
469 __glibcxx_check_insert(__position);
470 _Base_iterator __res = _Base::emplace(__position.base(),
471 std::forward<_Args>(__args)...);
472 this->_M_invalidate_all();
473 return iterator(__res, this);
478#if __cplusplus >= 201103L
479 insert(const_iterator __position, const _Tp& __x)
481 insert(iterator __position, const _Tp& __x)
484 __glibcxx_check_insert(__position);
485 _Base_iterator __res = _Base::insert(__position.base(), __x);
486 this->_M_invalidate_all();
487 return iterator(__res, this);
490#if __cplusplus >= 201103L
492 insert(const_iterator __position, _Tp&& __x)
493 { return emplace(__position, std::move(__x)); }
496 insert(const_iterator __position, initializer_list<value_type> __l)
498 __glibcxx_check_insert(__position);
499 _Base_iterator __res = _Base::insert(__position.base(), __l);
500 this->_M_invalidate_all();
501 return iterator(__res, this);
505#if __cplusplus >= 201103L
507 insert(const_iterator __position, size_type __n, const _Tp& __x)
509 __glibcxx_check_insert(__position);
510 _Base_iterator __res = _Base::insert(__position.base(), __n, __x);
511 this->_M_invalidate_all();
512 return iterator(__res, this);
516 insert(iterator __position, size_type __n, const _Tp& __x)
518 __glibcxx_check_insert(__position);
519 _Base::insert(__position.base(), __n, __x);
520 this->_M_invalidate_all();
524#if __cplusplus >= 201103L
525 template<class _InputIterator,
526 typename = std::_RequireInputIter<_InputIterator>>
528 insert(const_iterator __position,
529 _InputIterator __first, _InputIterator __last)
531 typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
532 __glibcxx_check_insert_range(__position, __first, __last, __dist);
533 _Base_iterator __res;
534 if (__dist.second >= __gnu_debug::__dp_sign)
535 __res = _Base::insert(__position.base(),
536 __gnu_debug::__unsafe(__first),
537 __gnu_debug::__unsafe(__last));
539 __res = _Base::insert(__position.base(), __first, __last);
541 this->_M_invalidate_all();
542 return iterator(__res, this);
545 template<class _InputIterator>
547 insert(iterator __position,
548 _InputIterator __first, _InputIterator __last)
550 typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
551 __glibcxx_check_insert_range(__position, __first, __last, __dist);
553 if (__dist.second >= __gnu_debug::__dp_sign)
554 _Base::insert(__position.base(),
555 __gnu_debug::__unsafe(__first),
556 __gnu_debug::__unsafe(__last));
558 _Base::insert(__position.base(), __first, __last);
560 this->_M_invalidate_all();
564#if __glibcxx_containers_ranges // C++ >= 23
565 template<__detail::__container_compatible_range<_Tp> _Rg>
567 insert_range(const_iterator __pos, _Rg&& __rg)
569 auto __res = _Base::insert_range(__pos.base(), std::forward<_Rg>(__rg));
570 this->_M_invalidate_all();
571 return iterator(__res, this);
574 template<std::__detail::__container_compatible_range<_Tp> _Rg>
576 prepend_range(_Rg&& __rg)
578 _Base::prepend_range(std::forward<_Rg>(__rg));
579 this->_M_invalidate_all();
582 template<std::__detail::__container_compatible_range<_Tp> _Rg>
584 append_range(_Rg&& __rg)
586 _Base::append_range(std::forward<_Rg>(__rg));
587 this->_M_invalidate_all();
592 pop_front() _GLIBCXX_NOEXCEPT
594 __glibcxx_check_nonempty();
595 this->_M_invalidate_if(_Equal(_Base::begin()));
600 pop_back() _GLIBCXX_NOEXCEPT
602 __glibcxx_check_nonempty();
603 this->_M_invalidate_if(_Equal(--_Base::end()));
608#if __cplusplus >= 201103L
609 erase(const_iterator __position)
611 erase(iterator __position)
614 __glibcxx_check_erase(__position);
615#if __cplusplus >= 201103L
616 _Base_const_iterator __victim = __position.base();
618 _Base_iterator __victim = __position.base();
620 if (__victim == _Base::begin() || __victim == _Base::end() - 1)
622 this->_M_invalidate_if(_Equal(__victim));
623 return iterator(_Base::erase(__victim), this);
627 _Base_iterator __res = _Base::erase(__victim);
628 this->_M_invalidate_all();
629 return iterator(__res, this);
634#if __cplusplus >= 201103L
635 erase(const_iterator __first, const_iterator __last)
637 erase(iterator __first, iterator __last)
640 // _GLIBCXX_RESOLVE_LIB_DEFECTS
641 // 151. can't currently clear() empty container
642 __glibcxx_check_erase_range(__first, __last);
644 if (__first.base() == __last.base())
645#if __cplusplus >= 201103L
646 return iterator(__first.base()._M_const_cast(), this);
650 else if (__first.base() == _Base::begin()
651 || __last.base() == _Base::end())
653 const deque* __this = this;
654 __this->_M_detach_singular();
655 for (_Base_const_iterator __position = __first.base();
656 __position != __last.base(); ++__position)
658 this->_M_invalidate_if(_Equal(__position));
662 return iterator(_Base::erase(__first.base(), __last.base()),
667 __this->_M_revalidate_singular();
668 __throw_exception_again;
673 _Base_iterator __res = _Base::erase(__first.base(),
675 this->_M_invalidate_all();
676 return iterator(__res, this);
682 _GLIBCXX_NOEXCEPT_IF( noexcept(declval<_Base&>().swap(__x)) )
689 clear() _GLIBCXX_NOEXCEPT
692 this->_M_invalidate_all();
696 _M_base() _GLIBCXX_NOEXCEPT { return *this; }
699 _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
702#if __cpp_deduction_guides >= 201606
703 template<typename _InputIterator, typename _ValT
704 = typename iterator_traits<_InputIterator>::value_type,
705 typename _Allocator = allocator<_ValT>,
706 typename = _RequireInputIter<_InputIterator>,
707 typename = _RequireAllocator<_Allocator>>
708 deque(_InputIterator, _InputIterator, _Allocator = _Allocator())
709 -> deque<_ValT, _Allocator>;
711 template<typename _Tp, typename _Allocator = allocator<_Tp>,
712 typename = _RequireAllocator<_Allocator>>
713 deque(size_t, _Tp, _Allocator = _Allocator())
714 -> deque<_Tp, _Allocator>;
716#if __glibcxx_containers_ranges // C++ >= 23
717 template<ranges::input_range _Rg,
718 typename _Alloc = allocator<ranges::range_value_t<_Rg>>>
719 deque(from_range_t, _Rg&&, _Alloc = _Alloc())
720 -> deque<ranges::range_value_t<_Rg>, _Alloc>;
724 template<typename _Tp, typename _Alloc>
726 operator==(const deque<_Tp, _Alloc>& __lhs,
727 const deque<_Tp, _Alloc>& __rhs)
728 { return __lhs._M_base() == __rhs._M_base(); }
730#if __cpp_lib_three_way_comparison
731 template<typename _Tp, typename _Alloc>
732 constexpr __detail::__synth3way_t<_Tp>
733 operator<=>(const deque<_Tp, _Alloc>& __x, const deque<_Tp, _Alloc>& __y)
734 { return __x._M_base() <=> __y._M_base(); }
736 template<typename _Tp, typename _Alloc>
738 operator!=(const deque<_Tp, _Alloc>& __lhs,
739 const deque<_Tp, _Alloc>& __rhs)
740 { return __lhs._M_base() != __rhs._M_base(); }
742 template<typename _Tp, typename _Alloc>
744 operator<(const deque<_Tp, _Alloc>& __lhs,
745 const deque<_Tp, _Alloc>& __rhs)
746 { return __lhs._M_base() < __rhs._M_base(); }
748 template<typename _Tp, typename _Alloc>
750 operator<=(const deque<_Tp, _Alloc>& __lhs,
751 const deque<_Tp, _Alloc>& __rhs)
752 { return __lhs._M_base() <= __rhs._M_base(); }
754 template<typename _Tp, typename _Alloc>
756 operator>=(const deque<_Tp, _Alloc>& __lhs,
757 const deque<_Tp, _Alloc>& __rhs)
758 { return __lhs._M_base() >= __rhs._M_base(); }
760 template<typename _Tp, typename _Alloc>
762 operator>(const deque<_Tp, _Alloc>& __lhs,
763 const deque<_Tp, _Alloc>& __rhs)
764 { return __lhs._M_base() > __rhs._M_base(); }
765#endif // three-way comparison
767 template<typename _Tp, typename _Alloc>
769 swap(deque<_Tp, _Alloc>& __lhs, deque<_Tp, _Alloc>& __rhs)
770 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))
771 { __lhs.swap(__rhs); }
773} // namespace __debug