__gnu_debug::_Safe_iterator< _Iterator, _Sequence > Class Template Reference

Safe iterator wrapper. More...

Inheritance diagram for __gnu_debug::_Safe_iterator< _Iterator, _Sequence >:

Inheritance graph

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions


Detailed Description

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

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.

Definition at line 63 of file safe_iterator.h.


Constructor & Destructor Documentation

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator (  )  [inline]

Postcondition:
the iterator is singular and unattached

Definition at line 99 of file safe_iterator.h.

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Iterator &  __i,
const _Sequence *  __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 108 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator_base::_M_singular().

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Safe_iterator< _Iterator, _Sequence > &  __x  )  [inline]

Copy construction.

Precondition:
x is not singular

Definition at line 120 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator_base::_M_singular().

template<typename _Iterator, typename _Sequence>
template<typename _MutableIterator >
__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator ( const _Safe_iterator< _MutableIterator, typename __gnu_cxx::__enable_if<(std::__are_same< _MutableIterator, typename _Sequence::iterator::_Base_iterator >::__value), _Sequence >::__type > &  __x  )  [inline]

Converting constructor from a mutable iterator to a constant iterator.

Precondition:
x is not singular

Definition at line 136 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.


Member Function Documentation

void __gnu_debug::_Safe_iterator_base::_M_attach ( _Safe_sequence_base __seq,
bool  __constant 
) [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().

template<typename _Iterator, typename _Sequence>
void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_attach ( const _Sequence *  __seq  )  [inline]

Attach iterator to the given sequence.

Definition at line 317 of file safe_iterator.h.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator=().

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

Likewise, but not thread-safe.

template<typename _Iterator, typename _Sequence>
void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_attach_single ( const _Sequence *  __seq  )  [inline]

Likewise, but not thread-safe.

Definition at line 325 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 130 of file safe_base.h.

References __gnu_debug::_Safe_iterator_base::_M_sequence.

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>
bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_dereferenceable (  )  const [inline]

void __gnu_debug::_Safe_iterator_base::_M_detach (  )  [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.

template<typename _Iterator, typename _Sequence>
template<typename _Iterator1 , typename _Iterator2 >
static std::pair<difference_type, _Distance_precision> __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_get_distance ( const _Iterator1 &  __lhs,
const _Iterator2 &  __rhs 
) [inline, static]

Determine the distance between two iterators with some known precision.

Definition at line 371 of file safe_iterator.h.

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

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_incrementable (  )  const [inline]

template<typename _Iterator , typename _Sequence >
void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_invalidate (  )  [inline]

template<typename _Iterator , typename _Sequence >
void __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_invalidate_single (  )  [inline]

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_begin (  )  const [inline]

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

Definition at line 396 of file safe_iterator.h.

References __gnu_debug::_Safe_iterator_base::_M_sequence.

template<typename _Iterator, typename _Sequence>
bool __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_is_end (  )  const [inline]

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

Definition at line 400 of file safe_iterator.h.

References __gnu_debug::_Safe_iterator_base::_M_sequence.

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

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

template<typename _Iterator, typename _Sequence>
_Iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::base (  )  const [inline]

template<typename _Iterator, typename _Sequence>
__gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator _Iterator (  )  const [inline]

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

Definition at line 313 of file safe_iterator.h.

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

Iterator dereference.

Precondition:
iterator is dereferenceable

Definition at line 170 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_dereferenceable().

template<typename _Iterator, typename _Sequence>
_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator++ ( int   )  [inline]

Iterator postincrement.

Precondition:
iterator is incrementable

Definition at line 214 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_incrementable().

template<typename _Iterator, typename _Sequence>
_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator++ (  )  [inline]

Iterator preincrement.

Precondition:
iterator is incrementable

Definition at line 200 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_incrementable().

template<typename _Iterator, typename _Sequence>
_Safe_iterator __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-- ( int   )  [inline]

Iterator postdecrement.

Precondition:
iterator is decrementable

Definition at line 244 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.

template<typename _Iterator, typename _Sequence>
_Safe_iterator& __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-- (  )  [inline]

Iterator predecrement.

Precondition:
iterator is decrementable

Definition at line 230 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.

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

Iterator dereference.

Precondition:
iterator is dereferenceable
Todo:
Make this correct w.r.t. iterators that return proxies

Use addressof() instead of & operator

Definition at line 186 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_dereferenceable().

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


Member Data Documentation

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

Definition at line 73 of file safe_base.h.

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

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

Definition at line 69 of file safe_base.h.

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 65 of file safe_base.h.

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


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

Generated on Thu Jul 23 21:17:24 2009 for libstdc++ by  doxygen 1.5.8