source: trunk/src/xmlpatterns/expr/qtemplatepattern_p.h@ 439

Last change on this file since 439 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 5.5 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
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_TemplatePattern_H
53#define Patternist_TemplatePattern_H
54
55#include "qtemplate_p.h"
56
57QT_BEGIN_HEADER
58QT_BEGIN_NAMESPACE
59
60namespace QPatternist
61{
62 /**
63 * @short Houses the data necessary for a template pattern.
64 *
65 * A template pattern is the match pattern, but have had each operand to @c
66 * | separated out into a separate TemplatePattern. For instance, the
67 * pattern <tt>a | b | c</tt>, becomes three separate TemplatePattern
68 * instances.
69 *
70 * @see TemplateMode
71 * @see Template
72 * @author Frans Englich <[email protected]>
73 * @ingroup Patternist_expressions
74 * @since 4.5
75 */
76 class TemplatePattern : public QSharedData
77 {
78 public:
79 typedef QExplicitlySharedDataPointer<TemplatePattern> Ptr;
80 typedef QVector<Ptr> Vector;
81 typedef int ID;
82
83 inline TemplatePattern(const Expression::Ptr &matchPattern,
84 const PatternPriority pri,
85 const ID id,
86 const Template::Ptr templ);
87
88 inline PatternPriority priority() const;
89 inline const Expression::Ptr &matchPattern() const;
90 inline void setMatchPattern(const Expression::Ptr &pattern);
91 inline const Template::Ptr &templateTarget() const;
92 inline ID id() const;
93
94 /**
95 * This ID is used to ensure that, as 6.4 Conflict Resolution for
96 * Template Rules reads:
97 *
98 * "If the pattern contains multiple alternatives separated by |, then
99 * the template rule is treated equivalently to a set of template
100 * rules, one for each alternative. However, it is not an error if a
101 * node matches more than one of the alternatives."
102 *
103 * For patterns separated by @c |, we have one Template instance for
104 * each alternative, but they all have the same ID, hence if several
105 * alternatives match, we don't flag it as an error if they have the
106 * same ID.
107 */
108 private:
109 Expression::Ptr m_matchPattern;
110 PatternPriority m_priority;
111 ID m_id;
112 Template::Ptr m_templateTarget;
113 Q_DISABLE_COPY(TemplatePattern)
114 };
115
116 TemplatePattern::TemplatePattern(const Expression::Ptr &matchPattern,
117 const PatternPriority pri,
118 const ID id,
119 const Template::Ptr templ) : m_matchPattern(matchPattern)
120 , m_priority(pri)
121 , m_id(id)
122 , m_templateTarget(templ)
123
124 {
125 Q_ASSERT(m_matchPattern);
126 Q_ASSERT(m_templateTarget);
127 }
128
129 const Expression::Ptr &TemplatePattern::matchPattern() const
130 {
131 return m_matchPattern;
132 }
133
134 void TemplatePattern::setMatchPattern(const Expression::Ptr &pattern)
135 {
136 m_matchPattern = pattern;
137 }
138
139 PatternPriority TemplatePattern::priority() const
140 {
141 return m_priority;
142 }
143
144 TemplatePattern::ID TemplatePattern::id() const
145 {
146 return m_id;
147 }
148
149 const Template::Ptr &TemplatePattern::templateTarget() const
150 {
151 return m_templateTarget;
152 }
153
154}
155
156QT_END_NAMESPACE
157
158QT_END_HEADER
159
160#endif
161
Note: See TracBrowser for help on using the repository browser.