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_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 throw ()
bool _M_dereferenceable () const
Is the iterator dereferenceable? void _M_detach_single () throw ()
_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? 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 () throw ()
bool _M_singular () const throw ()
void _M_unlink () throw ()
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.

Public Attributes¶

_Safe_iterator_base * _M_next
_Safe_iterator_base * _M_prior
_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¶

_Safe_iterator (_Iterator __i, _Safe_sequence_base *__seq, _Attach_single) noexcept
void _M_attach (_Safe_sequence_base *__seq, bool __constant)
void _M_attach_single (_Safe_sequence_base *__seq, bool __constant) throw ()
void _M_detach ()
__gnu_cxx::__mutex & _M_get_mutex () throw ()

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

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.

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

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

Postcondition

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.

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

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.

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.

References __gnu_debug::_Safe_iterator_base::_M_attach(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_S_constant().

void __gnu_debug::_Safe_iterator_base::_M_attach (_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.

Referenced by __gnu_debug::_Safe_iterator_base::_Safe_iterator_base(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_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 (_Safe_sequence_base * __seq) [inline]¶

Likewise, but not thread-safe.

References __gnu_debug::_Safe_iterator_base::_M_attach_single(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_S_constant().

void __gnu_debug::_Safe_iterator_base::_M_attach_single (_Safe_sequence_base * __seq, bool __constant) [protected], [inherited]¶

Likewise, but not thread-safe.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_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 __gnu_debug::_Safe_iterator_base::_M_sequence.

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?

References __gnu_debug::__base(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_incrementable(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::base().

bool __gnu_debug::_Safe_iterator_base::_M_can_compare (const _Safe_iterator_base & __x) const [inherited]¶

Can we compare this iterator to the given iterator __x? Returns true if both iterators are nonsingular and reference the same sequence.

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?

References __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_before_begin(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_end(), and __gnu_debug::_Safe_iterator_base::_M_singular().

void __gnu_debug::_Safe_iterator_base::_M_detach () [protected], [inherited]¶

Detach the iterator for whatever sequence it is attached to, if any.

void __gnu_debug::_Safe_iterator_base::_M_detach_single () [inherited]¶

Likewise, but not thread-safe.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

__gnu_cxx::__mutex& __gnu_debug::_Safe_iterator_base::_M_get_mutex () [protected], [inherited]¶

For use in _Safe_iterator.

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?

References __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_end(), and __gnu_debug::_Safe_iterator_base::_M_singular().

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

void __gnu_debug::_Safe_iterator_base::_M_invalidate () [inline], [inherited]¶

Invalidate the iterator, making it singular.

References __gnu_debug::_Safe_iterator_base::_M_version.

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< _Iterator, _Sequence, _Category >::_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?

References __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::base().

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?

References __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::base().

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

void __gnu_debug::_Safe_iterator_base::_M_reset () [inherited]¶

Reset all member variables

bool __gnu_debug::_Safe_iterator_base::_M_singular () const [inherited]¶

Is this iterator singular?

Referenced by __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_dereferenceable(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_incrementable(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_incrementable().

void __gnu_debug::_Safe_iterator_base::_M_unlink () [inline], [inherited]¶

Unlink itself

References __gnu_debug::_Safe_iterator_base::_M_next, and __gnu_debug::_Safe_iterator_base::_M_prior.

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.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_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.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_before_dereferenceable(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_is_begin(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_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.

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

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

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

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

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

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.

_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 __gnu_debug::_Safe_sequence< _SafeSequence >::_M_invalidate_if(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and __gnu_debug::_Safe_iterator_base::_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 __gnu_debug::_Safe_sequence< _SafeSequence >::_M_invalidate_if(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), and __gnu_debug::_Safe_iterator_base::_M_unlink().

_Safe_sequence_base* __gnu_debug::_Safe_iterator_base::_M_sequence [inherited]¶

The sequence this iterator references; may be NULL to indicate a singular iterator.

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

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 __gnu_debug::_Safe_iterator_base::_M_invalidate(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().