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 ****************************************************************************/
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.
52 #ifndef Patternist_ReturnOrderBy_H
53 #define Patternist_ReturnOrderBy_H
55 #include <private/qorderby_p.h>
56 #include <private/qunlimitedcontainer_p.h>
65 * @short Together with OrderBy, it implements XQuery 1.0's <tt>order by</tt> expression.
67 * ReturnOrderBy evaluates the sort keys and values, and hands it over to
68 * OrderBy, which is an AST ancestor, using SortTuples.
70 * @author Frans Englich <frans.englich@nokia.com>
71 * @ingroup Patternist_expressions
73 class ReturnOrderBy : public UnlimitedContainer
77 * In @p operands the first item is the return expression, and the
78 * rest, which is at least one, are the sort keys.
80 ReturnOrderBy(const OrderBy::Stability stability,
81 const OrderBy::OrderSpec::Vector &oSpecs,
82 const Expression::List &operands);
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;
92 inline OrderBy::OrderSpec::Vector orderSpecs() const
97 inline OrderBy::Stability stability() const
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.
109 inline void setStay(const bool a)
114 virtual Properties properties() const;
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.
121 const OrderBy::Stability m_stability;
123 OrderBy::OrderSpec::Vector m_orderSpecs;