src/xmlpatterns/expr/qreturnorderby_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_ReturnOrderBy_H
  53 #define Patternist_ReturnOrderBy_H
  54
  55 #include <private/qorderby_p.h>
  56 #include <private/qunlimitedcontainer_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Together with OrderBy, it implements XQuery 1.0's <tt>order by</tt> expression.
  66      *
  67      * ReturnOrderBy evaluates the sort keys and values, and hands it over to
  68      * OrderBy, which is an AST ancestor, using SortTuples.
  69      *
  70      * @author Frans Englich <frans.englich@nokia.com>
  71      * @ingroup Patternist_expressions
  72      */
  73     class ReturnOrderBy : public UnlimitedContainer
  74     {
  75     public:
  76         /**
  77          * In @p operands the first item is the return expression, and the
  78          * rest, which is at least one, are the sort keys.
  79          */
  80         ReturnOrderBy(const OrderBy::Stability stability,
  81                       const OrderBy::OrderSpec::Vector &oSpecs,
  82                       const Expression::List &operands);
  83
  84         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  85         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  86         virtual SequenceType::Ptr staticType() const;
  87         virtual SequenceType::List expectedOperandTypes() const;
  88         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  89         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  90         virtual ID id() const;
  91
  92         inline OrderBy::OrderSpec::Vector orderSpecs() const
  93         {
  94             return m_orderSpecs;
  95         }
  96
  97         inline OrderBy::Stability stability() const
  98         {
  99             return m_stability;
 100         }
 101
 102         /**
 103          * In the case of that we don't have a for-expression beloning us, but
 104          * only a let clause, this ReturnOrderBy breaks if it stays in the AST.
 105          * So, by default we assume that we should write ourselves away, unless
 106          * this function is called. The associated ForClause will call it
 107          * during typeCheck(), if it exists.
 108          */
 109         inline void setStay(const bool a)
 110         {
 111             m_flyAway = !a;
 112         }
 113
 114         virtual Properties properties() const;
 115     private:
 116         /**
 117          * This variable is unfortunately only used at compile time. However,
 118          * it's tricky to get rid of it due to how QueryTransformParser would
 119          * have to be adapted.
 120          */
 121         const OrderBy::Stability    m_stability;
 122
 123         OrderBy::OrderSpec::Vector  m_orderSpecs;
 124
 125         /**
 126          * @see stay()
 127          */
 128         bool                        m_flyAway;
 129     };
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif