1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: http://www.qt-project.org/
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
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.
52 #ifndef Patternist_SourceLocationReflection_H
53 #define Patternist_SourceLocationReflection_H
64 * @short Base class for all instances that represents something
65 * at a certain location.
67 * SourceLocationReflection does not provide the source location itself,
68 * the address to an instance is the mark for it, that in turn can be used
69 * for looking up the source location where that mapping is provided.
71 * However, this SourceLocationReflection is not itself the mark. The real
72 * mark is retrieved by calling actualReflection(). This mechanism
73 * allows a SourceLocationReflection sub-class to delegate, or be an alias,
74 * for another source location mark.
76 * If sourceLocation() returns a non-null object, it will be used instead
77 * of looking up via actualReflection().
79 * @author Frans Englich <frans.englich@nokia.com>
80 * @ingroup Patternist_expressions
82 class Q_AUTOTEST_EXPORT SourceLocationReflection
85 inline SourceLocationReflection()
89 virtual ~SourceLocationReflection()
93 virtual const SourceLocationReflection *actualReflection() const = 0;
96 * A description of what represents the source code location, for
97 * human consumption. Must be translated, as appropriate.
99 virtual QString description() const
104 virtual QSourceLocation sourceLocation() const;
107 Q_DISABLE_COPY(SourceLocationReflection)
110 class DelegatingSourceLocationReflection : public SourceLocationReflection
113 inline DelegatingSourceLocationReflection(const SourceLocationReflection *const r) : m_r(r)
118 virtual const SourceLocationReflection *actualReflection() const;
119 virtual QString description() const;
122 const SourceLocationReflection *const m_r;