src/xmlpatterns/expr/qnodecomparison_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_NodeComparison_H
  53 #define Patternist_NodeComparison_H
  54
  55 #include <private/qpaircontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Implements the node comparison operators <tt>\>\></tt>, <tt>\<\<</tt>, and @c is.
  66      *
  67      * @see <a href="http://www.w3.org/TR/xpath20/#id-node-comparisons">XML Path Language
  68      * (XPath) 2.0, 3.5.3 QXmlNodeModelIndex Comparisons</a>
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @ingroup Patternist_expressions
  71      */
  72     class Q_AUTOTEST_EXPORT NodeComparison : public PairContainer
  73     {
  74     public:
  75         NodeComparison(const Expression::Ptr &operand1,
  76                        const QXmlNodeModelIndex::DocumentOrder op,
  77                        const Expression::Ptr &operand2);
  78
  79         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  80         virtual bool evaluateEBV(const DynamicContext::Ptr &) const;
  81
  82         virtual SequenceType::List expectedOperandTypes() const;
  83
  84         virtual QXmlNodeModelIndex::DocumentOrder operatorID() const;
  85         /**
  86          * If any operator is the empty sequence, the NodeComparison rewrites
  87          * into that, since the empty sequence is always the result in that case.
  88          */
  89         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  90
  91         /**
  92          * @returns either CommonSequenceTypes::ZeroOrOneBoolean or
  93          * CommonSequenceTypes::ExactlyOneBoolean depending on the static
  94          * cardinality of its operands.
  95          */
  96         virtual SequenceType::Ptr staticType() const;
  97
  98         /**
  99          * Determines the string representation for a node comparison operator.
 100          *
 101          * @returns
 102          * - "<<" if @p op is Precedes
 103          * - ">>" if @p op is Follows
 104          * - "is" if @p op is Is
 105          */
 106         static QString displayName(const QXmlNodeModelIndex::DocumentOrder op);
 107
 108         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 109     private:
 110         enum Result
 111         {
 112             Empty,
 113             True,
 114             False
 115         };
 116         inline Result evaluate(const DynamicContext::Ptr &context) const;
 117
 118         const QXmlNodeModelIndex::DocumentOrder m_op;
 119
 120     };
 121 }
 122
 123 QT_END_NAMESPACE
 124
 125 QT_END_HEADER
 126
 127 #endif