1 // Debugging map 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/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 321 #if __cplusplus > 201402L 322 template <typename... _Args> 323 pair<iterator, bool> 324 try_emplace(const key_type& __k, _Args&&... __args) 325 { 326 auto __res = _Base::try_emplace(__k, 327 std::forward<_Args>(__args)...); 328 return { iterator(__res.first, this), __res.second }; 329 } 330 331 template <typename... _Args> 332 pair<iterator, bool> 333 try_emplace(key_type&& __k, _Args&&... __args) 334 { 335 auto __res = _Base::try_emplace(std::move(__k), 336 std::forward<_Args>(__args)...); 337 return { iterator(__res.first, this), __res.second }; 338 } 339 340 template <typename... _Args> 341 iterator 342 try_emplace(const_iterator __hint, const key_type& __k, 343 _Args&&... __args) 344 { 345 __glibcxx_check_insert(__hint); 346 return iterator(_Base::try_emplace(__hint.base(), __k, 347 std::forward<_Args>(__args)...), 348 this); 349 } 350 351 template <typename... _Args> 352 iterator 353 try_emplace(const_iterator __hint, key_type&& __k, _Args&&... __args) 354 { 355 __glibcxx_check_insert(__hint); 356 return iterator(_Base::try_emplace(__hint.base(), std::move(__k), 357 std::forward<_Args>(__args)...), 358 this); 359 } 360 361 template <typename _Obj> 362 std::pair<iterator, bool> 363 insert_or_assign(const key_type& __k, _Obj&& __obj) 364 { 365 auto __res = _Base::insert_or_assign(__k, 366 std::forward<_Obj>(__obj)); 367 return { iterator(__res.first, this), __res.second }; 368 } 369 370 template <typename _Obj> 371 std::pair<iterator, bool> 372 insert_or_assign(key_type&& __k, _Obj&& __obj) 373 { 374 auto __res = _Base::insert_or_assign(std::move(__k), 375 std::forward<_Obj>(__obj)); 376 return { iterator(__res.first, this), __res.second }; 377 } 378 379 template <typename _Obj> 380 iterator 381 insert_or_assign(const_iterator __hint, 382 const key_type& __k, _Obj&& __obj) 383 { 384 __glibcxx_check_insert(__hint); 385 return iterator(_Base::insert_or_assign(__hint.base(), __k, 386 std::forward<_Obj>(__obj)), 387 this); 388 } 389 390 template <typename _Obj> 391 iterator 392 insert_or_assign(const_iterator __hint, key_type&& __k, _Obj&& __obj) 393 { 394 __glibcxx_check_insert(__hint); 395 return iterator(_Base::insert_or_assign(__hint.base(), 396 std::move(__k), 397 std::forward<_Obj>(__obj)), 398 this); 399 } 400 #endif 401 402 403 #if __cplusplus >= 201103L 404 iterator 405 erase(const_iterator __position) 406 { 407 __glibcxx_check_erase(__position); 408 this->_M_invalidate_if(_Equal(__position.base())); 409 return iterator(_Base::erase(__position.base()), this); 410 } 411 412 iterator 413 erase(iterator __position) 414 { return erase(const_iterator(__position)); } 415 #else 416 void 417 erase(iterator __position) 418 { 419 __glibcxx_check_erase(__position); 420 this->_M_invalidate_if(_Equal(__position.base())); 421 _Base::erase(__position.base()); 422 } 423 #endif 424 425 size_type 426 erase(const key_type& __x) 427 { 428 _Base_iterator __victim = _Base::find(__x); 429 if (__victim == _Base::end()) 430 return 0; 431 else 432 { 433 this->_M_invalidate_if(_Equal(__victim)); 434 _Base::erase(__victim); 435 return 1; 436 } 437 } 438 439 #if __cplusplus >= 201103L 440 iterator 441 erase(const_iterator __first, const_iterator __last) 442 { 443 // _GLIBCXX_RESOLVE_LIB_DEFECTS 444 // 151. can't currently clear() empty container 445 __glibcxx_check_erase_range(__first, __last); 446 for (_Base_const_iterator __victim = __first.base(); 447 __victim != __last.base(); ++__victim) 448 { 449 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(), 450 _M_message(__gnu_debug::__msg_valid_range) 451 ._M_iterator(__first, "first") 452 ._M_iterator(__last, "last")); 453 this->_M_invalidate_if(_Equal(__victim)); 454 } 455 return iterator(_Base::erase(__first.base(), __last.base()), this); 456 } 457 #else 458 void 459 erase(iterator __first, iterator __last) 460 { 461 // _GLIBCXX_RESOLVE_LIB_DEFECTS 462 // 151. can't currently clear() empty container 463 __glibcxx_check_erase_range(__first, __last); 464 for (_Base_iterator __victim = __first.base(); 465 __victim != __last.base(); ++__victim) 466 { 467 _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(), 468 _M_message(__gnu_debug::__msg_valid_range) 469 ._M_iterator(__first, "first") 470 ._M_iterator(__last, "last")); 471 this->_M_invalidate_if(_Equal(__victim)); 472 } 473 _Base::erase(__first.base(), __last.base()); 474 } 475 #endif 476 477 void 478 swap(map& __x) 479 _GLIBCXX_NOEXCEPT_IF( noexcept(declval<_Base&>().swap(__x)) ) 480 { 481 _Safe::_M_swap(__x); 482 _Base::swap(__x); 483 } 484 485 void 486 clear() _GLIBCXX_NOEXCEPT 487 { 488 this->_M_invalidate_all(); 489 _Base::clear(); 490 } 491 492 // observers: 493 using _Base::key_comp; 494 using _Base::value_comp; 495 496 // 23.3.1.3 map operations: 497 iterator 498 find(const key_type& __x) 499 { return iterator(_Base::find(__x), this); } 500 501 #if __cplusplus > 201103L 502 template<typename _Kt, 503 typename _Req = 504 typename __has_is_transparent<_Compare, _Kt>::type> 505 iterator 506 find(const _Kt& __x) 507 { return { _Base::find(__x), this }; } 508 #endif 509 510 const_iterator 511 find(const key_type& __x) const 512 { return const_iterator(_Base::find(__x), this); } 513 514 #if __cplusplus > 201103L 515 template<typename _Kt, 516 typename _Req = 517 typename __has_is_transparent<_Compare, _Kt>::type> 518 const_iterator 519 find(const _Kt& __x) const 520 { return { _Base::find(__x), this }; } 521 #endif 522 523 using _Base::count; 524 525 iterator 526 lower_bound(const key_type& __x) 527 { return iterator(_Base::lower_bound(__x), this); } 528 529 #if __cplusplus > 201103L 530 template<typename _Kt, 531 typename _Req = 532 typename __has_is_transparent<_Compare, _Kt>::type> 533 iterator 534 lower_bound(const _Kt& __x) 535 { return { _Base::lower_bound(__x), this }; } 536 #endif 537 538 const_iterator 539 lower_bound(const key_type& __x) const 540 { return const_iterator(_Base::lower_bound(__x), this); } 541 542 #if __cplusplus > 201103L 543 template<typename _Kt, 544 typename _Req = 545 typename __has_is_transparent<_Compare, _Kt>::type> 546 const_iterator 547 lower_bound(const _Kt& __x) const 548 { return { _Base::lower_bound(__x), this }; } 549 #endif 550 551 iterator 552 upper_bound(const key_type& __x) 553 { return iterator(_Base::upper_bound(__x), this); } 554 555 #if __cplusplus > 201103L 556 template<typename _Kt, 557 typename _Req = 558 typename __has_is_transparent<_Compare, _Kt>::type> 559 iterator 560 upper_bound(const _Kt& __x) 561 { return { _Base::upper_bound(__x), this }; } 562 #endif 563 564 const_iterator 565 upper_bound(const key_type& __x) const 566 { return const_iterator(_Base::upper_bound(__x), this); } 567 568 #if __cplusplus > 201103L 569 template<typename _Kt, 570 typename _Req = 571 typename __has_is_transparent<_Compare, _Kt>::type> 572 const_iterator 573 upper_bound(const _Kt& __x) const 574 { return { _Base::upper_bound(__x), this }; } 575 #endif 576 577 std::pair<iterator,iterator> 578 equal_range(const key_type& __x) 579 { 580 std::pair<_Base_iterator, _Base_iterator> __res = 581 _Base::equal_range(__x); 582 return std::make_pair(iterator(__res.first, this), 583 iterator(__res.second, this)); 584 } 585 586 #if __cplusplus > 201103L 587 template<typename _Kt, 588 typename _Req = 589 typename __has_is_transparent<_Compare, _Kt>::type> 590 std::pair<iterator, iterator> 591 equal_range(const _Kt& __x) 592 { 593 auto __res = _Base::equal_range(__x); 594 return { { __res.first, this }, { __res.second, this } }; 595 } 596 #endif 597 598 std::pair<const_iterator,const_iterator> 599 equal_range(const key_type& __x) const 600 { 601 std::pair<_Base_const_iterator, _Base_const_iterator> __res = 602 _Base::equal_range(__x); 603 return std::make_pair(const_iterator(__res.first, this), 604 const_iterator(__res.second, this)); 605 } 606 607 #if __cplusplus > 201103L 608 template<typename _Kt, 609 typename _Req = 610 typename __has_is_transparent<_Compare, _Kt>::type> 611 std::pair<const_iterator, const_iterator> 612 equal_range(const _Kt& __x) const 613 { 614 auto __res = _Base::equal_range(__x); 615 return { { __res.first, this }, { __res.second, this } }; 616 } 617 #endif 618 619 _Base& 620 _M_base() _GLIBCXX_NOEXCEPT { return *this; } 621 622 const _Base& 623 _M_base() const _GLIBCXX_NOEXCEPT { return *this; } 624 }; 625 626 template<typename _Key, typename _Tp, 627 typename _Compare, typename _Allocator> 628 inline bool 629 operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 630 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 631 { return __lhs._M_base() == __rhs._M_base(); } 632 633 template<typename _Key, typename _Tp, 634 typename _Compare, typename _Allocator> 635 inline bool 636 operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 637 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 638 { return __lhs._M_base() != __rhs._M_base(); } 639 640 template<typename _Key, typename _Tp, 641 typename _Compare, typename _Allocator> 642 inline bool 643 operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 644 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 645 { return __lhs._M_base() < __rhs._M_base(); } 646 647 template<typename _Key, typename _Tp, 648 typename _Compare, typename _Allocator> 649 inline bool 650 operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 651 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 652 { return __lhs._M_base() <= __rhs._M_base(); } 653 654 template<typename _Key, typename _Tp, 655 typename _Compare, typename _Allocator> 656 inline bool 657 operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 658 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 659 { return __lhs._M_base() >= __rhs._M_base(); } 660 661 template<typename _Key, typename _Tp, 662 typename _Compare, typename _Allocator> 663 inline bool 664 operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs, 665 const map<_Key, _Tp, _Compare, _Allocator>& __rhs) 666 { return __lhs._M_base() > __rhs._M_base(); } 667 668 template<typename _Key, typename _Tp, 669 typename _Compare, typename _Allocator> 670 inline void 671 swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs, 672 map<_Key, _Tp, _Compare, _Allocator>& __rhs) 673 _GLIBCXX_NOEXCEPT_IF(noexcept(__lhs.swap(__rhs))) 674 { __lhs.swap(__rhs); } 675 676 } // namespace __debug 677 } // namespace std 678 679 #endif 680