src/xmlpatterns/expr/qnodesort.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 "qdeduplicateiterator_p.h"
  44 #include "qnodesort_p.h"
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 using namespace QPatternist;
  49
  50 NodeSortExpression::NodeSortExpression(const Expression::Ptr &op) : SingleContainer(op)
  51 {
  52 }
  53
  54 bool NodeSortExpression::lessThanUsingNodeModel(const Item &n1,
  55                                                 const Item &n2)
  56 {
  57     Q_ASSERT(n1.isNode());
  58     Q_ASSERT(n2.isNode());
  59
  60     if(n1.asNode().model() == n2.asNode().model())
  61         return n1.asNode().compareOrder(n2.asNode()) == QXmlNodeModelIndex::Precedes;
  62     else
  63     {
  64         /* The two nodes are from different trees. The sort order is implementation
  65          * defined, but it must be stable.
  66          *
  67          * We do this by looking at the pointer difference. The value means nothing,
  68          * but it is stable, and that's what we're looking for. */
  69         return n1.asNode().model() - n2.asNode().model() < 0;
  70     }
  71 }
  72
  73 Item::Iterator::Ptr NodeSortExpression::evaluateSequence(const DynamicContext::Ptr &context) const
  74 {
  75     Q_ASSERT_X(m_operand->staticType()->cardinality().allowsMany(), Q_FUNC_INFO,
  76                "It makes no sense to sort a single node.");
  77
  78     Item::List nodes(m_operand->evaluateSequence(context)->toList());
  79
  80     if(nodes.isEmpty())
  81         return CommonValues::emptyIterator;
  82     else if(nodes.first().isAtomicValue())
  83         return makeListIterator(nodes);
  84     else
  85     {
  86         qSort(nodes.begin(), nodes.end(), lessThanUsingNodeModel);
  87
  88         return Item::Iterator::Ptr(new DeduplicateIterator(nodes));
  89     }
  90 }
  91
  92 Expression::Ptr NodeSortExpression::wrapAround(const Expression::Ptr &operand,
  93                                                const StaticContext::Ptr &context)
  94 {
  95     Q_ASSERT(operand);
  96     Q_ASSERT(context);
  97
  98     const Expression::Ptr sort(new NodeSortExpression(operand));
  99     context->wrapExpressionWith(operand.data(), sort);
 100     return sort;
 101 }
 102
 103 Expression::Ptr NodeSortExpression::compress(const StaticContext::Ptr &context)
 104 {
 105     const Expression::Ptr me(SingleContainer::compress(context));
 106
 107     /* It make no sense to sort & deduplicate a single node. */
 108     if(m_operand->staticType()->cardinality().allowsMany())
 109         return me;
 110     else
 111         return m_operand;
 112 }
 113
 114 SequenceType::Ptr NodeSortExpression::staticType() const
 115 {
 116     return m_operand->staticType();
 117 }
 118
 119 SequenceType::List NodeSortExpression::expectedOperandTypes() const
 120 {
 121     SequenceType::List result;
 122     result.append(CommonSequenceTypes::ZeroOrMoreItems);
 123     return result;
 124 }
 125
 126 ExpressionVisitorResult::Ptr
 127 NodeSortExpression::accept(const ExpressionVisitor::Ptr &visitor) const
 128 {
 129     return visitor->visit(this);
 130 }
 131
 132 Expression::Properties NodeSortExpression::properties() const
 133 {
 134     /* The reason we disable elimination is that the assert for sorting a
 135      * single node in evaluateSequence() triggers unless our compress() routine
 136      * has been run. Anyhow, it's not that we would manage to write away anyway,
 137      * since the node source in most(all?) cases prevents it.
 138      */
 139     return AffectsOrderOnly | DisableElimination;
 140 }
 141
 142 QT_END_NAMESPACE