1 // Debugging map implementation -*- C++ -*-
3 // Copyright (C) 2003-2018 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_MAP_H
30 #define _GLIBCXX_DEBUG_MAP_H 1
32 #include <debug/safe_sequence.h>
33 #include <debug/safe_container.h>
34 #include <debug/safe_iterator.h>
37 namespace std _GLIBCXX_VISIBILITY(default)
41 /// Class std::map with safety/checking/debug instrumentation.
42 template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,
43 typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >
45 : public __gnu_debug::_Safe_container<
46 map<_Key, _Tp, _Compare, _Allocator>, _Allocator,
47 __gnu_debug::_Safe_node_sequence>,
48 public _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator>
50 typedef _GLIBCXX_STD_C::map<
51 _Key, _Tp, _Compare, _Allocator> _Base;
52 typedef __gnu_debug::_Safe_container<
53 map, _Allocator, __gnu_debug::_Safe_node_sequence> _Safe;
55 typedef typename _Base::const_iterator _Base_const_iterator;
56 typedef typename _Base::iterator _Base_iterator;
57 typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
61 typedef _Key key_type;
62 typedef _Tp mapped_type;
63 typedef std::pair<const _Key, _Tp> value_type;
64 typedef _Compare key_compare;
65 typedef _Allocator allocator_type;
66 typedef typename _Base::reference reference;
67 typedef typename _Base::const_reference const_reference;
69 typedef __gnu_debug::_Safe_iterator<_Base_iterator, map>
71 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator, map>
74 typedef typename _Base::size_type size_type;
75 typedef typename _Base::difference_type difference_type;
76 typedef typename _Base::pointer pointer;
77 typedef typename _Base::const_pointer const_pointer;
78 typedef std::reverse_iterator<iterator> reverse_iterator;
79 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
81 // 23.3.1.1 construct/copy/destroy:
83 #if __cplusplus < 201103L
92 map(const map&) = default;
95 map(initializer_list<value_type> __l,
96 const _Compare& __c = _Compare(),
97 const allocator_type& __a = allocator_type())
98 : _Base(__l, __c, __a) { }
101 map(const allocator_type& __a)
104 map(const map& __m, const allocator_type& __a)
105 : _Base(__m, __a) { }
107 map(map&& __m, const allocator_type& __a)
108 noexcept( noexcept(_Base(std::move(__m._M_base()), __a)) )
109 : _Safe(std::move(__m._M_safe()), __a),
110 _Base(std::move(__m._M_base()), __a) { }
112 map(initializer_list<value_type> __l, const allocator_type& __a)
113 : _Base(__l, __a) { }
115 template<typename _InputIterator>
116 map(_InputIterator __first, _InputIterator __last,
117 const allocator_type& __a)
118 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
120 __gnu_debug::__base(__last), __a)
126 map(const _Base& __x)
129 explicit map(const _Compare& __comp,
130 const _Allocator& __a = _Allocator())
131 : _Base(__comp, __a) { }
133 template<typename _InputIterator>
134 map(_InputIterator __first, _InputIterator __last,
135 const _Compare& __comp = _Compare(),
136 const _Allocator& __a = _Allocator())
137 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
139 __gnu_debug::__base(__last),
142 #if __cplusplus < 201103L
144 operator=(const map& __x)
146 this->_M_safe() = __x;
152 operator=(const map&) = default;
155 operator=(map&&) = default;
158 operator=(initializer_list<value_type> __l)
161 this->_M_invalidate_all();
166 // _GLIBCXX_RESOLVE_LIB_DEFECTS
167 // 133. map missing get_allocator()
168 using _Base::get_allocator;
172 begin() _GLIBCXX_NOEXCEPT
173 { return iterator(_Base::begin(), this); }
176 begin() const _GLIBCXX_NOEXCEPT
177 { return const_iterator(_Base::begin(), this); }
180 end() _GLIBCXX_NOEXCEPT
181 { return iterator(_Base::end(), this); }
184 end() const _GLIBCXX_NOEXCEPT
185 { return const_iterator(_Base::end(), this); }
188 rbegin() _GLIBCXX_NOEXCEPT
189 { return reverse_iterator(end()); }
191 const_reverse_iterator
192 rbegin() const _GLIBCXX_NOEXCEPT
193 { return const_reverse_iterator(end()); }
196 rend() _GLIBCXX_NOEXCEPT
197 { return reverse_iterator(begin()); }
199 const_reverse_iterator
200 rend() const _GLIBCXX_NOEXCEPT
201 { return const_reverse_iterator(begin()); }
203 #if __cplusplus >= 201103L
205 cbegin() const noexcept
206 { return const_iterator(_Base::begin(), this); }
209 cend() const noexcept
210 { return const_iterator(_Base::end(), this); }
212 const_reverse_iterator
213 crbegin() const noexcept
214 { return const_reverse_iterator(end()); }
216 const_reverse_iterator
217 crend() const noexcept
218 { return const_reverse_iterator(begin()); }
224 using _Base::max_size;
226 // 23.3.1.2 element access:
227 using _Base::operator[];
229 // _GLIBCXX_RESOLVE_LIB_DEFECTS
230 // DR 464. Suggestion for new member functions in standard containers.
234 #if __cplusplus >= 201103L
235 template<typename... _Args>
236 std::pair<iterator, bool>
237 emplace(_Args&&... __args)
239 auto __res = _Base::emplace(std::forward<_Args>(__args)...);
240 return std::pair<iterator, bool>(iterator(__res.first, this),
244 template<typename... _Args>
246 emplace_hint(const_iterator __pos, _Args&&... __args)
248 __glibcxx_check_insert(__pos);
249 return iterator(_Base::emplace_hint(__pos.base(),
250 std::forward<_Args>(__args)...),
255 std::pair<iterator, bool>
256 insert(const value_type& __x)
258 std::pair<_Base_iterator, bool> __res = _Base::insert(__x);
259 return std::pair<iterator, bool>(iterator(__res.first, this),
263 #if __cplusplus >= 201103L
264 // _GLIBCXX_RESOLVE_LIB_DEFECTS
265 // 2354. Unnecessary copying when inserting into maps with braced-init
266 std::pair<iterator, bool>
267 insert(value_type&& __x)
269 auto __res = _Base::insert(std::move(__x));
270 return { iterator(__res.first, this), __res.second };
273 template<typename _Pair, typename = typename
274 std::enable_if<std::is_constructible<value_type,
275 _Pair&&>::value>::type>
276 std::pair<iterator, bool>
279 std::pair<_Base_iterator, bool> __res
280 = _Base::insert(std::forward<_Pair>(__x));
281 return std::pair<iterator, bool>(iterator(__res.first, this),
286 #if __cplusplus >= 201103L
288 insert(std::initializer_list<value_type> __list)
289 { _Base::insert(__list); }
293 #if __cplusplus >= 201103L
294 insert(const_iterator __position, const value_type& __x)
296 insert(iterator __position, const value_type& __x)
299 __glibcxx_check_insert(__position);
300 return iterator(_Base::insert(__position.base(), __x), this);
303 #if __cplusplus >= 201103L
304 // _GLIBCXX_RESOLVE_LIB_DEFECTS
305 // 2354. Unnecessary copying when inserting into maps with braced-init
307 insert(const_iterator __position, value_type&& __x)
309 __glibcxx_check_insert(__position);
310 return { _Base::insert(__position.base(), std::move(__x)), this };
313 template<typename _Pair, typename = typename
314 std::enable_if<std::is_constructible<value_type,
315 _Pair&&>::value>::type>
317 insert(const_iterator __position, _Pair&& __x)
319 __glibcxx_check_insert(__position);
320 return iterator(_Base::insert(__position.base(),
321 std::forward<_Pair>(__x)), this);
325 template<typename _InputIterator>
327 insert(_InputIterator __first, _InputIterator __last)
329 typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
330 __glibcxx_check_valid_range2(__first, __last, __dist);
332 if (__dist.second >= __gnu_debug::__dp_sign)
333 _Base::insert(__gnu_debug::__unsafe(__first),
334 __gnu_debug::__unsafe(__last));
336 _Base::insert(__first, __last);
340 #if __cplusplus > 201402L
341 template <typename... _Args>
343 try_emplace(const key_type& __k, _Args&&... __args)
345 auto __res = _Base::try_emplace(__k,
346 std::forward<_Args>(__args)...);
347 return { iterator(__res.first, this), __res.second };
350 template <typename... _Args>
352 try_emplace(key_type&& __k, _Args&&... __args)
354 auto __res = _Base::try_emplace(std::move(__k),
355 std::forward<_Args>(__args)...);
356 return { iterator(__res.first, this), __res.second };
359 template <typename... _Args>
361 try_emplace(const_iterator __hint, const key_type& __k,
364 __glibcxx_check_insert(__hint);
365 return iterator(_Base::try_emplace(__hint.base(), __k,
366 std::forward<_Args>(__args)...),
370 template <typename... _Args>
372 try_emplace(const_iterator __hint, key_type&& __k, _Args&&... __args)
374 __glibcxx_check_insert(__hint);
375 return iterator(_Base::try_emplace(__hint.base(), std::move(__k),
376 std::forward<_Args>(__args)...),
380 template <typename _Obj>
381 std::pair<iterator, bool>
382 insert_or_assign(const key_type& __k, _Obj&& __obj)
384 auto __res = _Base::insert_or_assign(__k,
385 std::forward<_Obj>(__obj));
386 return { iterator(__res.first, this), __res.second };
389 template <typename _Obj>
390 std::pair<iterator, bool>
391 insert_or_assign(key_type&& __k, _Obj&& __obj)
393 auto __res = _Base::insert_or_assign(std::move(__k),
394 std::forward<_Obj>(__obj));
395 return { iterator(__res.first, this), __res.second };
398 template <typename _Obj>
400 insert_or_assign(const_iterator __hint,
401 const key_type& __k, _Obj&& __obj)
403 __glibcxx_check_insert(__hint);
404 return iterator(_Base::insert_or_assign(__hint.base(), __k,
405 std::forward<_Obj>(__obj)),
409 template <typename _Obj>
411 insert_or_assign(const_iterator __hint, key_type&& __k, _Obj&& __obj)
413 __glibcxx_check_insert(__hint);
414 return iterator(_Base::insert_or_assign(__hint.base(),
416 std::forward<_Obj>(__obj)),
421 #if __cplusplus > 201402L
422 using node_type = typename _Base::node_type;
423 using insert_return_type = _Node_insert_return<iterator, node_type>;
426 extract(const_iterator __position)
428 __glibcxx_check_erase(__position);
429 this->_M_invalidate_if(_Equal(__position.base()));
430 return _Base::extract(__position.base());
434 extract(const key_type& __key)
436 const auto __position = find(__key);
437 if (__position != end())
438 return extract(__position);
443 insert(node_type&& __nh)
445 auto __ret = _Base::insert(std::move(__nh));
446 iterator __pos = iterator(__ret.position, this);
447 return { __pos, __ret.inserted, std::move(__ret.node) };
451 insert(const_iterator __hint, node_type&& __nh)
453 __glibcxx_check_insert(__hint);
454 return iterator(_Base::insert(__hint.base(), std::move(__nh)), this);
460 #if __cplusplus >= 201103L
462 erase(const_iterator __position)
464 __glibcxx_check_erase(__position);
465 this->_M_invalidate_if(_Equal(__position.base()));
466 return iterator(_Base::erase(__position.base()), this);
470 erase(iterator __position)
471 { return erase(const_iterator(__position)); }
474 erase(iterator __position)
476 __glibcxx_check_erase(__position);
477 this->_M_invalidate_if(_Equal(__position.base()));
478 _Base::erase(__position.base());
483 erase(const key_type& __x)
485 _Base_iterator __victim = _Base::find(__x);
486 if (__victim == _Base::end())
490 this->_M_invalidate_if(_Equal(__victim));
491 _Base::erase(__victim);
496 #if __cplusplus >= 201103L
498 erase(const_iterator __first, const_iterator __last)
500 // _GLIBCXX_RESOLVE_LIB_DEFECTS
501 // 151. can't currently clear() empty container
502 __glibcxx_check_erase_range(__first, __last);
503 for (_Base_const_iterator __victim = __first.base();
504 __victim != __last.base(); ++__victim)
506 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
507 _M_message(__gnu_debug::__msg_valid_range)
508 ._M_iterator(__first, "first")
509 ._M_iterator(__last, "last"));
510 this->_M_invalidate_if(_Equal(__victim));
512 return iterator(_Base::erase(__first.base(), __last.base()), this);
516 erase(iterator __first, iterator __last)
518 // _GLIBCXX_RESOLVE_LIB_DEFECTS
519 // 151. can't currently clear() empty container
520 __glibcxx_check_erase_range(__first, __last);
521 for (_Base_iterator __victim = __first.base();
522 __victim != __last.base(); ++__victim)
524 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
525 _M_message(__gnu_debug::__msg_valid_range)
526 ._M_iterator(__first, "first")
527 ._M_iterator(__last, "last"));
528 this->_M_invalidate_if(_Equal(__victim));
530 _Base::erase(__first.base(), __last.base());
536 _GLIBCXX_NOEXCEPT_IF( noexcept(declval<_Base&>().swap(__x)) )
543 clear() _GLIBCXX_NOEXCEPT
545 this->_M_invalidate_all();
550 using _Base::key_comp;
551 using _Base::value_comp;
553 // 23.3.1.3 map operations:
555 find(const key_type& __x)
556 { return iterator(_Base::find(__x), this); }
558 #if __cplusplus > 201103L
559 template<typename _Kt,
561 typename __has_is_transparent<_Compare, _Kt>::type>
564 { return { _Base::find(__x), this }; }
568 find(const key_type& __x) const
569 { return const_iterator(_Base::find(__x), this); }
571 #if __cplusplus > 201103L
572 template<typename _Kt,
574 typename __has_is_transparent<_Compare, _Kt>::type>
576 find(const _Kt& __x) const
577 { return { _Base::find(__x), this }; }
583 lower_bound(const key_type& __x)
584 { return iterator(_Base::lower_bound(__x), this); }
586 #if __cplusplus > 201103L
587 template<typename _Kt,
589 typename __has_is_transparent<_Compare, _Kt>::type>
591 lower_bound(const _Kt& __x)
592 { return { _Base::lower_bound(__x), this }; }
596 lower_bound(const key_type& __x) const
597 { return const_iterator(_Base::lower_bound(__x), this); }
599 #if __cplusplus > 201103L
600 template<typename _Kt,
602 typename __has_is_transparent<_Compare, _Kt>::type>
604 lower_bound(const _Kt& __x) const
605 { return { _Base::lower_bound(__x), this }; }
609 upper_bound(const key_type& __x)
610 { return iterator(_Base::upper_bound(__x), this); }
612 #if __cplusplus > 201103L
613 template<typename _Kt,
615 typename __has_is_transparent<_Compare, _Kt>::type>
617 upper_bound(const _Kt& __x)
618 { return { _Base::upper_bound(__x), this }; }
622 upper_bound(const key_type& __x) const
623 { return const_iterator(_Base::upper_bound(__x), this); }
625 #if __cplusplus > 201103L
626 template<typename _Kt,
628 typename __has_is_transparent<_Compare, _Kt>::type>
630 upper_bound(const _Kt& __x) const
631 { return { _Base::upper_bound(__x), this }; }
634 std::pair<iterator,iterator>
635 equal_range(const key_type& __x)
637 std::pair<_Base_iterator, _Base_iterator> __res =
638 _Base::equal_range(__x);
639 return std::make_pair(iterator(__res.first, this),
640 iterator(__res.second, this));
643 #if __cplusplus > 201103L
644 template<typename _Kt,
646 typename __has_is_transparent<_Compare, _Kt>::type>
647 std::pair<iterator, iterator>
648 equal_range(const _Kt& __x)
650 auto __res = _Base::equal_range(__x);
651 return { { __res.first, this }, { __res.second, this } };
655 std::pair<const_iterator,const_iterator>
656 equal_range(const key_type& __x) const
658 std::pair<_Base_const_iterator, _Base_const_iterator> __res =
659 _Base::equal_range(__x);
660 return std::make_pair(const_iterator(__res.first, this),
661 const_iterator(__res.second, this));
664 #if __cplusplus > 201103L
665 template<typename _Kt,
667 typename __has_is_transparent<_Compare, _Kt>::type>
668 std::pair<const_iterator, const_iterator>
669 equal_range(const _Kt& __x) const
671 auto __res = _Base::equal_range(__x);
672 return { { __res.first, this }, { __res.second, this } };
677 _M_base() _GLIBCXX_NOEXCEPT { return *this; }
680 _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
683 #if __cpp_deduction_guides >= 201606
685 template<typename _InputIterator,
686 typename _Compare = less<__iter_key_t<_InputIterator>>,
687 typename _Allocator = allocator<__iter_to_alloc_t<_InputIterator>>,
688 typename = _RequireInputIter<_InputIterator>,
689 typename = _RequireAllocator<_Allocator>>
690 map(_InputIterator, _InputIterator,
691 _Compare = _Compare(), _Allocator = _Allocator())
692 -> map<__iter_key_t<_InputIterator>, __iter_val_t<_InputIterator>,
693 _Compare, _Allocator>;
695 template<typename _Key, typename _Tp, typename _Compare = less<_Key>,
696 typename _Allocator = allocator<pair<const _Key, _Tp>>,
697 typename = _RequireAllocator<_Allocator>>
698 map(initializer_list<pair<_Key, _Tp>>,
699 _Compare = _Compare(), _Allocator = _Allocator())
700 -> map<_Key, _Tp, _Compare, _Allocator>;
702 template <typename _InputIterator, typename _Allocator,
703 typename = _RequireInputIter<_InputIterator>,
704 typename = _RequireAllocator<_Allocator>>
705 map(_InputIterator, _InputIterator, _Allocator)
706 -> map<__iter_key_t<_InputIterator>, __iter_val_t<_InputIterator>,
707 less<__iter_key_t<_InputIterator>>, _Allocator>;
709 template<typename _Key, typename _Tp, typename _Allocator,
710 typename = _RequireAllocator<_Allocator>>
711 map(initializer_list<pair<_Key, _Tp>>, _Allocator)
712 -> map<_Key, _Tp, less<_Key>, _Allocator>;
716 template<typename _Key, typename _Tp,
717 typename _Compare, typename _Allocator>
719 operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
720 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
721 { return __lhs._M_base() == __rhs._M_base(); }
723 template<typename _Key, typename _Tp,
724 typename _Compare, typename _Allocator>
726 operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
727 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
728 { return __lhs._M_base() != __rhs._M_base(); }
730 template<typename _Key, typename _Tp,
731 typename _Compare, typename _Allocator>
733 operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
734 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
735 { return __lhs._M_base() < __rhs._M_base(); }
737 template<typename _Key, typename _Tp,
738 typename _Compare, typename _Allocator>
740 operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
741 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
742 { return __lhs._M_base() <= __rhs._M_base(); }
744 template<typename _Key, typename _Tp,
745 typename _Compare, typename _Allocator>
747 operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
748 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
749 { return __lhs._M_base() >= __rhs._M_base(); }
751 template<typename _Key, typename _Tp,
752 typename _Compare, typename _Allocator>
754 operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
755 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
756 { return __lhs._M_base() > __rhs._M_base(); }
758 template<typename _Key, typename _Tp,
759 typename _Compare, typename _Allocator>
761 swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs,
762 map<_Key, _Tp, _Compare, _Allocator>& __rhs)
763 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))
764 { __lhs.swap(__rhs); }
766 } // namespace __debug