1 // Debugging multiset implementation -*- C++ -*-
2 
3 // Copyright (C) 2003, 2004, 2005
4 // Free Software Foundation, Inc.
5 //
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 2, or (at your option)
10 // any later version.
11 
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.
16 
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING.  If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20 // USA.
21 
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction.  Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License.  This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
30 
31 /** @file debug/multiset.h
32  *  This file is a GNU debug extension to the Standard C++ Library.
33  */
34 
35 #ifndef _GLIBCXX_DEBUG_MULTISET_H
36 #define _GLIBCXX_DEBUG_MULTISET_H 1
37 
38 #include <debug/safe_sequence.h>
39 #include <debug/safe_iterator.h>
40 #include <utility>
41 
42 namespace std
43 {
44 namespace __debug
45 {
46   template<typename _Key, typename _Compare = std::less<_Key>,
47 	   typename _Allocator = std::allocator<_Key> >
48     class multiset
49     : public _GLIBCXX_STD::multiset<_Key, _Compare, _Allocator>,
50       public __gnu_debug::_Safe_sequence<multiset<_Key, _Compare, _Allocator> >
51     {
52       typedef _GLIBCXX_STD::multiset<_Key, _Compare, _Allocator> _Base;
53       typedef __gnu_debug::_Safe_sequence<multiset> _Safe_base;
54 
55     public:
56       // types:
57       typedef _Key				     key_type;
58       typedef _Key				     value_type;
59       typedef _Compare				     key_compare;
60       typedef _Compare				     value_compare;
61       typedef _Allocator			     allocator_type;
62       typedef typename _Base::reference	             reference;
63       typedef typename _Base::const_reference        const_reference;
64 
65       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator, multiset>
66       iterator;
67       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
68 					  multiset> const_iterator;
69 
70       typedef typename _Base::size_type              size_type;
71       typedef typename _Base::difference_type        difference_type;
72       typedef typename _Base::pointer                pointer;
73       typedef typename _Base::const_pointer          const_pointer;
74       typedef std::reverse_iterator<iterator>        reverse_iterator;
75       typedef std::reverse_iterator<const_iterator>  const_reverse_iterator;
76 
77       // 23.3.3.1 construct/copy/destroy:
78       explicit multiset(const _Compare& __comp = _Compare(),
79 			const _Allocator& __a = _Allocator())
_Base(__comp,__a)80       : _Base(__comp, __a) { }
81 
82       template<typename _InputIterator>
83         multiset(_InputIterator __first, _InputIterator __last,
84 		 const _Compare& __comp = _Compare(),
85 		 const _Allocator& __a = _Allocator())
_Base(__gnu_debug::__check_valid_range (__first,__last),__last,__comp,__a)86 	: _Base(__gnu_debug::__check_valid_range(__first, __last), __last,
87 		__comp, __a) { }
88 
multiset(const multiset<_Key,_Compare,_Allocator> & __x)89       multiset(const multiset<_Key,_Compare,_Allocator>& __x)
90       : _Base(__x), _Safe_base() { }
91 
multiset(const _Base & __x)92       multiset(const _Base& __x) : _Base(__x), _Safe_base() { }
93 
~multiset()94       ~multiset() { }
95 
96       multiset<_Key,_Compare,_Allocator>&
97       operator=(const multiset<_Key,_Compare,_Allocator>& __x)
98       {
99 	*static_cast<_Base*>(this) = __x;
100 	this->_M_invalidate_all();
101 	return *this;
102       }
103 
104       using _Base::get_allocator;
105 
106       // iterators:
107       iterator
begin()108       begin()
109       { return iterator(_Base::begin(), this); }
110 
111       const_iterator
begin()112       begin() const
113       { return const_iterator(_Base::begin(), this); }
114 
115       iterator
end()116       end()
117       { return iterator(_Base::end(), this); }
118 
119       const_iterator
end()120       end() const
121       { return const_iterator(_Base::end(), this); }
122 
123       reverse_iterator
rbegin()124       rbegin()
125       { return reverse_iterator(end()); }
126 
127       const_reverse_iterator
rbegin()128       rbegin() const
129       { return const_reverse_iterator(end()); }
130 
131       reverse_iterator
rend()132       rend()
133       { return reverse_iterator(begin()); }
134 
135       const_reverse_iterator
rend()136       rend() const
137       { return const_reverse_iterator(begin()); }
138 
139       // capacity:
140       using _Base::empty;
141       using _Base::size;
142       using _Base::max_size;
143 
144       // modifiers:
145       iterator
insert(const value_type & __x)146       insert(const value_type& __x)
147       { return iterator(_Base::insert(__x), this); }
148 
149       iterator
insert(iterator __position,const value_type & __x)150       insert(iterator __position, const value_type& __x)
151       {
152 	__glibcxx_check_insert(__position);
153 	return iterator(_Base::insert(__position.base(), __x), this);
154       }
155 
156       template<typename _InputIterator>
157       void
insert(_InputIterator __first,_InputIterator __last)158       insert(_InputIterator __first, _InputIterator __last)
159       {
160 	__glibcxx_check_valid_range(__first, __last);
161 	_Base::insert(__first, __last);
162       }
163 
164       void
erase(iterator __position)165       erase(iterator __position)
166       {
167 	__glibcxx_check_erase(__position);
168 	__position._M_invalidate();
169 	_Base::erase(__position.base());
170       }
171 
172       size_type
erase(const key_type & __x)173       erase(const key_type& __x)
174       {
175 	std::pair<iterator, iterator> __victims = this->equal_range(__x);
176 	size_type __count = 0;
177 	while (__victims.first != __victims.second)
178 	{
179 	  iterator __victim = __victims.first++;
180 	  __victim._M_invalidate();
181 	  _Base::erase(__victim.base());
182 	  ++__count;
183 	}
184 	return __count;
185       }
186 
187       void
erase(iterator __first,iterator __last)188       erase(iterator __first, iterator __last)
189       {
190 	// _GLIBCXX_RESOLVE_LIB_DEFECTS
191 	// 151. can't currently clear() empty container
192 	__glibcxx_check_erase_range(__first, __last);
193 	while (__first != __last)
194 	this->erase(__first++);
195       }
196 
197       void
swap(multiset<_Key,_Compare,_Allocator> & __x)198       swap(multiset<_Key,_Compare,_Allocator>& __x)
199       {
200 	_Base::swap(__x);
201 	this->_M_swap(__x);
202       }
203 
204       void
clear()205       clear()
206       { this->erase(begin(), end()); }
207 
208       // observers:
209       using _Base::key_comp;
210       using _Base::value_comp;
211 
212       // multiset operations:
213       iterator
find(const key_type & __x)214       find(const key_type& __x)
215       { return iterator(_Base::find(__x), this); }
216 
217       // _GLIBCXX_RESOLVE_LIB_DEFECTS
218       // 214. set::find() missing const overload
219       const_iterator
find(const key_type & __x)220       find(const key_type& __x) const
221       { return const_iterator(_Base::find(__x), this); }
222 
223       using _Base::count;
224 
225       iterator
lower_bound(const key_type & __x)226       lower_bound(const key_type& __x)
227       { return iterator(_Base::lower_bound(__x), this); }
228 
229       // _GLIBCXX_RESOLVE_LIB_DEFECTS
230       // 214. set::find() missing const overload
231       const_iterator
lower_bound(const key_type & __x)232       lower_bound(const key_type& __x) const
233       { return const_iterator(_Base::lower_bound(__x), this); }
234 
235       iterator
upper_bound(const key_type & __x)236       upper_bound(const key_type& __x)
237       { return iterator(_Base::upper_bound(__x), this); }
238 
239       // _GLIBCXX_RESOLVE_LIB_DEFECTS
240       // 214. set::find() missing const overload
241       const_iterator
upper_bound(const key_type & __x)242       upper_bound(const key_type& __x) const
243       { return const_iterator(_Base::upper_bound(__x), this); }
244 
245       std::pair<iterator,iterator>
equal_range(const key_type & __x)246       equal_range(const key_type& __x)
247       {
248 	typedef typename _Base::iterator _Base_iterator;
249 	std::pair<_Base_iterator, _Base_iterator> __res =
250         _Base::equal_range(__x);
251 	return std::make_pair(iterator(__res.first, this),
252 			      iterator(__res.second, this));
253       }
254 
255       // _GLIBCXX_RESOLVE_LIB_DEFECTS
256       // 214. set::find() missing const overload
257       std::pair<const_iterator,const_iterator>
equal_range(const key_type & __x)258       equal_range(const key_type& __x) const
259       {
260 	typedef typename _Base::const_iterator _Base_iterator;
261 	std::pair<_Base_iterator, _Base_iterator> __res =
262         _Base::equal_range(__x);
263 	return std::make_pair(const_iterator(__res.first, this),
264 			      const_iterator(__res.second, this));
265       }
266 
267       _Base&
_M_base()268       _M_base() { return *this; }
269 
270       const _Base&
_M_base()271       _M_base() const { return *this; }
272 
273     private:
274       void
_M_invalidate_all()275       _M_invalidate_all()
276       {
277 	typedef typename _Base::const_iterator _Base_const_iterator;
278 	typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
279 	this->_M_invalidate_if(_Not_equal(_M_base().end()));
280       }
281     };
282 
283   template<typename _Key, typename _Compare, typename _Allocator>
284     inline bool
285     operator==(const multiset<_Key,_Compare,_Allocator>& __lhs,
286 	       const multiset<_Key,_Compare,_Allocator>& __rhs)
287     { return __lhs._M_base() == __rhs._M_base(); }
288 
289   template<typename _Key, typename _Compare, typename _Allocator>
290     inline bool
291     operator!=(const multiset<_Key,_Compare,_Allocator>& __lhs,
292 	       const multiset<_Key,_Compare,_Allocator>& __rhs)
293     { return __lhs._M_base() != __rhs._M_base(); }
294 
295   template<typename _Key, typename _Compare, typename _Allocator>
296     inline bool
297     operator<(const multiset<_Key,_Compare,_Allocator>& __lhs,
298 	      const multiset<_Key,_Compare,_Allocator>& __rhs)
299     { return __lhs._M_base() < __rhs._M_base(); }
300 
301   template<typename _Key, typename _Compare, typename _Allocator>
302     inline bool
303     operator<=(const multiset<_Key,_Compare,_Allocator>& __lhs,
304 	       const multiset<_Key,_Compare,_Allocator>& __rhs)
305     { return __lhs._M_base() <= __rhs._M_base(); }
306 
307   template<typename _Key, typename _Compare, typename _Allocator>
308     inline bool
309     operator>=(const multiset<_Key,_Compare,_Allocator>& __lhs,
310 	       const multiset<_Key,_Compare,_Allocator>& __rhs)
311     { return __lhs._M_base() >= __rhs._M_base(); }
312 
313   template<typename _Key, typename _Compare, typename _Allocator>
314     inline bool
315     operator>(const multiset<_Key,_Compare,_Allocator>& __lhs,
316 	      const multiset<_Key,_Compare,_Allocator>& __rhs)
317     { return __lhs._M_base() > __rhs._M_base(); }
318 
319   template<typename _Key, typename _Compare, typename _Allocator>
320     void
swap(multiset<_Key,_Compare,_Allocator> & __x,multiset<_Key,_Compare,_Allocator> & __y)321     swap(multiset<_Key,_Compare,_Allocator>& __x,
322 	 multiset<_Key,_Compare,_Allocator>& __y)
323     { return __x.swap(__y); }
324 } // namespace __debug
325 } // namespace std
326 
327 #endif
328