1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_StackContextBase_H
51#define Patternist_StackContextBase_H
52
53#include <QVector>
54
55#include <private/qdaytimeduration_p.h>
56#include <private/qdelegatingdynamiccontext_p.h>
57#include <private/qexpression_p.h>
58
59QT_BEGIN_NAMESPACE
60
61namespace QPatternist
62{
63 /**
64 * @short Base class for all DynamicContext classes that needs to supply
65 * variables. It has a new frame for local caches, position iterators,
66 * expressions, range variables, template parameters but notably continues
67 * to delegate global caches.
68 *
69 * @author Frans Englich <frans.englich@nokia.com>
70 */
71 template<typename TSuperClass>
72 class StackContextBase : public TSuperClass
73 {
74 public:
75 StackContextBase();
76 /**
77 * Construct a StackContextBase and passes @p prevContext to its super class. This
78 * constructor is typically used when the super class is DelegatingDynamicContext.
79 */
80 StackContextBase(const DynamicContext::Ptr &prevContext);
81
82 virtual void setRangeVariable(const VariableSlotID slotNumber,
83 const Item &newValue);
84 virtual Item rangeVariable(const VariableSlotID slotNumber) const;
85
86 virtual void setExpressionVariable(const VariableSlotID slotNumber,
87 const Expression::Ptr &newValue);
88 virtual Expression::Ptr expressionVariable(const VariableSlotID slotNumber) const;
89
90 virtual Item::Iterator::Ptr positionIterator(const VariableSlotID slot) const;
91 virtual void setPositionIterator(const VariableSlotID slot,
92 const Item::Iterator::Ptr &newValue);
93 virtual ItemCacheCell &itemCacheCell(const VariableSlotID slot);
94 virtual ItemSequenceCacheCell::Vector &itemSequenceCacheCells(const VariableSlotID slot);
95
96 virtual DynamicContext::TemplateParameterHash &templateParameterStore();
97
98 protected:
99 /**
100 * This function is protected, although it only is used in this class. I don't
101 * know why it has to be, but it won't compile when private.
102 */
103 template<typename VectorType, typename UnitType>
104 inline
105 void setSlotVariable(const VariableSlotID slot,
106 const UnitType &newValue,
107 VectorType &container) const;
108
109 private:
110 Item::Vector m_rangeVariables;
111 Expression::Vector m_expressionVariables;
112 Item::Iterator::Vector m_positionIterators;
113 ItemCacheCell::Vector m_itemCacheCells;
114 ItemSequenceCacheCell::Vector m_itemSequenceCacheCells;
115 DynamicContext::TemplateParameterHash m_templateParameterStore;
116 };
117
118 #include "qstackcontextbase_tpl_p.h"
119
120 /**
121 * @short A DynamicContext that creates a new scope for variables.
122 *
123 * This DynamicContext is used for recursive user function calls, for example.
124 */
125 typedef StackContextBase<DelegatingDynamicContext> StackContext;
126}
127
128QT_END_NAMESPACE
129
130#endif
131

source code of qtxmlpatterns/src/xmlpatterns/environment/qstackcontextbase_p.h