__gnu_debug::_Safe_iterator< _Iterator, _Sequence > Class Template Reference

Safe iterator wrapper. More...

#include <debug/formatter.h>

Inheritance diagram for __gnu_debug::_Safe_iterator< _Iterator, _Sequence >:

Public Types
typedef _Iterator	iterator_type
typedef _Traits::iterator_category	iterator_category
typedef _Traits::value_type	value_type
typedef _Traits::difference_type	difference_type
typedef _Traits::reference	reference
typedef _Traits::pointer	pointer

Public Member Functions
	_Safe_iterator ()
	_Safe_iterator (const _Iterator &__i, const _Sequence *__seq)
	Safe iterator construction from an unsafe iterator and its sequence. More...
	_Safe_iterator (const _Safe_iterator &__x)
	Copy construction. More...
template<typename _MutableIterator >
	_Safe_iterator (const _Safe_iterator< _MutableIterator, typename __gnu_cxx::__enable_if<(std::__are_same< _MutableIterator, typename _Sequence::iterator::iterator_type >::__value), _Sequence >::__type > &__x)
	Converting constructor from a mutable iterator to a constant iterator. More...
_Safe_iterator &	operator= (const _Safe_iterator &__x)
	Copy assignment. More...
reference	operator* () const
	Iterator dereference. More...
pointer	operator-> () const
	Iterator dereference. More...
_Safe_iterator &	operator++ ()
	Iterator preincrement. More...
_Safe_iterator	operator++ (int)
	Iterator postincrement. More...
_Safe_iterator &	operator-- ()
	Iterator predecrement. More...
_Safe_iterator	operator-- (int)
	Iterator postdecrement. More...
reference	operator[] (const difference_type &__n) const
_Safe_iterator &	operator+= (const difference_type &__n)
_Safe_iterator	operator+ (const difference_type &__n) const
_Safe_iterator &	operator-= (const difference_type &__n)
_Safe_iterator	operator- (const difference_type &__n) const
_Iterator	base () const
	Return the underlying iterator. More...
	operator _Iterator () const
	Conversion to underlying non-debug iterator to allow better interaction with non-debug containers. More...
void	_M_attach (_Safe_sequence_base *__seq)
void	_M_attach_single (_Safe_sequence_base *__seq)
bool	_M_dereferenceable () const
	Is the iterator dereferenceable? More...
bool	_M_before_dereferenceable () const
	Is the iterator before a dereferenceable one? More...
bool	_M_incrementable () const
	Is the iterator incrementable? More...
bool	_M_decrementable () const
bool	_M_can_advance (const difference_type &__n) const
template<typename _Other >
bool	_M_valid_range (const _Safe_iterator< _Other, _Sequence > &__rhs) const
const _Sequence *	_M_get_sequence () const
bool	_M_is_begin () const
	Is this iterator equal to the sequence's begin() iterator? More...
bool	_M_is_end () const
	Is this iterator equal to the sequence's end() iterator? More...
bool	_M_is_before_begin () const
bool	_M_is_beginnest () const
Public Member Functions inherited from __gnu_debug::_Safe_iterator_base
void	_M_attach (_Safe_sequence_base *__seq, bool __constant)
void	_M_attach_single (_Safe_sequence_base *__seq, bool __constant) throw ()
void	_M_detach ()
void	_M_detach_single () throw ()
bool	_M_attached_to (const _Safe_sequence_base *__seq) const
_GLIBCXX_PURE bool	_M_singular () const throw ()
_GLIBCXX_PURE bool	_M_can_compare (const _Safe_iterator_base &__x) const throw ()
void	_M_invalidate ()
void	_M_reset () throw ()
void	_M_unlink () throw ()

Private Types
typedef _Safe_iterator	_Self
typedef std::iterator_traits < _Iterator >	_Traits

Private Member Functions
bool	_M_constant () const
	Determine if this is a constant iterator. More...

Private Attributes
_Iterator	_M_current
	The underlying iterator. More...

Additional Inherited Members
Public Attributes inherited from __gnu_debug::_Safe_iterator_base
_Safe_sequence_base *	_M_sequence
unsigned int	_M_version
_Safe_iterator_base *	_M_prior
_Safe_iterator_base *	_M_next
Protected Member Functions inherited from __gnu_debug::_Safe_iterator_base
	_Safe_iterator_base ()
	_Safe_iterator_base (const _Safe_sequence_base *__seq, bool __constant)
	_Safe_iterator_base (const _Safe_iterator_base &__x, bool __constant)
_Safe_iterator_base &	operator= (const _Safe_iterator_base &)
	_Safe_iterator_base (const _Safe_iterator_base &)
	~_Safe_iterator_base ()
__gnu_cxx::__mutex &	_M_get_mutex () throw ()

Detailed Description

template<typename _Iterator, typename _Sequence>
class __gnu_debug::_Safe_iterator< _Iterator, _Sequence >

Safe iterator wrapper.

The class template _Safe_iterator is a wrapper around an iterator that tracks the iterator's movement among sequences and checks that operations performed on the "safe" iterator are legal. In additional to the basic iterator operations (which are validated, and then passed to the underlying iterator), _Safe_iterator has member functions for iterator invalidation, attaching/detaching the iterator from sequences, and querying the iterator's state.

Member Typedef Documentation

template<typename _Iterator, typename _Sequence>

typedef _Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Self

private

template<typename _Iterator, typename _Sequence>

typedef std::iterator_traits<_Iterator> __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Traits

private

template<typename _Iterator, typename _Sequence>

typedef _Traits::difference_type __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::difference_type

template<typename _Iterator, typename _Sequence>

typedef _Traits::iterator_category __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::iterator_category

template<typename _Iterator, typename _Sequence>

typedef _Iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::iterator_type

template<typename _Iterator, typename _Sequence>

typedef _Traits::pointer __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::pointer

template<typename _Iterator, typename _Sequence>

typedef _Traits::reference __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::reference

template<typename _Iterator, typename _Sequence>

typedef _Traits::value_type __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::value_type

Constructor & Destructor Documentation

template<typename _Iterator, typename _Sequence>

__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( )

inline

Postcondition

the iterator is singular and unattached

: _M_current() { }

template<typename _Iterator, typename _Sequence>

__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Iterator &  __i, const _Sequence *  __seq  )

inline

Safe iterator construction from an unsafe iterator and its sequence.

Precondition

seq is not NULL

Postcondition

this is not singular

      : _Safe_iterator_base(__seq, _M_constant()), _M_current(__i)
      {
    _GLIBCXX_DEBUG_VERIFY(! this->_M_singular(),
                  _M_message(__msg_init_singular)
                  ._M_iterator(*this, "this"));
      }

template<typename _Iterator, typename _Sequence>

__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Safe_iterator< _Iterator, _Sequence > &  __x )

inline

Copy construction.

      : _Safe_iterator_base(__x, _M_constant()), _M_current(__x._M_current)
      {
    // _GLIBCXX_RESOLVE_LIB_DEFECTS
    // DR 408. Is vector<reverse_iterator<char*> > forbidden?
    _GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
                  || __x._M_current == _Iterator(),
                  _M_message(__msg_init_copy_singular)
                  ._M_iterator(*this, "this")
                  ._M_iterator(__x, "other"));
      }

template<typename _Iterator, typename _Sequence>

template<typename _MutableIterator >

__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Safe_iterator< _MutableIterator, typename __gnu_cxx::__enable_if<(std::__are_same< _MutableIterator, typename _Sequence::iterator::iterator_type >::__value), _Sequence >::__type > &  __x )

inline

Converting constructor from a mutable iterator to a constant iterator.

    : _Safe_iterator_base(__x, _M_constant()), _M_current(__x.base())
        {
      // _GLIBCXX_RESOLVE_LIB_DEFECTS
      // DR 408. Is vector<reverse_iterator<char*> > forbidden?
      _GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
                || __x.base() == _Iterator(),
                _M_message(__msg_init_const_singular)
                ._M_iterator(*this, "this")
                ._M_iterator(__x, "other"));
    }

Member Function Documentation

template<typename _Iterator, typename _Sequence>

void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_attach ( _Safe_sequence_base *  __seq )

inline

Attach iterator to the given sequence.

      {
    _Safe_iterator_base::_M_attach(__seq, _M_constant());
      }

template<typename _Iterator, typename _Sequence>

void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_attach_single ( _Safe_sequence_base *  __seq )

inline

Likewise, but not thread-safe.

      {
    _Safe_iterator_base::_M_attach_single(__seq, _M_constant());
      }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_before_dereferenceable ( ) const

inline

Is the iterator before a dereferenceable one?

      {
    if (this->_M_incrementable())
    {
      _Iterator __base = base();
      return ++__base != _M_get_sequence()->_M_base().end();
    }
    return false;
      }

template<typename _Iterator , typename _Sequence >

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_can_advance

(

const difference_type &

__n

)

const

    {
      typedef typename _Sequence::const_iterator const_debug_iterator;
      typedef typename const_debug_iterator::iterator_type const_iterator;

      if (this->_M_singular())
    return false;
      if (__n == 0)
    return true;
      if (__n < 0)
    {
      const_iterator __begin = _M_get_sequence()->_M_base().begin();
      std::pair<difference_type, _Distance_precision> __dist =
        __get_distance(__begin, base());
      bool __ok =  ((__dist.second == __dp_exact && __dist.first >= -__n)
            || (__dist.second != __dp_exact && __dist.first > 0));
      return __ok;
    }
      else
    {
      const_iterator __end = _M_get_sequence()->_M_base().end();
      std::pair<difference_type, _Distance_precision> __dist =
        __get_distance(base(), __end);
      bool __ok = ((__dist.second == __dp_exact && __dist.first >= __n)
               || (__dist.second != __dp_exact && __dist.first > 0));
      return __ok;
    }
    }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_constant ( ) const

inlineprivate

Determine if this is a constant iterator.

      {
    typedef typename _Sequence::const_iterator const_iterator;
    return std::__are_same<const_iterator, _Safe_iterator>::__value;
      }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_decrementable ( ) const

inline

{ return !_M_singular() && !_M_is_begin(); }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_dereferenceable ( ) const

inline

Is the iterator dereferenceable?

      { return !this->_M_singular() && !_M_is_end() && !_M_is_before_begin(); }

template<typename _Iterator, typename _Sequence>

const _Sequence* __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_get_sequence ( ) const

inline

      { return static_cast<const _Sequence*>(_M_sequence); }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_incrementable ( ) const

inline

Is the iterator incrementable?

      { return !this->_M_singular() && !_M_is_end(); }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_before_begin ( ) const

inline

Is this iterator equal to the sequence's before_begin() iterator if any?

      {
    return _BeforeBeginHelper<_Sequence>::_S_Is(base(), _M_get_sequence());
      }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_begin ( ) const

inline

Is this iterator equal to the sequence's begin() iterator?

      { return base() == _M_get_sequence()->_M_base().begin(); }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_beginnest ( ) const

inline

Is this iterator equal to the sequence's before_begin() iterator if any or begin() otherwise?

      {
    return _BeforeBeginHelper<_Sequence>::_S_Is_Beginnest(base(),
                              _M_get_sequence());
      }

template<typename _Iterator, typename _Sequence>

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_end ( ) const

inline

Is this iterator equal to the sequence's end() iterator?

      { return base() == _M_get_sequence()->_M_base().end(); }

template<typename _Iterator , typename _Sequence >

template<typename _Other >

bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_valid_range

(

const _Safe_iterator< _Other, _Sequence > &

__rhs

)

const

      {
    if (!_M_can_compare(__rhs))
      return false;

    /* Determine if we can order the iterators without the help of
       the container */
    std::pair<difference_type, _Distance_precision> __dist =
      __get_distance(base(), __rhs.base());
    switch (__dist.second) {
    case __dp_equality:
      if (__dist.first == 0)
        return true;
      break;

    case __dp_sign:
    case __dp_exact:
      return __dist.first >= 0;
    }

    /* We can only test for equality, but check if one of the
       iterators is at an extreme. */
    /* Optim for classic [begin, it) or [it, end) ranges, limit checks
     * when code is valid.  Note, for the special case of forward_list,
     * before_begin replaces the role of begin.  */ 
    if (_M_is_beginnest() || __rhs._M_is_end())
      return true;
    if (_M_is_end() || __rhs._M_is_beginnest())
      return false;

    // Assume that this is a valid range; we can't check anything else
    return true;
      }

template<typename _Iterator, typename _Sequence>

_Iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::base ( ) const

inline

Return the underlying iterator.

{ return _M_current; }

template<typename _Iterator, typename _Sequence>

__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator _Iterator ( ) const

inline

Conversion to underlying non-debug iterator to allow better interaction with non-debug containers.

{ return _M_current; }

template<typename _Iterator, typename _Sequence>

reference __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator* ( ) const

inline

Iterator dereference.

Precondition

iterator is dereferenceable

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_dereferenceable(),
                  _M_message(__msg_bad_deref)
                  ._M_iterator(*this, "this"));
    return *_M_current;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator+ ( const difference_type &  __n ) const

inline

      {
    _Safe_iterator __tmp(*this);
    __tmp += __n;
    return __tmp;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator++ ( )

inline

Iterator preincrement.

Precondition

iterator is incrementable

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_incrementable(),
                  _M_message(__msg_bad_inc)
                  ._M_iterator(*this, "this"));
    ++_M_current;
    return *this;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator++ ( int  )

inline

Iterator postincrement.

Precondition

iterator is incrementable

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_incrementable(),
                  _M_message(__msg_bad_inc)
                  ._M_iterator(*this, "this"));
    _Safe_iterator __tmp(*this);
    ++_M_current;
    return __tmp;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator+= ( const difference_type &  __n )

inline

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_can_advance(__n),
                  _M_message(__msg_advance_oob)
                  ._M_iterator(*this)._M_integer(__n));
    _M_current += __n;
    return *this;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator- ( const difference_type &  __n ) const

inline

      {
    _Safe_iterator __tmp(*this);
    __tmp -= __n;
    return __tmp;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-- ( )

inline

Iterator predecrement.

Precondition

iterator is decrementable

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_decrementable(),
                  _M_message(__msg_bad_dec)
                  ._M_iterator(*this, "this"));
    --_M_current;
    return *this;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-- ( int  )

inline

Iterator postdecrement.

Precondition

iterator is decrementable

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_decrementable(),
                  _M_message(__msg_bad_dec)
                  ._M_iterator(*this, "this"));
    _Safe_iterator __tmp(*this);
    --_M_current;
    return __tmp;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-= ( const difference_type &  __n )

inline

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_can_advance(-__n),
                  _M_message(__msg_retreat_oob)
                  ._M_iterator(*this)._M_integer(__n));
    _M_current += -__n;
    return *this;
      }

template<typename _Iterator, typename _Sequence>

pointer __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-> ( ) const

inline

Iterator dereference.

Precondition

iterator is dereferenceable

Todo:

Make this correct w.r.t. iterators that return proxies

Use addressof() instead of & operator

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_dereferenceable(),
                  _M_message(__msg_bad_deref)
                  ._M_iterator(*this, "this"));
    return &*_M_current;
      }

template<typename _Iterator, typename _Sequence>

_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator= ( const _Safe_iterator< _Iterator, _Sequence > &  __x )

inline

Copy assignment.

      {
    // _GLIBCXX_RESOLVE_LIB_DEFECTS
    // DR 408. Is vector<reverse_iterator<char*> > forbidden?
    _GLIBCXX_DEBUG_VERIFY(!__x._M_singular()
                  || __x._M_current == _Iterator(),
                  _M_message(__msg_copy_singular)
                  ._M_iterator(*this, "this")
                  ._M_iterator(__x, "other"));
    _M_current = __x._M_current;
    this->_M_attach(__x._M_sequence);
    return *this;
      }

template<typename _Iterator, typename _Sequence>

reference __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator[] ( const difference_type &  __n ) const

inline

      {
    _GLIBCXX_DEBUG_VERIFY(this->_M_can_advance(__n)
                  && this->_M_can_advance(__n+1),
                  _M_message(__msg_iter_subscript_oob)
                  ._M_iterator(*this)._M_integer(__n));

    return _M_current[__n];
      }

Member Data Documentation

template<typename _Iterator, typename _Sequence>

_Iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_current

private

The underlying iterator.

---

The documentation for this class was generated from the following files:

• GCC4/inc/debug/formatter.h
• GCC4/inc/debug/safe_iterator.h
• GCC4/inc/debug/safe_iterator.tcc