src/xmlpatterns/expr/qsourcelocationreflection_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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