__gnu_debug::_Safe_iterator_base Class Reference

Basic functionality for a safe iterator. More...

#include <debug/safe_base.h>

Inheritance diagram for __gnu_debug::_Safe_iterator_base:

Public 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 ()
bool	_M_attached_to (const _Safe_sequence_base *__seq) const
_GLIBCXX_PURE bool	_M_singular () const throw ()
_GLIBCXX_PURE bool	_M_can_compare (const _Safe_iterator_base &__x) const throw ()
void	_M_invalidate ()
void	_M_reset () throw ()
void	_M_unlink () throw ()

Public Attributes
_Safe_sequence_base *	_M_sequence
unsigned int	_M_version
_Safe_iterator_base *	_M_prior
_Safe_iterator_base *	_M_next

Protected Member Functions
	_Safe_iterator_base ()
	_Safe_iterator_base (const _Safe_sequence_base *__seq, bool __constant)
	_Safe_iterator_base (const _Safe_iterator_base &__x, bool __constant)
_Safe_iterator_base &	operator= (const _Safe_iterator_base &)
	_Safe_iterator_base (const _Safe_iterator_base &)
	~_Safe_iterator_base ()
__gnu_cxx::__mutex &	_M_get_mutex () throw ()

Detailed Description

Basic functionality for a safe iterator.

The _Safe_iterator_base base class implements the functionality of a safe iterator that is not specific to a particular iterator type. It contains a pointer back to the sequence it references along with iterator version information and pointers to form a doubly-linked list of iterators referenced by the container.

This class must not perform any operations that can throw an exception, or the exception guarantees of derived iterators will be broken.

Constructor & Destructor Documentation

__gnu_debug::_Safe_iterator_base::_Safe_iterator_base ( )

inlineprotected

Initializes the iterator and makes it singular.

    : _M_sequence(0), _M_version(0), _M_prior(0), _M_next(0)
    { }

__gnu_debug::_Safe_iterator_base::_Safe_iterator_base ( const _Safe_sequence_base *  __seq, bool  __constant  )

inlineprotected

Initialize the iterator to reference the sequence pointed to by __seq. __constant is true when we are initializing a constant iterator, and false if it is a mutable iterator. Note that __seq may be NULL, in which case the iterator will be singular. Otherwise, the iterator will reference __seq and be nonsingular.

    : _M_sequence(0), _M_version(0), _M_prior(0), _M_next(0)
    { this->_M_attach(const_cast<_Safe_sequence_base*>(__seq), __constant); }

__gnu_debug::_Safe_iterator_base::_Safe_iterator_base ( const _Safe_iterator_base &  __x, bool  __constant  )

inlineprotected

Initializes the iterator to reference the same sequence that __x does. __constant is true if this is a constant iterator, and false if it is mutable.

    : _M_sequence(0), _M_version(0), _M_prior(0), _M_next(0)
    { this->_M_attach(__x._M_sequence, __constant); }

__gnu_debug::_Safe_iterator_base::_Safe_iterator_base ( const _Safe_iterator_base &  )

explicitprotected

__gnu_debug::_Safe_iterator_base::~_Safe_iterator_base ( )

inlineprotected

{ this->_M_detach(); }

Member Function Documentation

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

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.

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

Likewise, but not thread-safe.

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

inline

Determines if we are attached to the given sequence.

    { return _M_sequence == __seq; }

_GLIBCXX_PURE bool __gnu_debug::_Safe_iterator_base::_M_can_compare	(	const _Safe_iterator_base &	__x	)	const
throw	(
	)

Can we compare this iterator to the given iterator __x? Returns true if both iterators are nonsingular and reference the same sequence.

void __gnu_debug::_Safe_iterator_base::_M_detach

(

)

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

void __gnu_debug::_Safe_iterator_base::_M_detach_single	(		)
throw	(
	)

Likewise, but not thread-safe.

__gnu_cxx::__mutex& __gnu_debug::_Safe_iterator_base::_M_get_mutex ( ) throw ( )

protected

For use in _Safe_iterator.

void __gnu_debug::_Safe_iterator_base::_M_invalidate ( )

inline

Invalidate the iterator, making it singular.

    { _M_version = 0; }

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

Reset all member variables

_GLIBCXX_PURE bool __gnu_debug::_Safe_iterator_base::_M_singular	(		)	const
throw	(
	)

Is this iterator singular?

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

inline

Unlink itself

    {
      if (_M_prior)
    _M_prior->_M_next = _M_next;
      if (_M_next)
    _M_next->_M_prior = _M_prior;
    }

_Safe_iterator_base& __gnu_debug::_Safe_iterator_base::operator= ( const _Safe_iterator_base &  )

protected

Member Data Documentation

_Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_next

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

_Safe_iterator_base* __gnu_debug::_Safe_iterator_base::_M_prior

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

_Safe_sequence_base* __gnu_debug::_Safe_iterator_base::_M_sequence

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

unsigned int __gnu_debug::_Safe_iterator_base::_M_version

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.

---

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

• GCC4/inc/debug/safe_base.h