libstdc++-v3/include/debug/multimap.h

   1 // Debugging multimap implementation -*- C++ -*-
   2
   3 // Copyright (C) 2003-2016 Free Software Foundation, Inc.
   4 //
   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)
   9 // any later version.
  10
  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.
  15
  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.
  19
  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/>.
  24
  25 /** @file debug/multimap.h
  26  *  This file is a GNU debug extension to the Standard C++ Library.
  27  */
  28
  29 #ifndef _GLIBCXX_DEBUG_MULTIMAP_H
  30 #define _GLIBCXX_DEBUG_MULTIMAP_H 1
  31
  32 #include <debug/safe_sequence.h>
  33 #include <debug/safe_container.h>
  34 #include <debug/safe_iterator.h>
  35 #include <utility>
  36
  37 namespace std _GLIBCXX_VISIBILITY(default)
  38 {
  39 namespace __debug
  40 {
  41   /// Class std::multimap 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> > >
  44     class multimap
  45       : public __gnu_debug::_Safe_container<
  46         multimap<_Key, _Tp, _Compare, _Allocator>, _Allocator,
  47         __gnu_debug::_Safe_node_sequence>,
  48         public _GLIBCXX_STD_C::multimap<_Key, _Tp, _Compare, _Allocator>
  49     {
  50       typedef _GLIBCXX_STD_C::multimap<
  51         _Key, _Tp, _Compare, _Allocator>                        _Base;
  52       typedef __gnu_debug::_Safe_container<
  53         multimap, _Allocator, __gnu_debug::_Safe_node_sequence> _Safe;
  54
  55       typedef typename _Base::const_iterator    _Base_const_iterator;
  56       typedef typename _Base::iterator          _Base_iterator;
  57       typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
  58
  59     public:
  60       // types:
  61       typedef _Key                                      key_type;
  62       typedef _Tp                                       mapped_type;
  63       typedef std::pair<const _Key, _Tp>                value_type;
  64       typedef _Compare                                  key_compare;
  65       typedef _Allocator                                allocator_type;
  66       typedef typename _Base::reference                 reference;
  67       typedef typename _Base::const_reference           const_reference;
  68
  69       typedef __gnu_debug::_Safe_iterator<_Base_iterator, multimap>
  70                                                         iterator;
  71       typedef __gnu_debug::_Safe_iterator<_Base_const_iterator,
  72                                           multimap>     const_iterator;
  73
  74       typedef typename _Base::size_type                 size_type;
  75       typedef typename _Base::difference_type           difference_type;
  76       typedef typename _Base::pointer                   pointer;
  77       typedef typename _Base::const_pointer             const_pointer;
  78       typedef std::reverse_iterator<iterator>           reverse_iterator;
  79       typedef std::reverse_iterator<const_iterator>     const_reverse_iterator;
  80
  81       // 23.3.1.1 construct/copy/destroy:
  82
  83 #if __cplusplus < 201103L
  84       multimap() : _Base() { }
  85
  86       multimap(const multimap& __x)
  87       : _Base(__x) { }
  88
  89       ~multimap() { }
  90 #else
  91       multimap() = default;
  92       multimap(const multimap&) = default;
  93       multimap(multimap&&) = default;
  94
  95       multimap(initializer_list<value_type> __l,
  96                const _Compare& __c = _Compare(),
  97                const allocator_type& __a = allocator_type())
  98       : _Base(__l, __c, __a) { }
  99
 100       explicit
 101       multimap(const allocator_type& __a)
 102       : _Base(__a) { }
 103
 104       multimap(const multimap& __m, const allocator_type& __a)
 105       : _Base(__m, __a) { }
 106
 107       multimap(multimap&& __m, const allocator_type& __a)
 108       : _Safe(std::move(__m._M_safe()), __a),
 109         _Base(std::move(__m._M_base()), __a) { }
 110
 111       multimap(initializer_list<value_type> __l, const allocator_type& __a)
 112       : _Base(__l, __a) { }
 113
 114       template<typename _InputIterator>
 115         multimap(_InputIterator __first, _InputIterator __last,
 116                  const allocator_type& __a)
 117         : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
 118                                                                      __last)),
 119                 __gnu_debug::__base(__last), __a) { }
 120
 121       ~multimap() = default;
 122 #endif
 123
 124       explicit multimap(const _Compare& __comp,
 125                         const _Allocator& __a = _Allocator())
 126       : _Base(__comp, __a) { }
 127
 128       template<typename _InputIterator>
 129       multimap(_InputIterator __first, _InputIterator __last,
 130                const _Compare& __comp = _Compare(),
 131                const _Allocator& __a = _Allocator())
 132         : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,
 133                                                                      __last)),
 134                 __gnu_debug::__base(__last),
 135               __comp, __a) { }
 136
 137       multimap(const _Base& __x)
 138       : _Base(__x) { }
 139
 140 #if __cplusplus < 201103L
 141       multimap&
 142       operator=(const multimap& __x)
 143       {
 144         this->_M_safe() = __x;
 145         _M_base() = __x;
 146         return *this;
 147       }
 148 #else
 149       multimap&
 150       operator=(const multimap&) = default;
 151
 152       multimap&
 153       operator=(multimap&&) = default;
 154
 155       multimap&
 156       operator=(initializer_list<value_type> __l)
 157       {
 158         _M_base() = __l;
 159         this->_M_invalidate_all();
 160         return *this;
 161       }
 162 #endif
 163
 164       using _Base::get_allocator;
 165
 166       // iterators:
 167       iterator
 168       begin() _GLIBCXX_NOEXCEPT
 169       { return iterator(_Base::begin(), this); }
 170
 171       const_iterator
 172       begin() const _GLIBCXX_NOEXCEPT
 173       { return const_iterator(_Base::begin(), this); }
 174
 175       iterator
 176       end() _GLIBCXX_NOEXCEPT
 177       { return iterator(_Base::end(), this); }
 178
 179       const_iterator
 180       end() const _GLIBCXX_NOEXCEPT
 181       { return const_iterator(_Base::end(), this); }
 182
 183       reverse_iterator
 184       rbegin() _GLIBCXX_NOEXCEPT
 185       { return reverse_iterator(end()); }
 186
 187       const_reverse_iterator
 188       rbegin() const _GLIBCXX_NOEXCEPT
 189       { return const_reverse_iterator(end()); }
 190
 191       reverse_iterator
 192       rend() _GLIBCXX_NOEXCEPT
 193       { return reverse_iterator(begin()); }
 194
 195       const_reverse_iterator
 196       rend() const _GLIBCXX_NOEXCEPT
 197       { return const_reverse_iterator(begin()); }
 198
 199 #if __cplusplus >= 201103L
 200       const_iterator
 201       cbegin() const noexcept
 202       { return const_iterator(_Base::begin(), this); }
 203
 204       const_iterator
 205       cend() const noexcept
 206       { return const_iterator(_Base::end(), this); }
 207
 208       const_reverse_iterator
 209       crbegin() const noexcept
 210       { return const_reverse_iterator(end()); }
 211
 212       const_reverse_iterator
 213       crend() const noexcept
 214       { return const_reverse_iterator(begin()); }
 215 #endif
 216
 217       // capacity:
 218       using _Base::empty;
 219       using _Base::size;
 220       using _Base::max_size;
 221
 222       // modifiers:
 223 #if __cplusplus >= 201103L
 224       template<typename... _Args>
 225         iterator
 226         emplace(_Args&&... __args)
 227         {
 228           return iterator(_Base::emplace(std::forward<_Args>(__args)...), this);
 229         }
 230
 231       template<typename... _Args>
 232         iterator
 233         emplace_hint(const_iterator __pos, _Args&&... __args)
 234         {
 235           __glibcxx_check_insert(__pos);
 236           return iterator(_Base::emplace_hint(__pos.base(),
 237                                               std::forward<_Args>(__args)...),
 238                           this);
 239         }
 240 #endif
 241
 242       iterator
 243       insert(const value_type& __x)
 244       { return iterator(_Base::insert(__x), this); }
 245
 246 #if __cplusplus >= 201103L
 247       template<typename _Pair, typename = typename
 248                std::enable_if<std::is_constructible<value_type,
 249                                                     _Pair&&>::value>::type>
 250         iterator
 251         insert(_Pair&& __x)
 252         { return iterator(_Base::insert(std::forward<_Pair>(__x)), this); }
 253 #endif
 254
 255 #if __cplusplus >= 201103L
 256       void
 257       insert(std::initializer_list<value_type> __list)
 258       { _Base::insert(__list); }
 259 #endif
 260
 261       iterator
 262 #if __cplusplus >= 201103L
 263       insert(const_iterator __position, const value_type& __x)
 264 #else
 265       insert(iterator __position, const value_type& __x)
 266 #endif
 267       {
 268         __glibcxx_check_insert(__position);
 269         return iterator(_Base::insert(__position.base(), __x), this);
 270       }
 271
 272 #if __cplusplus >= 201103L
 273       template<typename _Pair, typename = typename
 274                std::enable_if<std::is_constructible<value_type,
 275                                                     _Pair&&>::value>::type>
 276         iterator
 277         insert(const_iterator __position, _Pair&& __x)
 278         {
 279           __glibcxx_check_insert(__position);
 280           return iterator(_Base::insert(__position.base(),
 281                                         std::forward<_Pair>(__x)), this);
 282         }
 283 #endif
 284
 285       template<typename _InputIterator>
 286         void
 287         insert(_InputIterator __first, _InputIterator __last)
 288         {
 289           typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
 290           __glibcxx_check_valid_range2(__first, __last, __dist);
 291
 292           if (__dist.second >= __gnu_debug::__dp_sign)
 293             _Base::insert(__gnu_debug::__unsafe(__first),
 294                           __gnu_debug::__unsafe(__last));
 295           else
 296             _Base::insert(__first, __last);
 297         }
 298
 299 #if __cplusplus > 201402L
 300       using node_type = typename _Base::node_type;
 301
 302       node_type
 303       extract(const_iterator __position)
 304       {
 305         __glibcxx_check_erase(__position);
 306         this->_M_invalidate_if(_Equal(__position.base()));
 307         return _Base::extract(__position.base());
 308       }
 309
 310       node_type
 311       extract(const key_type& __key)
 312       {
 313         const auto __position = find(__key);
 314         if (__position != end())
 315           return extract(__position);
 316         return {};
 317       }
 318
 319       iterator
 320       insert(node_type&& __nh)
 321       { return iterator(_Base::insert(std::move(__nh)), this); }
 322
 323       iterator
 324       insert(const_iterator __hint, node_type&& __nh)
 325       {
 326         __glibcxx_check_insert(__hint);
 327         return iterator(_Base::insert(__hint.base(), std::move(__nh)), this);
 328       }
 329
 330       using _Base::merge;
 331 #endif // C++17
 332
 333 #if __cplusplus >= 201103L
 334       iterator
 335       erase(const_iterator __position)
 336       {
 337         __glibcxx_check_erase(__position);
 338         this->_M_invalidate_if(_Equal(__position.base()));
 339         return iterator(_Base::erase(__position.base()), this);
 340       }
 341
 342       iterator
 343       erase(iterator __position)
 344       { return erase(const_iterator(__position)); }
 345 #else
 346       void
 347       erase(iterator __position)
 348       {
 349         __glibcxx_check_erase(__position);
 350         this->_M_invalidate_if(_Equal(__position.base()));
 351         _Base::erase(__position.base());
 352       }
 353 #endif
 354
 355       size_type
 356       erase(const key_type& __x)
 357       {
 358         std::pair<_Base_iterator, _Base_iterator> __victims =
 359           _Base::equal_range(__x);
 360         size_type __count = 0;
 361         _Base_iterator __victim = __victims.first;
 362         while (__victim !=  __victims.second)
 363           {
 364             this->_M_invalidate_if(_Equal(__victim));
 365             _Base::erase(__victim++);
 366             ++__count;
 367           }
 368         return __count;
 369       }
 370
 371 #if __cplusplus >= 201103L
 372       iterator
 373       erase(const_iterator __first, const_iterator __last)
 374       {
 375         // _GLIBCXX_RESOLVE_LIB_DEFECTS
 376         // 151. can't currently clear() empty container
 377         __glibcxx_check_erase_range(__first, __last);
 378         for (_Base_const_iterator __victim = __first.base();
 379              __victim != __last.base(); ++__victim)
 380           {
 381             _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
 382                                   _M_message(__gnu_debug::__msg_valid_range)
 383                                   ._M_iterator(__first, "first")
 384                                   ._M_iterator(__last, "last"));
 385             this->_M_invalidate_if(_Equal(__victim));
 386           }
 387         return iterator(_Base::erase(__first.base(), __last.base()), this);
 388       }
 389 #else
 390       void
 391       erase(iterator __first, iterator __last)
 392       {
 393         // _GLIBCXX_RESOLVE_LIB_DEFECTS
 394         // 151. can't currently clear() empty container
 395         __glibcxx_check_erase_range(__first, __last);
 396         for (_Base_iterator __victim = __first.base();
 397              __victim != __last.base(); ++__victim)
 398           {
 399             _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),
 400                                   _M_message(__gnu_debug::__msg_valid_range)
 401                                   ._M_iterator(__first, "first")
 402                                   ._M_iterator(__last, "last"));
 403             this->_M_invalidate_if(_Equal(__victim));
 404           }
 405         _Base::erase(__first.base(), __last.base());
 406       }
 407 #endif
 408
 409       void
 410       swap(multimap& __x)
 411       _GLIBCXX_NOEXCEPT_IF( noexcept(declval<_Base&>().swap(__x)) )
 412       {
 413         _Safe::_M_swap(__x);
 414         _Base::swap(__x);
 415       }
 416
 417       void
 418       clear() _GLIBCXX_NOEXCEPT
 419       {
 420         this->_M_invalidate_all();
 421         _Base::clear();
 422       }
 423
 424       // observers:
 425       using _Base::key_comp;
 426       using _Base::value_comp;
 427
 428       // 23.3.1.3 multimap operations:
 429       iterator
 430       find(const key_type& __x)
 431       { return iterator(_Base::find(__x), this); }
 432
 433 #if __cplusplus > 201103L
 434       template<typename _Kt,
 435                typename _Req =
 436                  typename __has_is_transparent<_Compare, _Kt>::type>
 437         iterator
 438         find(const _Kt& __x)
 439         { return { _Base::find(__x), this }; }
 440 #endif
 441
 442       const_iterator
 443       find(const key_type& __x) const
 444       { return const_iterator(_Base::find(__x), this); }
 445
 446 #if __cplusplus > 201103L
 447       template<typename _Kt,
 448                typename _Req =
 449                  typename __has_is_transparent<_Compare, _Kt>::type>
 450         const_iterator
 451         find(const _Kt& __x) const
 452         { return { _Base::find(__x), this }; }
 453 #endif
 454
 455       using _Base::count;
 456
 457       iterator
 458       lower_bound(const key_type& __x)
 459       { return iterator(_Base::lower_bound(__x), this); }
 460
 461 #if __cplusplus > 201103L
 462       template<typename _Kt,
 463                typename _Req =
 464                  typename __has_is_transparent<_Compare, _Kt>::type>
 465         iterator
 466         lower_bound(const _Kt& __x)
 467         { return { _Base::lower_bound(__x), this }; }
 468 #endif
 469
 470       const_iterator
 471       lower_bound(const key_type& __x) const
 472       { return const_iterator(_Base::lower_bound(__x), this); }
 473
 474 #if __cplusplus > 201103L
 475       template<typename _Kt,
 476                typename _Req =
 477                  typename __has_is_transparent<_Compare, _Kt>::type>
 478         const_iterator
 479         lower_bound(const _Kt& __x) const
 480         { return { _Base::lower_bound(__x), this }; }
 481 #endif
 482
 483       iterator
 484       upper_bound(const key_type& __x)
 485       { return iterator(_Base::upper_bound(__x), this); }
 486
 487 #if __cplusplus > 201103L
 488       template<typename _Kt,
 489                typename _Req =
 490                  typename __has_is_transparent<_Compare, _Kt>::type>
 491         iterator
 492         upper_bound(const _Kt& __x)
 493         { return { _Base::upper_bound(__x), this }; }
 494 #endif
 495
 496       const_iterator
 497       upper_bound(const key_type& __x) const
 498       { return const_iterator(_Base::upper_bound(__x), this); }
 499
 500 #if __cplusplus > 201103L
 501       template<typename _Kt,
 502                typename _Req =
 503                  typename __has_is_transparent<_Compare, _Kt>::type>
 504         const_iterator
 505         upper_bound(const _Kt& __x) const
 506         { return { _Base::upper_bound(__x), this }; }
 507 #endif
 508
 509       std::pair<iterator,iterator>
 510       equal_range(const key_type& __x)
 511       {
 512         std::pair<_Base_iterator, _Base_iterator> __res =
 513         _Base::equal_range(__x);
 514         return std::make_pair(iterator(__res.first, this),
 515                               iterator(__res.second, this));
 516       }
 517
 518 #if __cplusplus > 201103L
 519       template<typename _Kt,
 520                typename _Req =
 521                  typename __has_is_transparent<_Compare, _Kt>::type>
 522         std::pair<iterator, iterator>
 523         equal_range(const _Kt& __x)
 524         {
 525           auto __res = _Base::equal_range(__x);
 526           return { { __res.first, this }, { __res.second, this } };
 527         }
 528 #endif
 529
 530       std::pair<const_iterator,const_iterator>
 531       equal_range(const key_type& __x) const
 532       {
 533         std::pair<_Base_const_iterator, _Base_const_iterator> __res =
 534           _Base::equal_range(__x);
 535         return std::make_pair(const_iterator(__res.first, this),
 536                               const_iterator(__res.second, this));
 537       }
 538
 539 #if __cplusplus > 201103L
 540       template<typename _Kt,
 541                typename _Req =
 542                  typename __has_is_transparent<_Compare, _Kt>::type>
 543         std::pair<const_iterator, const_iterator>
 544         equal_range(const _Kt& __x) const
 545         {
 546           auto __res = _Base::equal_range(__x);
 547           return { { __res.first, this }, { __res.second, this } };
 548         }
 549 #endif
 550
 551       _Base&
 552       _M_base() _GLIBCXX_NOEXCEPT { return *this; }
 553
 554       const _Base&
 555       _M_base() const _GLIBCXX_NOEXCEPT { return *this; }
 556     };
 557
 558   template<typename _Key, typename _Tp,
 559            typename _Compare, typename _Allocator>
 560     inline bool
 561     operator==(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 562                const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 563     { return __lhs._M_base() == __rhs._M_base(); }
 564
 565   template<typename _Key, typename _Tp,
 566            typename _Compare, typename _Allocator>
 567     inline bool
 568     operator!=(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 569                const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 570     { return __lhs._M_base() != __rhs._M_base(); }
 571
 572   template<typename _Key, typename _Tp,
 573            typename _Compare, typename _Allocator>
 574     inline bool
 575     operator<(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 576               const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 577     { return __lhs._M_base() < __rhs._M_base(); }
 578
 579   template<typename _Key, typename _Tp,
 580            typename _Compare, typename _Allocator>
 581     inline bool
 582     operator<=(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 583                const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 584     { return __lhs._M_base() <= __rhs._M_base(); }
 585
 586   template<typename _Key, typename _Tp,
 587            typename _Compare, typename _Allocator>
 588     inline bool
 589     operator>=(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 590                const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 591     { return __lhs._M_base() >= __rhs._M_base(); }
 592
 593   template<typename _Key, typename _Tp,
 594            typename _Compare, typename _Allocator>
 595     inline bool
 596     operator>(const multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 597               const multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 598     { return __lhs._M_base() > __rhs._M_base(); }
 599
 600   template<typename _Key, typename _Tp,
 601            typename _Compare, typename _Allocator>
 602     inline void
 603     swap(multimap<_Key, _Tp, _Compare, _Allocator>& __lhs,
 604          multimap<_Key, _Tp, _Compare, _Allocator>& __rhs)
 605     _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs)))
 606     { __lhs.swap(__rhs); }
 607
 608 } // namespace __debug
 609 } // namespace std
 610
 611 #endif