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

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

SYNOPSIS

#include <safe_iterator.h>

Inherits .

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
using iterator_concept
typedef _Iterator iterator_type
typedef _Traits::pointer pointer
typedef _Traits::reference reference
typedef _Traits::value_type value_type

  Public Member Functions
constexpr _Safe_iterator () noexcept
constexpr _Safe_iterator (_Iterator __i, const _Safe_sequence_base *__seq) noexcept
Safe iterator construction from an unsafe iterator and its sequence.
constexpr _Safe_iterator (_Safe_iterator &&__x) noexcept
Move construction.
constexpr _Safe_iterator (const _Safe_iterator &__x) noexcept
Copy construction.
template<typename _MutableIterator> constexpr _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 (const _Safe_sequence_base *__seq)
void _M_attach_single (const _Safe_sequence_base *__seq)
bool _M_attached_to (const _Safe_sequence_base *__seq) const
bool _M_before_dereferenceable () const
Is the iterator before a dereferenceable one?
template<typename _Diff> bool _M_can_advance (const std::pair< _Diff, _Distance_precision > &__dist, int __way) const
bool _M_can_advance (difference_type __n, bool __strict=false) const
bool _M_can_compare (const _Safe_iterator_base &__x) const noexcept
bool _M_dereferenceable () const
Is the iterator dereferenceable?
void _M_detach_single () noexcept
_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?
void _M_invalidate ()
bool _M_is_before_begin () const
Is this iterator equal to the sequence's before_begin() iterator if any?
constexpr 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?
void _M_reset () noexcept
bool _M_singular () const noexcept
void _M_unlink () noexcept
bool _M_valid_range (const _Safe_iterator &__rhs, std::pair< difference_type, _Distance_precision > &__dist, bool __check_dereferenceable=true) const
bool _M_value_initialized () const
Is the iterator value-initialized?
constexpr const _Iterator & base () const noexcept
constexpr _Iterator & base () noexcept
Return the underlying iterator.
constexpr operator _Iterator () const noexcept
Conversion to underlying non-debug iterator to allow better interaction with non-debug containers.
constexpr reference operator* () const noexcept
Iterator dereference.
constexpr _Safe_iterator & operator++ () noexcept
Iterator preincrement.
constexpr _Safe_iterator operator++ (int) noexcept
Iterator postincrement.
constexpr pointer operator-> () const noexcept
Iterator dereference.
constexpr _Safe_iterator & operator= (_Safe_iterator &&__x) noexcept
Move assignment.
constexpr _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.

  Public Attributes
_Safe_iterator_base * _M_next
_Safe_iterator_base * _M_prior
const _Safe_sequence_base * _M_sequence
unsigned int _M_version

  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
constexpr _Safe_iterator (const _Safe_iterator &__x, _Unchecked) noexcept
void _M_attach (const _Safe_sequence_base *__seq, bool __constant)
void _M_attach_single (const _Safe_sequence_base *__seq, bool __constant) noexcept
void _M_detach ()
__gnu_cxx::__mutex & _M_get_mutex () noexcept

  Friends
template<typename _IteR> constexpr friend bool operator== (const _Self &__lhs, const _Safe_iterator< _IteR, _Sequence, iterator_category > &__rhs) noexcept
constexpr friend 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.

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], [constexpr], [noexcept]

Postcondition
    the iterator is singular and unattached

  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], [constexpr], [noexcept]

Safe iterator construction from an unsafe iterator and its sequence.

Precondition
    seq is not NULL

Postcondition
    this is not singular

  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], [constexpr], [noexcept]

Copy construction.

  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], [constexpr], [noexcept]

Move construction.

Postcondition
    __x is singular and unattached

  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], [constexpr], [noexcept]

Converting constructor from a mutable iterator to a constant iterator.

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 (const _Safe_sequence_base * __seq) [inline]
Attach iterator to the given sequence.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_attach (const _Safe_sequence_base * __seq, bool __constant) [protected], [inherited]
Attaches this iterator to the given sequence, detaching it from whatever sequence it was attached to originally. If the new sequence is the NULL pointer, the iterator is left unattached.

References _M_attach().

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach(), and _M_attach().

  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 (const _Safe_sequence_base * __seq) [inline]
Likewise, but not thread-safe.

  void __gnu_debug::_Safe_iterator_base::_M_attach_single (const _Safe_sequence_base * __seq, bool __constant) [protected], [noexcept], [inherited]
Likewise, but not thread-safe.

References _M_attach_single().

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach_single(), and _M_attach_single().

  bool __gnu_debug::_Safe_iterator_base::_M_attached_to (const _Safe_sequence_base * __seq) const [inline], [inherited]
Determines if we are attached to the given sequence.

References _M_attached_to(), and _M_sequence.

Referenced by _M_attached_to().

  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?

  bool __gnu_debug::_Safe_iterator_base::_M_can_compare (const _Safe_iterator_base & __x) const [noexcept], [inherited]
Can we compare this iterator to the given iterator __x? Returns true if both iterators are nonsingular and reference the same sequence.

References _Safe_iterator_base(), and _M_can_compare().

Referenced by _M_can_compare().

  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?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator*(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator->().

  void __gnu_debug::_Safe_iterator_base::_M_detach () [protected], [inherited]
Detach the iterator for whatever sequence it is attached to, if any.

References _M_detach().

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), _M_detach(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_detach_single () [noexcept], [inherited]
Likewise, but not thread-safe.

  __gnu_cxx::__mutex & __gnu_debug::_Safe_iterator_base::_M_get_mutex () [protected], [noexcept], [inherited]
For use in _Safe_iterator.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator++(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

  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?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_before_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++().

  void __gnu_debug::_Safe_iterator_base::_M_invalidate () [inline], [inherited]
Invalidate the iterator, making it singular.

References _M_invalidate(), and _M_version.

Referenced by _M_invalidate().

  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?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_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], [constexpr]

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

  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?

  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?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_dereferenceable(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_incrementable().

  void __gnu_debug::_Safe_iterator_base::_M_reset () [noexcept], [inherited]
Reset all member variables

  bool __gnu_debug::_Safe_iterator_base::_M_singular () const [noexcept], [inherited]
Is this iterator singular?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_Safe_local_iterator(), __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_dereferenceable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_incrementable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::_M_incrementable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_unlink () [inline], [noexcept], [inherited]
Unlink itself

References _M_next, _M_prior, and _M_unlink().

Referenced by _M_unlink().

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

Is the iterator value-initialized?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=().

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

Determine if this is a constant iterator.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::_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], [constexpr], [noexcept]

Return the underlying iterator.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_before_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_is_begin(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_is_end(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_value_initialized(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator*(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator->(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=().

  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], [constexpr], [noexcept]

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

  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], [nodiscard], [constexpr], [noexcept]

Iterator dereference.

Precondition
    iterator is dereferenceable

  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], [constexpr], [noexcept]

Iterator preincrement.

Precondition
    iterator is incrementable

  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], [constexpr], [noexcept]

Iterator postincrement.

Precondition
    iterator is incrementable

  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], [nodiscard], [constexpr], [noexcept]

Iterator dereference.

Precondition
    iterator is dereferenceable

  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], [constexpr], [noexcept]

Move assignment.

Postcondition
    __x is singular and unattached

  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], [constexpr], [noexcept]

Copy assignment.

Member Data Documentation

  _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_next [inherited]
Pointer to the next iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and _M_unlink().

  _Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_prior [inherited]
Pointer to the previous iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and _M_unlink().

  const _Safe_sequence_base* __gnu_debug::_Safe_iterator_base::_M_sequence [inherited]
The sequence this iterator references; may be NULL to indicate a singular iterator. Stored as pointer-to-const because sequence could be declared as const.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), _M_attached_to(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

  unsigned int __gnu_debug::_Safe_iterator_base::_M_version [inherited]
The version number of this iterator. The sentinel value 0 is used to indicate an invalidated iterator (i.e., one that is singular because of an operation on the container). This version number must equal the version number in the sequence referenced by _M_sequence for the iterator to be non-singular.

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), _M_invalidate(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

Author

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