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

NAME
__gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category > - Safe iterator wrapper.

SYNOPSIS

Inherited by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::random_access_iterator_tag >.

  Public Types
typedef _Safe_iterator< _Iterator, _Sequence, iterator_category > _Self
typedef _Traits::difference_type difference_type
typedef _Traits::iterator_category iterator_category
typedef _Iterator iterator_type
typedef _Traits::pointer pointer
typedef _Traits::reference reference
typedef _Traits::value_type value_type

  Public Member Functions
_Safe_iterator () noexcept
_Safe_iterator (_Iterator __i, const _Safe_sequence_base *__seq) noexcept
Safe iterator construction from an unsafe iterator and its sequence.
_Safe_iterator (_Safe_iterator &&__x) noexcept
Move construction.
_Safe_iterator (const _Safe_iterator &__x) noexcept
Copy construction.
template<typename _MutableIterator > _Safe_iterator (const _Safe_iterator< _MutableIterator, _Sequence, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Category >::__type > &__x) noexcept
Converting constructor from a mutable iterator to a constant iterator.
void _M_attach (_Safe_sequence_base *__seq)
void _M_attach_single (_Safe_sequence_base *__seq)
bool _M_before_dereferenceable () const
Is the iterator before a dereferenceable one?
bool _M_can_advance (difference_type __n, bool __strict=false) const
bool _M_dereferenceable () const
Is the iterator dereferenceable?
_Distance_traits< _Iterator >::__type _M_get_distance_from_begin () const
_Distance_traits< _Iterator >::__type _M_get_distance_to (const _Safe_iterator &__rhs) const
_Distance_traits< _Iterator >::__type _M_get_distance_to_end () const
__gnu_cxx::__conditional_type< _IsConstant::__value, const _Sequence *, _Sequence * >::__type _M_get_sequence () const
bool _M_incrementable () const
Is the iterator incrementable?
bool _M_is_before_begin () const
Is this iterator equal to the sequence's before_begin() iterator if any?
bool _M_is_begin () const
Is this iterator equal to the sequence's begin() iterator?
bool _M_is_beginnest () const
Is this iterator equal to the sequence's before_begin() iterator if any or begin() otherwise?
bool _M_is_end () const
Is this iterator equal to the sequence's end() iterator?
bool _M_valid_range (const _Safe_iterator &__rhs, std::pair< difference_type, _Distance_precision > &__dist, bool __check_dereferenceable=true) const
const _Iterator & base () const noexcept
_Iterator & base () noexcept
Return the underlying iterator.
operator _Iterator () const noexcept
Conversion to underlying non-debug iterator to allow better interaction with non-debug containers.
reference operator* () const noexcept
Iterator dereference.
_Safe_iterator & operator++ () noexcept
Iterator preincrement.
_Safe_iterator operator++ (int) noexcept
Iterator postincrement.
pointer operator-> () const noexcept
Iterator dereference.
_Safe_iterator & operator= (_Safe_iterator &&__x) noexcept
Move assignment.
_Safe_iterator & operator= (const _Safe_iterator &__x) noexcept
Copy assignment.

  Static Public Member Functions
static constexpr bool _S_constant ()
Determine if this is a constant iterator.

  Protected Types
typedef std::__are_same< typename _Sequence::_Base::const_iterator, _Iterator > _IsConstant
typedef __gnu_cxx::__conditional_type< _IsConstant::__value, typename _Sequence::_Base::iterator, typename _Sequence::_Base::const_iterator >::__type _OtherIterator

  Protected Member Functions
_Safe_iterator (_Iterator __i, _Safe_sequence_base *__seq, _Attach_single) noexcept

  Friends
template<typename _IteR > bool operator!= (const _Self &__lhs, const _Safe_iterator< _IteR, _Sequence, iterator_category > &__rhs) noexcept
bool operator!= (const _Self &__lhs, const _Self &__rhs) noexcept
template<typename _IteR > bool operator== (const _Self &__lhs, const _Safe_iterator< _IteR, _Sequence, iterator_category > &__rhs) noexcept
bool operator== (const _Self &__lhs, const _Self &__rhs) noexcept

Detailed Description

  template<typename _Iterator, typename _Sequence, typename _Category = typename std::iterator_traits<_Iterator>::iterator_category>
class __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >" 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.

Note that _Iterator must be the first base class so that it gets initialized before the iterator is being attached to the container's list of iterators and it is being detached before _Iterator get destroyed. Otherwise it would result in a data race.

Definition at line 61 of file debug.h.

Constructor & Destructor Documentation

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Safe_iterator () [inline], [noexcept]

Postcondition
    the iterator is singular and unattached

Definition at line 151 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Safe_iterator (_Iterator __i, const _Safe_sequence_base * __seq) [inline], [noexcept]

Safe iterator construction from an unsafe iterator and its sequence.

Precondition
    seq is not NULL

Postcondition
    this is not singular

Definition at line 160 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Safe_iterator (const _Safe_iterator< _Iterator, _Sequence, _Category > & __x) [inline], [noexcept]

Copy construction.

Definition at line 172 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Safe_iterator (_Safe_iterator< _Iterator, _Sequence, _Category > && __x) [inline], [noexcept]

Move construction.

Postcondition
    __x is singular and unattached

Definition at line 190 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> template<typename _MutableIterator > __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Safe_iterator (const _Safe_iterator< _MutableIterator, _Sequence, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Category >::__type > & __x) [inline], [noexcept]

Converting constructor from a mutable iterator to a constant iterator.

Definition at line 210 of file safe_iterator.h.

Member Function Documentation

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> void __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach (_Safe_sequence_base * __seq) [inline]
Attach iterator to the given sequence.

Definition at line 374 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> void __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach_single (_Safe_sequence_base * __seq) [inline]
Likewise, but not thread-safe.

Definition at line 379 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_before_dereferenceable () const [inline]

Is the iterator before a dereferenceable one?

Definition at line 389 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_dereferenceable () const [inline]

Is the iterator dereferenceable?

Definition at line 384 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_incrementable () const [inline]

Is the iterator incrementable?

Definition at line 401 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_before_dereferenceable().

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_before_begin () const [inline]

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

Definition at line 445 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_dereferenceable().

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_begin () const [inline]

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

Definition at line 434 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_beginnest () const [inline]

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

Definition at line 451 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_end () const [inline]

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

Definition at line 439 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_dereferenceable(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_incrementable().

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> static constexpr bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_S_constant () [inline], [static], [constexpr]

Determine if this is a constant iterator.

Definition at line 354 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_attach(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_attach_single().

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> _Iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::base () [inline], [noexcept]

Return the underlying iterator.

Definition at line 361 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_before_dereferenceable(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_is_begin(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::_M_is_end().

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator _Iterator () const [inline], [noexcept]

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

Definition at line 370 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> reference __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator* () const [inline], [noexcept]

Iterator dereference.

Precondition
    iterator is dereferenceable

Definition at line 299 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> _Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator++ () [inline], [noexcept]

Iterator preincrement.

Precondition
    iterator is incrementable

Definition at line 326 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> _Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator++ (int) [inline], [noexcept]

Iterator postincrement.

Precondition
    iterator is incrementable

Definition at line 341 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> pointer __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator-> () const [inline], [noexcept]

Iterator dereference.

Precondition
    iterator is dereferenceable

Definition at line 312 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> _Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator= (_Safe_iterator< _Iterator, _Sequence, _Category > && __x) [inline], [noexcept]

Move assignment.

Postcondition
    __x is singular and unattached

Definition at line 264 of file safe_iterator.h.

  template<typename _Iterator , typename _Sequence , typename _Category = typename std::iterator_traits<_Iterator>::iterator_category> _Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::operator= (const _Safe_iterator< _Iterator, _Sequence, _Category > & __x) [inline], [noexcept]

Copy assignment.

Definition at line 232 of file safe_iterator.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.