1 // Debugging set implementation -*- C++ -*-
3 // Copyright (C) 2003-2015 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_SET_H
30 #define _GLIBCXX_DEBUG_SET_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::set with safety/checking/debug instrumentation.
42 template<typename _Key
, typename _Compare
= std::less
<_Key
>,
43 typename _Allocator
= std::allocator
<_Key
> >
45 : public __gnu_debug::_Safe_container
<
46 set
<_Key
, _Compare
, _Allocator
>, _Allocator
,
47 __gnu_debug::_Safe_node_sequence
>,
48 public _GLIBCXX_STD_C::set
<_Key
,_Compare
,_Allocator
>
50 typedef _GLIBCXX_STD_C::set
<_Key
, _Compare
, _Allocator
> _Base
;
51 typedef __gnu_debug::_Safe_container
<
52 set
, _Allocator
, __gnu_debug::_Safe_node_sequence
> _Safe
;
54 typedef typename
_Base::const_iterator _Base_const_iterator
;
55 typedef typename
_Base::iterator _Base_iterator
;
56 typedef __gnu_debug::_Equal_to
<_Base_const_iterator
> _Equal
;
60 typedef _Key key_type
;
61 typedef _Key value_type
;
62 typedef _Compare key_compare
;
63 typedef _Compare value_compare
;
64 typedef _Allocator allocator_type
;
65 typedef typename
_Base::reference reference
;
66 typedef typename
_Base::const_reference const_reference
;
68 typedef __gnu_debug::_Safe_iterator
<_Base_iterator
, set
>
70 typedef __gnu_debug::_Safe_iterator
<_Base_const_iterator
, set
>
73 typedef typename
_Base::size_type size_type
;
74 typedef typename
_Base::difference_type difference_type
;
75 typedef typename
_Base::pointer pointer
;
76 typedef typename
_Base::const_pointer const_pointer
;
77 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
78 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
80 // 23.3.3.1 construct/copy/destroy:
82 #if __cplusplus < 201103L
91 set(const set
&) = default;
94 set(initializer_list
<value_type
> __l
,
95 const _Compare
& __comp
= _Compare(),
96 const allocator_type
& __a
= allocator_type())
97 : _Base(__l
, __comp
, __a
) { }
100 set(const allocator_type
& __a
)
103 set(const set
& __x
, const allocator_type
& __a
)
104 : _Base(__x
, __a
) { }
106 set(set
&& __x
, const allocator_type
& __a
)
107 : _Safe(std::move(__x
._M_safe()), __a
),
108 _Base(std::move(__x
._M_base()), __a
) { }
110 set(initializer_list
<value_type
> __l
, const allocator_type
& __a
)
111 : _Base(__l
, __a
) { }
113 template<typename _InputIterator
>
114 set(_InputIterator __first
, _InputIterator __last
,
115 const allocator_type
& __a
)
116 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first
,
118 __gnu_debug::__base(__last
), __a
) { }
123 explicit set(const _Compare
& __comp
,
124 const _Allocator
& __a
= _Allocator())
125 : _Base(__comp
, __a
) { }
127 template<typename _InputIterator
>
128 set(_InputIterator __first
, _InputIterator __last
,
129 const _Compare
& __comp
= _Compare(),
130 const _Allocator
& __a
= _Allocator())
131 : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first
,
133 __gnu_debug::__base(__last
),
136 set(const _Base
& __x
)
139 #if __cplusplus < 201103L
141 operator=(const set
& __x
)
143 this->_M_safe() = __x
;
149 operator=(const set
&) = default;
152 operator=(set
&&) = default;
155 operator=(initializer_list
<value_type
> __l
)
158 this->_M_invalidate_all();
163 using _Base::get_allocator
;
167 begin() _GLIBCXX_NOEXCEPT
168 { return iterator(_Base::begin(), this); }
171 begin() const _GLIBCXX_NOEXCEPT
172 { return const_iterator(_Base::begin(), this); }
175 end() _GLIBCXX_NOEXCEPT
176 { return iterator(_Base::end(), this); }
179 end() const _GLIBCXX_NOEXCEPT
180 { return const_iterator(_Base::end(), this); }
183 rbegin() _GLIBCXX_NOEXCEPT
184 { return reverse_iterator(end()); }
186 const_reverse_iterator
187 rbegin() const _GLIBCXX_NOEXCEPT
188 { return const_reverse_iterator(end()); }
191 rend() _GLIBCXX_NOEXCEPT
192 { return reverse_iterator(begin()); }
194 const_reverse_iterator
195 rend() const _GLIBCXX_NOEXCEPT
196 { return const_reverse_iterator(begin()); }
198 #if __cplusplus >= 201103L
200 cbegin() const noexcept
201 { return const_iterator(_Base::begin(), this); }
204 cend() const noexcept
205 { return const_iterator(_Base::end(), this); }
207 const_reverse_iterator
208 crbegin() const noexcept
209 { return const_reverse_iterator(end()); }
211 const_reverse_iterator
212 crend() const noexcept
213 { return const_reverse_iterator(begin()); }
219 using _Base::max_size
;
222 #if __cplusplus >= 201103L
223 template<typename
... _Args
>
224 std::pair
<iterator
, bool>
225 emplace(_Args
&&... __args
)
227 auto __res
= _Base::emplace(std::forward
<_Args
>(__args
)...);
228 return std::pair
<iterator
, bool>(iterator(__res
.first
, this),
232 template<typename
... _Args
>
234 emplace_hint(const_iterator __pos
, _Args
&&... __args
)
236 __glibcxx_check_insert(__pos
);
237 return iterator(_Base::emplace_hint(__pos
.base(),
238 std::forward
<_Args
>(__args
)...),
243 std::pair
<iterator
, bool>
244 insert(const value_type
& __x
)
246 std::pair
<_Base_iterator
, bool> __res
= _Base::insert(__x
);
247 return std::pair
<iterator
, bool>(iterator(__res
.first
, this),
251 #if __cplusplus >= 201103L
252 std::pair
<iterator
, bool>
253 insert(value_type
&& __x
)
255 std::pair
<_Base_iterator
, bool> __res
256 = _Base::insert(std::move(__x
));
257 return std::pair
<iterator
, bool>(iterator(__res
.first
, this),
263 insert(const_iterator __position
, const value_type
& __x
)
265 __glibcxx_check_insert(__position
);
266 return iterator(_Base::insert(__position
.base(), __x
), this);
269 #if __cplusplus >= 201103L
271 insert(const_iterator __position
, value_type
&& __x
)
273 __glibcxx_check_insert(__position
);
274 return iterator(_Base::insert(__position
.base(), std::move(__x
)),
279 template <typename _InputIterator
>
281 insert(_InputIterator __first
, _InputIterator __last
)
283 typename
__gnu_debug::_Distance_traits
<_InputIterator
>::__type __dist
;
284 __glibcxx_check_valid_range2(__first
, __last
, __dist
);
286 if (__dist
.second
>= __gnu_debug::__dp_sign
)
287 _Base::insert(__gnu_debug::__unsafe(__first
),
288 __gnu_debug::__unsafe(__last
));
290 _Base::insert(__first
, __last
);
293 #if __cplusplus >= 201103L
295 insert(initializer_list
<value_type
> __l
)
296 { _Base::insert(__l
); }
299 #if __cplusplus >= 201103L
301 erase(const_iterator __position
)
303 __glibcxx_check_erase(__position
);
304 this->_M_invalidate_if(_Equal(__position
.base()));
305 return iterator(_Base::erase(__position
.base()), this);
309 erase(iterator __position
)
311 __glibcxx_check_erase(__position
);
312 this->_M_invalidate_if(_Equal(__position
.base()));
313 _Base::erase(__position
.base());
318 erase(const key_type
& __x
)
320 _Base_iterator __victim
= _Base::find(__x
);
321 if (__victim
== _Base::end())
325 this->_M_invalidate_if(_Equal(__victim
));
326 _Base::erase(__victim
);
331 #if __cplusplus >= 201103L
333 erase(const_iterator __first
, const_iterator __last
)
335 // _GLIBCXX_RESOLVE_LIB_DEFECTS
336 // 151. can't currently clear() empty container
337 __glibcxx_check_erase_range(__first
, __last
);
338 for (_Base_const_iterator __victim
= __first
.base();
339 __victim
!= __last
.base(); ++__victim
)
341 _GLIBCXX_DEBUG_VERIFY(__victim
!= _Base::end(),
342 _M_message(__gnu_debug::__msg_valid_range
)
343 ._M_iterator(__first
, "first")
344 ._M_iterator(__last
, "last"));
345 this->_M_invalidate_if(_Equal(__victim
));
347 return iterator(_Base::erase(__first
.base(), __last
.base()), this);
351 erase(iterator __first
, iterator __last
)
353 // _GLIBCXX_RESOLVE_LIB_DEFECTS
354 // 151. can't currently clear() empty container
355 __glibcxx_check_erase_range(__first
, __last
);
356 for (_Base_iterator __victim
= __first
.base();
357 __victim
!= __last
.base(); ++__victim
)
359 _GLIBCXX_DEBUG_VERIFY(__victim
!= _Base::end(),
360 _M_message(__gnu_debug::__msg_valid_range
)
361 ._M_iterator(__first
, "first")
362 ._M_iterator(__last
, "last"));
363 this->_M_invalidate_if(_Equal(__victim
));
365 _Base::erase(__first
.base(), __last
.base());
371 #if __cplusplus >= 201103L
372 noexcept( noexcept(declval
<_Base
>().swap(__x
)) )
380 clear() _GLIBCXX_NOEXCEPT
382 this->_M_invalidate_all();
387 using _Base::key_comp
;
388 using _Base::value_comp
;
392 find(const key_type
& __x
)
393 { return iterator(_Base::find(__x
), this); }
395 // _GLIBCXX_RESOLVE_LIB_DEFECTS
396 // 214. set::find() missing const overload
398 find(const key_type
& __x
) const
399 { return const_iterator(_Base::find(__x
), this); }
401 #if __cplusplus > 201103L
402 template<typename _Kt
,
404 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
407 { return { _Base::find(__x
), this }; }
409 template<typename _Kt
,
411 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
413 find(const _Kt
& __x
) const
414 { return { _Base::find(__x
), this }; }
420 lower_bound(const key_type
& __x
)
421 { return iterator(_Base::lower_bound(__x
), this); }
423 // _GLIBCXX_RESOLVE_LIB_DEFECTS
424 // 214. set::find() missing const overload
426 lower_bound(const key_type
& __x
) const
427 { return const_iterator(_Base::lower_bound(__x
), this); }
429 #if __cplusplus > 201103L
430 template<typename _Kt
,
432 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
434 lower_bound(const _Kt
& __x
)
435 { return { _Base::lower_bound(__x
), this }; }
437 template<typename _Kt
,
439 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
441 lower_bound(const _Kt
& __x
) const
442 { return { _Base::lower_bound(__x
), this }; }
446 upper_bound(const key_type
& __x
)
447 { return iterator(_Base::upper_bound(__x
), this); }
449 // _GLIBCXX_RESOLVE_LIB_DEFECTS
450 // 214. set::find() missing const overload
452 upper_bound(const key_type
& __x
) const
453 { return const_iterator(_Base::upper_bound(__x
), this); }
455 #if __cplusplus > 201103L
456 template<typename _Kt
,
458 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
460 upper_bound(const _Kt
& __x
)
461 { return { _Base::upper_bound(__x
), this }; }
463 template<typename _Kt
,
465 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
467 upper_bound(const _Kt
& __x
) const
468 { return { _Base::upper_bound(__x
), this }; }
471 std::pair
<iterator
, iterator
>
472 equal_range(const key_type
& __x
)
474 std::pair
<_Base_iterator
, _Base_iterator
> __res
=
475 _Base::equal_range(__x
);
476 return std::make_pair(iterator(__res
.first
, this),
477 iterator(__res
.second
, this));
480 // _GLIBCXX_RESOLVE_LIB_DEFECTS
481 // 214. set::find() missing const overload
482 std::pair
<const_iterator
, const_iterator
>
483 equal_range(const key_type
& __x
) const
485 std::pair
<_Base_const_iterator
, _Base_const_iterator
> __res
=
486 _Base::equal_range(__x
);
487 return std::make_pair(const_iterator(__res
.first
, this),
488 const_iterator(__res
.second
, this));
491 #if __cplusplus > 201103L
492 template<typename _Kt
,
494 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
495 std::pair
<iterator
, iterator
>
496 equal_range(const _Kt
& __x
)
498 auto __res
= _Base::equal_range(__x
);
499 return { { __res
.first
, this }, { __res
.second
, this } };
502 template<typename _Kt
,
504 typename __has_is_transparent
<_Compare
, _Kt
>::type
>
505 std::pair
<const_iterator
, const_iterator
>
506 equal_range(const _Kt
& __x
) const
508 auto __res
= _Base::equal_range(__x
);
509 return { { __res
.first
, this }, { __res
.second
, this } };
514 _M_base() _GLIBCXX_NOEXCEPT
{ return *this; }
517 _M_base() const _GLIBCXX_NOEXCEPT
{ return *this; }
520 template<typename _Key
, typename _Compare
, typename _Allocator
>
522 operator==(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
523 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
524 { return __lhs
._M_base() == __rhs
._M_base(); }
526 template<typename _Key
, typename _Compare
, typename _Allocator
>
528 operator!=(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
529 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
530 { return __lhs
._M_base() != __rhs
._M_base(); }
532 template<typename _Key
, typename _Compare
, typename _Allocator
>
534 operator<(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
535 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
536 { return __lhs
._M_base() < __rhs
._M_base(); }
538 template<typename _Key
, typename _Compare
, typename _Allocator
>
540 operator<=(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
541 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
542 { return __lhs
._M_base() <= __rhs
._M_base(); }
544 template<typename _Key
, typename _Compare
, typename _Allocator
>
546 operator>=(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
547 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
548 { return __lhs
._M_base() >= __rhs
._M_base(); }
550 template<typename _Key
, typename _Compare
, typename _Allocator
>
552 operator>(const set
<_Key
, _Compare
, _Allocator
>& __lhs
,
553 const set
<_Key
, _Compare
, _Allocator
>& __rhs
)
554 { return __lhs
._M_base() > __rhs
._M_base(); }
556 template<typename _Key
, typename _Compare
, typename _Allocator
>
558 swap(set
<_Key
, _Compare
, _Allocator
>& __x
,
559 set
<_Key
, _Compare
, _Allocator
>& __y
)
560 { return __x
.swap(__y
); }
562 } // namespace __debug