1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
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_XsdAttributeReference_H
53 #define Patternist_XsdAttributeReference_H
54 
55 #include "qxsdattributeuse_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 attribute reference resolving.
67      *
68      * For easy resolving of attribute references, we have this class
69      * that can be used as a place holder for the real attribute use
70      * object it is referring to.
71      * So whenever the parser detects an attribute reference, it creates
72      * a XsdAttributeReference and returns it instead of the XsdAttributeUse.
73      * During a later phase, the resolver will look for all XsdAttributeReferences
74      * in the schema and will replace them with their referring XsdAttributeUse
75      * objects.
76      *
77      * @ingroup Patternist_schema
78      * @author Tobias Koenig <tobias.koenig@nokia.com>
79      */
80     class XsdAttributeReference : public XsdAttributeUse
81     {
82         public:
83             typedef QExplicitlySharedDataPointer<XsdAttributeReference> Ptr;
84 
85             /**
86              * Describes the type of the attribute reference.
87              */
88             enum Type
89             {
90                 AttributeUse,   ///< The reference points to an attribute use.
91                 AttributeGroup  ///< The reference points to an attribute group.
92             };
93 
94             /**
95              * Always returns false, used to avoid dynamic casts.
96              */
97             virtual bool isAttributeUse() const;
98 
99             /**
100              * Always returns true, used to avoid dynamic casts.
101              */
102             virtual bool isReference() const;
103 
104             /**
105              * Sets the @p type of the attribute reference.
106              */
107             void setType(Type type);
108 
109             /**
110              * Returns the type of the attribute reference.
111              */
112             Type type() const;
113 
114             /**
115              * Sets the @p name of the attribute or attribute group the
116              * attribute reference refers to.
117              */
118             void setReferenceName(const QXmlName &name);
119 
120             /**
121              * Returns the name of the attribute or attribute group the
122              * attribute reference refers to.
123              */
124             QXmlName referenceName() const;
125 
126             /**
127              * Sets the source @p location where the reference is located.
128              */
129             void setSourceLocation(const QSourceLocation &location);
130 
131             /**
132              * Returns the source location where the reference is located.
133              */
134             QSourceLocation sourceLocation() const;
135 
136         private:
137             Type            m_type;
138             QXmlName        m_referenceName;
139             QSourceLocation m_sourceLocation;
140     };
141 }
142 
143 QT_END_NAMESPACE
144 
145 QT_END_HEADER
146 
147 #endif
148