Qore Programming Language  0.9.3.1
ListIterator Class Reference

For use on the stack only: iterates through a the elements of a QoreListNode. More...

#include <QoreListNode.h>

Collaboration diagram for ListIterator:

Public Member Methods

DLLEXPORT ListIterator (QoreListNode *lst, size_t n_pos=-1)
 initializes the iterator to the position given or, if omitted, just before the first element More...
 
DLLEXPORT ListIterator (QoreListNode &lst, size_t n_pos=-1)
 initializes the iterator to the position given or, if omitted, just before the first element More...
 
DLLLOCAL bool empty () const
 returns true if the list is empty
 
DLLEXPORT bool first () const
 returns true when the iterator is pointing to the first element in the list
 
DLLLOCAL QoreListNodegetList ()
 returns the list
 
DLLEXPORT QoreValue getReferencedValue () const
 returns the referenced value of the list element More...
 
DLLEXPORT QoreValue getValue () const
 returns a pointer to the value of the list element More...
 
DLLLOCAL size_t index () const
 returns the current iterator position in the list or -1 if not pointing at a valid element
 
DLLEXPORT bool last () const
 returns true when the iterator is pointing to the last element in the list
 
DLLLOCAL size_t max () const
 returns the number of elements in the list
 
DLLEXPORT bool next ()
 moves the iterator to the next element, returns true if the iterator is pointing to an element of the list More...
 
DLLEXPORT bool prev ()
 moves the iterator to the previous element, returns true if the iterator is pointing to an element of the list More...
 
DLLEXPORT int set (size_t n_pos)
 sets the iterator to a specific position in the list More...
 
DLLLOCAL bool valid () const
 returns true if the iterator is pointing to a valid element
 

Private Member Methods

DLLLOCAL void * operator new (size_t)
 this function is not implemented; it is here as a private function in order to prohibit it from being used
 

Detailed Description

For use on the stack only: iterates through a the elements of a QoreListNode.

// iterate forward through the list
while (li.next()) {
QoreStringValueHelper str(li.getValue());
printf("%d: '%s'\n", li.index(), str->getBuffer());
}
// iterate backwards through the list
while (li.prev()) {
QoreStringValueHelper str(li.getValue());
printf("%d: '%s'\n", li.index(), str->getBuffer());
}
See also
ConstListIterator

Constructor & Destructor Documentation

◆ ListIterator() [1/2]

DLLEXPORT ListIterator::ListIterator ( QoreListNode lst,
size_t  n_pos = -1 
)

initializes the iterator to the position given or, if omitted, just before the first element

Parameters
lstthe list to iterate
n_posthe starting position (-1 means just before the first element so that the initial call to next() or prev() will put the iterator on the first element)

◆ ListIterator() [2/2]

DLLEXPORT ListIterator::ListIterator ( QoreListNode lst,
size_t  n_pos = -1 
)

initializes the iterator to the position given or, if omitted, just before the first element

Parameters
lstthe list to iterate
n_posthe starting position (-1 means just before the first element so that the initial call to next() or prev() will put the iterator on the first element)

Member Function Documentation

◆ getReferencedValue()

DLLEXPORT QoreValue ListIterator::getReferencedValue ( ) const

returns the referenced value of the list element

Since
Qore 0.9

◆ getValue()

DLLEXPORT QoreValue ListIterator::getValue ( ) const

returns a pointer to the value of the list element

Deprecated:
do not use; use get() instead

◆ next()

DLLEXPORT bool ListIterator::next ( )

moves the iterator to the next element, returns true if the iterator is pointing to an element of the list

if the iterator is on the last element, it moves to an invalid position before the first element and returns false note that a subsequent call to next() after it returns false will move the iterator to the first element again (assuming there is at least one element in the list)

Returns
returns true if the iterator has been moved to point to a valid element of the list, false if there are no more elements to iterate

◆ prev()

DLLEXPORT bool ListIterator::prev ( )

moves the iterator to the previous element, returns true if the iterator is pointing to an element of the list

if the iterator is on the first element, it moves to an invalid position before the first element and returns false note that a subsequent call to prev() after it returns false will move the iterator to the last element again (assuming there is at least one element in the list)

Returns
returns true if the iterator has been moved to point to a valid element of the list, false if there are no more elements to iterate
Note
after this function returns false, do not use the iterator until it points to a valid element, otherwise a crash will result

◆ set()

DLLEXPORT int ListIterator::set ( size_t  n_pos)

sets the iterator to a specific position in the list

In the case an invalid position is given (element not present in the list), the iterator will not be pointing to a valid element in the list

Parameters
n_posthe position in the list to set (first element is position 0)
Returns
0 for OK, -1 for invalid position
Note
if this function returns -1, do not use the iterator until it points to a valid element, otherwise a crash will result

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