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_SourceLocationReflection_H 51 #define Patternist_SourceLocationReflection_H 52 53 QT_BEGIN_NAMESPACE 54 55 class QString; 56 57 namespace QPatternist 58 { 59 /** 60 * @short Base class for all instances that represents something 61 * at a certain location. 62 * 63 * SourceLocationReflection does not provide the source location itself, 64 * the address to an instance is the mark for it, that in turn can be used 65 * for looking up the source location where that mapping is provided. 66 * 67 * However, this SourceLocationReflection is not itself the mark. The real 68 * mark is retrieved by calling actualReflection(). This mechanism 69 * allows a SourceLocationReflection sub-class to delegate, or be an alias, 70 * for another source location mark. 71 * 72 * If sourceLocation() returns a non-null object, it will be used instead 73 * of looking up via actualReflection(). 74 * 75 * @author Frans Englich <frans.englich@nokia.com> 76 * @ingroup Patternist_expressions 77 */ 78 class Q_AUTOTEST_EXPORT SourceLocationReflection 79 { 80 public: SourceLocationReflection()81 inline SourceLocationReflection() 82 { 83 } 84 ~SourceLocationReflection()85 virtual ~SourceLocationReflection() 86 { 87 } 88 89 virtual const SourceLocationReflection *actualReflection() const = 0; 90 91 /** 92 * A description of what represents the source code location, for 93 * human consumption. Must be translated, as appropriate. 94 */ description()95 virtual QString description() const 96 { 97 return QString(); 98 } 99 100 virtual QSourceLocation sourceLocation() const; 101 102 private: 103 Q_DISABLE_COPY(SourceLocationReflection) 104 }; 105 106 class DelegatingSourceLocationReflection : public SourceLocationReflection 107 { 108 public: DelegatingSourceLocationReflection(const SourceLocationReflection * const r)109 inline DelegatingSourceLocationReflection(const SourceLocationReflection *const r) : m_r(r) 110 { 111 Q_ASSERT(r); 112 } 113 114 virtual const SourceLocationReflection *actualReflection() const; 115 virtual QString description() const; 116 117 private: 118 const SourceLocationReflection *const m_r; 119 }; 120 121 } 122 123 QT_END_NAMESPACE 124 125 #endif 126