src/xmlpatterns/expr/qreturnorderby.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   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 #include "qcommonsequencetypes_p.h"
  43 #include "qexpressionsequence_p.h"
  44 #include "qsorttuple_p.h"
  45
  46 #include "qreturnorderby_p.h"
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 using namespace QPatternist;
  51
  52 ReturnOrderBy::ReturnOrderBy(const OrderBy::Stability aStability,
  53                              const OrderBy::OrderSpec::Vector &oSpecs,
  54                              const Expression::List &ops) : UnlimitedContainer(ops)
  55                                                           , m_stability(aStability)
  56                                                           , m_orderSpecs(oSpecs)
  57                                                           , m_flyAway(true)
  58 {
  59     Q_ASSERT_X(m_operands.size() >= 2, Q_FUNC_INFO,
  60                "ReturnOrderBy must have the return expression, and at least one sort key.");
  61     Q_ASSERT(m_orderSpecs.size() == ops.size() - 1);
  62 }
  63
  64 Item ReturnOrderBy::evaluateSingleton(const DynamicContext::Ptr &context) const
  65 {
  66     Q_ASSERT(m_operands.size() > 1);
  67     const Item::Iterator::Ptr value(makeListIterator(m_operands.first()->evaluateSequence(context)->toList()));
  68     Item::Vector sortKeys;
  69
  70     /* We're skipping the first operand. */
  71     const int len = m_operands.size() - 1;
  72     sortKeys.resize(len);
  73
  74     for(int i = 1; i <= len; ++i)
  75         sortKeys[i - 1] = m_operands.at(i)->evaluateSingleton(context);
  76
  77     return Item(new SortTuple(value, sortKeys));
  78 }
  79
  80 bool ReturnOrderBy::evaluateEBV(const DynamicContext::Ptr &context) const
  81 {
  82     // TODO This is temporary code.
  83     return m_operands.first()->evaluateEBV(context);
  84 }
  85
  86 Expression::Ptr ReturnOrderBy::compress(const StaticContext::Ptr &context)
  87 {
  88     /* We first did this in typeCheck(), but that broke due to that type checks were
  89      * missed, which other pieces relied on. */
  90     if(m_flyAway)
  91     {
  92         /* We only want the return expression, not the sort keys. */
  93         return m_operands.first()->compress(context);
  94     }
  95     else
  96     {
  97         /* We don't need the members, so don't keep a reference to them. */
  98         m_orderSpecs.clear();
  99
 100         return UnlimitedContainer::compress(context);
 101     }
 102 }
 103
 104 Expression::Properties ReturnOrderBy::properties() const
 105 {
 106     /* For some unknown reason this is necessary for XQTS test case orderBy18. */
 107     return DisableElimination;
 108 }
 109
 110 ExpressionVisitorResult::Ptr ReturnOrderBy::accept(const ExpressionVisitor::Ptr &visitor) const
 111 {
 112     return visitor->visit(this);
 113 }
 114
 115 SequenceType::Ptr ReturnOrderBy::staticType() const
 116 {
 117     return m_operands.first()->staticType();
 118 }
 119
 120 SequenceType::List ReturnOrderBy::expectedOperandTypes() const
 121 {
 122     SequenceType::List result;
 123     result.append(CommonSequenceTypes::ZeroOrMoreItems);
 124     result.append(CommonSequenceTypes::ZeroOrOneAtomicType);
 125     return result;
 126 }
 127
 128 Expression::ID ReturnOrderBy::id() const
 129 {
 130     return IDReturnOrderBy;
 131 }
 132
 133 QT_END_NAMESPACE