/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $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_DelegatingDynamicContext_H
#define Patternist_DelegatingDynamicContext_H

#include <private/qdynamiccontext_p.h>
#include <private/qexpression_p.h>

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    /**
     * @short Base class for dynamic contexts that are
     * created from an existing one.
     *
     * In some cases multiple DynamicContext instances must be used in
     * order to maintain somekind of scope. This class delegates
     * the DynamicContext interface onto another DynamicContext instance,
     * allowing the sub-class to only implement what it needs to.
     *
     * @author Frans Englich <frans.englich@nokia.com>
     */
    class DelegatingDynamicContext : public DynamicContext
    {
    public:
        xsInteger contextPosition() const override;
        Item contextItem() const override;
        xsInteger contextSize() override;

        ItemCacheCell &itemCacheCell(const VariableSlotID slot) override;
        ItemSequenceCacheCell::Vector &itemSequenceCacheCells(const VariableSlotID slot) override;

        void setRangeVariable(const VariableSlotID slotNumber,
                              const Item &newValue) override;
        Item rangeVariable(const VariableSlotID slotNumber) const override;

        void setExpressionVariable(const VariableSlotID slotNumber,
                                   const Expression::Ptr &newValue) override;
        Expression::Ptr expressionVariable(const VariableSlotID slotNumber) const override;

        void setFocusIterator(const Item::Iterator::Ptr &it) override;
        Item::Iterator::Ptr focusIterator() const override;

        Item::Iterator::Ptr positionIterator(const VariableSlotID slot) const override;
        void setPositionIterator(const VariableSlotID slot,
                                 const Item::Iterator::Ptr &newValue) override;

        QAbstractMessageHandler * messageHandler() const override;
        QExplicitlySharedDataPointer<DayTimeDuration> implicitTimezone() const override;
        QDateTime currentDateTime() const override;
        QAbstractXmlReceiver *outputReceiver() const override;
        NodeBuilder::Ptr nodeBuilder(const QUrl &baseURI) const override;
        ResourceLoader::Ptr resourceLoader() const override;
        ExternalVariableLoader::Ptr externalVariableLoader() const override;
        NamePool::Ptr namePool() const override;
        QSourceLocation locationFor(const SourceLocationReflection *const reflection) const override;
        void addNodeModel(const QAbstractXmlNodeModel::Ptr &nm) override;
        const QAbstractUriResolver *uriResolver() const override;
        ItemCacheCell &globalItemCacheCell(const VariableSlotID slot) override;
        ItemSequenceCacheCell::Vector &globalItemSequenceCacheCells(const VariableSlotID slot) override;
        Item currentItem() const override;
        TemplateParameterHash &templateParameterStore() override;

        DynamicContext::Ptr previousContext() const override;
        QExplicitlySharedDataPointer<TemplateMode> currentTemplateMode() const override;

    protected:
        DelegatingDynamicContext(const DynamicContext::Ptr &prevContext);

        const DynamicContext::Ptr m_prevContext;
    };
}

QT_END_NAMESPACE

#endif