src/xmlpatterns/expr/qvariablereference_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_VariableReference_H
       
    53 #define Patternist_VariableReference_H
       
    54 
       
    55 #include "qemptycontainer_p.h"
       
    56 
       
    57 QT_BEGIN_HEADER
       
    58 
       
    59 QT_BEGIN_NAMESPACE
       
    60 
       
    61 template<typename T> class QList;
       
    62 
       
    63 namespace QPatternist
       
    64 {
       
    65     /**
       
    66      * @short Baseclass for classes being references to variables.
       
    67      *
       
    68      * @author Frans Englich <frans.englich@nokia.com>
       
    69      * @ingroup Patternist_expressions
       
    70      */
       
    71     class VariableReference : public EmptyContainer
       
    72     {
       
    73     public:
       
    74         typedef QExplicitlySharedDataPointer<VariableReference> Ptr;
       
    75         typedef QList<VariableReference::Ptr> List;
       
    76 
       
    77         /**
       
    78          * Creates a VariableReference.
       
    79          *
       
    80          * @param slot must be a valid slot. That is, zero or larger.
       
    81          */
       
    82         VariableReference(const VariableSlotID slot);
       
    83 
       
    84         /**
       
    85          * @returns the slot that this reference communicates through.
       
    86          *
       
    87          * This is a slot in the DynamicContext. Which one, depends on the
       
    88          * type, which this VariableReference does not have information about.
       
    89          * For instance, it could DynamicContext::expressionVariable() or
       
    90          * DynamicContext::rangeVariable().
       
    91          */
       
    92         inline VariableSlotID slot() const;
       
    93 
       
    94         /**
       
    95          * @returns DisableElimination
       
    96          */
       
    97         virtual Properties properties() const;
       
    98 
       
    99     private:
       
   100         /**
       
   101          * The slot. Same as returned by slot().
       
   102          *
       
   103          *  This variable is not called m_slot, because that creates a weird
       
   104          *  compiler error on hpuxi-acc. See the preprocessor output. EvaluationCache::m_varSlot
       
   105          *  is a similar workaround.
       
   106          */
       
   107         const VariableSlotID m_varSlot;
       
   108     };
       
   109 
       
   110     inline VariableSlotID VariableReference::slot() const
       
   111     {
       
   112         return m_varSlot;
       
   113     }
       
   114 
       
   115 }
       
   116 
       
   117 QT_END_NAMESPACE
       
   118 
       
   119 QT_END_HEADER
       
   120 
       
   121 #endif