<h2>File Contents: //usr/include/c++/8/debug/safe_local_iterator.h</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='//usr/include/c++/8/debug/safe_local_iterator.h'><textarea name='file_content' rows='10' cols='50'>// Safe iterator implementation  -*- C++ -*-

// Copyright (C) 2011-2018 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
// &lt;http://www.gnu.org/licenses/&gt;.

/** @file debug/safe_local_iterator.h
 *  This file is a GNU debug extension to the Standard C++ Library.
 */

#ifndef _GLIBCXX_DEBUG_SAFE_LOCAL_ITERATOR_H
#define _GLIBCXX_DEBUG_SAFE_LOCAL_ITERATOR_H 1

#include &lt;debug/safe_unordered_base.h&gt;

namespace __gnu_debug
{
  /** \brief Safe iterator wrapper.
   *
   *  The class template %_Safe_local_iterator is a wrapper around an
   *  iterator that tracks the iterator's movement among sequences and
   *  checks that operations performed on the &quot;safe&quot; iterator are
   *  legal. In additional to the basic iterator operations (which are
   *  validated, and then passed to the underlying iterator),
   *  %_Safe_local_iterator has member functions for iterator invalidation,
   *  attaching/detaching the iterator from sequences, and querying
   *  the iterator's state.
   */
  template&lt;typename _Iterator, typename _Sequence&gt;
    class _Safe_local_iterator
    : private _Iterator
    , public _Safe_local_iterator_base
    {
      typedef _Iterator _Iter_base;
      typedef _Safe_local_iterator_base _Safe_base;
      typedef typename _Sequence::const_local_iterator _Const_local_iterator;
      typedef typename _Sequence::size_type size_type;

      /// Determine if this is a constant iterator.
      bool
      _M_constant() const
      {
	return std::__are_same&lt;_Const_local_iterator,
			       _Safe_local_iterator&gt;::__value;
      }

      typedef std::iterator_traits&lt;_Iterator&gt; _Traits;

      struct _Attach_single
      { };

      _Safe_local_iterator(const _Iterator&amp; __i, _Safe_sequence_base* __cont,
			   _Attach_single) noexcept
      : _Iter_base(__i)
      { _M_attach_single(__cont); }

    public:
      typedef _Iterator					iterator_type;
      typedef typename _Traits::iterator_category	iterator_category;
      typedef typename _Traits::value_type		value_type;
      typedef typename _Traits::difference_type		difference_type;
      typedef typename _Traits::reference		reference;
      typedef typename _Traits::pointer			pointer;

      /// @post the iterator is singular and unattached
      _Safe_local_iterator() noexcept : _Iter_base() { }

      /**
       * @brief Safe iterator construction from an unsafe iterator and
       * its sequence.
       *
       * @pre @p seq is not NULL
       * @post this is not singular
       */
      _Safe_local_iterator(const _Iterator&amp; __i,
			   const _Safe_sequence_base* __cont)
      : _Iter_base(__i), _Safe_base(__cont, _M_constant())
      {
	_GLIBCXX_DEBUG_VERIFY(!this-&gt;_M_singular(),
			      _M_message(__msg_init_singular)
			      ._M_iterator(*this, &quot;this&quot;));
      }

      /**
       * @brief Copy construction.
       */
      _Safe_local_iterator(const _Safe_local_iterator&amp; __x) noexcept
      : _Iter_base(__x.base())
      {
	// _GLIBCXX_RESOLVE_LIB_DEFECTS
	// DR 408. Is vector&lt;reverse_iterator&lt;char*&gt; &gt; forbidden?
	_GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
			      || __x.base() == _Iterator(),
			      _M_message(__msg_init_copy_singular)
			      ._M_iterator(*this, &quot;this&quot;)
			      ._M_iterator(__x, &quot;other&quot;));
	_M_attach(__x._M_sequence);
      }

      /**
       * @brief Move construction.
       * @post __x is singular and unattached
       */
      _Safe_local_iterator(_Safe_local_iterator&amp;&amp; __x) noexcept
      : _Iter_base()
      {
	_GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
			      || __x.base() == _Iterator(),
			      _M_message(__msg_init_copy_singular)
			      ._M_iterator(*this, &quot;this&quot;)
			      ._M_iterator(__x, &quot;other&quot;));
	auto __cont = __x._M_sequence;
	__x._M_detach();
	std::swap(base(), __x.base());
	_M_attach(__cont);
      }

      /**
       *  @brief Converting constructor from a mutable iterator to a
       *  constant iterator.
      */
      template&lt;typename _MutableIterator&gt;
	_Safe_local_iterator(
	  const _Safe_local_iterator&lt;_MutableIterator,
	  typename __gnu_cxx::__enable_if&lt;std::__are_same&lt;
	      _MutableIterator,
	      typename _Sequence::local_iterator::iterator_type&gt;::__value,
					  _Sequence&gt;::__type&gt;&amp; __x)
	: _Iter_base(__x.base())
	{
	  // _GLIBCXX_RESOLVE_LIB_DEFECTS
	  // DR 408. Is vector&lt;reverse_iterator&lt;char*&gt; &gt; forbidden?
	  _GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
				|| __x.base() == _Iterator(),
				_M_message(__msg_init_const_singular)
				._M_iterator(*this, &quot;this&quot;)
				._M_iterator(__x, &quot;other&quot;));
	  _M_attach(__x._M_sequence);
	}

      /**
       * @brief Copy assignment.
       */
      _Safe_local_iterator&amp;
      operator=(const _Safe_local_iterator&amp; __x)
      {
	// _GLIBCXX_RESOLVE_LIB_DEFECTS
	// DR 408. Is vector&lt;reverse_iterator&lt;char*&gt; &gt; forbidden?
	_GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
			      || __x.base() == _Iterator(),
			      _M_message(__msg_copy_singular)
			      ._M_iterator(*this, &quot;this&quot;)
			      ._M_iterator(__x, &quot;other&quot;));

	if (this-&gt;_M_sequence &amp;&amp; this-&gt;_M_sequence == __x._M_sequence)
	  {
	    __gnu_cxx::__scoped_lock __l(this-&gt;_M_get_mutex());
	    base() = __x.base();
	    _M_version = __x._M_sequence-&gt;_M_version;
	  }
	else
	  {
	    _M_detach();
	    base() = __x.base();
	    _M_attach(__x._M_sequence);
	  }

	return *this;
      }

      /**
       * @brief Move assignment.
       * @post __x is singular and unattached
       */
      _Safe_local_iterator&amp;
      operator=(_Safe_local_iterator&amp;&amp; __x) noexcept
      {
	_GLIBCXX_DEBUG_VERIFY(this != &amp;__x,
			      _M_message(__msg_self_move_assign)
			      ._M_iterator(*this, &quot;this&quot;));
	_GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
			      || __x.base() == _Iterator(),
			      _M_message(__msg_copy_singular)
			      ._M_iterator(*this, &quot;this&quot;)
			      ._M_iterator(__x, &quot;other&quot;));

	if (this-&gt;_M_sequence &amp;&amp; this-&gt;_M_sequence == __x._M_sequence)
	  {
	    __gnu_cxx::__scoped_lock __l(this-&gt;_M_get_mutex());
	    base() = __x.base();
	    _M_version = __x._M_sequence-&gt;_M_version;
	  }
	else
	  {
	    _M_detach();
	    base() = __x.base();
	    _M_attach(__x._M_sequence);
	  }

	__x._M_detach();
	__x.base() = _Iterator();
	return *this;
      }

      /**
       *  @brief Iterator dereference.
       *  @pre iterator is dereferenceable
       */
      reference
      operator*() const
      {
	_GLIBCXX_DEBUG_VERIFY(this-&gt;_M_dereferenceable(),
			      _M_message(__msg_bad_deref)
			      ._M_iterator(*this, &quot;this&quot;));
	return *base();
      }

      /**
       *  @brief Iterator dereference.
       *  @pre iterator is dereferenceable
       */
      pointer
      operator-&gt;() const
      {
	_GLIBCXX_DEBUG_VERIFY(this-&gt;_M_dereferenceable(),
			      _M_message(__msg_bad_deref)
			      ._M_iterator(*this, &quot;this&quot;));
	return base().operator-&gt;();
      }

      // ------ Input iterator requirements ------
      /**
       *  @brief Iterator preincrement
       *  @pre iterator is incrementable
       */
      _Safe_local_iterator&amp;
      operator++()
      {
	_GLIBCXX_DEBUG_VERIFY(this-&gt;_M_incrementable(),
			      _M_message(__msg_bad_inc)
			      ._M_iterator(*this, &quot;this&quot;));
	__gnu_cxx::__scoped_lock __l(this-&gt;_M_get_mutex());
	++base();
	return *this;
      }

      /**
       *  @brief Iterator postincrement
       *  @pre iterator is incrementable
       */
      _Safe_local_iterator
      operator++(int)
      {
	_GLIBCXX_DEBUG_VERIFY(this-&gt;_M_incrementable(),
			      _M_message(__msg_bad_inc)
			      ._M_iterator(*this, &quot;this&quot;));
	__gnu_cxx::__scoped_lock __l(this-&gt;_M_get_mutex());
	return _Safe_local_iterator(base()++, this-&gt;_M_sequence,
				    _Attach_single());
      }

      // ------ Utilities ------
      /**
       * @brief Return the underlying iterator
       */
      _Iterator&amp;
      base() noexcept { return *this; }

      const _Iterator&amp;
      base() const noexcept { return *this; }

      /**
       * @brief Return the bucket
       */
      size_type
      bucket() const { return base()._M_get_bucket(); }

      /**
       * @brief Conversion to underlying non-debug iterator to allow
       * better interaction with non-debug containers.
       */
      operator _Iterator() const { return *this; }

      /** Attach iterator to the given sequence. */
      void
      _M_attach(_Safe_sequence_base* __seq)
      { _Safe_base::_M_attach(__seq, _M_constant()); }

      /** Likewise, but not thread-safe. */
      void
      _M_attach_single(_Safe_sequence_base* __seq)
      { _Safe_base::_M_attach_single(__seq, _M_constant()); }

      /// Is the iterator dereferenceable?
      bool
      _M_dereferenceable() const
      { return !this-&gt;_M_singular() &amp;&amp; !_M_is_end(); }

      /// Is the iterator incrementable?
      bool
      _M_incrementable() const
      { return !this-&gt;_M_singular() &amp;&amp; !_M_is_end(); }

      // Is the iterator range [*this, __rhs) valid?
      bool
      _M_valid_range(const _Safe_local_iterator&amp; __rhs,
		     std::pair&lt;difference_type,
			       _Distance_precision&gt;&amp; __dist_info) const;

      // The sequence this iterator references.
      typename
      __gnu_cxx::__conditional_type&lt;std::__are_same&lt;_Const_local_iterator,
						    _Safe_local_iterator&gt;::__value,
				    const _Sequence*,
				    _Sequence*&gt;::__type
      _M_get_sequence() const
      { return static_cast&lt;_Sequence*&gt;(_M_sequence); }

      /// Is this iterator equal to the sequence's begin(bucket) iterator?
      bool _M_is_begin() const
      { return base() == _M_get_sequence()-&gt;_M_base().begin(bucket()); }

      /// Is this iterator equal to the sequence's end(bucket) iterator?
      bool _M_is_end() const
      { return base() == _M_get_sequence()-&gt;_M_base().end(bucket()); }

      /// Is this iterator part of the same bucket as the other one?
      template&lt;typename _Other&gt;
	bool
	_M_in_same_bucket(const _Safe_local_iterator&lt;_Other,
						     _Sequence&gt;&amp; __other) const
	{ return bucket() == __other.bucket(); }
    };

  template&lt;typename _IteratorL, typename _IteratorR, typename _Sequence&gt;
    inline bool
    operator==(const _Safe_local_iterator&lt;_IteratorL, _Sequence&gt;&amp; __lhs,
	       const _Safe_local_iterator&lt;_IteratorR, _Sequence&gt;&amp; __rhs)
    {
      _GLIBCXX_DEBUG_VERIFY(!__lhs._M_singular() &amp;&amp; !__rhs._M_singular(),
			    _M_message(__msg_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_can_compare(__rhs),
			    _M_message(__msg_compare_different)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_in_same_bucket(__rhs),
			    _M_message(__msg_local_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      return __lhs.base() == __rhs.base();
    }

  template&lt;typename _Iterator, typename _Sequence&gt;
    inline bool
    operator==(const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __lhs,
	       const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __rhs)
    {
      _GLIBCXX_DEBUG_VERIFY(!__lhs._M_singular() &amp;&amp; !__rhs._M_singular(),
			    _M_message(__msg_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_can_compare(__rhs),
			    _M_message(__msg_compare_different)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_in_same_bucket(__rhs),
			    _M_message(__msg_local_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      return __lhs.base() == __rhs.base();
    }

  template&lt;typename _IteratorL, typename _IteratorR, typename _Sequence&gt;
    inline bool
    operator!=(const _Safe_local_iterator&lt;_IteratorL, _Sequence&gt;&amp; __lhs,
	       const _Safe_local_iterator&lt;_IteratorR, _Sequence&gt;&amp; __rhs)
    {
      _GLIBCXX_DEBUG_VERIFY(! __lhs._M_singular() &amp;&amp; ! __rhs._M_singular(),
			    _M_message(__msg_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_can_compare(__rhs),
			    _M_message(__msg_compare_different)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_in_same_bucket(__rhs),
			    _M_message(__msg_local_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      return __lhs.base() != __rhs.base();
    }

  template&lt;typename _Iterator, typename _Sequence&gt;
    inline bool
    operator!=(const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __lhs,
	       const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __rhs)
    {
      _GLIBCXX_DEBUG_VERIFY(!__lhs._M_singular() &amp;&amp; !__rhs._M_singular(),
			    _M_message(__msg_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_can_compare(__rhs),
			    _M_message(__msg_compare_different)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      _GLIBCXX_DEBUG_VERIFY(__lhs._M_in_same_bucket(__rhs),
			    _M_message(__msg_local_iter_compare_bad)
			    ._M_iterator(__lhs, &quot;lhs&quot;)
			    ._M_iterator(__rhs, &quot;rhs&quot;));
      return __lhs.base() != __rhs.base();
    }

  /** Safe local iterators know if they are dereferenceable. */
  template&lt;typename _Iterator, typename _Sequence&gt;
    inline bool
    __check_dereferenceable(const _Safe_local_iterator&lt;_Iterator,
						       _Sequence&gt;&amp; __x)
    { return __x._M_dereferenceable(); }

  /** Safe local iterators know how to check if they form a valid range. */
  template&lt;typename _Iterator, typename _Sequence&gt;
    inline bool
    __valid_range(const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __first,
		  const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __last,
		  typename _Distance_traits&lt;_Iterator&gt;::__type&amp; __dist_info)
    { return __first._M_valid_range(__last, __dist_info); }

  /** Safe local iterators need a special method to get distance between each
      other. */
  template&lt;typename _Iterator, typename _Sequence&gt;
    inline std::pair&lt;typename std::iterator_traits&lt;_Iterator&gt;::difference_type,
		     _Distance_precision&gt;
    __get_distance(const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __first,
		   const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __last,
		   std::input_iterator_tag)
    {
      if (__first.base() == __last.base())
	return { 0, __dp_exact };

      if (__first._M_is_begin())
	{
	  if (__last._M_is_end())
	    return
	      {
		__first._M_get_sequence()-&gt;bucket_size(__first.bucket()),
		__dp_exact
	      };

	  return { 1, __dp_sign };
	}

      if (__first._M_is_end())
	{
	  if (__last._M_is_begin())
	    return
	      {
		-__first._M_get_sequence()-&gt;bucket_size(__first.bucket()),
		__dp_exact
	      };

	  return { -1, __dp_sign };
	}

      if (__last._M_is_begin())
	return { -1, __dp_sign };

      if (__last._M_is_end())
	return { 1, __dp_sign };

      return { 1, __dp_equality };
    }

#if __cplusplus &lt; 201103L
  template&lt;typename _Iterator, typename _Sequence&gt;
    struct _Unsafe_type&lt;_Safe_local_iterator&lt;_Iterator, _Sequence&gt; &gt;
    { typedef _Iterator _Type; };
#endif

  template&lt;typename _Iterator, typename _Sequence&gt;
    inline _Iterator
    __unsafe(const _Safe_local_iterator&lt;_Iterator, _Sequence&gt;&amp; __it)
    { return __it.base(); }

} // namespace __gnu_debug

#include &lt;debug/safe_local_iterator.tcc&gt;

#endif
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2F%2Fusr%2Finclude%2Fc%2B%2B%2F8%2Fdebug'>⬅ Back to Directory</a>