Implements a common base class for iterators for a double linked list ADT. More...

#include <Containers_T.h>

Inheritance diagram for ACE_Double_Linked_List_Iterator_Base< T >:

Collaboration diagram for ACE_Double_Linked_List_Iterator_Base< T >:

Public Member Functions
int	next (T *&) const
T *	next (void) const
int	done (void) const
	Returns 1 when all items have been seen, else 0.
T &	operator* (void) const
void	reset (ACE_Double_Linked_List< T > &)
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Protected Member Functions
	ACE_Double_Linked_List_Iterator_Base (const ACE_Double_Linked_List< T > &)
	Constructor.
	ACE_Double_Linked_List_Iterator_Base (const ACE_Double_Linked_List_Iterator_Base< T > &iter)
	Copy constructor.
int	go_head (void)
int	go_tail (void)
T *	not_done (void) const
T *	do_advance (void)
T *	do_retreat (void)
void	dump_i (void) const
	Dump the state of an object.
Protected Attributes
T *	current_
	Remember where we are.
const ACE_Double_Linked_List< T > *	dllist_

Detailed Description

template<class T>
class ACE_Double_Linked_List_Iterator_Base< T >

Implements a common base class for iterators for a double linked list ADT.

Definition at line 556 of file Containers_T.h.

Constructor & Destructor Documentation

template<class T>

ACE_Double_Linked_List_Iterator_Base< T >::ACE_Double_Linked_List_Iterator_Base ( const ACE_Double_Linked_List< T > & dll ) [protected]

Constructor.

Definition at line 345 of file Containers_T.cpp.

  : current_ (0), dllist_ (&dll)
{
  // Do nothing
}

template<class T>

ACE_Double_Linked_List_Iterator_Base< T >::ACE_Double_Linked_List_Iterator_Base ( const ACE_Double_Linked_List_Iterator_Base< T > & iter ) [protected]

Copy constructor.

Definition at line 352 of file Containers_T.cpp.

  : current_ (iter.current_),
    dllist_ (iter.dllist_)
{
  // Do nothing
}

Member Function Documentation

template<class T >

T * ACE_Double_Linked_List_Iterator_Base< T >::do_advance ( void ) [protected]

Advance to the next element in the list. Return the address of the next element if there are more, 0 otherwise.

Definition at line 419 of file Containers_T.cpp.

{
  if (this->not_done ())
    {
      this->current_ = static_cast<T*> (this->current_->next_);
      return this->not_done ();
    }
  else
    return 0;
}

template<class T >

T * ACE_Double_Linked_List_Iterator_Base< T >::do_retreat ( void ) [protected]

Retreat to the previous element in the list. Return the address of the previous element if there are more, 0 otherwise.

Definition at line 431 of file Containers_T.cpp.

{
  if (this->not_done ())
    {
      this->current_ = static_cast<T*> (this->current_->prev_);
      return this->not_done ();
    }
  else
    return 0;
}

template<class T >

int ACE_Double_Linked_List_Iterator_Base< T >::done ( void ) const

Returns 1 when all items have been seen, else 0.

Definition at line 375 of file Containers_T.cpp.

{
  return this->not_done () ? 0 : 1;
}

template<class T >

void ACE_Double_Linked_List_Iterator_Base< T >::dump_i ( void ) const [protected]

Dump the state of an object.

Definition at line 443 of file Containers_T.cpp.

{
  ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
  ACE_DEBUG ((LM_DEBUG,  ACE_TEXT ("current_ = %x"), this->current_));
  ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
}

template<class T >

int ACE_Double_Linked_List_Iterator_Base< T >::go_head ( void ) [protected]

Move to the first element of the list. Returns 0 if the list is empty, else 1.

Note:: the head of the ACE_DLList is actually a null entry, so the first element is actually the 2n'd entry

Definition at line 396 of file Containers_T.cpp.

{
  this->current_ = static_cast<T*> (dllist_->head_->next_);
  return this->current_ ? 1 : 0;
}

template<class T >

int ACE_Double_Linked_List_Iterator_Base< T >::go_tail ( void ) [protected]

Move to the last element of the list. Returns 0 if the list is empty, else 1.

Definition at line 403 of file Containers_T.cpp.

{
  this->current_ = static_cast<T*> (dllist_->head_->prev_);
  return this->current_ ? 1 : 0;
}

template<class T>

T * ACE_Double_Linked_List_Iterator_Base< T >::next ( void ) const

Deprecated:: Return the address of next (current) unvisited item in the list. 0 if there is no more element available.

Reimplemented in ACE_DLList_Iterator< T >, and ACE_DLList_Reverse_Iterator< T >.

Definition at line 361 of file Containers_T.cpp.

{
  return this->not_done ();
}

template<class T>

int ACE_Double_Linked_List_Iterator_Base< T >::next ( T *& ptr ) const

Passes back the {entry} under the iterator. Returns 0 if the iteration has completed, otherwise 1

Definition at line 367 of file Containers_T.cpp.

{
  ptr = this->not_done ();
  return ptr ? 1 : 0;
}

template<class T >

T * ACE_Double_Linked_List_Iterator_Base< T >::not_done ( void ) const [protected]

Check if we reach the end of the list. Can also be used to get the *current* element in the list. Return the address of the current item if there are still elements left , 0 if we run out of element.

Definition at line 410 of file Containers_T.cpp.

{
  if (this->current_ != this->dllist_->head_)
    return this->current_;
  else
    return 0;
}

template<class T >

T & ACE_Double_Linked_List_Iterator_Base< T >::operator* ( void ) const

STL-like iterator dereference operator: returns a reference to the node underneath the iterator.

Definition at line 381 of file Containers_T.cpp.

{
  return *(this->not_done ());
}

template<class T>

void ACE_Double_Linked_List_Iterator_Base< T >::reset ( ACE_Double_Linked_List< T > & dll )

Retasks the iterator to iterate over a new Double_Linked_List. This allows clients to reuse an iterator without incurring the constructor overhead. If you do use this, be aware that if there are more than one reference to this iterator, the other "clients" may be very bothered when their iterator changes. @ Here be dragons. Comments?

Reimplemented in ACE_Double_Linked_List_Iterator< T >, ACE_Double_Linked_List_Reverse_Iterator< T >, ACE_Double_Linked_List_Iterator< ACE_DLList_Node >, and ACE_Double_Linked_List_Reverse_Iterator< ACE_DLList_Node >.

Definition at line 389 of file Containers_T.cpp.