Subversion Repositories altor32

// Debugging map implementation -*- C++ -*-

// Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011, 2012

// 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

// <http://www.gnu.org/licenses/>.

/** @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 <debug/safe_sequence.h>

#include <debug/safe_iterator.h>

#include <utility>

namespace std _GLIBCXX_VISIBILITY(default)

{

namespace __debug

{

  /// Class std::map with safety/checking/debug instrumentation.

  template<typename _Key, typename _Tp, typename _Compare = std::less<_Key>,

           typename _Allocator = std::allocator<std::pair<const _Key, _Tp> > >

    class map

    : public _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator>,

      public __gnu_debug::_Safe_sequence<map<_Key, _Tp, _Compare, _Allocator> >

    {

      typedef _GLIBCXX_STD_C::map<_Key, _Tp, _Compare, _Allocator> _Base;

      typedef typename _Base::const_iterator _Base_const_iterator;

      typedef typename _Base::iterator _Base_iterator;

      typedef __gnu_debug::_Equal_to<_Base_const_iterator> _Equal;

    public:

      // types:

      typedef _Key                                  key_type;

      typedef _Tp                                   mapped_type;

      typedef std::pair<const _Key, _Tp>            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<iterator>       reverse_iterator;

      typedef std::reverse_iterator<const_iterator> const_reverse_iterator;

      // 23.3.1.1 construct/copy/destroy:

      explicit map(const _Compare& __comp = _Compare(),

                   const _Allocator& __a = _Allocator())

      : _Base(__comp, __a) { }

      template<typename _InputIterator>

        map(_InputIterator __first, _InputIterator __last,

            const _Compare& __comp = _Compare(),

            const _Allocator& __a = _Allocator())

        : _Base(__gnu_debug::__base(__gnu_debug::__check_valid_range(__first,

                                                                     __last)),

                __gnu_debug::__base(__last),

                __comp, __a) { }

      map(const map& __x)

      : _Base(__x) { }

      map(const _Base& __x)

      : _Base(__x) { }

#if __cplusplus >= 201103L

      map(map&& __x)

      noexcept(is_nothrow_copy_constructible<_Compare>::value)

      : _Base(std::move(__x))

      { this->_M_swap(__x); }

      map(initializer_list<value_type> __l,

          const _Compare& __c = _Compare(),

          const allocator_type& __a = allocator_type())

      : _Base(__l, __c, __a) { }

#endif

      ~map() _GLIBCXX_NOEXCEPT { }

      map&

      operator=(const map& __x)

      {

        *static_cast<_Base*>(this) = __x;

        this->_M_invalidate_all();

        return *this;

      }

#if __cplusplus >= 201103L

      map&

      operator=(map&& __x)

      {

        // NB: DR 1204.

        // NB: DR 675.

        __glibcxx_check_self_move_assign(__x);

        clear();

        swap(__x);

        return *this;

      }

      map&

      operator=(initializer_list<value_type> __l)

      {

        this->clear();

        this->insert(__l);

        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<typename... _Args>

        std::pair<iterator, bool>

        emplace(_Args&&... __args)

        {

          auto __res = _Base::emplace(std::forward<_Args>(__args)...);

          return std::pair<iterator, bool>(iterator(__res.first, this),

                                           __res.second);

        }

      template<typename... _Args>

        iterator

        emplace_hint(const_iterator __pos, _Args&&... __args)

        {

          __glibcxx_check_insert(__pos);

          return iterator(_Base::emplace_hint(__pos.base(),

                                              std::forward<_Args>(__args)...),

                          this);

        }

#endif

      std::pair<iterator, bool>

      insert(const value_type& __x)

      {

        std::pair<_Base_iterator, bool> __res = _Base::insert(__x);

        return std::pair<iterator, bool>(iterator(__res.first, this),

                                         __res.second);

      }

#if __cplusplus >= 201103L

      template<typename _Pair, typename = typename

               std::enable_if<std::is_constructible<value_type,

                                                    _Pair&&>::value>::type>

        std::pair<iterator, bool>

        insert(_Pair&& __x)

        {

          std::pair<_Base_iterator, bool> __res

            = _Base::insert(std::forward<_Pair>(__x));

          return std::pair<iterator, bool>(iterator(__res.first, this),

                                           __res.second);

        }

#endif

#if __cplusplus >= 201103L

      void

      insert(std::initializer_list<value_type> __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

      template<typename _Pair, typename = typename

               std::enable_if<std::is_constructible<value_type,

                                                    _Pair&&>::value>::type>

        iterator

        insert(const_iterator __position, _Pair&& __x)

        {

          __glibcxx_check_insert(__position);

          return iterator(_Base::insert(__position.base(),

                                        std::forward<_Pair>(__x)), this);

        }

#endif

      template<typename _InputIterator>

        void

        insert(_InputIterator __first, _InputIterator __last)

        {

          __glibcxx_check_valid_range(__first, __last);

          _Base::insert(__gnu_debug::__base(__first),

                        __gnu_debug::__base(__last));

        }

#if __cplusplus >= 201103L

      iterator

      erase(const_iterator __position)

      {

        __glibcxx_check_erase(__position);

        this->_M_invalidate_if(_Equal(__position.base()));

        return iterator(_Base::erase(__position.base()), this);

      }

      iterator

      erase(iterator __position)

      { return erase(const_iterator(__position)); }

#else

      void

      erase(iterator __position)

      {

        __glibcxx_check_erase(__position);

        this->_M_invalidate_if(_Equal(__position.base()));

        _Base::erase(__position.base());

      }

#endif

      size_type

      erase(const key_type& __x)

      {

        _Base_iterator __victim = _Base::find(__x);

        if (__victim == _Base::end())

          return 0;

        else

          {

            this->_M_invalidate_if(_Equal(__victim));

            _Base::erase(__victim);

            return 1;

          }

      }

#if __cplusplus >= 201103L

      iterator

      erase(const_iterator __first, const_iterator __last)

      {

        // _GLIBCXX_RESOLVE_LIB_DEFECTS

        // 151. can't currently clear() empty container

        __glibcxx_check_erase_range(__first, __last);

        for (_Base_const_iterator __victim = __first.base();

             __victim != __last.base(); ++__victim)

          {

            _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),

                                  _M_message(__gnu_debug::__msg_valid_range)

                                  ._M_iterator(__first, "first")

                                  ._M_iterator(__last, "last"));

            this->_M_invalidate_if(_Equal(__victim));

          }

        return iterator(_Base::erase(__first.base(), __last.base()), this);

      }

#else

      void

      erase(iterator __first, iterator __last)

      {

        // _GLIBCXX_RESOLVE_LIB_DEFECTS

        // 151. can't currently clear() empty container

        __glibcxx_check_erase_range(__first, __last);

        for (_Base_iterator __victim = __first.base();

             __victim != __last.base(); ++__victim)

          {

            _GLIBCXX_DEBUG_VERIFY(__victim != _Base::end(),

                                  _M_message(__gnu_debug::__msg_valid_range)

                                  ._M_iterator(__first, "first")

                                  ._M_iterator(__last, "last"));

            this->_M_invalidate_if(_Equal(__victim));

          }

        _Base::erase(__first.base(), __last.base());

      }

#endif

      void

      swap(map& __x)

      {

        _Base::swap(__x);

        this->_M_swap(__x);

      }

      void

      clear() _GLIBCXX_NOEXCEPT

      {

        this->_M_invalidate_all();

        _Base::clear();

      }

      // observers:

      using _Base::key_comp;

      using _Base::value_comp;

      // 23.3.1.3 map operations:

      iterator

      find(const key_type& __x)

      { return iterator(_Base::find(__x), this); }

      const_iterator

      find(const key_type& __x) const

      { return const_iterator(_Base::find(__x), this); }

      using _Base::count;

      iterator

      lower_bound(const key_type& __x)

      { return iterator(_Base::lower_bound(__x), this); }

      const_iterator

      lower_bound(const key_type& __x) const

      { return const_iterator(_Base::lower_bound(__x), this); }

      iterator

      upper_bound(const key_type& __x)

      { return iterator(_Base::upper_bound(__x), this); }

      const_iterator

      upper_bound(const key_type& __x) const

      { return const_iterator(_Base::upper_bound(__x), this); }

      std::pair<iterator,iterator>

      equal_range(const key_type& __x)

      {

        std::pair<_Base_iterator, _Base_iterator> __res =

        _Base::equal_range(__x);

        return std::make_pair(iterator(__res.first, this),

                              iterator(__res.second, this));

      }

      std::pair<const_iterator,const_iterator>

      equal_range(const key_type& __x) const

      {

        std::pair<_Base_const_iterator, _Base_const_iterator> __res =

        _Base::equal_range(__x);

        return std::make_pair(const_iterator(__res.first, this),

                              const_iterator(__res.second, this));

      }

      _Base&

      _M_base() _GLIBCXX_NOEXCEPT       { return *this; }

      const _Base&

      _M_base() const _GLIBCXX_NOEXCEPT { return *this; }

    private:

      void

      _M_invalidate_all()

      {

        typedef __gnu_debug::_Not_equal_to<_Base_const_iterator> _Not_equal;

        this->_M_invalidate_if(_Not_equal(_M_base().end()));

      }

    };

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator==(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() == __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator!=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() != __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator<(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

              const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() < __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator<=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() <= __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator>=(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

               const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() >= __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline bool

    operator>(const map<_Key, _Tp, _Compare, _Allocator>& __lhs,

              const map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { return __lhs._M_base() > __rhs._M_base(); }

  template<typename _Key, typename _Tp,

           typename _Compare, typename _Allocator>

    inline void

    swap(map<_Key, _Tp, _Compare, _Allocator>& __lhs,

         map<_Key, _Tp, _Compare, _Allocator>& __rhs)

    { __lhs.swap(__rhs); }

} // namespace __debug

} // namespace std

#endif