libstdc++
__gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category > Class Template Reference
Inheritance diagram for __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >:
[legend]

List of all members.

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 (const _Safe_iterator &__x) noexcept
 _Safe_iterator (_Safe_iterator &&__x) noexcept
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
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
bool _M_can_advance (difference_type __n) const
bool _M_can_compare (const _Safe_iterator_base &__x) const throw ()
bool _M_dereferenceable () const
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
void _M_invalidate ()
bool _M_is_before_begin () const
bool _M_is_begin () const
bool _M_is_beginnest () const
bool _M_is_end () const
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
_Iterator & base () noexcept
const _Iterator & base () const noexcept
 operator _Iterator () const noexcept
reference operator* () const noexcept
_Safe_iteratoroperator++ () noexcept
_Safe_iterator operator++ (int) noexcept
pointer operator-> () const noexcept
_Safe_iteratoroperator= (const _Safe_iterator &__x) noexcept
_Safe_iteratoroperator= (_Safe_iterator &&__x) noexcept

Static Public Member Functions

static constexpr bool _S_constant ()

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

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 _IteR >
bool operator== (const _Self &__lhs, const _Safe_iterator< _IteR, _Sequence, iterator_category > &__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 109 of file safe_iterator.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]
Postcondition:
the iterator is singular and unattached

Definition at line 144 of file safe_iterator.h.

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

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]

Safe iterator construction from an unsafe iterator and its sequence.

Precondition:
seq is not NULL
Postcondition:
this is not singular

Definition at line 153 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]

Copy construction.

Definition at line 165 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]

Move construction.

Postcondition:
__x is singular and unattached

Definition at line 183 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]

Converting constructor from a mutable iterator to a constant iterator.

Definition at line 203 of file safe_iterator.h.


Member Function Documentation

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.

Reimplemented in __gnu_debug::_Safe_local_iterator_base.

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

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]
void __gnu_debug::_Safe_iterator_base::_M_attach_single ( _Safe_sequence_base __seq,
bool  __constant 
) throw () [protected, inherited]
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 372 of file safe_iterator.h.

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.

Definition at line 131 of file safe_base.h.

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?

Definition at line 382 of file safe_iterator.h.

bool __gnu_debug::_Safe_iterator_base::_M_can_compare ( const _Safe_iterator_base __x) const throw () [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]
void __gnu_debug::_Safe_iterator_base::_M_detach ( ) [protected, inherited]

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

Reimplemented in __gnu_debug::_Safe_local_iterator_base.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::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]

Invalidate the iterator, making it singular.

Definition at line 146 of file safe_base.h.

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?

Definition at line 438 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 427 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 444 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]
void __gnu_debug::_Safe_iterator_base::_M_reset ( ) throw () [inherited]

Reset all member variables

void __gnu_debug::_Safe_iterator_base::_M_unlink ( ) throw () [inline, inherited]
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]
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]

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

Definition at line 363 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]

Iterator dereference.

Precondition:
iterator is dereferenceable

Definition at line 292 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]

Iterator preincrement.

Precondition:
iterator is incrementable

Definition at line 319 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]

Iterator postincrement.

Precondition:
iterator is incrementable

Definition at line 334 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]

Iterator dereference.

Precondition:
iterator is dereferenceable

Definition at line 305 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]

Copy assignment.

Definition at line 225 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]

Move assignment.

Postcondition:
__x is singular and unattached

Definition at line 257 of file safe_iterator.h.


Member Data Documentation

Pointer to the next iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Definition at line 74 of file safe_base.h.

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

Pointer to the previous iterator in the sequence's list of iterators. Only valid when _M_sequence != NULL.

Definition at line 70 of file safe_base.h.

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

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.

Definition at line 66 of file safe_base.h.

Referenced by __gnu_debug::_Safe_iterator_base::_M_invalidate(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator=(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >::operator=().


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