S/390: Add static OSC breaker if necessary.
[official-gcc.git] / libstdc++-v3 / include / debug / map.h
blob51cd140a1227835c4e15769e5cc24eb9243250e5
1 // Debugging map implementation -*- C++ -*-
3 // Copyright (C) 2003-2016 Free Software Foundation, Inc.
4 //
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)
9 // any later version.
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/map.h
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>
35 #include <utility>
37 namespace std _GLIBCXX_VISIBILITY(default)
39 namespace __debug
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> > >
44 class map
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;
59 public:
60 // types:
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>
70 iterator;
71 typedef __gnu_debug::_Safe_iterator<_Base_const_iterator, map>
72 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 map() : _Base() { }
86 map(const map& __x)
87 : _Base(__x) { }
89 ~map() { }
90 #else
91 map() = default;
92 map(const map&) = default;
93 map(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) { }
100 explicit
101 map(const allocator_type& __a)
102 : _Base(__a) { }
104 map(const map& __m, const allocator_type& __a)
105 : _Base(__m, __a) { }
107 map(map&& __m, const allocator_type& __a)
108 : _Safe(std::move(__m._M_safe()), __a),
109 _Base(std::move(__m._M_base()), __a) { }
111 map(initializer_list<value_type> __l, const allocator_type& __a)
112 : _Base(__l, __a) { }
114 template<typename _InputIterator>
115 map(_InputIterator __first, _InputIterator __last,
116 const allocator_type& __a)
117 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
118 __last)),
119 __gnu_debug::__base(__last), __a)
122 ~map() = default;
123 #endif
125 map(const _Base& __x)
126 : _Base(__x) { }
128 explicit map(const _Compare& __comp,
129 const _Allocator& __a = _Allocator())
130 : _Base(__comp, __a) { }
132 template<typename _InputIterator>
133 map(_InputIterator __first, _InputIterator __last,
134 const _Compare& __comp = _Compare(),
135 const _Allocator& __a = _Allocator())
136 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
137 __last)),
138 __gnu_debug::__base(__last),
139 __comp, __a) { }
141 #if __cplusplus < 201103L
142 map&
143 operator=(const map& __x)
145 this->_M_safe() = __x;
146 _M_base() = __x;
147 return *this;
149 #else
150 map&
151 operator=(const map&) = default;
153 map&
154 operator=(map&&) = default;
156 map&
157 operator=(initializer_list<value_type> __l)
159 _M_base() = __l;
160 this->_M_invalidate_all();
161 return *this;
163 #endif
165 // _GLIBCXX_RESOLVE_LIB_DEFECTS
166 // 133. map missing get_allocator()
167 using _Base::get_allocator;
169 // iterators:
170 iterator
171 begin() _GLIBCXX_NOEXCEPT
172 { return iterator(_Base::begin(), this); }
174 const_iterator
175 begin() const _GLIBCXX_NOEXCEPT
176 { return const_iterator(_Base::begin(), this); }
178 iterator
179 end() _GLIBCXX_NOEXCEPT
180 { return iterator(_Base::end(), this); }
182 const_iterator
183 end() const _GLIBCXX_NOEXCEPT
184 { return const_iterator(_Base::end(), this); }
186 reverse_iterator
187 rbegin() _GLIBCXX_NOEXCEPT
188 { return reverse_iterator(end()); }
190 const_reverse_iterator
191 rbegin() const _GLIBCXX_NOEXCEPT
192 { return const_reverse_iterator(end()); }
194 reverse_iterator
195 rend() _GLIBCXX_NOEXCEPT
196 { return reverse_iterator(begin()); }
198 const_reverse_iterator
199 rend() const _GLIBCXX_NOEXCEPT
200 { return const_reverse_iterator(begin()); }
202 #if __cplusplus >= 201103L
203 const_iterator
204 cbegin() const noexcept
205 { return const_iterator(_Base::begin(), this); }
207 const_iterator
208 cend() const noexcept
209 { return const_iterator(_Base::end(), this); }
211 const_reverse_iterator
212 crbegin() const noexcept
213 { return const_reverse_iterator(end()); }
215 const_reverse_iterator
216 crend() const noexcept
217 { return const_reverse_iterator(begin()); }
218 #endif
220 // capacity:
221 using _Base::empty;
222 using _Base::size;
223 using _Base::max_size;
225 // 23.3.1.2 element access:
226 using _Base::operator[];
228 // _GLIBCXX_RESOLVE_LIB_DEFECTS
229 // DR 464. Suggestion for new member functions in standard containers.
230 using _Base::at;
232 // modifiers:
233 #if __cplusplus >= 201103L
234 template<typename... _Args>
235 std::pair<iterator, bool>
236 emplace(_Args&&... __args)
238 auto __res = _Base::emplace(std::forward<_Args>(__args)...);
239 return std::pair<iterator, bool>(iterator(__res.first, this),
240 __res.second);
243 template<typename... _Args>
244 iterator
245 emplace_hint(const_iterator __pos, _Args&&... __args)
247 __glibcxx_check_insert(__pos);
248 return iterator(_Base::emplace_hint(__pos.base(),
249 std::forward<_Args>(__args)...),
250 this);
252 #endif
254 std::pair<iterator, bool>
255 insert(const value_type& __x)
257 std::pair<_Base_iterator, bool> __res = _Base::insert(__x);
258 return std::pair<iterator, bool>(iterator(__res.first, this),
259 __res.second);
262 #if __cplusplus >= 201103L
263 template<typename _Pair, typename = typename
264 std::enable_if<std::is_constructible<value_type,
265 _Pair&&>::value>::type>
266 std::pair<iterator, bool>
267 insert(_Pair&& __x)
269 std::pair<_Base_iterator, bool> __res
270 = _Base::insert(std::forward<_Pair>(__x));
271 return std::pair<iterator, bool>(iterator(__res.first, this),
272 __res.second);
274 #endif
276 #if __cplusplus >= 201103L
277 void
278 insert(std::initializer_list<value_type> __list)
279 { _Base::insert(__list); }
280 #endif
282 iterator
283 #if __cplusplus >= 201103L
284 insert(const_iterator __position, const value_type& __x)
285 #else
286 insert(iterator __position, const value_type& __x)
287 #endif
289 __glibcxx_check_insert(__position);
290 return iterator(_Base::insert(__position.base(), __x), this);
293 #if __cplusplus >= 201103L
294 template<typename _Pair, typename = typename
295 std::enable_if<std::is_constructible<value_type,
296 _Pair&&>::value>::type>
297 iterator
298 insert(const_iterator __position, _Pair&& __x)
300 __glibcxx_check_insert(__position);
301 return iterator(_Base::insert(__position.base(),
302 std::forward<_Pair>(__x)), this);
304 #endif
306 template<typename _InputIterator>
307 void
308 insert(_InputIterator __first, _InputIterator __last)
310 typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
311 __glibcxx_check_valid_range2(__first, __last, __dist);
313 if (__dist.second >= __gnu_debug::__dp_sign)
314 _Base::insert(__gnu_debug::__unsafe(__first),
315 __gnu_debug::__unsafe(__last));
316 else
317 _Base::insert(__first, __last);
321 #if __cplusplus > 201402L
322 template <typename... _Args>
323 pair<iterator, bool>
324 try_emplace(const key_type& __k, _Args&&... __args)
326 auto __res = _Base::try_emplace(__k,
327 std::forward<_Args>(__args)...);
328 return { iterator(__res.first, this), __res.second };
331 template <typename... _Args>
332 pair<iterator, bool>
333 try_emplace(key_type&& __k, _Args&&... __args)
335 auto __res = _Base::try_emplace(std::move(__k),
336 std::forward<_Args>(__args)...);
337 return { iterator(__res.first, this), __res.second };
340 template <typename... _Args>
341 iterator
342 try_emplace(const_iterator __hint, const key_type& __k,
343 _Args&&... __args)
345 __glibcxx_check_insert(__hint);
346 return iterator(_Base::try_emplace(__hint.base(), __k,
347 std::forward<_Args>(__args)...),
348 this);
351 template <typename... _Args>
352 iterator
353 try_emplace(const_iterator __hint, key_type&& __k, _Args&&... __args)
355 __glibcxx_check_insert(__hint);
356 return iterator(_Base::try_emplace(__hint.base(), std::move(__k),
357 std::forward<_Args>(__args)...),
358 this);
361 template <typename _Obj>
362 std::pair<iterator, bool>
363 insert_or_assign(const key_type& __k, _Obj&& __obj)
365 auto __res = _Base::insert_or_assign(__k,
366 std::forward<_Obj>(__obj));
367 return { iterator(__res.first, this), __res.second };
370 template <typename _Obj>
371 std::pair<iterator, bool>
372 insert_or_assign(key_type&& __k, _Obj&& __obj)
374 auto __res = _Base::insert_or_assign(std::move(__k),
375 std::forward<_Obj>(__obj));
376 return { iterator(__res.first, this), __res.second };
379 template <typename _Obj>
380 iterator
381 insert_or_assign(const_iterator __hint,
382 const key_type& __k, _Obj&& __obj)
384 __glibcxx_check_insert(__hint);
385 return iterator(_Base::insert_or_assign(__hint.base(), __k,
386 std::forward<_Obj>(__obj)),
387 this);
390 template <typename _Obj>
391 iterator
392 insert_or_assign(const_iterator __hint, key_type&& __k, _Obj&& __obj)
394 __glibcxx_check_insert(__hint);
395 return iterator(_Base::insert_or_assign(__hint.base(),
396 std::move(__k),
397 std::forward<_Obj>(__obj)),
398 this);
400 #endif // C++17
402 #if __cplusplus > 201402L
403 using node_type = typename _Base::node_type;
405 struct insert_return_type
407 bool inserted;
408 iterator position;
409 node_type node;
412 node_type
413 extract(const_iterator __position)
415 __glibcxx_check_erase(__position);
416 this->_M_invalidate_if(_Equal(__position.base()));
417 return _Base::extract(__position.base());
420 node_type
421 extract(const key_type& __key)
423 const auto __position = find(__key);
424 if (__position != end())
425 return extract(__position);
426 return {};
429 insert_return_type
430 insert(node_type&& __nh)
432 auto __ret = _Base::insert(std::move(__nh));
433 iterator __pos = iterator(__ret.position, this);
434 return { __ret.inserted, __pos, std::move(__ret.node) };
437 iterator
438 insert(const_iterator __hint, node_type&& __nh)
440 __glibcxx_check_insert(__hint);
441 return iterator(_Base::insert(__hint.base(), std::move(__nh)), this);
444 using _Base::merge;
445 #endif // C++17
447 #if __cplusplus >= 201103L
448 iterator
449 erase(const_iterator __position)
451 __glibcxx_check_erase(__position);
452 this->_M_invalidate_if(_Equal(__position.base()));
453 return iterator(_Base::erase(__position.base()), this);
456 iterator
457 erase(iterator __position)
458 { return erase(const_iterator(__position)); }
459 #else
460 void
461 erase(iterator __position)
463 __glibcxx_check_erase(__position);
464 this->_M_invalidate_if(_Equal(__position.base()));
465 _Base::erase(__position.base());
467 #endif
469 size_type
470 erase(const key_type& __x)
472 _Base_iterator __victim = _Base::find(__x);
473 if (__victim == _Base::end())
474 return 0;
475 else
477 this->_M_invalidate_if(_Equal(__victim));
478 _Base::erase(__victim);
479 return 1;
483 #if __cplusplus >= 201103L
484 iterator
485 erase(const_iterator __first, const_iterator __last)
487 // _GLIBCXX_RESOLVE_LIB_DEFECTS
488 // 151. can't currently clear() empty container
489 __glibcxx_check_erase_range(__first, __last);
490 for (_Base_const_iterator __victim = __first.base();
491 __victim != __last.base(); ++__victim)
493 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
494 _M_message(__gnu_debug::__msg_valid_range)
495 ._M_iterator(__first, "first")
496 ._M_iterator(__last, "last"));
497 this->_M_invalidate_if(_Equal(__victim));
499 return iterator(_Base::erase(__first.base(), __last.base()), this);
501 #else
502 void
503 erase(iterator __first, iterator __last)
505 // _GLIBCXX_RESOLVE_LIB_DEFECTS
506 // 151. can't currently clear() empty container
507 __glibcxx_check_erase_range(__first, __last);
508 for (_Base_iterator __victim = __first.base();
509 __victim != __last.base(); ++__victim)
511 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
512 _M_message(__gnu_debug::__msg_valid_range)
513 ._M_iterator(__first, "first")
514 ._M_iterator(__last, "last"));
515 this->_M_invalidate_if(_Equal(__victim));
517 _Base::erase(__first.base(), __last.base());
519 #endif
521 void
522 swap(map& __x)
523 _GLIBCXX_NOEXCEPT_IF( noexcept(declval<_Base&>().swap(__x)) )
525 _Safe::_M_swap(__x);
526 _Base::swap(__x);
529 void
530 clear() _GLIBCXX_NOEXCEPT
532 this->_M_invalidate_all();
533 _Base::clear();
536 // observers:
537 using _Base::key_comp;
538 using _Base::value_comp;
540 // 23.3.1.3 map operations:
541 iterator
542 find(const key_type& __x)
543 { return iterator(_Base::find(__x), this); }
545 #if __cplusplus > 201103L
546 template<typename _Kt,
547 typename _Req =
548 typename __has_is_transparent<_Compare, _Kt>::type>
549 iterator
550 find(const _Kt& __x)
551 { return { _Base::find(__x), this }; }
552 #endif
554 const_iterator
555 find(const key_type& __x) const
556 { return const_iterator(_Base::find(__x), this); }
558 #if __cplusplus > 201103L
559 template<typename _Kt,
560 typename _Req =
561 typename __has_is_transparent<_Compare, _Kt>::type>
562 const_iterator
563 find(const _Kt& __x) const
564 { return { _Base::find(__x), this }; }
565 #endif
567 using _Base::count;
569 iterator
570 lower_bound(const key_type& __x)
571 { return iterator(_Base::lower_bound(__x), this); }
573 #if __cplusplus > 201103L
574 template<typename _Kt,
575 typename _Req =
576 typename __has_is_transparent<_Compare, _Kt>::type>
577 iterator
578 lower_bound(const _Kt& __x)
579 { return { _Base::lower_bound(__x), this }; }
580 #endif
582 const_iterator
583 lower_bound(const key_type& __x) const
584 { return const_iterator(_Base::lower_bound(__x), this); }
586 #if __cplusplus > 201103L
587 template<typename _Kt,
588 typename _Req =
589 typename __has_is_transparent<_Compare, _Kt>::type>
590 const_iterator
591 lower_bound(const _Kt& __x) const
592 { return { _Base::lower_bound(__x), this }; }
593 #endif
595 iterator
596 upper_bound(const key_type& __x)
597 { return iterator(_Base::upper_bound(__x), this); }
599 #if __cplusplus > 201103L
600 template<typename _Kt,
601 typename _Req =
602 typename __has_is_transparent<_Compare, _Kt>::type>
603 iterator
604 upper_bound(const _Kt& __x)
605 { return { _Base::upper_bound(__x), this }; }
606 #endif
608 const_iterator
609 upper_bound(const key_type& __x) const
610 { return const_iterator(_Base::upper_bound(__x), this); }
612 #if __cplusplus > 201103L
613 template<typename _Kt,
614 typename _Req =
615 typename __has_is_transparent<_Compare, _Kt>::type>
616 const_iterator
617 upper_bound(const _Kt& __x) const
618 { return { _Base::upper_bound(__x), this }; }
619 #endif
621 std::pair<iterator,iterator>
622 equal_range(const key_type& __x)
624 std::pair<_Base_iterator, _Base_iterator> __res =
625 _Base::equal_range(__x);
626 return std::make_pair(iterator(__res.first, this),
627 iterator(__res.second, this));
630 #if __cplusplus > 201103L
631 template<typename _Kt,
632 typename _Req =
633 typename __has_is_transparent<_Compare, _Kt>::type>
634 std::pair<iterator, iterator>
635 equal_range(const _Kt& __x)
637 auto __res = _Base::equal_range(__x);
638 return { { __res.first, this }, { __res.second, this } };
640 #endif
642 std::pair<const_iterator,const_iterator>
643 equal_range(const key_type& __x) const
645 std::pair<_Base_const_iterator, _Base_const_iterator> __res =
646 _Base::equal_range(__x);
647 return std::make_pair(const_iterator(__res.first, this),
648 const_iterator(__res.second, this));
651 #if __cplusplus > 201103L
652 template<typename _Kt,
653 typename _Req =
654 typename __has_is_transparent<_Compare, _Kt>::type>
655 std::pair<const_iterator, const_iterator>
656 equal_range(const _Kt& __x) const
658 auto __res = _Base::equal_range(__x);
659 return { { __res.first, this }, { __res.second, this } };
661 #endif
663 _Base&
664 _M_base() _GLIBCXX_NOEXCEPT { return *this; }
666 const _Base&
667 _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
670 template<typename _Key, typename _Tp,
671 typename _Compare, typename _Allocator>
672 inline bool
673 operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
674 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
675 { return __lhs._M_base() == __rhs._M_base(); }
677 template<typename _Key, typename _Tp,
678 typename _Compare, typename _Allocator>
679 inline bool
680 operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
681 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
682 { return __lhs._M_base() != __rhs._M_base(); }
684 template<typename _Key, typename _Tp,
685 typename _Compare, typename _Allocator>
686 inline bool
687 operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
688 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
689 { return __lhs._M_base() < __rhs._M_base(); }
691 template<typename _Key, typename _Tp,
692 typename _Compare, typename _Allocator>
693 inline bool
694 operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
695 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
696 { return __lhs._M_base() <= __rhs._M_base(); }
698 template<typename _Key, typename _Tp,
699 typename _Compare, typename _Allocator>
700 inline bool
701 operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
702 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
703 { return __lhs._M_base() >= __rhs._M_base(); }
705 template<typename _Key, typename _Tp,
706 typename _Compare, typename _Allocator>
707 inline bool
708 operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
709 const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
710 { return __lhs._M_base() > __rhs._M_base(); }
712 template<typename _Key, typename _Tp,
713 typename _Compare, typename _Allocator>
714 inline void
715 swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs,
716 map<_Key, _Tp, _Compare, _Allocator>& __rhs)
717 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))
718 { __lhs.swap(__rhs); }
720 } // namespace __debug
721 } // namespace std
723 #endif