// Debugging map implementation -*- C++ -*-
// Copyright (C) 2003-2026 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
// terms of the GNU General Public License as published by the
// Free Software Foundation; either version 3, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// .
/** @file debug/map.h
* This file is a GNU debug extension to the Standard C++ Library.
*/
#ifndef _GLIBCXX_DEBUG_MAP_H
#define _GLIBCXX_DEBUG_MAP_H 1
#include
#include
#include
#include
namespace std _GLIBCXX_VISIBILITY(default)
{
namespace __debug
{
/// Class std::map with safety/checking/debug instrumentation.
template,
typename _Allocator = std::allocator > >
class map
: public __gnu_debug::_Safe_container<
map<_Key, _Tp, _Compare, _Allocator>, _Allocator,
__gnu_debug::_Safe_node_sequence>,
public _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator>
{
typedef _GLIBCXX_STD_C::map<
_Key, _Tp, _Compare, _Allocator> _Base;
typedef __gnu_debug::_Safe_container<
map, _Allocator, __gnu_debug::_Safe_node_sequence> _Safe;
typedef typename _Base::const_iterator _Base_const_iterator;
typedef typename _Base::iterator _Base_iterator;
typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;
template
friend class ::__gnu_debug::_Safe_iterator;
// Reference wrapper for base class. Disambiguates map(const _Base&)
// from copy constructor by requiring a user-defined conversion.
// See PR libstdc++/90102.
struct _Base_ref
{
_Base_ref(const _Base& __r) : _M_ref(__r) { }
const _Base& _M_ref;
};
public:
// types:
typedef _Key key_type;
typedef _Tp mapped_type;
typedef std::pair value_type;
typedef _Compare key_compare;
typedef _Allocator allocator_type;
typedef typename _Base::reference reference;
typedef typename _Base::const_reference const_reference;
typedef __gnu_debug::_Safe_iterator<_Base_iterator, map>
iterator;
typedef __gnu_debug::_Safe_iterator<_Base_const_iterator, map>
const_iterator;
typedef typename _Base::size_type size_type;
typedef typename _Base::difference_type difference_type;
typedef typename _Base::pointer pointer;
typedef typename _Base::const_pointer const_pointer;
typedef std::reverse_iterator reverse_iterator;
typedef std::reverse_iterator const_reverse_iterator;
// 23.3.1.1 construct/copy/destroy:
#if __cplusplus < 201103L
map() : _Base() { }
map(const map& __x)
: _Base(__x) { }
~map() { }
#else
map() = default;
map(const map&) = default;
map(map&&) = default;
map(initializer_list __l,
const _Compare& __c = _Compare(),
const allocator_type& __a = allocator_type())
: _Base(__l, __c, __a) { }
explicit
map(const allocator_type& __a)
: _Base(__a) { }
map(const map& __m, const __type_identity_t& __a)
: _Base(__m, __a) { }
map(map&& __m, const __type_identity_t& __a)
noexcept( noexcept(_Base(std::move(__m), __a)) )
: _Safe(std::move(__m), __a),
_Base(std::move(__m), __a) { }
map(initializer_list __l, const allocator_type& __a)
: _Base(__l, __a) { }
template
map(_InputIterator __first, _InputIterator __last,
const allocator_type& __a)
: _Base(__gnu_debug::__base(
__glibcxx_check_valid_constructor_range(__first, __last)),
__gnu_debug::__base(__last), __a)
{ }
#if __glibcxx_containers_ranges // C++ >= 23
/**
* @brief Construct a map from a range.
* @since C++23
*/
template _Rg>
map(std::from_range_t __t, _Rg&& __rg,
const _Compare& __c,
const allocator_type& __a = allocator_type())
: _Base(__t, std::forward<_Rg>(__rg), __c, __a)
{ }
template _Rg>
map(std::from_range_t __t, _Rg&& __rg,
const allocator_type& __a = allocator_type())
: _Base(__t, std::forward<_Rg>(__rg), __a)
{ }
#endif
~map() = default;
#endif
map(_Base_ref __x)
: _Base(__x._M_ref) { }
explicit map(const _Compare& __comp,
const _Allocator& __a = _Allocator())
: _Base(__comp, __a) { }
template
map(_InputIterator __first, _InputIterator __last,
const _Compare& __comp = _Compare(),
const _Allocator& __a = _Allocator())
: _Base(__gnu_debug::__base(
__glibcxx_check_valid_constructor_range(__first, __last)),
__gnu_debug::__base(__last),
__comp, __a) { }
#if __cplusplus >= 201103L
map&
operator=(const map&) = default;
map&
operator=(map&&) = default;
map&
operator=(initializer_list __l)
{
_Base::operator=(__l);
this->_M_invalidate_all();
return *this;
}
#endif
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// 133. map missing get_allocator()
using _Base::get_allocator;
// iterators:
iterator
begin() _GLIBCXX_NOEXCEPT
{ return iterator(_Base::begin(), this); }
const_iterator
begin() const _GLIBCXX_NOEXCEPT
{ return const_iterator(_Base::begin(), this); }
iterator
end() _GLIBCXX_NOEXCEPT
{ return iterator(_Base::end(), this); }
const_iterator
end() const _GLIBCXX_NOEXCEPT
{ return const_iterator(_Base::end(), this); }
reverse_iterator
rbegin() _GLIBCXX_NOEXCEPT
{ return reverse_iterator(end()); }
const_reverse_iterator
rbegin() const _GLIBCXX_NOEXCEPT
{ return const_reverse_iterator(end()); }
reverse_iterator
rend() _GLIBCXX_NOEXCEPT
{ return reverse_iterator(begin()); }
const_reverse_iterator
rend() const _GLIBCXX_NOEXCEPT
{ return const_reverse_iterator(begin()); }
#if __cplusplus >= 201103L
const_iterator
cbegin() const noexcept
{ return const_iterator(_Base::begin(), this); }
const_iterator
cend() const noexcept
{ return const_iterator(_Base::end(), this); }
const_reverse_iterator
crbegin() const noexcept
{ return const_reverse_iterator(end()); }
const_reverse_iterator
crend() const noexcept
{ return const_reverse_iterator(begin()); }
#endif
// capacity:
using _Base::empty;
using _Base::size;
using _Base::max_size;
// 23.3.1.2 element access:
using _Base::operator[];
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// DR 464. Suggestion for new member functions in standard containers.
using _Base::at;
// modifiers:
#if __cplusplus >= 201103L
template
std::pair
emplace(_Args&&... __args)
{
auto __res = _Base::emplace(std::forward<_Args>(__args)...);
return { { __res.first, this }, __res.second };
}
template
iterator
emplace_hint(const_iterator __pos, _Args&&... __args)
{
__glibcxx_check_insert(__pos);
return
{
_Base::emplace_hint(__pos.base(), std::forward<_Args>(__args)...),
this
};
}
#endif
std::pair
insert(const value_type& __x)
{
std::pair<_Base_iterator, bool> __res = _Base::insert(__x);
return std::pair(iterator(__res.first, this),
__res.second);
}
#if __cplusplus >= 201103L
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// 2354. Unnecessary copying when inserting into maps with braced-init
std::pair
insert(value_type&& __x)
{
auto __res = _Base::insert(std::move(__x));
return { { __res.first, this }, __res.second };
}
template::value>::type>
std::pair
insert(_Pair&& __x)
{
auto __res = _Base::insert(std::forward<_Pair>(__x));
return { { __res.first, this }, __res.second };
}
#endif
#if __cplusplus >= 201103L
void
insert(std::initializer_list __list)
{ _Base::insert(__list); }
#endif
iterator
#if __cplusplus >= 201103L
insert(const_iterator __position, const value_type& __x)
#else
insert(iterator __position, const value_type& __x)
#endif
{
__glibcxx_check_insert(__position);
return iterator(_Base::insert(__position.base(), __x), this);
}
#if __cplusplus >= 201103L
// _GLIBCXX_RESOLVE_LIB_DEFECTS
// 2354. Unnecessary copying when inserting into maps with braced-init
iterator
insert(const_iterator __position, value_type&& __x)
{
__glibcxx_check_insert(__position);
return { _Base::insert(__position.base(), std::move(__x)), this };
}
template::value>::type>
iterator
insert(const_iterator __position, _Pair&& __x)
{
__glibcxx_check_insert(__position);
return
{
_Base::insert(__position.base(), std::forward<_Pair>(__x)),
this
};
}
#endif
template
void
insert(_InputIterator __first, _InputIterator __last)
{
typename __gnu_debug::_Distance_traits<_InputIterator>::__type __dist;
__glibcxx_check_valid_range2(__first, __last, __dist);
if (__dist.second >= __gnu_debug::__dp_sign)
_Base::insert(__gnu_debug::__unsafe(__first),
__gnu_debug::__unsafe(__last));
else
_Base::insert(__first, __last);
}
#ifdef __glibcxx_map_try_emplace // C++ >= 17 && HOSTED
template
pair
try_emplace(const key_type& __k, _Args&&... __args)
{
auto __res = _Base::try_emplace(__k,
std::forward<_Args>(__args)...);
return { { __res.first, this }, __res.second };
}
template
pair
try_emplace(key_type&& __k, _Args&&... __args)
{
auto __res = _Base::try_emplace(std::move(__k),
std::forward<_Args>(__args)...);
return { { __res.first, this }, __res.second };
}
template
iterator
try_emplace(const_iterator __hint, const key_type& __k,
_Args&&... __args)
{
__glibcxx_check_insert(__hint);
return
{
_Base::try_emplace(__hint.base(), __k,
std::forward<_Args>(__args)...),
this
};
}
template
iterator
try_emplace(const_iterator __hint, key_type&& __k, _Args&&... __args)
{
__glibcxx_check_insert(__hint);
return
{
_Base::try_emplace(__hint.base(), std::move(__k),
std::forward<_Args>(__args)...),
this
};
}
template
std::pair
insert_or_assign(const key_type& __k, _Obj&& __obj)
{
auto __res = _Base::insert_or_assign(__k,
std::forward<_Obj>(__obj));
return { { __res.first, this }, __res.second };
}
template
std::pair
insert_or_assign(key_type&& __k, _Obj&& __obj)
{
auto __res = _Base::insert_or_assign(std::move(__k),
std::forward<_Obj>(__obj));
return { { __res.first, this }, __res.second };
}
template
iterator
insert_or_assign(const_iterator __hint,
const key_type& __k, _Obj&& __obj)
{
__glibcxx_check_insert(__hint);
return
{
_Base::insert_or_assign(__hint.base(), __k,
std::forward<_Obj>(__obj)),
this
};
}
template
iterator
insert_or_assign(const_iterator __hint, key_type&& __k, _Obj&& __obj)
{
__glibcxx_check_insert(__hint);
return
{
_Base::insert_or_assign(__hint.base(), std::move(__k),
std::forward<_Obj>(__obj)),
this
};
}
#endif // C++17
#ifdef __glibcxx_node_extract // >= C++17 && HOSTED
using node_type = typename _Base::node_type;
using insert_return_type = _Node_insert_return;
node_type
extract(const_iterator __position)
{
__glibcxx_check_erase(__position);
this->_M_invalidate_if(_Equal(__position.base()));
return _Base::extract(__position.base());
}
node_type
extract(const key_type& __key)
{
const auto __position = find(__key);
if (__position != end())
return extract(__position);
return {};
}
# ifdef __glibcxx_associative_heterogeneous_erasure
template <__heterogeneous_tree_key