Basic functionality for a safe iterator. More...

#include <safe_base.h>

Inheritance diagram for __gnu_debug::_Safe_iterator_base:

Collaboration diagram for __gnu_debug::_Safe_iterator_base:

Public Member Functions
void	_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. More...

void	_M_attach_single (_Safe_sequence_base *__seq, bool __constant) throw ()
	Likewise, but not thread-safe. More...

bool	_M_attached_to (const _Safe_sequence_base *__seq) const
	Determines if we are attached to the given sequence. More...

_GLIBCXX_PURE bool	_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. More...

void	_M_detach ()
	Detach the iterator for whatever sequence it is attached to, if any. More...

void	_M_detach_single () throw ()
	Likewise, but not thread-safe. More...

void	_M_invalidate ()
	Invalidate the iterator, making it singular. More...

void	_M_reset () throw ()
	Reset all member variables. More...

_GLIBCXX_PURE bool	_M_singular () const throw ()
	Is this iterator singular? More...

void	_M_unlink () throw ()
	Unlink itself. More...

Public Attributes
_Safe_iterator_base *	_M_next
	Pointer to the next iterator in the sequence's list of iterators. More...

_Safe_iterator_base *	_M_prior
	Pointer to the previous iterator in the sequence's list of iterators. More...

_Safe_sequence_base *	_M_sequence
	The sequence this iterator references; may be NULL to indicate a singular iterator. More...

unsigned int	_M_version
	The version number of this iterator. More...

Protected Member Functions
	_Safe_iterator_base ()
	Initializes the iterator and makes it singular. More...

	_Safe_iterator_base (const _Safe_sequence_base *__seq, bool __constant)
	Initialize the iterator to reference the sequence pointed to by `__seq`. More...

	_Safe_iterator_base (const _Safe_iterator_base &__x, bool __constant)
	Initializes the iterator to reference the same sequence that `__x` does. More...

	~_Safe_iterator_base ()

__gnu_cxx::__mutex &	_M_get_mutex () throw ()
	For use in _Safe_iterator. More...

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.

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

References _M_attach().

Here is the call graph for this function:

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

References _M_attach(), and _M_sequence.

Here is the call graph for this function:

__gnu_debug::_Safe_iterator_base::~_Safe_iterator_base ( )

inlineprotected

References _M_detach().

Here is the call graph for this function:

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.

Referenced by __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_attach(), and _Safe_iterator_base().

Here is the caller graph for this function:

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

Likewise, but not thread-safe.

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

Here is the caller graph for this function:

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.

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

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

Here is the caller graph for this function:

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.

Referenced by __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator++(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator++(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator+=(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator--(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator-=(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::operator=(), and __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::operator=().

Here is the caller graph for this function:

void __gnu_debug::_Safe_iterator_base::_M_invalidate ( )

inline

Invalidate the iterator, making it singular.

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?

Referenced by __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_decrementable(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_dereferenceable(), __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_M_incrementable(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_M_incrementable(), __gnu_debug::_Error_formatter::_Parameter::_Parameter(), __gnu_debug::_Safe_iterator< _Iterator, _Sequence >::_Safe_iterator(), and __gnu_debug::_Safe_local_iterator< _Iterator, _Sequence >::_Safe_local_iterator().

Here is the caller graph for this function:

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

inline

Unlink itself.

References _M_next, and _M_prior.

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.

Referenced by _M_unlink().

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

Referenced by _M_unlink().

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

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

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

/usr/include/c++/5/debug/safe_base.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation