src/xmlpatterns/expr/qquantifiedexpression_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_QuantifiedExpression_H
  53 #define Patternist_QuantifiedExpression_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      * @short Implements XPath 2.0's quantification expressions @c some and @c every.
  65      *
  66      * @see <a href="http://www.w3.org/TR/xpath20/#id-quantified-expressions">XML Path Language
  67      * (XPath) 2.0, 3.9 Quantified Expressions</a>
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      * @ingroup Patternist_expressions
  70      */
  71     class Q_AUTOTEST_EXPORT QuantifiedExpression : public PairContainer
  72     {
  73     public:
  74         enum Operator
  75         {
  76             Some    = 1,
  77             Every
  78         };
  79
  80         QuantifiedExpression(const VariableSlotID varSlot,
  81                              const Operator quantifier,
  82                              const Expression::Ptr &inClause,
  83                              const Expression::Ptr &testExpression);
  84
  85         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  86         virtual SequenceType::Ptr staticType() const;
  87         virtual SequenceType::List expectedOperandTypes() const;
  88
  89         Operator operatorID() const;
  90
  91         /**
  92          * Determines the string representation for a quantification operator.
  93          *
  94          * @return "some" if @p quantifier is Some, or "every" if @p quantifier
  95          * is Every
  96          */
  97         static QString displayName(const Operator quantifier);
  98
  99         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 100
 101         inline Item mapToItem(const Item &item, const DynamicContext::Ptr &context) const;
 102
 103     private:
 104         typedef QExplicitlySharedDataPointer<const QuantifiedExpression> ConstPtr;
 105         const VariableSlotID m_varSlot;
 106         const Operator m_quantifier;
 107     };
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif