libstdc++
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence > Class Template Reference

#include <safe_local_iterator.h>

Inheritance diagram for __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >:
[legend]

Public Types

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_local_iterator () noexcept
 _Safe_local_iterator (_Iterator __i, const _Safe_sequence_base *__cont)
 _Safe_local_iterator (_Safe_local_iterator &&__x) noexcept
 _Safe_local_iterator (const _Safe_local_iterator &__x) noexcept
template<typename _MutableIterator>
 _Safe_local_iterator (const _Safe_local_iterator< _MutableIterator, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Sequence >::__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_can_compare (const _Safe_iterator_base &__x) const throw ()
bool _M_dereferenceable () const
_Distance_traits< _Iterator >::__type _M_get_distance_to (const _Safe_local_iterator &__rhs) const
__gnu_cxx::__conditional_type< _IsConstant::__value, const_Sequence *, _Sequence * >::__type _M_get_sequence () const
template<typename _Other>
bool _M_in_same_bucket (const _Safe_local_iterator< _Other, _Sequence > &__other) const
bool _M_incrementable () const
void _M_invalidate ()
bool _M_is_begin () 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_local_iterator &__rhs, std::pair< difference_type, _Distance_precision > &__dist_info) const
bool _M_value_initialized () const
const _Iterator & base () const noexcept
_Iterator & base () noexcept
size_type bucket () const
 operator _Iterator () const
reference operator* () const
_Safe_local_iteratoroperator++ ()
_Safe_local_iterator operator++ (int)
pointer operator-> () const
_Safe_local_iteratoroperator= (_Safe_local_iterator &&__x) noexcept
_Safe_local_iteratoroperator= (const _Safe_local_iterator &__x)

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 Member Functions

void _M_attach (_Safe_sequence_base *__seq, bool __constant)
void _M_attach_single (_Safe_sequence_base *__seq, bool __constant) throw ()
void _M_detach ()
void _M_detach_single () throw ()
_Safe_unordered_container_base_M_get_container () const noexcept
__gnu_cxx::__mutex & _M_get_mutex () throw ()

Friends

bool operator!= (const _Self &__lhs, const _OtherSelf &__rhs) noexcept
bool operator!= (const _Self &__lhs, const _Self &__rhs) noexcept
bool operator== (const _Self &__lhs, const _OtherSelf &__rhs) noexcept
bool operator== (const _Self &__lhs, const _Self &__rhs) noexcept

Detailed Description

template<typename _Iterator, typename _Sequence>
class __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >

Safe iterator wrapper.

The class template _Safe_local_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_local_iterator has member functions for iterator invalidation, attaching/detaching the iterator from sequences, and querying the iterator's state.

Definition at line 64 of file safe_local_iterator.h.

Member Typedef Documentation

◆ difference_type

template<typename _Iterator, typename _Sequence>
typedef _Traits::difference_type __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::difference_type

Definition at line 98 of file safe_local_iterator.h.

◆ iterator_category

template<typename _Iterator, typename _Sequence>
typedef _Traits::iterator_category __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::iterator_category

Definition at line 96 of file safe_local_iterator.h.

◆ iterator_type

template<typename _Iterator, typename _Sequence>
typedef _Iterator __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::iterator_type

Definition at line 95 of file safe_local_iterator.h.

◆ pointer

template<typename _Iterator, typename _Sequence>
typedef _Traits::pointer __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::pointer

Definition at line 100 of file safe_local_iterator.h.

◆ reference

template<typename _Iterator, typename _Sequence>
typedef _Traits::reference __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::reference

Definition at line 99 of file safe_local_iterator.h.

◆ value_type

template<typename _Iterator, typename _Sequence>
typedef _Traits::value_type __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::value_type

Definition at line 97 of file safe_local_iterator.h.

Constructor & Destructor Documentation

◆ _Safe_local_iterator() [1/5]

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator ( )
inlinenoexcept
Postcondition
the iterator is singular and unattached

Definition at line 103 of file safe_local_iterator.h.

◆ _Safe_local_iterator() [2/5]

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator ( _Iterator __i,
const _Safe_sequence_base * __cont )
inline

Safe iterator construction from an unsafe iterator and its sequence.

Precondition
seq is not NULL
Postcondition
this is not singular

Definition at line 112 of file safe_local_iterator.h.

◆ _Safe_local_iterator() [3/5]

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator ( const _Safe_local_iterator< _Iterator, _Sequence > & __x)
inlinenoexcept

Copy construction.

Definition at line 119 of file safe_local_iterator.h.

◆ _Safe_local_iterator() [4/5]

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator ( _Safe_local_iterator< _Iterator, _Sequence > && __x)
inlinenoexcept

Move construction.

Postcondition
__x is singular and unattached

Definition at line 136 of file safe_local_iterator.h.

◆ _Safe_local_iterator() [5/5]

template<typename _Iterator, typename _Sequence>
template<typename _MutableIterator>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator ( const _Safe_local_iterator< _MutableIterator, typename __gnu_cxx::__enable_if< _IsConstant::__value &&std::__are_same< _MutableIterator, _OtherIterator >::__value, _Sequence >::__type > & __x)
inlinenoexcept

Converting constructor from a mutable iterator to a constant iterator.

Definition at line 155 of file safe_local_iterator.h.

Member Function Documentation

◆ _M_attach() [1/2]

◆ _M_attach() [2/2]

void __gnu_debug::_Safe_local_iterator_base::_M_attach ( _Safe_sequence_base * __seq,
bool __constant )
protectedinherited

Attaches this iterator to the given container, detaching it from whatever container it was attached to originally. If the new container is the NULL pointer, the iterator is left unattached.

References _M_attach().

Referenced by _Safe_local_iterator_base(), _Safe_local_iterator_base(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_M_attach(), and _M_attach().

◆ _M_attach_single() [1/2]

template<typename _Iterator, typename _Sequence>
void __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_attach_single ( _Safe_sequence_base * __seq)
inline

Likewise, but not thread-safe.

Definition at line 328 of file safe_local_iterator.h.

◆ _M_attach_single() [2/2]

void __gnu_debug::_Safe_local_iterator_base::_M_attach_single ( _Safe_sequence_base * __seq,
bool __constant )
throw ( )
protectedinherited

◆ _M_attached_to()

bool __gnu_debug::_Safe_iterator_base::_M_attached_to ( const _Safe_sequence_base * __seq) const
inlineinherited

Determines if we are attached to the given sequence.

Definition at line 145 of file safe_base.h.

References _M_attached_to(), and _M_sequence.

Referenced by _M_attached_to().

◆ _M_can_compare()

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.

References _Safe_iterator_base(), and _M_can_compare().

Referenced by _M_can_compare().

◆ _M_dereferenceable()

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_dereferenceable ( ) const
inline

◆ _M_detach()

void __gnu_debug::_Safe_local_iterator_base::_M_detach ( )
protectedinherited

◆ _M_detach_single()

void __gnu_debug::_Safe_local_iterator_base::_M_detach_single ( )
throw ( )
protectedinherited

Likewise, but not thread-safe.

References _M_detach_single().

Referenced by _M_detach_single().

◆ _M_get_distance_to()

template<typename _Iterator, typename _Sequence>
_Distance_traits< _Iterator >::__type __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_get_distance_to ( const _Safe_local_iterator< _Iterator, _Sequence > & __rhs) const

Definition at line 36 of file safe_local_iterator.tcc.

◆ _M_get_mutex()

◆ _M_get_sequence()

template<typename _Iterator, typename _Sequence>
__gnu_cxx::__conditional_type< _IsConstant::__value, const_Sequence *, _Sequence * >::__type __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_get_sequence ( ) const
inline

Definition at line 359 of file safe_local_iterator.h.

◆ _M_in_same_bucket()

template<typename _Iterator, typename _Sequence>
template<typename _Other>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_in_same_bucket ( const _Safe_local_iterator< _Other, _Sequence > & __other) const
inline

Is this iterator part of the same bucket as the other one?

Definition at line 373 of file safe_local_iterator.h.

◆ _M_incrementable()

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_incrementable ( ) const
inline

◆ _M_invalidate()

void __gnu_debug::_Safe_iterator_base::_M_invalidate ( )
inlineinherited

Invalidate the iterator, making it singular.

Definition at line 160 of file safe_base.h.

References _M_invalidate(), and _M_version.

Referenced by _M_invalidate().

◆ _M_is_begin()

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_begin ( ) const
inline

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

Definition at line 363 of file safe_local_iterator.h.

◆ _M_is_end()

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_is_end ( ) const
inline

◆ _M_reset()

void __gnu_debug::_Safe_iterator_base::_M_reset ( )
throw ( )
inherited

Reset all member variables

◆ _M_singular()

◆ _M_unlink()

void __gnu_debug::_Safe_iterator_base::_M_unlink ( )
throw ( )
inlineinherited

Unlink itself

Definition at line 169 of file safe_base.h.

References _M_next, _M_prior, and _M_unlink().

Referenced by _M_unlink().

◆ _M_valid_range()

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_valid_range ( const _Safe_local_iterator< _Iterator, _Sequence > & __rhs,
std::pair< difference_type, _Distance_precision > & __dist_info ) const

Definition at line 77 of file safe_local_iterator.tcc.

◆ _M_value_initialized()

◆ _S_constant()

template<typename _Iterator, typename _Sequence>
constexpr bool __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_S_constant ( )
inlinestaticconstexpr

◆ base() [1/2]

template<typename _Iterator, typename _Sequence>
const _Iterator & __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::base ( ) const
inlinenoexcept

Definition at line 307 of file safe_local_iterator.h.

◆ base() [2/2]

◆ bucket()

◆ operator _Iterator()

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator _Iterator ( ) const
inline

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

Definition at line 319 of file safe_local_iterator.h.

◆ operator*()

template<typename _Iterator, typename _Sequence>
reference __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator* ( ) const
inline

Iterator dereference.

Precondition
iterator is dereferenceable

Definition at line 241 of file safe_local_iterator.h.

◆ operator++() [1/2]

template<typename _Iterator, typename _Sequence>
_Safe_local_iterator & __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator++ ( )
inline

Iterator preincrement.

Precondition
iterator is incrementable

Definition at line 268 of file safe_local_iterator.h.

◆ operator++() [2/2]

template<typename _Iterator, typename _Sequence>
_Safe_local_iterator __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator++ ( int )
inline

Iterator postincrement.

Precondition
iterator is incrementable

Definition at line 283 of file safe_local_iterator.h.

◆ operator->()

template<typename _Iterator, typename _Sequence>
pointer __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator-> ( ) const
inline

Iterator dereference.

Precondition
iterator is dereferenceable

Definition at line 254 of file safe_local_iterator.h.

◆ operator=() [1/2]

template<typename _Iterator, typename _Sequence>
_Safe_local_iterator & __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator= ( _Safe_local_iterator< _Iterator, _Sequence > && __x)
inlinenoexcept

Move assignment.

Postcondition
__x is singular and unattached

Definition at line 207 of file safe_local_iterator.h.

◆ operator=() [2/2]

template<typename _Iterator, typename _Sequence>
_Safe_local_iterator & __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator= ( const _Safe_local_iterator< _Iterator, _Sequence > & __x)
inline

Copy assignment.

Definition at line 176 of file safe_local_iterator.h.

◆ operator!= [1/2]

template<typename _Iterator, typename _Sequence>
bool operator!= ( const _Self & __lhs,
const _OtherSelf & __rhs )
friend

Definition at line 392 of file safe_local_iterator.h.

◆ operator!= [2/2]

template<typename _Iterator, typename _Sequence>
bool operator!= ( const _Self & __lhs,
const _Self & __rhs )
friend

Definition at line 399 of file safe_local_iterator.h.

◆ operator== [1/2]

template<typename _Iterator, typename _Sequence>
bool operator== ( const _Self & __lhs,
const _OtherSelf & __rhs )
friend

Definition at line 378 of file safe_local_iterator.h.

◆ operator== [2/2]

template<typename _Iterator, typename _Sequence>
bool operator== ( const _Self & __lhs,
const _Self & __rhs )
friend

Definition at line 385 of file safe_local_iterator.h.

Member Data Documentation

◆ _M_next

_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.

Definition at line 74 of file safe_base.h.

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

◆ _M_prior

_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.

Definition at line 70 of file safe_base.h.

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

◆ _M_sequence

◆ _M_version

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.

Definition at line 66 of file safe_base.h.

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


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