src/xmlpatterns/expr/qcontextitem_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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_ContextItem_H
  53 #define Patternist_ContextItem_H
  54
  55 #include "qemptycontainer_p.h"
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Implements the context item, the dot: <tt>.</tt>.
  65      *
  66      * @see <a href="http://www.w3.org/TR/xpath20/#id-context-item-expression">XML Path Language
  67      * (XPath) 2.0, 3.1.4 Context Item Expression</a>
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      * @ingroup Patternist_expressions
  70      */
  71     class ContextItem : public EmptyContainer
  72     {
  73     public:
  74         /**
  75          * @p expr is possibly used for error reporting. If this context item has been
  76          * created implicitly, such as for the expression <tt>fn:string()</tt>, @p expr
  77          * should be passed a valid pointer to the Expression that this context
  78          * item is generated for.
  79          */
  80         inline ContextItem(const Expression::Ptr &expr = Expression::Ptr()) : m_expr(expr)
  81         {
  82         }
  83
  84         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  85         virtual SequenceType::Ptr staticType() const;
  86
  87         /**
  88          * @returns always DisableElimination and RequiresContextItem
  89          */
  90         virtual Expression::Properties properties() const;
  91
  92         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  93
  94         /**
  95          * Overridden to store a pointer to StaticContext::contextItemType().
  96          */
  97         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  98
  99         /**
 100          * Overridden to store a pointer to StaticContext::contextItemType().
 101          */
 102         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 103                                           const SequenceType::Ptr &reqType);
 104
 105         /**
 106          * @returns always IDContextItem
 107          */
 108         virtual ID id() const;
 109
 110         /**
 111          * @returns always BuiltinTypes::item;
 112          */
 113         virtual ItemType::Ptr expectedContextItemType() const;
 114
 115         virtual const SourceLocationReflection *actualReflection() const;
 116         virtual void announceFocusType(const ItemType::Ptr &type);
 117
 118     private:
 119         ItemType::Ptr           m_itemType;
 120         const Expression::Ptr   m_expr;
 121     };
 122 }
 123
 124 QT_END_NAMESPACE
 125
 126 QT_END_HEADER
 127
 128 #endif