1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 //
43 //  W A R N I N G
44 //  -------------
45 //
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.
49 //
50 // We mean it.
51 
52 #ifndef Patternist_SortTuple_H
53 #define Patternist_SortTuple_H
54 
55 #include "qitem_p.h"
56 #include "qitem_p.h"
57 #include "qitemtype_p.h"
58 
59 QT_BEGIN_HEADER
60 
61 QT_BEGIN_NAMESPACE
62 
63 namespace QPatternist
64 {
65     /**
66      * @short Represents a value and its sort keys
67      * in FLOWR's <tt>order by</tt> clause.
68      *
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
72      * call them.
73      *
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
76      * source values.
77      *
78      * @ingroup Patternist_xdm
79      * @author Frans Englich <frans.englich@nokia.com>
80      */
81     class SortTuple : public AtomicValue
82     {
83     public:
84         /**
85          * @p aSortKeys may be empty.
86          */
SortTuple(const Item::Iterator::Ptr & aValue,const Item::Vector & aSortKeys)87         inline SortTuple(const Item::Iterator::Ptr &aValue,
88                          const Item::Vector &aSortKeys) : m_sortKeys(aSortKeys),
89                                                           m_value(aValue)
90         {
91             Q_ASSERT(m_value);
92             Q_ASSERT(!m_sortKeys.isEmpty());
93         }
94 
95         /**
96          * A smart pointer wrapping SortTuple instances.
97          */
98         typedef QExplicitlySharedDataPointer<SortTuple> Ptr;
99 
100         /**
101          * This function is sometimes called by Literal::description().
102          * This function simply returns "SortTuple".
103          */
104         virtual QString stringValue() const;
105 
106         /**
107          * @short Always asserts.
108          */
109         virtual Item::Iterator::Ptr typedValue() const;
110 
111         /**
112          * @short Always asserts.
113          */
114         virtual bool isAtomicValue() const;
115 
116         /**
117          * @short Always asserts.
118          */
119         virtual bool isNode() const;
120 
121         /**
122          * @short Always asserts.
123          */
124         virtual bool hasError() const;
125 
126         virtual ItemType::Ptr type() const;
127 
sortKeys()128         inline const Item::Vector &sortKeys() const
129         {
130             return m_sortKeys;
131         }
132 
value()133         inline const Item::Iterator::Ptr &value() const
134         {
135             return m_value;
136         }
137 
138     private:
139         const Item::Vector          m_sortKeys;
140         const Item::Iterator::Ptr   m_value;
141     };
142 }
143 
144 QT_END_NAMESPACE
145 
146 QT_END_HEADER
147 
148 #endif
149