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_TemplatePattern_H
51#define Patternist_TemplatePattern_H
52
53#include <private/qtemplate_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59 /**
60 * @short Houses the data necessary for a template pattern.
61 *
62 * A template pattern is the match pattern, but have had each operand to @c
63 * | separated out into a separate TemplatePattern. For instance, the
64 * pattern <tt>a | b | c</tt>, becomes three separate TemplatePattern
65 * instances.
66 *
67 * @see TemplateMode
68 * @see Template
69 * @author Frans Englich <frans.englich@nokia.com>
70 * @ingroup Patternist_expressions
71 * @since 4.5
72 */
73 class TemplatePattern : public QSharedData
74 {
75 public:
76 typedef QExplicitlySharedDataPointer<TemplatePattern> Ptr;
77 typedef QVector<Ptr> Vector;
78 typedef int ID;
79
80 inline TemplatePattern(const Expression::Ptr &matchPattern,
81 const PatternPriority pri,
82 const ID id,
83 const Template::Ptr templ);
84
85 inline PatternPriority priority() const;
86 inline const Expression::Ptr &matchPattern() const;
87 inline void setMatchPattern(const Expression::Ptr &pattern);
88 inline const Template::Ptr &templateTarget() const;
89 inline ID id() const;
90
91 /**
92 * This ID is used to ensure that, as 6.4 Conflict Resolution for
93 * Template Rules reads:
94 *
95 * "If the pattern contains multiple alternatives separated by |, then
96 * the template rule is treated equivalently to a set of template
97 * rules, one for each alternative. However, it is not an error if a
98 * node matches more than one of the alternatives."
99 *
100 * For patterns separated by @c |, we have one Template instance for
101 * each alternative, but they all have the same ID, hence if several
102 * alternatives match, we don't flag it as an error if they have the
103 * same ID.
104 */
105 private:
106 Expression::Ptr m_matchPattern;
107 PatternPriority m_priority;
108 ID m_id;
109 Template::Ptr m_templateTarget;
110 Q_DISABLE_COPY(TemplatePattern)
111 };
112
113 TemplatePattern::TemplatePattern(const Expression::Ptr &matchPattern,
114 const PatternPriority pri,
115 const ID id,
116 const Template::Ptr templ) : m_matchPattern(matchPattern)
117 , m_priority(pri)
118 , m_id(id)
119 , m_templateTarget(templ)
120
121 {
122 Q_ASSERT(m_matchPattern);
123 Q_ASSERT(m_templateTarget);
124 }
125
126 const Expression::Ptr &TemplatePattern::matchPattern() const
127 {
128 return m_matchPattern;
129 }
130
131 void TemplatePattern::setMatchPattern(const Expression::Ptr &pattern)
132 {
133 m_matchPattern = pattern;
134 }
135
136 PatternPriority TemplatePattern::priority() const
137 {
138 return m_priority;
139 }
140
141 TemplatePattern::ID TemplatePattern::id() const
142 {
143 return m_id;
144 }
145
146 const Template::Ptr &TemplatePattern::templateTarget() const
147 {
148 return m_templateTarget;
149 }
150
151}
152
153QT_END_NAMESPACE
154
155#endif
156
157

source code of qtxmlpatterns/src/xmlpatterns/expr/qtemplatepattern_p.h