1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #include "qcommonsequencetypes_p.h"
43 #include "qdeduplicateiterator_p.h"
44 #include "qnodesort_p.h"
48 using namespace QPatternist;
50 NodeSortExpression::NodeSortExpression(const Expression::Ptr &op) : SingleContainer(op)
54 bool NodeSortExpression::lessThanUsingNodeModel(const Item &n1,
57 Q_ASSERT(n1.isNode());
58 Q_ASSERT(n2.isNode());
60 if(n1.asNode().model() == n2.asNode().model())
61 return n1.asNode().compareOrder(n2.asNode()) == QXmlNodeModelIndex::Precedes;
64 /* The two nodes are from different trees. The sort order is implementation
65 * defined, but it must be stable.
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;
73 Item::Iterator::Ptr NodeSortExpression::evaluateSequence(const DynamicContext::Ptr &context) const
75 Q_ASSERT_X(m_operand->staticType()->cardinality().allowsMany(), Q_FUNC_INFO,
76 "It makes no sense to sort a single node.");
78 Item::List nodes(m_operand->evaluateSequence(context)->toList());
81 return CommonValues::emptyIterator;
82 else if(nodes.first().isAtomicValue())
83 return makeListIterator(nodes);
86 qSort(nodes.begin(), nodes.end(), lessThanUsingNodeModel);
88 return Item::Iterator::Ptr(new DeduplicateIterator(nodes));
92 Expression::Ptr NodeSortExpression::wrapAround(const Expression::Ptr &operand,
93 const StaticContext::Ptr &context)
98 const Expression::Ptr sort(new NodeSortExpression(operand));
99 context->wrapExpressionWith(operand.data(), sort);
103 Expression::Ptr NodeSortExpression::compress(const StaticContext::Ptr &context)
105 const Expression::Ptr me(SingleContainer::compress(context));
107 /* It make no sense to sort & deduplicate a single node. */
108 if(m_operand->staticType()->cardinality().allowsMany())
114 SequenceType::Ptr NodeSortExpression::staticType() const
116 return m_operand->staticType();
119 SequenceType::List NodeSortExpression::expectedOperandTypes() const
121 SequenceType::List result;
122 result.append(CommonSequenceTypes::ZeroOrMoreItems);
126 ExpressionVisitorResult::Ptr
127 NodeSortExpression::accept(const ExpressionVisitor::Ptr &visitor) const
129 return visitor->visit(this);
132 Expression::Properties NodeSortExpression::properties() const
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.
139 return AffectsOrderOnly | DisableElimination;