QPatternist::DocumentProjector Class Reference

#include <qdocumentprojector_p.h>

Inheritance diagram for QPatternist::DocumentProjector:

Public Functions
virtual void	attribute (const QXmlName name, const QString &value)
	Signals the presence of an attribute node. More...
virtual void	characters (const QString &value)
virtual void	comment (const QString &value)
	DocumentProjector (const ProjectedExpression::Vector &paths, QAbstractXmlReceiver *const receiver)
virtual void	endDocument ()
virtual void	endElement ()
	Signals the end of the current element. More...
virtual void	item (const Item &item)
	Sends an Item to this QAbstractXmlReceiver that may be a QXmlNodeModelIndex or an AtomicValue. More...
virtual void	namespaceBinding (const QXmlName nb)
virtual void	processingInstruction (const QXmlName name, const QString &value)
virtual void	startDocument ()
virtual void	startElement (const QXmlName name)
	Signals the start of an element by name name. More...
Public Functions inherited from QPatternist::QAbstractXmlReceiver
virtual void	namespaceBinding (const QXmlName &nb)=0
	Signals the presence of the namespace declaration nb. More...
	QAbstractXmlReceiver ()
virtual void	whitespaceOnly (const QStringRef &value)
virtual	~QAbstractXmlReceiver ()
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...

Public Variables
ProjectedExpression::Action	m_action
int	m_nodesInProcess
const int	m_pathCount
ProjectedExpression::Vector	m_paths
QAbstractXmlReceiver *const	m_receiver
Public Variables inherited from QSharedData
QAtomicInt	ref

Additional Inherited Members
Public Types inherited from QPatternist::QAbstractXmlReceiver
typedef QExplicitlySharedDataPointer< QAbstractXmlReceiver >	Ptr
Protected Functions inherited from QPatternist::QAbstractXmlReceiver
void	sendAsNode (const Item &outputItem)

Detailed Description

Author

Frans Englich frans.nosp@m..eng.nosp@m.lich@.nosp@m.noki.nosp@m.a.com

Definition at line 69 of file qdocumentprojector_p.h.

Constructors and Destructors

DocumentProjector()

DocumentProjector::DocumentProjector	(	const ProjectedExpression::Vector &	paths,
		QAbstractXmlReceiver *const	receiver
	)

Definition at line 48 of file qdocumentprojector.cpp.

                                                                           : m_paths(paths)
                                                                           , m_pathCount(paths.count())
                                                                           , m_action(ProjectedExpression::Move)
                                                                           , m_nodesInProcess(0)
                                                                           , m_receiver(receiver)
{
    Q_ASSERT_X(paths.count() > 0, Q_FUNC_INFO,
               "Using DocumentProjector with no paths is an "
               "overhead and has also undefined behavior.");
    Q_ASSERT(m_receiver);
}

Functions

attribute()

void DocumentProjector::attribute ( const QXmlName  name, const QString &  value  )

virtual

Signals the presence of an attribute node.

This function is guaranteed by the caller to always be called after a call to startElement() or attribute().

Parameters

name	the name of the attribute. Guaranteed to always be non-null.
value	the value of the attribute. Guaranteed to always be non-null.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 168 of file qdocumentprojector.cpp.

{
    Q_UNUSED(name);
    Q_UNUSED(value);
}

characters()

void DocumentProjector::characters ( const QString &  value )

virtual

Sends a text node with value value. Adjascent text nodes may be sent. There's no restrictions on value, beyond that it must be valid XML characters. For instance, value may contain only whitespace.

See also

whitespaceOnly()

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 187 of file qdocumentprojector.cpp.

{
    Q_UNUSED(value);
}

comment()

void DocumentProjector::comment ( const QString &  value )

virtual

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 180 of file qdocumentprojector.cpp.

{
    Q_ASSERT_X(!value.contains(QLatin1String("--")), Q_FUNC_INFO,
               "Invalid input; it's the caller's responsibility to ensure the input is correct.");
    Q_UNUSED(value);
}

endDocument()

void DocumentProjector::endDocument ( )

virtual

End of a document node.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 210 of file qdocumentprojector.cpp.

{
}

endElement()

void DocumentProjector::endElement ( )

virtual

Signals the end of the current element.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 125 of file qdocumentprojector.cpp.

{
    if(m_action == ProjectedExpression::Keep)
    {
        Q_ASSERT(m_nodesInProcess == 1);

        m_receiver->endElement();

        /* We have now kept the single node, and now wants to skip
         * all its children. */
        m_action = ProjectedExpression::Skip;
        m_nodesInProcess = 0;
    }
    else if(m_action == ProjectedExpression::KeepSubtree)
    {
        m_receiver->endElement();
        --m_nodesInProcess;

        if(m_nodesInProcess == 0)
        {
            /* We have now skipped all the children, let's do
             * a new path analysis. */
            m_action = ProjectedExpression::Move;
        }
    }
    else
    {
        Q_ASSERT_X(m_action == ProjectedExpression::Skip, Q_FUNC_INFO,
                   "We're not supposed to be in a Move action here.");
        /* We skip calling m_receiver's endElement() here since we're
         * skipping. */
        Q_ASSERT(m_nodesInProcess > 0);
        --m_nodesInProcess;

        if(m_nodesInProcess == 0)
        {
            /* Ok, we've skipped them all, let's do something
             * new -- let's Move on to the next path! */
            m_action = ProjectedExpression::Move;
        }
    }
}

item()

void DocumentProjector::item ( const Item &  item )

virtual

Sends an Item to this QAbstractXmlReceiver that may be a QXmlNodeModelIndex or an AtomicValue.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 201 of file qdocumentprojector.cpp.

{
    Q_UNUSED(outputItem);
}

namespaceBinding()

void DocumentProjector::namespaceBinding ( const QXmlName  nb )

virtual

Definition at line 175 of file qdocumentprojector.cpp.

{
    Q_UNUSED(nb);
}

processingInstruction()

void DocumentProjector::processingInstruction ( const QXmlName  name, const QString &  value  )

virtual

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 192 of file qdocumentprojector.cpp.

{
    Q_ASSERT_X(!value.contains(QLatin1String("?>")), Q_FUNC_INFO,
               "Invalid input; it's the caller's responsibility to ensure the input is correct.");
    Q_UNUSED(name);
    Q_UNUSED(value);
}

startDocument()

void DocumentProjector::startDocument ( )

virtual

Start of a document node.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 206 of file qdocumentprojector.cpp.

{
}

startElement()

void DocumentProjector::startElement ( const QXmlName  name )

virtual

Signals the start of an element by name name.

Implements QPatternist::QAbstractXmlReceiver.

Definition at line 61 of file qdocumentprojector.cpp.

{
    Q_UNUSED(name);

    switch(m_action)
    {
        case ProjectedExpression::KeepSubtree:
        {
            m_receiver->startElement(name);
            /* Fallthrough. */
        }
        case ProjectedExpression::Skip:
        {
            ++m_nodesInProcess;
            return;
        }
        default:
        {
            Q_ASSERT_X(m_action == ProjectedExpression::Move, Q_FUNC_INFO,
                       "We're not supposed to receive Keep here, because "
                       "endElement() should always end that state.");

            for(int i = 0; i < m_pathCount; ++i)
            {
                m_action = m_paths.at(i)->actionForElement(name, m_paths[i]);

                switch(m_action)
                {
                    case ProjectedExpression::Keep:
                    {
                        m_action = ProjectedExpression::Keep;
                        continue;
                    }
                    case ProjectedExpression::KeepSubtree:
                    {
                        /* Ok, at least one path wanted this node. Pass it on,
                         * and exit. */
                        m_receiver->startElement(name);
                        ++m_nodesInProcess;
                        return;
                    }
                    case ProjectedExpression::Skip:
                    {
                        /* This particular path doesn't need it, but
                         * some other path might, so continue looping. */
                        continue;
                    }
                    case ProjectedExpression::Move:
                        Q_ASSERT_X(false, Q_FUNC_INFO, "The action functions can never return Move.");
                }
            }

            ++m_nodesInProcess;

            if(m_action == ProjectedExpression::Keep)
                m_receiver->startElement(name);
            else
            {
                Q_ASSERT(m_action == ProjectedExpression::Skip);
            }
        }
    }
}

Properties

m_action

ProjectedExpression::Action QPatternist::DocumentProjector::m_action

Definition at line 97 of file qdocumentprojector_p.h.

Referenced by endElement(), and startElement().

m_nodesInProcess

int QPatternist::DocumentProjector::m_nodesInProcess

Definition at line 98 of file qdocumentprojector_p.h.

Referenced by endElement(), and startElement().

m_pathCount

const int QPatternist::DocumentProjector::m_pathCount

Definition at line 96 of file qdocumentprojector_p.h.

Referenced by startElement().

m_paths

ProjectedExpression::Vector QPatternist::DocumentProjector::m_paths

Definition at line 95 of file qdocumentprojector_p.h.

Referenced by startElement().

m_receiver

QAbstractXmlReceiver* const QPatternist::DocumentProjector::m_receiver

Definition at line 99 of file qdocumentprojector_p.h.

Referenced by DocumentProjector(), endElement(), and startElement().

---

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

• /src/xmlpatterns/projection/qdocumentprojector_p.h
• /src/xmlpatterns/projection/qdocumentprojector.cpp