libstdc++
__gnu_debug::_Safe_iterator Class Reference
Inheritance diagram for __gnu_debug::_Safe_iterator:

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions


Detailed Description

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.


Constructor & Destructor Documentation

__gnu_debug::_Safe_iterator::_Safe_iterator ( ) [inline]
Postcondition:
the iterator is singular and unattached

Definition at line 113 of file safe_iterator.h.

__gnu_debug::_Safe_iterator::_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 122 of file safe_iterator.h.

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

__gnu_debug::_Safe_iterator::_Safe_iterator ( const _Safe_iterator __x) [inline]

Copy construction.

Definition at line 133 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.

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

Converting constructor from a mutable iterator to a constant iterator.

Definition at line 150 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().

void __gnu_debug::_Safe_iterator::_M_attach ( _Safe_sequence_base __seq) [inline]

Attach iterator to the given sequence.

Definition at line 335 of file safe_iterator.h.

Referenced by operator=().

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

Likewise, but not thread-safe.

void __gnu_debug::_Safe_iterator::_M_attach_single ( _Safe_sequence_base __seq) [inline]

Likewise, but not thread-safe.

Definition at line 342 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::_M_before_dereferenceable ( ) const [inline]

Is the iterator before a dereferenceable one?

Definition at line 354 of file safe_iterator.h.

References _M_incrementable(), and _M_dereferenceable().

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.

bool __gnu_debug::_Safe_iterator::_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 ( ) throw () [inherited]

Likewise, but not thread-safe.

Referenced by __gnu_debug::_Safe_sequence::_M_transfer_from_if().

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

Determine the distance between two iterators with some known precision.

Definition at line 388 of file safe_iterator.h.

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

For use in _Safe_iterator.

bool __gnu_debug::_Safe_iterator::_M_incrementable ( ) const [inline]

Is the iterator incrementable?

Definition at line 362 of file safe_iterator.h.

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

Referenced by operator++(), and _M_before_dereferenceable().

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

Invalidate the iterator, making it singular.

Definition at line 143 of file safe_base.h.

References __gnu_debug::_Safe_iterator_base::_M_version.

bool __gnu_debug::_Safe_iterator::_M_is_before_begin ( ) const [inline]

Is this iterator equal to the sequence's before_begin() iterator if any?

Definition at line 417 of file safe_iterator.h.

References base().

Referenced by _M_dereferenceable().

bool __gnu_debug::_Safe_iterator::_M_is_begin ( ) const [inline]

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

Definition at line 408 of file safe_iterator.h.

References base().

bool __gnu_debug::_Safe_iterator::_M_is_end ( ) const [inline]

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

Definition at line 412 of file safe_iterator.h.

References base().

Referenced by _M_dereferenceable(), and _M_incrementable().

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

Reset all member variables

bool __gnu_debug::_Safe_iterator_base::_M_singular ( ) const throw () [inherited]
void __gnu_debug::_Safe_iterator_base::_M_unlink ( ) throw () [inline, inherited]
_Iterator __gnu_debug::_Safe_iterator::base ( ) const [inline]

Return the underlying iterator.

Definition at line 325 of file safe_iterator.h.

Referenced by _M_is_begin(), _M_is_end(), and _M_is_before_begin().

__gnu_debug::_Safe_iterator::operator _Iterator ( ) const [inline]

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

Definition at line 331 of file safe_iterator.h.

reference __gnu_debug::_Safe_iterator::operator* ( ) const [inline]

Iterator dereference.

Precondition:
iterator is dereferenceable

Definition at line 189 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and _M_dereferenceable().

_Safe_iterator& __gnu_debug::_Safe_iterator::operator++ ( ) [inline]

Iterator preincrement.

Precondition:
iterator is incrementable

Definition at line 218 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and _M_incrementable().

_Safe_iterator __gnu_debug::_Safe_iterator::operator++ ( int  ) [inline]

Iterator postincrement.

Precondition:
iterator is incrementable

Definition at line 232 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and _M_incrementable().

_Safe_iterator& __gnu_debug::_Safe_iterator::operator-- ( ) [inline]

Iterator predecrement.

Precondition:
iterator is decrementable

Definition at line 248 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.

_Safe_iterator __gnu_debug::_Safe_iterator::operator-- ( int  ) [inline]

Iterator postdecrement.

Precondition:
iterator is decrementable

Definition at line 262 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY.

pointer __gnu_debug::_Safe_iterator::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 204 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and _M_dereferenceable().

_Safe_iterator& __gnu_debug::_Safe_iterator::operator= ( const _Safe_iterator __x) [inline]

Copy assignment.

Definition at line 170 of file safe_iterator.h.

References _GLIBCXX_DEBUG_VERIFY, and _M_attach().


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_base::_M_unlink(), and __gnu_debug::_Safe_sequence::_M_transfer_from_if().

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.

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

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

Definition at line 56 of file safe_base.h.

Referenced by __gnu_debug::_Safe_iterator_base::_M_attached_to(), and __gnu_debug::_Safe_sequence::_M_transfer_from_if().

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_base::_M_invalidate().


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