1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 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 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    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_RangeExpression_H

    53 #define Patternist_RangeExpression_H

    54 

    55 #include "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