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_VariableReference_H |
51 | #define Patternist_VariableReference_H |
52 | |
53 | #include <private/qemptycontainer_p.h> |
54 | |
55 | QT_BEGIN_NAMESPACE |
56 | |
57 | template<typename T> class QList; |
58 | |
59 | namespace QPatternist |
60 | { |
61 | /** |
62 | * @short Baseclass for classes being references to variables. |
63 | * |
64 | * @author Frans Englich <frans.englich@nokia.com> |
65 | * @ingroup Patternist_expressions |
66 | */ |
67 | class Q_AUTOTEST_EXPORT VariableReference : public EmptyContainer |
68 | { |
69 | public: |
70 | typedef QExplicitlySharedDataPointer<VariableReference> Ptr; |
71 | typedef QList<VariableReference::Ptr> List; |
72 | |
73 | /** |
74 | * Creates a VariableReference. |
75 | * |
76 | * @param slot must be a valid slot. That is, zero or larger. |
77 | */ |
78 | VariableReference(const VariableSlotID slot); |
79 | ~VariableReference(); |
80 | |
81 | /** |
82 | * @returns the slot that this reference communicates through. |
83 | * |
84 | * This is a slot in the DynamicContext. Which one, depends on the |
85 | * type, which this VariableReference does not have information about. |
86 | * For instance, it could DynamicContext::expressionVariable() or |
87 | * DynamicContext::rangeVariable(). |
88 | */ |
89 | inline VariableSlotID slot() const; |
90 | |
91 | /** |
92 | * @returns DisableElimination |
93 | */ |
94 | virtual Properties properties() const; |
95 | |
96 | private: |
97 | /** |
98 | * The slot. Same as returned by slot(). |
99 | * |
100 | * This variable is not called m_slot, because that creates a weird |
101 | * compiler error on hpuxi-acc. See the preprocessor output. EvaluationCache::m_varSlot |
102 | * is a similar workaround. |
103 | */ |
104 | const VariableSlotID m_varSlot; |
105 | }; |
106 | |
107 | inline VariableSlotID VariableReference::slot() const |
108 | { |
109 | return m_varSlot; |
110 | } |
111 | |
112 | } |
113 | |
114 | QT_END_NAMESPACE |
115 | |
116 | #endif |
117 | |