src/xmlpatterns/environment/qstackcontextbase_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_StackContextBase_H
  53 #define Patternist_StackContextBase_H
  54
  55 #include <QVector>
  56
  57 #include <private/qdaytimeduration_p.h>
  58 #include <private/qdelegatingdynamiccontext_p.h>
  59 #include <private/qexpression_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 namespace QPatternist
  66 {
  67     /**
  68      * @short Base class for all DynamicContext classes that needs to supply
  69      * variables. It has a new frame for local caches, position iterators,
  70      * expressions, range variables, template parameters but notably continues
  71      * to delegate global caches.
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      */
  75     template<typename TSuperClass>
  76     class StackContextBase : public TSuperClass
  77     {
  78     public:
  79         StackContextBase();
  80         /**
  81          * Construct a StackContextBase and passes @p prevContext to its super class. This
  82          * constructor is typically used when the super class is DelegatingDynamicContext.
  83          */
  84         StackContextBase(const DynamicContext::Ptr &prevContext);
  85
  86         virtual void setRangeVariable(const VariableSlotID slotNumber,
  87                                       const Item &newValue);
  88         virtual Item rangeVariable(const VariableSlotID slotNumber) const;
  89
  90         virtual void setExpressionVariable(const VariableSlotID slotNumber,
  91                                            const Expression::Ptr &newValue);
  92         virtual Expression::Ptr expressionVariable(const VariableSlotID slotNumber) const;
  93
  94         virtual Item::Iterator::Ptr positionIterator(const VariableSlotID slot) const;
  95         virtual void setPositionIterator(const VariableSlotID slot,
  96                                          const Item::Iterator::Ptr &newValue);
  97         virtual ItemCacheCell &itemCacheCell(const VariableSlotID slot);
  98         virtual ItemSequenceCacheCell::Vector &itemSequenceCacheCells(const VariableSlotID slot);
  99
 100         virtual DynamicContext::TemplateParameterHash &templateParameterStore();
 101
 102     protected:
 103         /**
 104          * This function is protected, although it only is used in this class. I don't
 105          * know why it has to be, but it won't compile when private.
 106          */
 107         template<typename VectorType, typename UnitType>
 108         inline
 109         void setSlotVariable(const VariableSlotID slot,
 110                              const UnitType &newValue,
 111                              VectorType &container) const;
 112
 113     private:
 114         Item::Vector                            m_rangeVariables;
 115         Expression::Vector                      m_expressionVariables;
 116         Item::Iterator::Vector                  m_positionIterators;
 117         ItemCacheCell::Vector                   m_itemCacheCells;
 118         ItemSequenceCacheCell::Vector           m_itemSequenceCacheCells;
 119         DynamicContext::TemplateParameterHash   m_templateParameterStore;
 120     };
 121
 122     #include "qstackcontextbase_tpl_p.h"
 123
 124     /**
 125      * @short A DynamicContext that creates a new scope for variables.
 126      *
 127      * This DynamicContext is used for recursive user function calls, for example.
 128      */
 129     typedef StackContextBase<DelegatingDynamicContext> StackContext;
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif