Safe_iterator_base Class Reference

#include <safe_base.h>

Inheritance diagram for Safe_iterator_base:

Inheritance graph
Collaboration diagram for Safe_iterator_base:

Collaboration graph
List of all members.

Detailed Description

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.

Definition at line 50 of file safe_base.h.

Public Member Functions

Public Attributes

Protected Member Functions


Constructor & Destructor Documentation

Safe_iterator_base  )  [inline, protected]
 

Initializes the iterator and makes it singular.

Definition at line 76 of file safe_base.h.

Safe_iterator_base const Safe_sequence_base seq,
bool  constant
[inline, protected]
 

Initialize the iterator to reference the sequence pointed to by . 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.

Definition at line 87 of file safe_base.h.

Safe_iterator_base const Safe_iterator_base x,
bool  constant
[inline, 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.

Definition at line 94 of file safe_base.h.


Member Function Documentation

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. If the new sequence is the NULL pointer, the iterator is left unattached.

bool M_attached_to const Safe_sequence_base seq  )  const [inline]
 

Determines if we are attached to the given sequence.

Definition at line 120 of file safe_base.h.

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

void M_detach  ) 
 

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

bool M_singular  )  const
 

Is this iterator singular?


Member Data Documentation

Safe_iterator_base* M_next
 

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

Definition at line 72 of file safe_base.h.

Safe_iterator_base* M_prior
 

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

Definition at line 68 of file safe_base.h.

Safe_sequence_base* M_sequence
 

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

Definition at line 55 of file safe_base.h.

unsigned int 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.

Definition at line 64 of file safe_base.h.


The documentation for this class was generated from the following file:
Generated on Sun Jul 25 00:12:39 2004 for libstdc++ source by doxygen 1.3.7