1 // Debugging multimap 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/>.
25 /** @file debug/multimap.h
26 * This file is a GNU debug extension to the Standard C++ Library.
29 #ifndef _GLIBCXX_DEBUG_MULTIMAP_H
30 #define _GLIBCXX_DEBUG_MULTIMAP_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::multimap 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 multimap
<_Key
, _Tp
, _Compare
, _Allocator
>, _Allocator
,
47 __gnu_debug::_Safe_node_sequence
>,
48 public _GLIBCXX_STD_C::multimap
<_Key
, _Tp
, _Compare
, _Allocator
>
50 typedef _GLIBCXX_STD_C::multimap
<
51 _Key
, _Tp
, _Compare
, _Allocator
> _Base
;
52 typedef __gnu_debug::_Safe_container
<
53 multimap
, _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
, multimap
>
71 typedef __gnu_debug::_Safe_iterator
<_Base_const_iterator
,
72 multimap
> const_iterator
;
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
84 multimap() : _Base() { }
86 multimap(const multimap
& __x
)
92 multimap(const multimap
&) = default;
93 multimap(multimap
&&) = default;
95 multimap(initializer_list
<value_type
> __l
,
96 const _Compare
& __c
= _Compare(),
97 const allocator_type
& __a
= allocator_type())
98 : _Base(__l
, __c
, __a
) { }
101 multimap(const allocator_type
& __a
)
104 multimap(const multimap
& __m
, const allocator_type
& __a
)
105 : _Base(__m
, __a
) { }
107 multimap(multimap
&& __m
, const allocator_type
& __a
)
108 : _Safe(std::move(__m
._M_safe()), __a
),
109 _Base(std::move(__m
._M_base()), __a
) { }
111 multimap(initializer_list
<value_type
> __l
, const allocator_type
& __a
)
112 : _Base(__l
, __a
) { }
114 template<typename _InputIterator
>
115 multimap(_InputIterator __first
, _InputIterator __last
,
116 const allocator_type
& __a
)
117 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first
,
119 __gnu_debug::__base(__last
), __a
) { }
121 ~multimap() = default;
124 explicit multimap(const _Compare
& __comp
,
125 const _Allocator
& __a
= _Allocator())
126 : _Base(__comp
, __a
) { }
128 template<typename _InputIterator
>
129 multimap(_InputIterator __first
, _InputIterator __last
,
130 const _Compare
& __comp
= _Compare(),
131 const _Allocator
& __a
= _Allocator())
132 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first
,
134 __gnu_debug::__base(__last
),
137 multimap(const _Base
& __x
)
140 #if __cplusplus < 201103L
142 operator=(const multimap
& __x
)
144 this->_M_safe() = __x
;
150 operator=(const multimap
&) = default;
153 operator=(multimap
&&) = default;
156 operator=(initializer_list
<value_type
> __l
)
159 this->_M_invalidate_all();
164 using _Base::get_allocator
;
168 begin() _GLIBCXX_NOEXCEPT
169 { return iterator(_Base::begin(), this); }
172 begin() const _GLIBCXX_NOEXCEPT
173 { return const_iterator(_Base::begin(), this); }
176 end() _GLIBCXX_NOEXCEPT
177 { return iterator(_Base::end(), this); }
180 end() const _GLIBCXX_NOEXCEPT
181 { return const_iterator(_Base::end(), this); }
184 rbegin() _GLIBCXX_NOEXCEPT
185 { return reverse_iterator(end()); }
187 const_reverse_iterator
188 rbegin() const _GLIBCXX_NOEXCEPT
189 { return const_reverse_iterator(end()); }
192 rend() _GLIBCXX_NOEXCEPT
193 { return reverse_iterator(begin()); }
195 const_reverse_iterator
196 rend() const _GLIBCXX_NOEXCEPT
197 { return const_reverse_iterator(begin()); }
199 #if __cplusplus >= 201103L
201 cbegin() const noexcept
202 { return const_iterator(_Base::begin(), this); }
205 cend() const noexcept
206 { return const_iterator(_Base::end(), this); }
208 const_reverse_iterator
209 crbegin() const noexcept
210 { return const_reverse_iterator(end()); }
212 const_reverse_iterator
213 crend() const noexcept
214 { return const_reverse_iterator(begin()); }
220 using _Base::max_size
;
223 #if __cplusplus >= 201103L
224 template<typename
... _Args
>
226 emplace(_Args
&&... __args
)
228 return iterator(_Base::emplace(std::forward
<_Args
>(__args
)...), this);
231 template<typename
... _Args
>
233 emplace_hint(const_iterator __pos
, _Args
&&... __args
)
235 __glibcxx_check_insert(__pos
);
236 return iterator(_Base::emplace_hint(__pos
.base(),
237 std::forward
<_Args
>(__args
)...),
243 insert(const value_type
& __x
)
244 { return iterator(_Base::insert(__x
), this); }
246 #if __cplusplus >= 201103L
247 // _GLIBCXX_RESOLVE_LIB_DEFECTS
248 // 2354. Unnecessary copying when inserting into maps with braced-init
250 insert(value_type
&& __x
)
251 { return { _Base::insert(std::move(__x
)), this }; }
253 template<typename _Pair
, typename
= typename
254 std::enable_if
<std::is_constructible
<value_type
,
255 _Pair
&&>::value
>::type
>
258 { return iterator(_Base::insert(std::forward
<_Pair
>(__x
)), this); }
261 #if __cplusplus >= 201103L
263 insert(std::initializer_list
<value_type
> __list
)
264 { _Base::insert(__list
); }
268 #if __cplusplus >= 201103L
269 insert(const_iterator __position
, const value_type
& __x
)
271 insert(iterator __position
, const value_type
& __x
)
274 __glibcxx_check_insert(__position
);
275 return iterator(_Base::insert(__position
.base(), __x
), this);
278 #if __cplusplus >= 201103L
279 // _GLIBCXX_RESOLVE_LIB_DEFECTS
280 // 2354. Unnecessary copying when inserting into maps with braced-init
282 insert(const_iterator __position
, value_type
&& __x
)
284 __glibcxx_check_insert(__position
);
285 return { _Base::insert(__position
.base(), std::move(__x
)), this };
288 template<typename _Pair
, typename
= typename
289 std::enable_if
<std::is_constructible
<value_type
,
290 _Pair
&&>::value
>::type
>
292 insert(const_iterator __position
, _Pair
&& __x
)
294 __glibcxx_check_insert(__position
);
295 return iterator(_Base::insert(__position
.base(),
296 std::forward
<_Pair
>(__x
)), this);
300 template<typename _InputIterator
>
302 insert(_InputIterator __first
, _InputIterator __last
)
304 typename
__gnu_debug::_Distance_traits
<_InputIterator
>::__type __dist
;
305 __glibcxx_check_valid_range2(__first
, __last
, __dist
);
307 if (__dist
.second
>= __gnu_debug::__dp_sign
)
308 _Base::insert(__gnu_debug::__unsafe(__first
),
309 __gnu_debug::__unsafe(__last
));
311 _Base::insert(__first
, __last
);
314 #if __cplusplus > 201402L
315 using node_type
= typename
_Base::node_type
;
318 extract(const_iterator __position
)
320 __glibcxx_check_erase(__position
);
321 this->_M_invalidate_if(_Equal(__position
.base()));
322 return _Base::extract(__position
.base());
326 extract(const key_type
& __key
)
328 const auto __position
= find(__key
);
329 if (__position
!= end())
330 return extract(__position
);
335 insert(node_type
&& __nh
)
336 { return iterator(_Base::insert(std::move(__nh
)), this); }
339 insert(const_iterator __hint
, node_type
&& __nh
)
341 __glibcxx_check_insert(__hint
);
342 return iterator(_Base::insert(__hint
.base(), std::move(__nh
)), this);
348 #if __cplusplus >= 201103L
350 erase(const_iterator __position
)
352 __glibcxx_check_erase(__position
);
353 this->_M_invalidate_if(_Equal(__position
.base()));
354 return iterator(_Base::erase(__position
.base()), this);
358 erase(iterator __position
)
359 { return erase(const_iterator(__position
)); }
362 erase(iterator __position
)
364 __glibcxx_check_erase(__position
);
365 this->_M_invalidate_if(_Equal(__position
.base()));
366 _Base::erase(__position
.base());
371 erase(const key_type
& __x
)
373 std::pair
<_Base_iterator
, _Base_iterator
> __victims
=
374 _Base::equal_range(__x
);
375 size_type __count
= 0;
376 _Base_iterator __victim
= __victims
.first
;
377 while (__victim
!= __victims
.second
)
379 this->_M_invalidate_if(_Equal(__victim
));
380 _Base::erase(__victim
++);
386 #if __cplusplus >= 201103L
388 erase(const_iterator __first
, const_iterator __last
)
390 // _GLIBCXX_RESOLVE_LIB_DEFECTS
391 // 151. can't currently clear() empty container
392 __glibcxx_check_erase_range(__first
, __last
);
393 for (_Base_const_iterator __victim
= __first
.base();
394 __victim
!= __last
.base(); ++__victim
)
396 _GLIBCXX_DEBUG_VERIFY(__victim
!= _Base::end(),
397 _M_message(__gnu_debug::__msg_valid_range
)
398 ._M_iterator(__first
, "first")
399 ._M_iterator(__last
, "last"));
400 this->_M_invalidate_if(_Equal(__victim
));
402 return iterator(_Base::erase(__first
.base(), __last
.base()), this);
406 erase(iterator __first
, iterator __last
)
408 // _GLIBCXX_RESOLVE_LIB_DEFECTS
409 // 151. can't currently clear() empty container
410 __glibcxx_check_erase_range(__first
, __last
);
411 for (_Base_iterator __victim
= __first
.base();
412 __victim
!= __last
.base(); ++__victim
)
414 _GLIBCXX_DEBUG_VERIFY(__victim
!= _Base::end(),
415 _M_message(__gnu_debug::__msg_valid_range
)
416 ._M_iterator(__first
, "first")
417 ._M_iterator(__last
, "last"));
418 this->_M_invalidate_if(_Equal(__victim
));
420 _Base::erase(__first
.base(), __last
.base());
426 _GLIBCXX_NOEXCEPT_IF( noexcept(declval
<_Base
&>().swap(__x
)) )
433 clear() _GLIBCXX_NOEXCEPT
435 this->_M_invalidate_all();
440 using _Base::key_comp
;
441 using _Base::value_comp
;
443 // 23.3.1.3 multimap operations:
445 find(const key_type
& __x
)
446 { return iterator(_Base::find(__x
), this); }
448 #if __cplusplus > 201103L
449 template<typename _Kt
,
451 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
454 { return { _Base::find(__x
), this }; }
458 find(const key_type
& __x
) const
459 { return const_iterator(_Base::find(__x
), this); }
461 #if __cplusplus > 201103L
462 template<typename _Kt
,
464 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
466 find(const _Kt
& __x
) const
467 { return { _Base::find(__x
), this }; }
473 lower_bound(const key_type
& __x
)
474 { return iterator(_Base::lower_bound(__x
), this); }
476 #if __cplusplus > 201103L
477 template<typename _Kt
,
479 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
481 lower_bound(const _Kt
& __x
)
482 { return { _Base::lower_bound(__x
), this }; }
486 lower_bound(const key_type
& __x
) const
487 { return const_iterator(_Base::lower_bound(__x
), this); }
489 #if __cplusplus > 201103L
490 template<typename _Kt
,
492 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
494 lower_bound(const _Kt
& __x
) const
495 { return { _Base::lower_bound(__x
), this }; }
499 upper_bound(const key_type
& __x
)
500 { return iterator(_Base::upper_bound(__x
), this); }
502 #if __cplusplus > 201103L
503 template<typename _Kt
,
505 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
507 upper_bound(const _Kt
& __x
)
508 { return { _Base::upper_bound(__x
), this }; }
512 upper_bound(const key_type
& __x
) const
513 { return const_iterator(_Base::upper_bound(__x
), this); }
515 #if __cplusplus > 201103L
516 template<typename _Kt
,
518 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
520 upper_bound(const _Kt
& __x
) const
521 { return { _Base::upper_bound(__x
), this }; }
524 std::pair
<iterator
,iterator
>
525 equal_range(const key_type
& __x
)
527 std::pair
<_Base_iterator
, _Base_iterator
> __res
=
528 _Base::equal_range(__x
);
529 return std::make_pair(iterator(__res
.first
, this),
530 iterator(__res
.second
, this));
533 #if __cplusplus > 201103L
534 template<typename _Kt
,
536 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
537 std::pair
<iterator
, iterator
>
538 equal_range(const _Kt
& __x
)
540 auto __res
= _Base::equal_range(__x
);
541 return { { __res
.first
, this }, { __res
.second
, this } };
545 std::pair
<const_iterator
,const_iterator
>
546 equal_range(const key_type
& __x
) const
548 std::pair
<_Base_const_iterator
, _Base_const_iterator
> __res
=
549 _Base::equal_range(__x
);
550 return std::make_pair(const_iterator(__res
.first
, this),
551 const_iterator(__res
.second
, this));
554 #if __cplusplus > 201103L
555 template<typename _Kt
,
557 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
558 std::pair
<const_iterator
, const_iterator
>
559 equal_range(const _Kt
& __x
) const
561 auto __res
= _Base::equal_range(__x
);
562 return { { __res
.first
, this }, { __res
.second
, this } };
567 _M_base() _GLIBCXX_NOEXCEPT
{ return *this; }
570 _M_base() const _GLIBCXX_NOEXCEPT
{ return *this; }
573 #if __cpp_deduction_guides >= 201606
575 template<typename _InputIterator
,
576 typename _Compare
= less
<__iter_key_t
<_InputIterator
>>,
577 typename _Allocator
= allocator
<__iter_to_alloc_t
<_InputIterator
>>,
578 typename
= _RequireInputIter
<_InputIterator
>,
579 typename
= _RequireAllocator
<_Allocator
>>
580 multimap(_InputIterator
, _InputIterator
,
581 _Compare
= _Compare(), _Allocator
= _Allocator())
582 -> multimap
<__iter_key_t
<_InputIterator
>, __iter_val_t
<_InputIterator
>,
583 _Compare
, _Allocator
>;
585 template<typename _Key
, typename _Tp
, typename _Compare
= less
<_Key
>,
586 typename _Allocator
= allocator
<pair
<const _Key
, _Tp
>>,
587 typename
= _RequireAllocator
<_Allocator
>>
588 multimap(initializer_list
<pair
<_Key
, _Tp
>>,
589 _Compare
= _Compare(), _Allocator
= _Allocator())
590 -> multimap
<_Key
, _Tp
, _Compare
, _Allocator
>;
592 template<typename _InputIterator
, typename _Allocator
,
593 typename
= _RequireInputIter
<_InputIterator
>,
594 typename
= _RequireAllocator
<_Allocator
>>
595 multimap(_InputIterator
, _InputIterator
, _Allocator
)
596 -> multimap
<__iter_key_t
<_InputIterator
>, __iter_val_t
<_InputIterator
>,
597 less
<__iter_key_t
<_InputIterator
>>, _Allocator
>;
599 template<typename _Key
, typename _Tp
, typename _Allocator
,
600 typename
= _RequireAllocator
<_Allocator
>>
601 multimap(initializer_list
<pair
<_Key
, _Tp
>>, _Allocator
)
602 -> multimap
<_Key
, _Tp
, less
<_Key
>, _Allocator
>;
606 template<typename _Key
, typename _Tp
,
607 typename _Compare
, typename _Allocator
>
609 operator==(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
610 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
611 { return __lhs
._M_base() == __rhs
._M_base(); }
613 template<typename _Key
, typename _Tp
,
614 typename _Compare
, typename _Allocator
>
616 operator!=(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
617 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
618 { return __lhs
._M_base() != __rhs
._M_base(); }
620 template<typename _Key
, typename _Tp
,
621 typename _Compare
, typename _Allocator
>
623 operator<(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
624 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
625 { return __lhs
._M_base() < __rhs
._M_base(); }
627 template<typename _Key
, typename _Tp
,
628 typename _Compare
, typename _Allocator
>
630 operator<=(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
631 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
632 { return __lhs
._M_base() <= __rhs
._M_base(); }
634 template<typename _Key
, typename _Tp
,
635 typename _Compare
, typename _Allocator
>
637 operator>=(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
638 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
639 { return __lhs
._M_base() >= __rhs
._M_base(); }
641 template<typename _Key
, typename _Tp
,
642 typename _Compare
, typename _Allocator
>
644 operator>(const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
645 const multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
646 { return __lhs
._M_base() > __rhs
._M_base(); }
648 template<typename _Key
, typename _Tp
,
649 typename _Compare
, typename _Allocator
>
651 swap(multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
652 multimap
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
653 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs
.swap(__rhs
)))
654 { __lhs
.swap(__rhs
); }
656 } // namespace __debug