src/xmlpatterns/environment/qdelegatingdynamiccontext_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_DelegatingDynamicContext_H
  53 #define Patternist_DelegatingDynamicContext_H
  54
  55 #include <private/qdynamiccontext_p.h>
  56 #include <private/qexpression_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Base class for dynamic contexts that are
  66      * created from an existing one.
  67      *
  68      * In some cases multiple DynamicContext instances must be used in
  69      * order to maintain somekind of scope. This class delegates
  70      * the DynamicContext interface onto another DynamicContext instance,
  71      * allowing the sub-class to only implement what it needs to.
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      */
  75     class DelegatingDynamicContext : public DynamicContext
  76     {
  77     public:
  78         virtual xsInteger contextPosition() const;
  79         virtual Item contextItem() const;
  80         virtual xsInteger contextSize();
  81
  82         virtual ItemCacheCell &itemCacheCell(const VariableSlotID slot);
  83         virtual ItemSequenceCacheCell::Vector &itemSequenceCacheCells(const VariableSlotID slot);
  84
  85         virtual void setRangeVariable(const VariableSlotID slotNumber,
  86                                       const Item &newValue);
  87         virtual Item rangeVariable(const VariableSlotID slotNumber) const;
  88
  89         virtual void setExpressionVariable(const VariableSlotID slotNumber,
  90                                            const Expression::Ptr &newValue);
  91         virtual Expression::Ptr expressionVariable(const VariableSlotID slotNumber) const;
  92
  93         virtual void setFocusIterator(const Item::Iterator::Ptr &it);
  94         virtual Item::Iterator::Ptr focusIterator() const;
  95
  96         virtual Item::Iterator::Ptr positionIterator(const VariableSlotID slot) const;
  97         virtual void setPositionIterator(const VariableSlotID slot,
  98                                          const Item::Iterator::Ptr &newValue);
  99
 100         virtual QAbstractMessageHandler * messageHandler() const;
 101         virtual QExplicitlySharedDataPointer<DayTimeDuration> implicitTimezone() const;
 102         virtual QDateTime currentDateTime() const;
 103         virtual QAbstractXmlReceiver *outputReceiver() const;
 104         virtual NodeBuilder::Ptr nodeBuilder(const QUrl &baseURI) const;
 105         virtual ResourceLoader::Ptr resourceLoader() const;
 106         virtual ExternalVariableLoader::Ptr externalVariableLoader() const;
 107         virtual NamePool::Ptr namePool() const;
 108         virtual QSourceLocation locationFor(const SourceLocationReflection *const reflection) const;
 109         virtual void addNodeModel(const QAbstractXmlNodeModel::Ptr &nm);
 110         virtual const QAbstractUriResolver *uriResolver() const;
 111         virtual ItemCacheCell &globalItemCacheCell(const VariableSlotID slot);
 112         virtual ItemSequenceCacheCell::Vector &globalItemSequenceCacheCells(const VariableSlotID slot);
 113         virtual Item currentItem() const;
 114         virtual TemplateParameterHash &templateParameterStore();
 115
 116         virtual DynamicContext::Ptr previousContext() const;
 117         virtual QExplicitlySharedDataPointer<TemplateMode> currentTemplateMode() const;
 118
 119     protected:
 120         DelegatingDynamicContext(const DynamicContext::Ptr &prevContext);
 121
 122         const DynamicContext::Ptr m_prevContext;
 123     };
 124 }
 125
 126 QT_END_NAMESPACE
 127
 128 QT_END_HEADER
 129
 130 #endif