src/xmlpatterns/expr/qsourcelocationreflection_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  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_SourceLocationReflection_H
  53 #define Patternist_SourceLocationReflection_H
  54
  55 QT_BEGIN_HEADER
  56
  57 QT_BEGIN_NAMESPACE
  58
  59 class QString;
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Base class for all instances that represents something
  65      * at a certain location.
  66      *
  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.
  70      *
  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.
  75      *
  76      * If sourceLocation() returns a non-null object, it will be used instead
  77      * of looking up via actualReflection().
  78      *
  79      * @author Frans Englich <frans.englich@nokia.com>
  80      * @ingroup Patternist_expressions
  81      */
  82     class Q_AUTOTEST_EXPORT SourceLocationReflection
  83     {
  84     public:
  85         inline SourceLocationReflection()
  86         {
  87         }
  88
  89         virtual ~SourceLocationReflection()
  90         {
  91         }
  92
  93         virtual const SourceLocationReflection *actualReflection() const = 0;
  94
  95         /**
  96          * A description of what represents the source code location, for
  97          * human consumption. Must be translated, as appropriate.
  98          */
  99         virtual QString description() const
 100         {
 101             return QString();
 102         }
 103
 104         virtual QSourceLocation sourceLocation() const;
 105
 106     private:
 107         Q_DISABLE_COPY(SourceLocationReflection)
 108     };
 109
 110     class DelegatingSourceLocationReflection : public SourceLocationReflection
 111     {
 112     public:
 113         inline DelegatingSourceLocationReflection(const SourceLocationReflection *const r) : m_r(r)
 114         {
 115             Q_ASSERT(r);
 116         }
 117
 118         virtual const SourceLocationReflection *actualReflection() const;
 119         virtual QString description() const;
 120
 121     private:
 122         const SourceLocationReflection *const m_r;
 123     };
 124
 125 }
 126
 127 QT_END_NAMESPACE
 128
 129 QT_END_HEADER
 130
 131 #endif