src/xmlpatterns/expr/qemptysequence_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   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.
  17 **
  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.
  21 **
  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.
  29 **
  30 ** Other Usage
  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.
  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_EmptySequence_H
  53 #define Patternist_EmptySequence_H
  54
  55 #include <private/qemptycontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Implements the value instance of empty sequence: <tt>()</tt>.
  65      *
  66      * @author Frans Englich <frans.englich@nokia.com>
  67      * @ingroup Patternist_xdm
  68      */
  69     class EmptySequence : public EmptyContainer
  70     {
  71     public:
  72         /**
  73          * @short Creates an EmptySequence that is a replacement for @p
  74          * replacementFor.
  75          *
  76          * @see EmptySequence()
  77          */
  78         static Expression::Ptr create(const Expression *const replacementFor,
  79                                       const StaticContext::Ptr &context);
  80
  81
  82         /**
  83          * @short Creates an instance of EmptySequence.
  84          *
  85          * @note In most cases create() should be used, since it takes care of
  86          * adjusting source location annotations.
  87          *
  88          * @see create()
  89          */
  90         inline EmptySequence()
  91         {
  92         }
  93
  94         virtual QString stringValue() const;
  95
  96         /**
  97          * @returns always an empty iterator, an instance of EmptyIterator.
  98          */
  99         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
 100
 101         /**
 102          * @returns always @c null.
 103          */
 104         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
 105
 106         /**
 107          * Does nothing.
 108          */
 109         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &) const;
 110
 111         /**
 112          * @returns always @c false.
 113          */
 114         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
 115
 116         /**
 117          * @returns always CommonSequenceTypes::Empty
 118          */
 119         virtual ItemType::Ptr type() const;
 120
 121         /**
 122          * @returns always CommonSequenceTypes::Empty
 123          */
 124         virtual SequenceType::Ptr staticType() const;
 125
 126         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 127         virtual ID id() const;
 128         virtual Properties properties() const;
 129     };
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif