src/xmlpatterns/expr/qvaluecomparison_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 ** 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_ValueComparison_H
  53 #define Patternist_ValueComparison_H
  54
  55 #include <private/qatomiccomparator_p.h>
  56 #include <private/qpaircontainer_p.h>
  57 #include <private/qcomparisonplatform_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65
  66     /**
  67      * @short Implements XPath 2.0 value comparions, such as the <tt>eq</tt> operator.
  68      *
  69      * ComparisonPlatform is inherited with @c protected scope because ComparisonPlatform
  70      * must access members of ValueComparison.
  71      *
  72      * @see <a href="http://www.w3.org/TR/xpath20/#id-value-comparisons">XML Path Language
  73      * (XPath) 2.0, 3.5.1 Value Comparisons</a>
  74      * @author Frans Englich <frans.englich@nokia.com>
  75      * @ingroup Patternist_expressions
  76      */
  77     class ValueComparison : public PairContainer,
  78                             public ComparisonPlatform<ValueComparison, true>
  79     {
  80     public:
  81         ValueComparison(const Expression::Ptr &op1,
  82                         const AtomicComparator::Operator op,
  83                         const Expression::Ptr &op2);
  84
  85         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  86
  87         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  88                                           const SequenceType::Ptr &reqType);
  89
  90         /**
  91          * @returns always CommonSequenceTypes::ExactlyOneBoolean
  92          */
  93         virtual SequenceType::Ptr staticType() const;
  94
  95         virtual SequenceType::List expectedOperandTypes() const;
  96
  97         /**
  98          * @returns IDValueComparison
  99          */
 100         virtual ID id() const;
 101
 102         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 103         virtual QList<QExplicitlySharedDataPointer<OptimizationPass> > optimizationPasses() const;
 104
 105         /**
 106          * Overridden to optimize case-insensitive compares.
 107          */
 108         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 109
 110         /**
 111          * @returns the operator that this ValueComparison is using.
 112          */
 113         inline AtomicComparator::Operator operatorID() const
 114         {
 115             return m_operator;
 116         }
 117
 118         /**
 119          * It is considered that the string value from @p op1 will be compared against @p op2. This
 120          * function determines whether the user intends the comparison to be case insensitive. If
 121          * that is the case @c true is returned, and the operands are re-written appropriately.
 122          *
 123          * This is a helper function for Expression classes that compares strings.
 124          *
 125          * @see ComparisonPlatform::useCaseInsensitiveComparator()
 126          */
 127         static bool isCaseInsensitiveCompare(Expression::Ptr &op1, Expression::Ptr &op2);
 128
 129     private:
 130         const AtomicComparator::Operator m_operator;
 131     };
 132 }
 133
 134 QT_END_NAMESPACE
 135
 136 QT_END_HEADER
 137
 138 #endif