libstdc++
debug/map.h
Go to the documentation of this file.
00001 // Debugging map implementation -*- C++ -*-
00002 
00003 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011
00004 // Free Software Foundation, Inc.
00005 //
00006 // This file is part of the GNU ISO C++ Library.  This library is free
00007 // software; you can redistribute it and/or modify it under the
00008 // terms of the GNU General Public License as published by the
00009 // Free Software Foundation; either version 3, or (at your option)
00010 // any later version.
00011 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 // GNU General Public License for more details.
00016 
00017 // Under Section 7 of GPL version 3, you are granted additional
00018 // permissions described in the GCC Runtime Library Exception, version
00019 // 3.1, as published by the Free Software Foundation.
00020 
00021 // You should have received a copy of the GNU General Public License and
00022 // a copy of the GCC Runtime Library Exception along with this program;
00023 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
00024 // <http://www.gnu.org/licenses/>.
00025 
00026 /** @file debug/map.h
00027  *  This file is a GNU debug extension to the Standard C++ Library.
00028  */
00029 
00030 #ifndef _GLIBCXX_DEBUG_MAP_H
00031 #define _GLIBCXX_DEBUG_MAP_H 1
00032 
00033 #include <debug/safe_sequence.h>
00034 #include <debug/safe_iterator.h>
00035 #include <utility>
00036 
00037 namespace std _GLIBCXX_VISIBILITY(default)
00038 {
00039 namespace __debug
00040 {
00041   /// Class std::map with safety/checking/debug instrumentation.
00042   template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,
00043        typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >
00044     class map
00045     : public _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator>,
00046       public __gnu_debug::_Safe_sequence<map<_Key, _Tp, _Compare, _Allocator> >
00047     {
00048       typedef _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator> _Base;
00049       typedef __gnu_debug::_Safe_sequence<map> _Safe_base;
00050 
00051       typedef typename _Base::const_iterator _Base_const_iterator;
00052       typedef typename _Base::iterator _Base_iterator;
00053       typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
00054     public:
00055       // types:
00056       typedef _Key                                  key_type;
00057       typedef _Tp                                   mapped_type;
00058       typedef std::pair<const _Key, _Tp>            value_type;
00059       typedef _Compare                              key_compare;
00060       typedef _Allocator                            allocator_type;
00061       typedef typename _Base::reference             reference;
00062       typedef typename _Base::const_reference       const_reference;
00063 
00064       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator, map>
00065                                                     iterator;
00066       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator, map>
00067                                                     const_iterator;
00068 
00069       typedef typename _Base::size_type             size_type;
00070       typedef typename _Base::difference_type       difference_type;
00071       typedef typename _Base::pointer               pointer;
00072       typedef typename _Base::const_pointer         const_pointer;
00073       typedef std::reverse_iterator<iterator>       reverse_iterator;
00074       typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
00075 
00076       // 23.3.1.1 construct/copy/destroy:
00077       explicit map(const _Compare& __comp = _Compare(),
00078            const _Allocator& __a = _Allocator())
00079       : _Base(__comp, __a) { }
00080 
00081       template<typename _InputIterator>
00082         map(_InputIterator __first, _InputIterator __last,
00083         const _Compare& __comp = _Compare(),
00084         const _Allocator& __a = _Allocator())
00085     : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
00086                                      __last)),
00087         __gnu_debug::__base(__last),
00088         __comp, __a), _Safe_base() { }
00089 
00090       map(const map& __x)
00091       : _Base(__x), _Safe_base() { }
00092 
00093       map(const _Base& __x)
00094       : _Base(__x), _Safe_base() { }
00095 
00096 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00097       map(map&& __x)
00098       : _Base(std::move(__x)), _Safe_base()
00099       { this->_M_swap(__x); }
00100 
00101       map(initializer_list<value_type> __l,
00102       const _Compare& __c = _Compare(),
00103       const allocator_type& __a = allocator_type())
00104       : _Base(__l, __c, __a), _Safe_base() { }
00105 #endif
00106 
00107       ~map() { }
00108 
00109       map&
00110       operator=(const map& __x)
00111       {
00112     *static_cast<_Base*>(this) = __x;
00113     this->_M_invalidate_all();
00114     return *this;
00115       }
00116 
00117 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00118       map&
00119       operator=(map&& __x)
00120       {
00121     // NB: DR 1204.
00122     // NB: DR 675.
00123     clear();
00124     swap(__x);
00125     return *this;
00126       }
00127 
00128       map&
00129       operator=(initializer_list<value_type> __l)
00130       {
00131     this->clear();
00132     this->insert(__l);
00133     return *this;
00134       }
00135 #endif
00136 
00137       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00138       // 133. map missing get_allocator()
00139       using _Base::get_allocator;
00140 
00141       // iterators:
00142       iterator 
00143       begin()
00144       { return iterator(_Base::begin(), this); }
00145 
00146       const_iterator
00147       begin() const
00148       { return const_iterator(_Base::begin(), this); }
00149 
00150       iterator
00151       end()
00152       { return iterator(_Base::end(), this); }
00153 
00154       const_iterator
00155       end() const
00156       { return const_iterator(_Base::end(), this); }
00157 
00158       reverse_iterator
00159       rbegin()
00160       { return reverse_iterator(end()); }
00161 
00162       const_reverse_iterator
00163       rbegin() const
00164       { return const_reverse_iterator(end()); }
00165 
00166       reverse_iterator
00167       rend()
00168       { return reverse_iterator(begin()); }
00169 
00170       const_reverse_iterator
00171       rend() const
00172       { return const_reverse_iterator(begin()); }
00173 
00174 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00175       const_iterator
00176       cbegin() const
00177       { return const_iterator(_Base::begin(), this); }
00178 
00179       const_iterator
00180       cend() const
00181       { return const_iterator(_Base::end(), this); }
00182 
00183       const_reverse_iterator
00184       crbegin() const
00185       { return const_reverse_iterator(end()); }
00186 
00187       const_reverse_iterator
00188       crend() const
00189       { return const_reverse_iterator(begin()); }
00190 #endif
00191 
00192       // capacity:
00193       using _Base::empty;
00194       using _Base::size;
00195       using _Base::max_size;
00196 
00197       // 23.3.1.2 element access:
00198       using _Base::operator[];
00199 
00200       // _GLIBCXX_RESOLVE_LIB_DEFECTS
00201       // DR 464. Suggestion for new member functions in standard containers.
00202       using _Base::at;
00203 
00204       // modifiers:
00205       std::pair<iterator, bool>
00206       insert(const value_type& __x)
00207       {
00208     typedef typename _Base::iterator _Base_iterator;
00209     std::pair<_Base_iterator, bool> __res = _Base::insert(__x);
00210     return std::pair<iterator, bool>(iterator(__res.first, this),
00211                      __res.second);
00212       }
00213 
00214 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00215       template<typename _Pair, typename = typename
00216            std::enable_if<std::is_convertible<_Pair,
00217                           value_type>::value>::type>
00218         std::pair<iterator, bool>
00219         insert(_Pair&& __x)
00220         {
00221       typedef typename _Base::iterator _Base_iterator;
00222       std::pair<_Base_iterator, bool> __res
00223         = _Base::insert(std::forward<_Pair>(__x));
00224       return std::pair<iterator, bool>(iterator(__res.first, this),
00225                        __res.second);
00226     }
00227 #endif
00228 
00229 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00230       void
00231       insert(std::initializer_list<value_type> __list)
00232       { _Base::insert(__list); }
00233 #endif
00234 
00235       iterator
00236 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00237       insert(const_iterator __position, const value_type& __x)
00238 #else
00239       insert(iterator __position, const value_type& __x)
00240 #endif
00241       {
00242     __glibcxx_check_insert(__position);
00243     return iterator(_Base::insert(__position.base(), __x), this);
00244       }
00245 
00246 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00247       template<typename _Pair, typename = typename
00248            std::enable_if<std::is_convertible<_Pair,
00249                           value_type>::value>::type>
00250         iterator
00251         insert(const_iterator __position, _Pair&& __x)
00252         {
00253       __glibcxx_check_insert(__position);
00254       return iterator(_Base::insert(__position.base(),
00255                     std::forward<_Pair>(__x)), this);
00256     }
00257 #endif
00258 
00259       template<typename _InputIterator>
00260         void
00261         insert(_InputIterator __first, _InputIterator __last)
00262         {
00263       __glibcxx_check_valid_range(__first, __last);
00264       _Base::insert(__gnu_debug::__base(__first),
00265             __gnu_debug::__base(__last));
00266     }
00267 
00268 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00269       iterator
00270       erase(const_iterator __position)
00271       {
00272     __glibcxx_check_erase(__position);
00273     this->_M_invalidate_if(_Equal(__position.base()));
00274     return iterator(_Base::erase(__position.base()), this);
00275       }
00276 
00277       iterator
00278       erase(iterator __position)
00279       { return erase(const_iterator(__position)); }
00280 #else
00281       void
00282       erase(iterator __position)
00283       {
00284     __glibcxx_check_erase(__position);
00285     this->_M_invalidate_if(_Equal(__position.base()));
00286     _Base::erase(__position.base());
00287       }
00288 #endif
00289 
00290       size_type
00291       erase(const key_type& __x)
00292       {
00293     _Base_iterator __victim = _Base::find(__x);
00294     if (__victim == _Base::end())
00295       return 0;
00296     else
00297       {
00298         this->_M_invalidate_if(_Equal(__victim));
00299         _Base::erase(__victim);
00300         return 1;
00301       }
00302       }
00303 
00304 #ifdef __GXX_EXPERIMENTAL_CXX0X__
00305       iterator
00306       erase(const_iterator __first, const_iterator __last)
00307       {
00308     // _GLIBCXX_RESOLVE_LIB_DEFECTS
00309     // 151. can't currently clear() empty container
00310     __glibcxx_check_erase_range(__first, __last);
00311     for (_Base_const_iterator __victim = __first.base();
00312          __victim != __last.base(); ++__victim)
00313       {
00314         _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
00315                   _M_message(__gnu_debug::__msg_valid_range)
00316                   ._M_iterator(__first, "first")
00317                   ._M_iterator(__last, "last"));
00318         this->_M_invalidate_if(_Equal(__victim));
00319       }
00320     return iterator(_Base::erase(__first.base(), __last.base()), this);
00321       }
00322 #else
00323       void
00324       erase(iterator __first, iterator __last)
00325       {
00326     // _GLIBCXX_RESOLVE_LIB_DEFECTS
00327     // 151. can't currently clear() empty container
00328     __glibcxx_check_erase_range(__first, __last);
00329     for (_Base_iterator __victim = __first.base();
00330          __victim != __last.base(); ++__victim)
00331       {
00332         _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
00333                   _M_message(__gnu_debug::__msg_valid_range)
00334                   ._M_iterator(__first, "first")
00335                   ._M_iterator(__last, "last"));
00336         this->_M_invalidate_if(_Equal(__victim));
00337       }
00338     _Base::erase(__first.base(), __last.base());
00339       }
00340 #endif
00341 
00342       void
00343       swap(map& __x)
00344       {
00345     _Base::swap(__x);
00346     this->_M_swap(__x);
00347       }
00348 
00349       void
00350       clear()
00351       {
00352     this->_M_invalidate_all();
00353     _Base::clear();
00354       }
00355 
00356       // observers:
00357       using _Base::key_comp;
00358       using _Base::value_comp;
00359 
00360       // 23.3.1.3 map operations:
00361       iterator
00362       find(const key_type& __x)
00363       { return iterator(_Base::find(__x), this); }
00364 
00365       const_iterator
00366       find(const key_type& __x) const
00367       { return const_iterator(_Base::find(__x), this); }
00368 
00369       using _Base::count;
00370 
00371       iterator
00372       lower_bound(const key_type& __x)
00373       { return iterator(_Base::lower_bound(__x), this); }
00374 
00375       const_iterator
00376       lower_bound(const key_type& __x) const
00377       { return const_iterator(_Base::lower_bound(__x), this); }
00378 
00379       iterator
00380       upper_bound(const key_type& __x)
00381       { return iterator(_Base::upper_bound(__x), this); }
00382 
00383       const_iterator
00384       upper_bound(const key_type& __x) const
00385       { return const_iterator(_Base::upper_bound(__x), this); }
00386 
00387       std::pair<iterator,iterator>
00388       equal_range(const key_type& __x)
00389       {
00390     typedef typename _Base::iterator _Base_iterator;
00391     std::pair<_Base_iterator, _Base_iterator> __res =
00392     _Base::equal_range(__x);
00393     return std::make_pair(iterator(__res.first, this),
00394                   iterator(__res.second, this));
00395       }
00396 
00397       std::pair<const_iterator,const_iterator>
00398       equal_range(const key_type& __x) const
00399       {
00400     typedef typename _Base::const_iterator _Base_const_iterator;
00401     std::pair<_Base_const_iterator, _Base_const_iterator> __res =
00402     _Base::equal_range(__x);
00403     return std::make_pair(const_iterator(__res.first, this),
00404                   const_iterator(__res.second, this));
00405       }
00406 
00407       _Base& 
00408       _M_base() { return *this; }
00409 
00410       const _Base&
00411       _M_base() const { return *this; }
00412 
00413     private:
00414       void
00415       _M_invalidate_all()
00416       {
00417     typedef typename _Base::const_iterator _Base_const_iterator;
00418     typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
00419     this->_M_invalidate_if(_Not_equal(_M_base().end()));
00420       }
00421     };
00422 
00423   template<typename _Key, typename _Tp,
00424        typename _Compare, typename _Allocator>
00425     inline bool
00426     operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00427            const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00428     { return __lhs._M_base() == __rhs._M_base(); }
00429 
00430   template<typename _Key, typename _Tp,
00431        typename _Compare, typename _Allocator>
00432     inline bool
00433     operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00434            const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00435     { return __lhs._M_base() != __rhs._M_base(); }
00436 
00437   template<typename _Key, typename _Tp,
00438        typename _Compare, typename _Allocator>
00439     inline bool
00440     operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00441           const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00442     { return __lhs._M_base() < __rhs._M_base(); }
00443 
00444   template<typename _Key, typename _Tp,
00445        typename _Compare, typename _Allocator>
00446     inline bool
00447     operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00448            const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00449     { return __lhs._M_base() <= __rhs._M_base(); }
00450 
00451   template<typename _Key, typename _Tp,
00452        typename _Compare, typename _Allocator>
00453     inline bool
00454     operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00455            const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00456     { return __lhs._M_base() >= __rhs._M_base(); }
00457 
00458   template<typename _Key, typename _Tp,
00459        typename _Compare, typename _Allocator>
00460     inline bool
00461     operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00462           const map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00463     { return __lhs._M_base() > __rhs._M_base(); }
00464 
00465   template<typename _Key, typename _Tp,
00466        typename _Compare, typename _Allocator>
00467     inline void
00468     swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs,
00469      map<_Key, _Tp, _Compare, _Allocator>& __rhs)
00470     { __lhs.swap(__rhs); }
00471 
00472 } // namespace __debug
00473 } // namespace std
00474 
00475 #endif