libstdc++
|
#include <safe_iterator.h>
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 (_Safe_iterator &&__x) noexcept | |
_Safe_iterator (const _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 |
const _Iterator & | base () const noexcept |
_Iterator & | base () noexcept |
operator _Iterator () const noexcept | |
reference | operator* () const noexcept |
_Safe_iterator & | operator++ () noexcept |
_Safe_iterator | operator++ (int) noexcept |
pointer | operator-> () const noexcept |
_Safe_iterator & | operator= (_Safe_iterator &&__x) noexcept |
_Safe_iterator & | operator= (const _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 | |
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 |
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.
|
protected |
Definition at line 120 of file safe_iterator.h.
|
protected |
Definition at line 125 of file safe_iterator.h.
typedef _Safe_iterator<_Iterator, _Sequence, iterator_category> __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_Self |
Definition at line 449 of file safe_iterator.h.
typedef _Traits::difference_type __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::difference_type |
Definition at line 139 of file safe_iterator.h.
typedef _Traits::iterator_category __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::iterator_category |
Definition at line 137 of file safe_iterator.h.
typedef _Iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::iterator_type |
Definition at line 136 of file safe_iterator.h.
typedef _Traits::pointer __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::pointer |
Definition at line 141 of file safe_iterator.h.
typedef _Traits::reference __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::reference |
Definition at line 140 of file safe_iterator.h.
typedef _Traits::value_type __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::value_type |
Definition at line 138 of file safe_iterator.h.
|
inlineprotectednoexcept |
Definition at line 130 of file safe_iterator.h.
|
inlinenoexcept |
Definition at line 144 of file safe_iterator.h.
|
inlinenoexcept |
Safe iterator construction from an unsafe iterator and its sequence.
seq
is not NULL Definition at line 153 of file safe_iterator.h.
|
inlinenoexcept |
Copy construction.
Definition at line 165 of file safe_iterator.h.
|
inlinenoexcept |
Move construction.
Definition at line 183 of file safe_iterator.h.
|
inlinenoexcept |
Converting constructor from a mutable iterator to a constant iterator.
Definition at line 203 of file safe_iterator.h.
|
inline |
Attach iterator to the given sequence.
Definition at line 367 of file safe_iterator.h.
References __gnu_debug::_Safe_iterator_base::_M_attach(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_S_constant().
|
protectedinherited |
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().
|
inline |
Likewise, but not thread-safe.
Definition at line 372 of file safe_iterator.h.
References __gnu_debug::_Safe_iterator_base::_M_attach_single(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_S_constant().
|
protectedinherited |
Likewise, but not thread-safe.
Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach_single().
|
inlineinherited |
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.
|
inline |
Is the iterator before a dereferenceable one?
Definition at line 382 of file safe_iterator.h.
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< _Iterator, _Sequence, _Category >::_M_can_advance | ( | difference_type | __n | ) | const |
Definition at line 84 of file safe_iterator.tcc.
|
inherited |
Can we compare this iterator to the given iterator __x
? Returns true if both iterators are nonsingular and reference the same sequence.
|
inline |
Is the iterator dereferenceable?
Definition at line 377 of file safe_iterator.h.
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().
|
protectedinherited |
Detach the iterator for whatever sequence it is attached to, if any.
|
inherited |
Likewise, but not thread-safe.
Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().
_Distance_traits< _Iterator >::__type __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_get_distance_from_begin |
Definition at line 36 of file safe_iterator.tcc.
_Distance_traits< _Iterator >::__type __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_get_distance_to | ( | const _Safe_iterator< _Iterator, _Sequence, _Category > & | __rhs | ) | const |
Definition at line 113 of file safe_iterator.tcc.
_Distance_traits< _Iterator >::__type __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_get_distance_to_end |
Definition at line 60 of file safe_iterator.tcc.
|
protectedinherited |
For use in _Safe_iterator.
|
inline |
Definition at line 410 of file safe_iterator.h.
|
inline |
Is the iterator incrementable?
Definition at line 394 of file safe_iterator.h.
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().
|
inlineinherited |
Invalidate the iterator, making it singular.
Definition at line 146 of file safe_base.h.
References __gnu_debug::_Safe_iterator_base::_M_version.
|
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, _Category >::_M_dereferenceable().
|
inline |
Is this iterator equal to the sequence's begin() iterator?
Definition at line 427 of file safe_iterator.h.
References __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::base().
|
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.
|
inline |
Is this iterator equal to the sequence's end() iterator?
Definition at line 432 of file safe_iterator.h.
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().
|
inherited |
Reset all member variables
|
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().
|
inlineinherited |
Unlink itself
Definition at line 155 of file safe_base.h.
bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_valid_range | ( | const _Safe_iterator< _Iterator, _Sequence, _Category > & | __rhs, |
std::pair< difference_type, _Distance_precision > & | __dist, | ||
bool | __check_dereferenceable = true |
||
) | const |
Definition at line 166 of file safe_iterator.tcc.
|
inlinestaticconstexpr |
Determine if this is a constant iterator.
Definition at line 347 of file safe_iterator.h.
Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >::_M_attach_single().
|
inlinenoexcept |
Definition at line 357 of file safe_iterator.h.
|
inlinenoexcept |
Return the underlying iterator.
Definition at line 354 of file safe_iterator.h.
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().
|
inlinenoexcept |
Conversion to underlying non-debug iterator to allow better interaction with non-debug containers.
Definition at line 363 of file safe_iterator.h.
|
inlinenoexcept |
Iterator dereference.
Definition at line 292 of file safe_iterator.h.
|
inlinenoexcept |
Iterator preincrement.
Definition at line 319 of file safe_iterator.h.
|
inlinenoexcept |
Iterator postincrement.
Definition at line 334 of file safe_iterator.h.
|
inlinenoexcept |
Iterator dereference.
Definition at line 305 of file safe_iterator.h.
|
inlinenoexcept |
Move assignment.
Definition at line 257 of file safe_iterator.h.
|
inlinenoexcept |
Copy assignment.
Definition at line 225 of file safe_iterator.h.
|
friend |
Definition at line 477 of file safe_iterator.h.
|
friend |
Definition at line 469 of file safe_iterator.h.
|
friend |
Definition at line 460 of file safe_iterator.h.
|
friend |
Definition at line 452 of file safe_iterator.h.
|
inherited |
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< _SafeSequence >::_M_invalidate_if(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().
|
inherited |
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< _SafeSequence >::_M_invalidate_if(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().
|
inherited |
The sequence this iterator references; may be NULL to indicate a singular iterator.
Definition at line 57 of file safe_base.h.
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().
|
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.
Definition at line 66 of file safe_base.h.
Referenced by __gnu_debug::_Safe_iterator_base::_M_invalidate(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().