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