|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2008 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_XsdReference_H |
|
53 #define Patternist_XsdReference_H |
|
54 |
|
55 #include "qxsdterm_p.h" |
|
56 |
|
57 #include <QtXmlPatterns/QSourceLocation> |
|
58 |
|
59 QT_BEGIN_HEADER |
|
60 |
|
61 QT_BEGIN_NAMESPACE |
|
62 |
|
63 namespace QPatternist |
|
64 { |
|
65 /** |
|
66 * @short A helper class for element and group reference resolving. |
|
67 * |
|
68 * For easy resolving of element and group references, we have this class |
|
69 * that can be used as a place holder for the real element or group |
|
70 * object it is referring to. |
|
71 * So whenever the parser detects an element or group reference, it creates |
|
72 * a XsdReference and returns it instead of the XsdElement or XsdModelGroup. |
|
73 * During a later phase, the resolver will look for all XsdReferences |
|
74 * in the schema and will replace them with their referring XsdElement or |
|
75 * XsdModelGroup objects. |
|
76 * |
|
77 * @ingroup Patternist_schema |
|
78 * @author Tobias Koenig <tobias.koenig@nokia.com> |
|
79 */ |
|
80 class XsdReference : public XsdTerm |
|
81 { |
|
82 public: |
|
83 typedef QExplicitlySharedDataPointer<XsdReference> Ptr; |
|
84 |
|
85 /** |
|
86 * Describes the type of the reference. |
|
87 */ |
|
88 enum Type |
|
89 { |
|
90 Element, ///< The reference points to an element. |
|
91 ModelGroup ///< The reference points to a model group. |
|
92 }; |
|
93 |
|
94 /** |
|
95 * Returns always @c true, used to avoid dynamic casts. |
|
96 */ |
|
97 virtual bool isReference() const; |
|
98 |
|
99 /** |
|
100 * Sets the @p type of the reference. |
|
101 * |
|
102 * @see Type |
|
103 */ |
|
104 void setType(Type type); |
|
105 |
|
106 /** |
|
107 * Returns the type of the reference. |
|
108 */ |
|
109 Type type() const; |
|
110 |
|
111 /** |
|
112 * Sets the @p name of the referenced object. |
|
113 * |
|
114 * The name can either be a top-level element declaration |
|
115 * or a top-level group declaration. |
|
116 */ |
|
117 void setReferenceName(const QXmlName &ame); |
|
118 |
|
119 /** |
|
120 * Returns the name of the referenced object. |
|
121 */ |
|
122 QXmlName referenceName() const; |
|
123 |
|
124 /** |
|
125 * Sets the source @p location where the reference is located. |
|
126 */ |
|
127 void setSourceLocation(const QSourceLocation &location); |
|
128 |
|
129 /** |
|
130 * Returns the source location where the reference is located. |
|
131 */ |
|
132 QSourceLocation sourceLocation() const; |
|
133 |
|
134 private: |
|
135 Type m_type; |
|
136 QXmlName m_referenceName; |
|
137 QSourceLocation m_sourceLocation; |
|
138 }; |
|
139 } |
|
140 |
|
141 QT_END_NAMESPACE |
|
142 |
|
143 QT_END_HEADER |
|
144 |
|
145 #endif |