1 // Debugging map implementation -*- C++ -*-
3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
27 * This file is a GNU debug extension to the Standard C++ Library.
30 #ifndef _GLIBCXX_DEBUG_MAP_H
31 #define _GLIBCXX_DEBUG_MAP_H 1
33 #include <debug/safe_sequence.h>
34 #include <debug/safe_iterator.h>
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 _GLIBCXX_STD_D::map
<_Key
, _Tp
, _Compare
, _Allocator
>,
46 public __gnu_debug::_Safe_sequence
<map
<_Key
, _Tp
, _Compare
, _Allocator
> >
48 typedef _GLIBCXX_STD_D::map
<_Key
, _Tp
, _Compare
, _Allocator
> _Base
;
49 typedef __gnu_debug::_Safe_sequence
<map
> _Safe_base
;
53 typedef _Key key_type
;
54 typedef _Tp mapped_type
;
55 typedef std::pair
<const _Key
, _Tp
> value_type
;
56 typedef _Compare key_compare
;
57 typedef _Allocator allocator_type
;
58 typedef typename
_Base::reference reference
;
59 typedef typename
_Base::const_reference const_reference
;
61 typedef __gnu_debug::_Safe_iterator
<typename
_Base::iterator
, map
>
63 typedef __gnu_debug::_Safe_iterator
<typename
_Base::const_iterator
, map
>
66 typedef typename
_Base::size_type size_type
;
67 typedef typename
_Base::difference_type difference_type
;
68 typedef typename
_Base::pointer pointer
;
69 typedef typename
_Base::const_pointer const_pointer
;
70 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
71 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
73 using _Base::value_compare
;
75 // 23.3.1.1 construct/copy/destroy:
76 explicit map(const _Compare
& __comp
= _Compare(),
77 const _Allocator
& __a
= _Allocator())
78 : _Base(__comp
, __a
) { }
80 template<typename _InputIterator
>
81 map(_InputIterator __first
, _InputIterator __last
,
82 const _Compare
& __comp
= _Compare(),
83 const _Allocator
& __a
= _Allocator())
84 : _Base(__gnu_debug::__check_valid_range(__first
, __last
), __last
,
85 __comp
, __a
), _Safe_base() { }
88 : _Base(__x
), _Safe_base() { }
91 : _Base(__x
), _Safe_base() { }
93 #ifdef __GXX_EXPERIMENTAL_CXX0X__
95 : _Base(std::move(__x
)), _Safe_base()
96 { this->_M_swap(__x
); }
98 map(initializer_list
<value_type
> __l
,
99 const _Compare
& __c
= _Compare(),
100 const allocator_type
& __a
= allocator_type())
101 : _Base(__l
, __c
, __a
), _Safe_base() { }
107 operator=(const map
& __x
)
109 *static_cast<_Base
*>(this) = __x
;
110 this->_M_invalidate_all();
114 #ifdef __GXX_EXPERIMENTAL_CXX0X__
126 operator=(initializer_list
<value_type
> __l
)
134 // _GLIBCXX_RESOLVE_LIB_DEFECTS
135 // 133. map missing get_allocator()
136 using _Base::get_allocator
;
141 { return iterator(_Base::begin(), this); }
145 { return const_iterator(_Base::begin(), this); }
149 { return iterator(_Base::end(), this); }
153 { return const_iterator(_Base::end(), this); }
157 { return reverse_iterator(end()); }
159 const_reverse_iterator
161 { return const_reverse_iterator(end()); }
165 { return reverse_iterator(begin()); }
167 const_reverse_iterator
169 { return const_reverse_iterator(begin()); }
171 #ifdef __GXX_EXPERIMENTAL_CXX0X__
174 { return const_iterator(_Base::begin(), this); }
178 { return const_iterator(_Base::end(), this); }
180 const_reverse_iterator
182 { return const_reverse_iterator(end()); }
184 const_reverse_iterator
186 { return const_reverse_iterator(begin()); }
192 using _Base::max_size
;
194 // 23.3.1.2 element access:
195 using _Base::operator[];
197 // _GLIBCXX_RESOLVE_LIB_DEFECTS
198 // DR 464. Suggestion for new member functions in standard containers.
202 std::pair
<iterator
, bool>
203 insert(const value_type
& __x
)
205 typedef typename
_Base::iterator _Base_iterator
;
206 std::pair
<_Base_iterator
, bool> __res
= _Base::insert(__x
);
207 return std::pair
<iterator
, bool>(iterator(__res
.first
, this),
211 #ifdef __GXX_EXPERIMENTAL_CXX0X__
213 insert(std::initializer_list
<value_type
> __list
)
214 { _Base::insert(__list
); }
218 insert(iterator __position
, const value_type
& __x
)
220 __glibcxx_check_insert(__position
);
221 return iterator(_Base::insert(__position
.base(), __x
), this);
224 template<typename _InputIterator
>
226 insert(_InputIterator __first
, _InputIterator __last
)
228 __glibcxx_check_valid_range(__first
, __last
);
229 _Base::insert(__first
, __last
);
232 #ifdef __GXX_EXPERIMENTAL_CXX0X__
234 erase(iterator __position
)
236 __glibcxx_check_erase(__position
);
237 __position
._M_invalidate();
238 return iterator(_Base::erase(__position
.base()), this);
242 erase(iterator __position
)
244 __glibcxx_check_erase(__position
);
245 __position
._M_invalidate();
246 _Base::erase(__position
.base());
251 erase(const key_type
& __x
)
253 iterator __victim
= find(__x
);
254 if (__victim
== end())
258 __victim
._M_invalidate();
259 _Base::erase(__victim
.base());
264 #ifdef __GXX_EXPERIMENTAL_CXX0X__
266 erase(iterator __first
, iterator __last
)
268 // _GLIBCXX_RESOLVE_LIB_DEFECTS
269 // 151. can't currently clear() empty container
270 __glibcxx_check_erase_range(__first
, __last
);
271 while (__first
!= __last
)
272 this->erase(__first
++);
277 erase(iterator __first
, iterator __last
)
279 // _GLIBCXX_RESOLVE_LIB_DEFECTS
280 // 151. can't currently clear() empty container
281 __glibcxx_check_erase_range(__first
, __last
);
282 while (__first
!= __last
)
283 this->erase(__first
++);
296 { this->erase(begin(), end()); }
299 using _Base::key_comp
;
300 using _Base::value_comp
;
302 // 23.3.1.3 map operations:
304 find(const key_type
& __x
)
305 { return iterator(_Base::find(__x
), this); }
308 find(const key_type
& __x
) const
309 { return const_iterator(_Base::find(__x
), this); }
314 lower_bound(const key_type
& __x
)
315 { return iterator(_Base::lower_bound(__x
), this); }
318 lower_bound(const key_type
& __x
) const
319 { return const_iterator(_Base::lower_bound(__x
), this); }
322 upper_bound(const key_type
& __x
)
323 { return iterator(_Base::upper_bound(__x
), this); }
326 upper_bound(const key_type
& __x
) const
327 { return const_iterator(_Base::upper_bound(__x
), this); }
329 std::pair
<iterator
,iterator
>
330 equal_range(const key_type
& __x
)
332 typedef typename
_Base::iterator _Base_iterator
;
333 std::pair
<_Base_iterator
, _Base_iterator
> __res
=
334 _Base::equal_range(__x
);
335 return std::make_pair(iterator(__res
.first
, this),
336 iterator(__res
.second
, this));
339 std::pair
<const_iterator
,const_iterator
>
340 equal_range(const key_type
& __x
) const
342 typedef typename
_Base::const_iterator _Base_const_iterator
;
343 std::pair
<_Base_const_iterator
, _Base_const_iterator
> __res
=
344 _Base::equal_range(__x
);
345 return std::make_pair(const_iterator(__res
.first
, this),
346 const_iterator(__res
.second
, this));
350 _M_base() { return *this; }
353 _M_base() const { return *this; }
359 typedef typename
_Base::const_iterator _Base_const_iterator
;
360 typedef __gnu_debug::_Not_equal_to
<_Base_const_iterator
> _Not_equal
;
361 this->_M_invalidate_if(_Not_equal(_M_base().end()));
365 template<typename _Key
, typename _Tp
,
366 typename _Compare
, typename _Allocator
>
368 operator==(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
369 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
370 { return __lhs
._M_base() == __rhs
._M_base(); }
372 template<typename _Key
, typename _Tp
,
373 typename _Compare
, typename _Allocator
>
375 operator!=(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
376 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
377 { return __lhs
._M_base() != __rhs
._M_base(); }
379 template<typename _Key
, typename _Tp
,
380 typename _Compare
, typename _Allocator
>
382 operator<(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
383 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
384 { return __lhs
._M_base() < __rhs
._M_base(); }
386 template<typename _Key
, typename _Tp
,
387 typename _Compare
, typename _Allocator
>
389 operator<=(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
390 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
391 { return __lhs
._M_base() <= __rhs
._M_base(); }
393 template<typename _Key
, typename _Tp
,
394 typename _Compare
, typename _Allocator
>
396 operator>=(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
397 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
398 { return __lhs
._M_base() >= __rhs
._M_base(); }
400 template<typename _Key
, typename _Tp
,
401 typename _Compare
, typename _Allocator
>
403 operator>(const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
404 const map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
405 { return __lhs
._M_base() > __rhs
._M_base(); }
407 template<typename _Key
, typename _Tp
,
408 typename _Compare
, typename _Allocator
>
410 swap(map
<_Key
, _Tp
, _Compare
, _Allocator
>& __lhs
,
411 map
<_Key
, _Tp
, _Compare
, _Allocator
>& __rhs
)
412 { __lhs
.swap(__rhs
); }
414 } // namespace __debug