/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QABSTRACTXMLRECEIVER_H

#define QABSTRACTXMLRECEIVER_H

#include <QtCore/QVariant>

#include <QtCore/QScopedPointer>

#include <QtXmlPatterns/QXmlNodeModelIndex>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(XmlPatterns)

class QAbstractXmlReceiverPrivate;

class QXmlName;

namespace QPatternist

{

    class Item;

}

class Q_XMLPATTERNS_EXPORT QAbstractXmlReceiver

{

public:

    QAbstractXmlReceiver();

    virtual ~QAbstractXmlReceiver();

    virtual void startElement(const QXmlName &name) = 0;

    virtual void endElement() = 0;

    virtual void attribute(const QXmlName &name,

                           const QStringRef &value) = 0;

    virtual void comment(const QString &value) = 0;

    virtual void characters(const QStringRef &value) = 0;

    virtual void startDocument() = 0;

    virtual void endDocument() = 0;

    virtual void processingInstruction(const QXmlName &target,

                                       const QString &value) = 0;

    virtual void atomicValue(const QVariant &value) = 0;

    virtual void namespaceBinding(const QXmlName &name) = 0;

    virtual void startOfSequence() = 0;

    virtual void endOfSequence() = 0;

    /* The members below are internal, not part of the public API, and

     * unsupported. Using them leads to undefined behavior. */

    virtual void whitespaceOnly(const QStringRef &value);

    virtual void item(const QPatternist::Item &item);

protected:

    QAbstractXmlReceiver(QAbstractXmlReceiverPrivate *d);

    QScopedPointer<QAbstractXmlReceiverPrivate> d_ptr;

    void sendAsNode(const QPatternist::Item &outputItem);

private:

    template<const QXmlNodeModelIndex::Axis axis>

    void sendFromAxis(const QXmlNodeModelIndex &node);

    Q_DISABLE_COPY(QAbstractXmlReceiver)

};

QT_END_NAMESPACE

QT_END_HEADER

#endif