1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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.
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.
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.
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.
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_SortTuple_H
53 #define Patternist_SortTuple_H
57 #include "qitemtype_p.h"
66 * @short Represents a value and its sort keys
67 * in FLOWR's <tt>order by</tt> clause.
69 * SortTuple doesn't correspond to anything in the XPath Data Model and
70 * can therefore well be described as an exotic implementation detail.
71 * Most of its functions asserts because it makes no sense to
74 * SortTuple exclusively exists for use with the expressions OrderBy and
75 * ReturnOrderBy, and acts as a carrier between those two for sort keys and
78 * @ingroup Patternist_xdm
79 * @author Frans Englich <frans.englich@nokia.com>
81 class SortTuple : public AtomicValue
85 * @p aSortKeys may be empty.
87 inline SortTuple(const Item::Iterator::Ptr &aValue,
88 const Item::Vector &aSortKeys) : m_sortKeys(aSortKeys),
92 Q_ASSERT(!m_sortKeys.isEmpty());
96 * A smart pointer wrapping SortTuple instances.
98 typedef QExplicitlySharedDataPointer<SortTuple> Ptr;
101 * This function is sometimes called by Literal::description().
102 * This function simply returns "SortTuple".
104 virtual QString stringValue() const;
107 * @short Always asserts.
109 virtual Item::Iterator::Ptr typedValue() const;
112 * @short Always asserts.
114 virtual bool isAtomicValue() const;
117 * @short Always asserts.
119 virtual bool isNode() const;
122 * @short Always asserts.
124 virtual bool hasError() const;
126 virtual ItemType::Ptr type() const;
128 inline const Item::Vector &sortKeys() const
133 inline const Item::Iterator::Ptr &value() const
139 const Item::Vector m_sortKeys;
140 const Item::Iterator::Ptr m_value;