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

**

** 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$

**

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

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_AccelTreeBuilder_H

#define Patternist_AccelTreeBuilder_H

#include <QSet>

#include <QStack>

#include "private/qxmlutils_p.h"

#include "qacceltree_p.h"

#include "qbuiltintypes_p.h"

#include "qcompressedwhitespace_p.h"

#include "qnamepool_p.h"

#include "qnodebuilder_p.h"

#include "qreportcontext_p.h"

#include "qsourcelocationreflection_p.h"

#include "qpatternistlocale_p.h"

#include <QtDebug>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short Builds an AccelTree from a stream of XML/Item events

     * received through the NodeBuilder interface.

     *

     * If FromDocument is @c true, it is assumed that AccelTreeBuilder is fed

     * events from an XML document, otherwise it is assumed the events

     * are from node constructor expressions.

     *

     * @author Frans Englich <frans.englich@nokia.com>

     */

    template<bool FromDocument>

    class AccelTreeBuilder : public NodeBuilder

                           , public SourceLocationReflection

    {

    public:

        typedef QExplicitlySharedDataPointer<AccelTreeBuilder> Ptr;

        /**

         * Describes the memory relevant features the builder shall support.

         */

        enum Feature

        {

            NoneFeature,                ///< No special features are enabled.

            SourceLocationsFeature = 1  ///< The accel tree builder will store source locations for each start element.

        };

        Q_DECLARE_FLAGS(Features, Feature)

        /**

         * @param context may be @c null.

         */

        AccelTreeBuilder(const QUrl &docURI,

                         const QUrl &baseURI,

                         const NamePool::Ptr &np,

                         ReportContext *const context,

                         Features features = NoneFeature);

        virtual void startDocument();

        virtual void endDocument();

        virtual void startElement(const QXmlName &name);

        void startElement(const QXmlName &name, qint64 line, qint64 column);

        virtual void endElement();

        virtual void attribute(const QXmlName &name, const QStringRef &value);

        virtual void characters(const QStringRef &ch);

        virtual void whitespaceOnly(const QStringRef &ch);

        virtual void processingInstruction(const QXmlName &target,

                                           const QString &data);

        virtual void namespaceBinding(const QXmlName &nb);

        virtual void comment(const QString &content);

        virtual void item(const Item &it);

        virtual QAbstractXmlNodeModel::Ptr builtDocument();

        virtual NodeBuilder::Ptr create(const QUrl &baseURI) const;

        virtual void startOfSequence();

        virtual void endOfSequence();

        inline AccelTree::Ptr builtDocument() const

        {

            return m_document;

        }

        virtual void atomicValue(const QVariant &value);

        virtual const SourceLocationReflection *actualReflection() const;

        virtual QSourceLocation sourceLocation() const;

    private:

        inline void startStructure();

        inline AccelTree::PreNumber currentDepth() const

        {

            return m_ancestors.count() -1;

        }

        inline AccelTree::PreNumber currentParent() const

        {

            return m_ancestors.isEmpty() ? -1 : m_ancestors.top();

        }

        enum Constants

        {

            DefaultNodeStackSize = 10,

            SizeIsEmpty = 0

        };

        AccelTree::PreNumber            m_preNumber;

        bool                            m_isPreviousAtomic;

        bool                            m_hasCharacters;

        /**

         * Whether m_characters has been run through

         * CompressedWhitespace::compress().

         */

        bool                            m_isCharactersCompressed;

        QString                         m_characters;

        NamePool::Ptr                   m_namePool;

        AccelTree::Ptr                  m_document;

        QStack<AccelTree::PreNumber>    m_ancestors;

        QStack<AccelTree::PreNumber>    m_size;

        /** If we have already commenced a document, we don't want to

         * add more document nodes. We keep track of them with this

         * counter, which ensures that startDocument() and endDocument()

         * are skipped consistently. */

        AccelTree::PreNumber            m_skippedDocumentNodes;

        /**

         * All attribute values goes through this set such that we store only

         * one QString for identical attribute values.

         */

        QSet<QString>                   m_attributeCompress;

        const QUrl                      m_documentURI;

        /**

         * We don't store a reference pointer here because then we get a

         * circular reference with GenericDynamicContext, when it stores us as

         * a member.

         */

        ReportContext *const            m_context;

        Features                        m_features;

    };

    Q_DECLARE_OPERATORS_FOR_FLAGS(AccelTreeBuilder<true>::Features)

    Q_DECLARE_OPERATORS_FOR_FLAGS(AccelTreeBuilder<false>::Features)

#include "qacceltreebuilder.cpp"

}

QT_END_NAMESPACE

QT_END_HEADER

#endif