1 /****************************************************************************

     2 **

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

     4 ** All rights reserved.

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

     6 **

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

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

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

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

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

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

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

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

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

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

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

    23 **

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

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

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

    27 **

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

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

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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 "qdaytimeduration_p.h"

    58 #include "qdelegatingdynamiccontext_p.h"

    59 #include "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.cpp"

   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