1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7**
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_SortTuple_H
51#define Patternist_SortTuple_H
52
53#include <private/qitem_p.h>
54#include <private/qitem_p.h>
55#include <private/qitemtype_p.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61 /**
62 * @short Represents a value and its sort keys
63 * in FLOWR's <tt>order by</tt> clause.
64 *
65 * SortTuple doesn't correspond to anything in the XPath Data Model and
66 * can therefore well be described as an exotic implementation detail.
67 * Most of its functions asserts because it makes no sense to
68 * call them.
69 *
70 * SortTuple exclusively exists for use with the expressions OrderBy and
71 * ReturnOrderBy, and acts as a carrier between those two for sort keys and
72 * source values.
73 *
74 * @ingroup Patternist_xdm
75 * @author Frans Englich <frans.englich@nokia.com>
76 */
77 class SortTuple : public AtomicValue
78 {
79 public:
80 /**
81 * @p aSortKeys may be empty.
82 */
83 inline SortTuple(const Item::Iterator::Ptr &aValue,
84 const Item::Vector &aSortKeys) : m_sortKeys(aSortKeys),
85 m_value(aValue)
86 {
87 Q_ASSERT(m_value);
88 Q_ASSERT(!m_sortKeys.isEmpty());
89 }
90
91 /**
92 * A smart pointer wrapping SortTuple instances.
93 */
94 typedef QExplicitlySharedDataPointer<SortTuple> Ptr;
95
96 /**
97 * This function is sometimes called by Literal::description().
98 * This function simply returns "SortTuple".
99 */
100 virtual QString stringValue() const;
101
102 /**
103 * @short Always asserts.
104 */
105 virtual Item::Iterator::Ptr typedValue() const;
106
107 /**
108 * @short Always asserts.
109 */
110 virtual bool isAtomicValue() const;
111
112 /**
113 * @short Always asserts.
114 */
115 virtual bool isNode() const;
116
117 /**
118 * @short Always asserts.
119 */
120 virtual bool hasError() const;
121
122 virtual ItemType::Ptr type() const;
123
124 inline const Item::Vector &sortKeys() const
125 {
126 return m_sortKeys;
127 }
128
129 inline const Item::Iterator::Ptr &value() const
130 {
131 return m_value;
132 }
133
134 private:
135 const Item::Vector m_sortKeys;
136 const Item::Iterator::Ptr m_value;
137 };
138}
139
140QT_END_NAMESPACE
141
142#endif
143

source code of qtxmlpatterns/src/xmlpatterns/data/qsorttuple_p.h