__gnu_debug::_Safe_iterator_base(3)

NAME
__gnu_debug::_Safe_iterator_base - Basic functionality for a safe iterator.

SYNOPSIS

#include <safe_base.h>

Inherited by __gnu_debug::_Safe_iterator< _Base_iterator, map >, __gnu_debug::_Safe_iterator< _Base_const_iterator, map >, __gnu_debug::_Safe_iterator< _Base_iterator, multimap >, __gnu_debug::_Safe_iterator< _Base_const_iterator, multimap >, __gnu_debug::_Safe_iterator< _Base_iterator, multiset >, __gnu_debug::_Safe_iterator< _Base_const_iterator, multiset >, __gnu_debug::_Safe_iterator< _Iterator, _Sequence, iterator_category >, __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::forward_iterator_tag >, __gnu_debug::_Safe_iterator< _OtherIterator, _Sequence, std::random_access_iterator_tag >, __gnu_debug::_Safe_iterator< _Base_iterator, set >, __gnu_debug::_Safe_iterator< _Base_const_iterator, set >, __gnu_debug::_Safe_iterator< _Base_iterator, deque >, __gnu_debug::_Safe_iterator< _Base_const_iterator, deque >, __gnu_debug::_Safe_iterator< _Base_iterator, forward_list >, __gnu_debug::_Safe_iterator< _Base_const_iterator, forward_list >, __gnu_debug::_Safe_iterator< _Base_iterator, list >, __gnu_debug::_Safe_iterator< _Base_const_iterator, list >, __gnu_debug::_Safe_iterator< typename _Base::__const_iterator, basic_string >, __gnu_debug::_Safe_iterator< typename _Base::iterator, basic_string >, __gnu_debug::_Safe_iterator< typename _Base::const_iterator, basic_string >, __gnu_debug::_Safe_iterator< _Base_iterator, unordered_map >, __gnu_debug::_Safe_iterator< _Base_const_iterator, unordered_map >, __gnu_debug::_Safe_iterator< _Base_iterator, unordered_multimap >, __gnu_debug::_Safe_iterator< _Base_const_iterator, unordered_multimap >, __gnu_debug::_Safe_iterator< _Base_iterator, unordered_set >, __gnu_debug::_Safe_iterator< _Base_const_iterator, unordered_set >, __gnu_debug::_Safe_iterator< _Base_iterator, unordered_multiset >, __gnu_debug::_Safe_iterator< _Base_const_iterator, unordered_multiset >, __gnu_debug::_Safe_iterator< _Base_iterator, vector >, __gnu_debug::_Safe_iterator< _Base_const_iterator, vector >, , __gnu_debug::_Safe_iterator< _Iterator, _Sequence, std::random_access_iterator_tag >, and __gnu_debug::_Safe_iterator< _Iterator, _Sequence, _Category >.

  Public Member Functions
bool _M_attached_to (const _Safe_sequence_base *__seq) const
bool _M_can_compare (const _Safe_iterator_base &__x) const throw ()
void _M_detach_single () throw ()
void _M_invalidate ()
void _M_reset () throw ()
bool _M_singular () const throw ()
void _M_unlink () throw ()

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

  Protected Member Functions
constexpr _Safe_iterator_base ()
constexpr _Safe_iterator_base (const _Safe_iterator_base &__x, bool __constant)
constexpr _Safe_iterator_base (const _Safe_sequence_base *__seq, bool __constant)
void _M_attach (_Safe_sequence_base *__seq, bool __constant)
void _M_attach_single (_Safe_sequence_base *__seq, bool __constant) throw ()
void _M_detach ()
__gnu_cxx::__mutex & _M_get_mutex () throw ()

  Friends
class _Safe_sequence_base

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 () [inline], [constexpr], [protected]
Initializes the iterator and makes it singular.

References _M_next, _M_prior, _M_sequence, and _M_version.

Referenced by _Safe_iterator_base(), and _M_can_compare().

  __gnu_debug::_Safe_iterator_base::_Safe_iterator_base (const _Safe_sequence_base * __seq, bool __constant) [inline], [constexpr], [protected]
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(), _M_next, _M_prior, _M_sequence, and _M_version.

  __gnu_debug::_Safe_iterator_base::_Safe_iterator_base (const _Safe_iterator_base & __x, bool __constant) [inline], [constexpr], [protected]
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 _Safe_iterator_base(), _M_attach(), _M_next, _M_prior, _M_sequence, and _M_version.

Member Function Documentation

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

References _M_attach().

Referenced by _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach(), and _M_attach().

  void __gnu_debug::_Safe_iterator_base::_M_attach_single (_Safe_sequence_base * __seq, bool __constant) [protected]
Likewise, but not thread-safe.

References _M_attach_single().

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_attach_single(), and _M_attach_single().

  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.

References _M_attached_to(), and _M_sequence.

Referenced by _M_attached_to().

  bool __gnu_debug::_Safe_iterator_base::_M_can_compare (const _Safe_iterator_base & __x) const
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().

  void __gnu_debug::_Safe_iterator_base::_M_detach () [protected]
Detach the iterator for whatever sequence it is attached to, if any.

References _M_detach().

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), _M_detach(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), and __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_detach_single ()
Likewise, but not thread-safe.

References _M_detach_single().

Referenced by _M_detach_single().

  __gnu_cxx::__mutex & __gnu_debug::_Safe_iterator_base::_M_get_mutex () [protected]
For use in _Safe_iterator.

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator++(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator++(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_invalidate () [inline]
Invalidate the iterator, making it singular.

References _M_invalidate(), and _M_version.

Referenced by _M_invalidate().

  void __gnu_debug::_Safe_iterator_base::_M_reset ()
Reset all member variables

  bool __gnu_debug::_Safe_iterator_base::_M_singular () const
Is this iterator singular?

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::__check_singular_aux(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_dereferenceable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_M_dereferenceable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_M_incrementable(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_M_incrementable(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=().

  void __gnu_debug::_Safe_iterator_base::_M_unlink () [inline]
Unlink itself

References _M_next, _M_prior, and _M_unlink().

Referenced by _M_unlink().

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

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

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

Referenced by __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::_Safe_iterator(), _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::_Safe_local_iterator(), __gnu_debug::_Safe_local_iterator_base::_Safe_local_iterator_base(), _M_attached_to(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _Sequence >::operator=().

  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 _Safe_iterator_base(), _Safe_iterator_base(), _Safe_iterator_base(), _M_invalidate(), and __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

Author

Generated automatically by Doxygen for libstdc++ from the source code.