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

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