QPatternist::SiblingIterator< IsFollowing > Class Template Reference

Iterates along the sibling axes in an AccelTree. More...

#include <qacceliterators_p.h>

Inheritance diagram for QPatternist::SiblingIterator< IsFollowing >:

Public Functions
virtual QXmlNodeModelIndex::Iterator::Ptr	copy () const
	Copies this QAbstractXmlForwardIterator and returns the copy. More...
virtual QXmlNodeModelIndex	next ()
	Returns the next item in the sequence, or a null object if the end has been reached. More...
	SiblingIterator (const AccelTree *const doc, const AccelTree::PreNumber pre)
Public Functions inherited from QPatternist::AccelIterator
virtual QXmlNodeModelIndex	current () const
	Returns the current item in the sequence. More...
virtual xsInteger	position () const
	Returns the current position in the sequence represented by this. More...
Public Functions inherited from QAbstractXmlForwardIterator< T >
virtual qint64	count ()
	Determines the number of items this QAbstractXmlForwardIterator represents. More...
virtual bool	isEmpty ()
	Returns true if the sequence is empty. More...
virtual T	last ()
	Returns the item at the end of this QAbstractXmlForwardIterator. More...
	QAbstractXmlForwardIterator ()
	Default constructor. More...
virtual qint64	sizeHint () const
	Gives a hint to the size of the contained sequence. More...
virtual QList< T >	toList ()
	Performs a copy of this QAbstractXmlForwardIterator(with copy()), and returns its items in a QList. More...
virtual QAbstractXmlForwardIterator< T >::Ptr	toReversed ()
	Returns a reverse iterator for the sequence. More...
virtual	~QAbstractXmlForwardIterator ()
	Destructor. More...
Public Functions inherited from QSharedData
	QSharedData ()
	Constructs a QSharedData object with a reference count of 0. More...
	QSharedData (const QSharedData &)
	Constructs a QSharedData object with reference count 0. More...

Properties
const AccelTree::Depth	m_depth

Additional Inherited Members
Public Types inherited from QAbstractXmlForwardIterator< T >
typedef QList< QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< T > > >	List
	A QList containing QAbstractXmlForwardIterator::Ptr instances. More...
typedef QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< T > >	Ptr
	A smart pointer wrapping an instance of a QAbstractXmlForwardIterator subclass. More...
typedef QVector< QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< T > > >	Vector
	A QVector containing QAbstractXmlForwardIterator::Ptr instances. More...
Public Variables inherited from QSharedData
QAtomicInt	ref
Protected Functions inherited from QPatternist::AccelIterator
	AccelIterator (const AccelTree *const doc, const AccelTree::PreNumber pre, const AccelTree::PreNumber currentPre)
QXmlNodeModelIndex	closedExit ()
Protected Variables inherited from QPatternist::AccelIterator
QXmlNodeModelIndex	m_current
AccelTree::PreNumber	m_currentPre
const AccelTree *const	m_document
xsInteger	m_position
const AccelTree::PreNumber	m_preNumber
Related Functions inherited from QAbstractXmlForwardIterator< T >
template<typename TResult , typename TSource , typename TMapper >
static QAbstractXmlForwardIterator< TResult >::Ptr	makeSequenceMappingIterator (const TMapper &mapper, const QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< TSource > > &source, const DynamicContext::Ptr &context)
	An object generator for SequenceMappingIterator. More...
bool	qIsForwardIteratorEnd (const T &unit)
	The Callback QAbstractXmlForwardIterator uses for determining whether unit is the end of a sequence. More...

Detailed Description

template<const bool IsFollowing>
class QPatternist::SiblingIterator< IsFollowing >

Iterates along the sibling axes in an AccelTree.

Author

Frans Englichfrans.nosp@m..eng.nosp@m.lich@.nosp@m.noki.nosp@m.a.com

Definition at line 196 of file qacceliterators_p.h.

Constructors and Destructors

SiblingIterator()

template<const bool IsFollowing>

QPatternist::SiblingIterator< IsFollowing >::SiblingIterator ( const AccelTree *const  doc, const AccelTree::PreNumber  pre  )

inline

Definition at line 199 of file qacceliterators_p.h.

                                                             : AccelIterator(doc, pre, pre + (IsFollowing ? 0 : -1)),
                                                                 m_depth(doc->depth(pre))
        {
            Q_ASSERT_X(IsFollowing || pre != 0, "",
                       "When being preceding-sibling, the context node cannot be the first node in the document.");
            Q_ASSERT_X(!IsFollowing || pre != m_document->maximumPreNumber(), "",
                       "When being following-sibling, the context node cannot be the last node in the document.");
        }

Functions

copy()

template<const bool IsFollowing>

virtual QXmlNodeModelIndex::Iterator::Ptr QPatternist::SiblingIterator< IsFollowing >::copy ( ) const

inlinevirtual

Copies this QAbstractXmlForwardIterator and returns the copy.

Warning

This function is not part of the public interface.

A copy and the original instance are completely independent of each other. Because evaluating an QAbstractXmlForwardIterator modifies it, one should always use a copy when an QAbstractXmlForwardIterator needs to be used several times.

Reimplemented from QAbstractXmlForwardIterator< T >.

Definition at line 252 of file qacceliterators_p.h.

        {
            return QXmlNodeModelIndex::Iterator::Ptr(new SiblingIterator<IsFollowing>(m_document, m_preNumber));
        }

next()

template<const bool IsFollowing>

virtual QXmlNodeModelIndex QPatternist::SiblingIterator< IsFollowing >::next ( )

inlinevirtual

Returns the next item in the sequence, or a null object if the end has been reached.

Implements QAbstractXmlForwardIterator< T >.

Definition at line 209 of file qacceliterators_p.h.

        {
            if(m_currentPre == -1)
                return QXmlNodeModelIndex();

            if(IsFollowing)
            {
                /* Skip the descendants, and jump to the next node. */
                m_currentPre += m_document->size(m_currentPre) + 1;

                if(m_currentPre > m_document->maximumPreNumber() || m_document->depth(m_currentPre) != m_depth)
                    return closedExit();
                else
                {
                    ++m_position;
                    m_current = m_document->createIndex(m_currentPre);
                    return m_current;
                }
            }
            else
            {
                while(m_document->depth(m_currentPre) > m_depth)
                    --m_currentPre;

                while(m_document->kind(m_currentPre) == QXmlNodeModelIndex::Attribute)
                    --m_currentPre;

                if(m_document->depth(m_currentPre) == m_depth &&
                   m_document->kind(m_currentPre) != QXmlNodeModelIndex::Attribute)
                {
                    m_current = m_document->createIndex(m_currentPre);
                    ++m_position;
                    --m_currentPre;
                    return m_current;
                }
                else
                {
                    m_currentPre = -1;
                    return closedExit();
                }
            }
        }

Properties

m_depth

template<const bool IsFollowing>

const AccelTree::Depth QPatternist::SiblingIterator< IsFollowing >::m_depth

private

Definition at line 258 of file qacceliterators_p.h.

---

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

• /src/xmlpatterns/acceltree/qacceliterators_p.h