src/xmlpatterns/data/qsorttuple_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  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 <private/qitem_p.h>
  56 #include <private/qitem_p.h>
  57 #include <private/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          */
  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
 128         inline const Item::Vector &sortKeys() const
 129         {
 130             return m_sortKeys;
 131         }
 132
 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