src/xmlpatterns/expr/qrangeexpression_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_RangeExpression_H
  53 #define Patternist_RangeExpression_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 XPath 2.0's @c to expression.
  66      *
  67      * Despite its name, RangeExpression is not related to RangeVariableDeclaration.
  68      *
  69      * @see <a href="http://www.w3.org/TR/xpath20/#construct_seq">XML Path Language
  70      * (XPath) 2.0, 3.3.1 Constructing Sequences</a>
  71      * @see RangeIterator
  72      * @author Frans Englich <frans.englich@nokia.com>
  73      * @ingroup Patternist_expressions
  74      */
  75     class RangeExpression : public PairContainer
  76     {
  77     public:
  78         RangeExpression(const Expression::Ptr &operand1, const Expression::Ptr &operand2);
  79
  80         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
  81         /**
  82          * It's likely that this function gets called if staticType() inferred
  83          * the cardinality to an exact number. In that case, we know that the
  84          * first arguments is the same as the second argument.
  85          */
  86         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  87
  88         virtual SequenceType::List expectedOperandTypes() const;
  89
  90         /**
  91          * @returns always CommonSequenceTypes::ZeroOrMoreIntegers
  92          */
  93         virtual SequenceType::Ptr staticType() const;
  94
  95         /**
  96          * Disables compression for optimization reasons. For example, the
  97          * expression "1 to 1000" would consume thousand allocated instances
  98          * of Integer, and RangeIterator is well suited for dynamic evaluation.
  99          *
 100          * @returns Expression::DisableElimination
 101          */
 102         virtual Expression::Properties properties() const;
 103
 104         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 105     };
 106 }
 107
 108 QT_END_NAMESPACE
 109
 110 QT_END_HEADER
 111
 112 #endif