libstdc++-v3/include/debug/unordered_map

   1 // Debugging unordered_map/unordered_multimap implementation -*- C++ -*-
   2
   3 // Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009
   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 3, 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 // 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.
  20
  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/>.
  25
  26 /** @file debug/unordered_map
  27  *  This file is a GNU debug extension to the Standard C++ Library.
  28  */
  29
  30 #ifndef _GLIBCXX_DEBUG_UNORDERED_MAP
  31 #define _GLIBCXX_DEBUG_UNORDERED_MAP 1
  32
  33 #ifdef __GXX_EXPERIMENTAL_CXX0X__
  34 # include <unordered_map>
  35 #else
  36 # include <c++0x_warning.h>
  37 #endif
  38
  39 #include <debug/safe_sequence.h>
  40 #include <debug/safe_iterator.h>
  41 #include <initializer_list>
  42
  43 namespace std
  44 {
  45 namespace __debug
  46 {
  47   template<typename _Key, typename _Tp,
  48            typename _Hash = std::hash<_Key>,
  49            typename _Pred = std::equal_to<_Key>,
  50            typename _Alloc = std::allocator<_Key> >
  51     class unordered_map
  52     : public _GLIBCXX_STD_D::unordered_map<_Key, _Tp, _Hash, _Pred, _Alloc>,
  53       public __gnu_debug::_Safe_sequence<unordered_map<_Key, _Tp, _Hash,
  54                                                        _Pred, _Alloc> >
  55     {
  56       typedef _GLIBCXX_STD_D::unordered_map<_Key, _Tp, _Hash,
  57                                             _Pred, _Alloc> _Base;
  58       typedef __gnu_debug::_Safe_sequence<unordered_map> _Safe_base;
  59
  60     public:
  61       typedef typename _Base::size_type       size_type;
  62       typedef typename _Base::hasher          hasher;
  63       typedef typename _Base::key_equal       key_equal;
  64       typedef typename _Base::allocator_type  allocator_type;
  65
  66       typedef typename _Base::key_type        key_type;
  67       typedef typename _Base::value_type      value_type;
  68
  69       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator,
  70                                           unordered_map> iterator;
  71       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
  72                                           unordered_map> const_iterator;
  73
  74       explicit
  75       unordered_map(size_type __n = 10,
  76                     const hasher& __hf = hasher(),
  77                     const key_equal& __eql = key_equal(),
  78                     const allocator_type& __a = allocator_type())
  79       : _Base(__n, __hf, __eql, __a) { }
  80
  81       template<typename _InputIterator>
  82         unordered_map(_InputIterator __f, _InputIterator __l,
  83                       size_type __n = 10,
  84                       const hasher& __hf = hasher(),
  85                       const key_equal& __eql = key_equal(),
  86                       const allocator_type& __a = allocator_type())
  87         : _Base(__gnu_debug::__check_valid_range(__f, __l), __l, __n,
  88                 __hf, __eql, __a), _Safe_base() { }
  89
  90       unordered_map(const unordered_map& __x)
  91       : _Base(__x), _Safe_base() { }
  92
  93       unordered_map(const _Base& __x)
  94       : _Base(__x), _Safe_base() { }
  95
  96       unordered_map(unordered_map&& __x)
  97       : _Base(std::forward<unordered_map>(__x)), _Safe_base() { }
  98
  99       unordered_map(initializer_list<value_type> __l,
 100                     size_type __n = 10,
 101                     const hasher& __hf = hasher(),
 102                     const key_equal& __eql = key_equal(),
 103                     const allocator_type& __a = allocator_type())
 104       : _Base(__l, __n, __hf, __eql, __a), _Safe_base() { }
 105
 106       unordered_map&
 107       operator=(const unordered_map& __x)
 108       {
 109         *static_cast<_Base*>(this) = __x;
 110         this->_M_invalidate_all();
 111         return *this;
 112       }
 113
 114       unordered_map&
 115       operator=(unordered_map&& __x)
 116       {
 117         // NB: DR 675.
 118         clear();
 119         swap(__x);
 120         return *this;
 121       }
 122
 123       unordered_map&
 124       operator=(initializer_list<value_type> __l)
 125       {
 126         this->clear();
 127         this->insert(__l);
 128         return *this;
 129       }
 130
 131       void
 132       swap(unordered_map& __x)
 133       {
 134         _Base::swap(__x);
 135         _Safe_base::_M_swap(__x);
 136       }
 137
 138       void
 139       clear()
 140       {
 141         _Base::clear();
 142         this->_M_invalidate_all();
 143       }
 144
 145       iterator
 146       begin()
 147       { return iterator(_Base::begin(), this); }
 148
 149       const_iterator
 150       begin() const
 151       { return const_iterator(_Base::begin(), this); }
 152
 153       iterator
 154       end()
 155       { return iterator(_Base::end(), this); }
 156
 157       const_iterator
 158       end() const
 159       { return const_iterator(_Base::end(), this); }
 160
 161       const_iterator
 162       cbegin() const
 163       { return const_iterator(_Base::begin(), this); }
 164
 165       const_iterator
 166       cend() const
 167       { return const_iterator(_Base::end(), this); }
 168
 169       // local versions
 170       using _Base::begin;
 171       using _Base::end;
 172       using _Base::cbegin;
 173       using _Base::cend;
 174
 175       std::pair<iterator, bool>
 176       insert(const value_type& __obj)
 177       {
 178         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 179         __pair_type __res = _Base::insert(__obj);
 180         return std::make_pair(iterator(__res.first, this), __res.second);
 181       }
 182
 183       iterator
 184       insert(iterator, const value_type& __obj)
 185       {
 186         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 187         __pair_type __res = _Base::insert(__obj);
 188         return iterator(__res.first, this);
 189       }
 190
 191       const_iterator
 192       insert(const_iterator, const value_type& __obj)
 193       {
 194         typedef std::pair<typename _Base::iterator, bool> __pair_type;
 195         __pair_type __res = _Base::insert(__obj);
 196         return const_iterator(__res.first, this);
 197       }
 198
 199       void
 200       insert(std::initializer_list<value_type> __l)
 201       { _Base::insert(__l); }
 202
 203       template<typename _InputIterator>
 204         void
 205         insert(_InputIterator __first, _InputIterator __last)
 206         {
 207           __glibcxx_check_valid_range(__first, __last);
 208           _Base::insert(__first, __last);
 209         }
 210
 211       iterator
 212       find(const key_type& __key)
 213       { return iterator(_Base::find(__key), this); }
 214
 215       const_iterator
 216       find(const key_type& __key) const
 217       { return const_iterator(_Base::find(__key), this); }
 218
 219       std::pair<iterator, iterator>
 220       equal_range(const key_type& __key)
 221       {
 222         typedef typename _Base::iterator _Base_iterator;
 223         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 224         __pair_type __res = _Base::equal_range(__key);
 225         return std::make_pair(iterator(__res.first, this),
 226                               iterator(__res.second, this));
 227       }
 228
 229       std::pair<const_iterator, const_iterator>
 230       equal_range(const key_type& __key) const
 231       {
 232         typedef typename _Base::const_iterator _Base_iterator;
 233         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 234         __pair_type __res = _Base::equal_range(__key);
 235         return std::make_pair(const_iterator(__res.first, this),
 236                               const_iterator(__res.second, this));
 237       }
 238
 239       size_type
 240       erase(const key_type& __key)
 241       {
 242         size_type __ret(0);
 243         iterator __victim(_Base::find(__key), this);
 244         if (__victim != end())
 245           {
 246             this->erase(__victim);
 247             __ret = 1;
 248           }
 249         return __ret;
 250       }
 251
 252       iterator
 253       erase(iterator __it)
 254       {
 255         __glibcxx_check_erase(__it);
 256         __it._M_invalidate();
 257         return iterator(_Base::erase(__it.base()), this);
 258       }
 259
 260       const_iterator
 261       erase(const_iterator __it)
 262       {
 263         __glibcxx_check_erase(__it);
 264         __it._M_invalidate();
 265         return const_iterator(_Base::erase(__it.base()), this);
 266       }
 267
 268       iterator
 269       erase(iterator __first, iterator __last)
 270       {
 271         __glibcxx_check_erase_range(__first, __last);
 272         for (iterator __tmp = __first; __tmp != __last;)
 273         {
 274           iterator __victim = __tmp++;
 275           __victim._M_invalidate();
 276         }
 277         return iterator(_Base::erase(__first.base(),
 278                                      __last.base()), this);
 279       }
 280
 281       const_iterator
 282       erase(const_iterator __first, const_iterator __last)
 283       {
 284         __glibcxx_check_erase_range(__first, __last);
 285         for (const_iterator __tmp = __first; __tmp != __last;)
 286         {
 287           const_iterator __victim = __tmp++;
 288           __victim._M_invalidate();
 289         }
 290         return const_iterator(_Base::erase(__first.base(),
 291                                            __last.base()), this);
 292       }
 293
 294       _Base&
 295       _M_base() { return *this; }
 296
 297       const _Base&
 298       _M_base() const { return *this; }
 299
 300     private:
 301       void
 302       _M_invalidate_all()
 303       {
 304         typedef typename _Base::const_iterator _Base_const_iterator;
 305         typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
 306         this->_M_invalidate_if(_Not_equal(_M_base().end()));
 307       }
 308     };
 309
 310   template<typename _Key, typename _Tp, typename _Hash,
 311            typename _Pred, typename _Alloc>
 312     inline void
 313     swap(unordered_map<_Key, _Tp, _Hash, _Pred, _Alloc>& __x,
 314          unordered_map<_Key, _Tp, _Hash, _Pred, _Alloc>& __y)
 315     { __x.swap(__y); }
 316
 317
 318   template<typename _Key, typename _Tp,
 319            typename _Hash = std::hash<_Key>,
 320            typename _Pred = std::equal_to<_Key>,
 321            typename _Alloc = std::allocator<_Key> >
 322     class unordered_multimap
 323     : public _GLIBCXX_STD_D::unordered_multimap<_Key, _Tp, _Hash,
 324                                                 _Pred, _Alloc>,
 325       public __gnu_debug::_Safe_sequence<unordered_multimap<_Key, _Tp, _Hash,
 326                                                             _Pred, _Alloc> >
 327     {
 328       typedef _GLIBCXX_STD_D::unordered_multimap<_Key, _Tp, _Hash,
 329                                                  _Pred, _Alloc> _Base;
 330       typedef __gnu_debug::_Safe_sequence<unordered_multimap> _Safe_base;
 331
 332     public:
 333       typedef typename _Base::size_type       size_type;
 334       typedef typename _Base::hasher          hasher;
 335       typedef typename _Base::key_equal       key_equal;
 336       typedef typename _Base::allocator_type  allocator_type;
 337
 338       typedef typename _Base::key_type        key_type;
 339       typedef typename _Base::value_type      value_type;
 340
 341       typedef __gnu_debug::_Safe_iterator<typename _Base::iterator,
 342                                           unordered_multimap> iterator;
 343       typedef __gnu_debug::_Safe_iterator<typename _Base::const_iterator,
 344                                           unordered_multimap> const_iterator;
 345
 346       explicit
 347       unordered_multimap(size_type __n = 10,
 348                          const hasher& __hf = hasher(),
 349                          const key_equal& __eql = key_equal(),
 350                          const allocator_type& __a = allocator_type())
 351       : _Base(__n, __hf, __eql, __a) { }
 352
 353       template<typename _InputIterator>
 354         unordered_multimap(_InputIterator __f, _InputIterator __l,
 355                            size_type __n = 10,
 356                            const hasher& __hf = hasher(),
 357                            const key_equal& __eql = key_equal(),
 358                            const allocator_type& __a = allocator_type())
 359         : _Base(__gnu_debug::__check_valid_range(__f, __l), __l, __n,
 360                 __hf, __eql, __a), _Safe_base() { }
 361
 362       unordered_multimap(const unordered_multimap& __x)
 363       : _Base(__x), _Safe_base() { }
 364
 365       unordered_multimap(const _Base& __x)
 366       : _Base(__x), _Safe_base() { }
 367
 368       unordered_multimap(unordered_multimap&& __x)
 369       : _Base(std::forward<unordered_multimap>(__x)), _Safe_base() { }
 370
 371       unordered_multimap(initializer_list<value_type> __l,
 372                          size_type __n = 10,
 373                          const hasher& __hf = hasher(),
 374                          const key_equal& __eql = key_equal(),
 375                          const allocator_type& __a = allocator_type())
 376       : _Base(__l, __n, __hf, __eql, __a), _Safe_base() { }
 377
 378       unordered_multimap&
 379       operator=(const unordered_multimap& __x)
 380       {
 381         *static_cast<_Base*>(this) = __x;
 382         this->_M_invalidate_all();
 383         return *this;
 384       }
 385
 386       unordered_multimap&
 387       operator=(unordered_multimap&& __x)
 388       {
 389         // NB: DR 675.
 390         clear();
 391         swap(__x);
 392         return *this;
 393       }
 394
 395       unordered_multimap&
 396       operator=(initializer_list<value_type> __l)
 397       {
 398         this->clear();
 399         this->insert(__l);
 400         return *this;
 401       }
 402
 403       void
 404       swap(unordered_multimap& __x)
 405       {
 406         _Base::swap(__x);
 407         _Safe_base::_M_swap(__x);
 408       }
 409
 410       void
 411       clear()
 412       {
 413         _Base::clear();
 414         this->_M_invalidate_all();
 415       }
 416
 417       iterator
 418       begin()
 419       { return iterator(_Base::begin(), this); }
 420
 421       const_iterator
 422       begin() const
 423       { return const_iterator(_Base::begin(), this); }
 424
 425       iterator
 426       end()
 427       { return iterator(_Base::end(), this); }
 428
 429       const_iterator
 430       end() const
 431       { return const_iterator(_Base::end(), this); }
 432
 433       const_iterator
 434       cbegin() const
 435       { return const_iterator(_Base::begin(), this); }
 436
 437       const_iterator
 438       cend() const
 439       { return const_iterator(_Base::end(), this); }
 440
 441       // local versions
 442       using _Base::begin;
 443       using _Base::end;
 444       using _Base::cbegin;
 445       using _Base::cend;
 446
 447       iterator
 448       insert(const value_type& __obj)
 449       { return iterator(_Base::insert(__obj), this); }
 450
 451       iterator
 452       insert(iterator, const value_type& __obj)
 453       { return iterator(_Base::insert(__obj), this); }
 454
 455       const_iterator
 456       insert(const_iterator, const value_type& __obj)
 457       { return const_iterator(_Base::insert(__obj), this); }
 458
 459       void
 460       insert(std::initializer_list<value_type> __l)
 461       { _Base::insert(__l); }
 462
 463       template<typename _InputIterator>
 464         void
 465         insert(_InputIterator __first, _InputIterator __last)
 466         {
 467           __glibcxx_check_valid_range(__first, __last);
 468           _Base::insert(__first, __last);
 469         }
 470
 471       iterator
 472       find(const key_type& __key)
 473       { return iterator(_Base::find(__key), this); }
 474
 475       const_iterator
 476       find(const key_type& __key) const
 477       { return const_iterator(_Base::find(__key), this); }
 478
 479       std::pair<iterator, iterator>
 480       equal_range(const key_type& __key)
 481       {
 482         typedef typename _Base::iterator _Base_iterator;
 483         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 484         __pair_type __res = _Base::equal_range(__key);
 485         return std::make_pair(iterator(__res.first, this),
 486                               iterator(__res.second, this));
 487       }
 488
 489       std::pair<const_iterator, const_iterator>
 490       equal_range(const key_type& __key) const
 491       {
 492         typedef typename _Base::const_iterator _Base_iterator;
 493         typedef std::pair<_Base_iterator, _Base_iterator> __pair_type;
 494         __pair_type __res = _Base::equal_range(__key);
 495         return std::make_pair(const_iterator(__res.first, this),
 496                               const_iterator(__res.second, this));
 497       }
 498
 499       size_type
 500       erase(const key_type& __key)
 501       {
 502         size_type __ret(0);
 503         iterator __victim(_Base::find(__key), this);
 504         if (__victim != end())
 505           {
 506             this->erase(__victim);
 507             __ret = 1;
 508           }
 509         return __ret;
 510       }
 511
 512       iterator
 513       erase(iterator __it)
 514       {
 515         __glibcxx_check_erase(__it);
 516         __it._M_invalidate();
 517         return iterator(_Base::erase(__it.base()), this);
 518       }
 519
 520       const_iterator
 521       erase(const_iterator __it)
 522       {
 523         __glibcxx_check_erase(__it);
 524         __it._M_invalidate();
 525         return const_iterator(_Base::erase(__it.base()), this);
 526       }
 527
 528       iterator
 529       erase(iterator __first, iterator __last)
 530       {
 531         __glibcxx_check_erase_range(__first, __last);
 532         for (iterator __tmp = __first; __tmp != __last;)
 533         {
 534           iterator __victim = __tmp++;
 535           __victim._M_invalidate();
 536         }
 537         return iterator(_Base::erase(__first.base(),
 538                                      __last.base()), this);
 539       }
 540
 541       const_iterator
 542       erase(const_iterator __first, const_iterator __last)
 543       {
 544         __glibcxx_check_erase_range(__first, __last);
 545         for (const_iterator __tmp = __first; __tmp != __last;)
 546         {
 547           const_iterator __victim = __tmp++;
 548           __victim._M_invalidate();
 549         }
 550         return const_iterator(_Base::erase(__first.base(),
 551                                            __last.base()), this);
 552       }
 553
 554       _Base&
 555       _M_base() { return *this; }
 556
 557       const _Base&
 558       _M_base() const { return *this; }
 559
 560     private:
 561       void
 562       _M_invalidate_all()
 563       {
 564         typedef typename _Base::const_iterator _Base_const_iterator;
 565         typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;
 566         this->_M_invalidate_if(_Not_equal(_M_base().end()));
 567       }
 568     };
 569
 570   template<typename _Key, typename _Tp, typename _Hash,
 571            typename _Pred, typename _Alloc>
 572     inline void
 573     swap(unordered_multimap<_Key, _Tp, _Hash, _Pred, _Alloc>& __x,
 574          unordered_multimap<_Key, _Tp, _Hash, _Pred, _Alloc>& __y)
 575     { __x.swap(__y); }
 576
 577 } // namespace __debug
 578 } // namespace std
 579
 580 #endif