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