src/xmlpatterns/expr/qorderby_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_OrderBy_H
  53 #define Patternist_OrderBy_H
  54
  55 #include <private/qatomiccomparator_p.h>
  56 #include <private/qcomparisonplatform_p.h>
  57 #include <private/qsinglecontainer_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     class ReturnOrderBy;
  66
  67     /**
  68      * @short Performs the sorting by being a parent to ForClause.
  69      *
  70      * The child of the ForClause is a ReturnOrderBy expression, which collects
  71      * the sort keys and values.
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      * @ingroup Patternist_expressions
  75      */
  76     class OrderBy : public SingleContainer
  77     {
  78     public:
  79         enum Stability
  80         {
  81             StableOrder,
  82             UnstableOrder
  83         };
  84
  85         /**
  86          * This class is value based.
  87          */
  88         class OrderSpec : public ComparisonPlatform<OrderBy::OrderSpec,
  89                                                     true, /* Yes, issue errors. */
  90                                                     AtomicComparator::AsValueComparison>
  91         {
  92         public:
  93             /**
  94              * We want this guy to be public.
  95              */
  96             using ComparisonPlatform<OrderBy::OrderSpec, true, AtomicComparator::AsValueComparison>::detailedFlexibleCompare;
  97
  98             typedef QVector<OrderSpec> Vector;
  99
 100             enum Direction
 101             {
 102                 Ascending,
 103                 Descending
 104             };
 105
 106             /**
 107              * @short Default constructor, which is needed by QVector.
 108              */
 109             inline OrderSpec()
 110             {
 111             }
 112
 113             inline OrderSpec(const Direction dir,
 114                              const StaticContext::OrderingEmptySequence orderingEmpty) : direction(dir),
 115                                                                                          orderingEmptySequence(orderingEmpty)
 116             {
 117             }
 118
 119             void prepare(const Expression::Ptr &source,
 120                          const StaticContext::Ptr &context);
 121
 122             const SourceLocationReflection *actualReflection() const
 123             {
 124                 return m_expr.data();
 125             }
 126
 127         private:
 128             Expression::Ptr m_expr;
 129
 130         public:
 131             /**
 132              * We place these afterwards, such that m_expr gets aligned at the
 133              * start of the address.
 134              */
 135             Direction direction;
 136
 137             StaticContext::OrderingEmptySequence orderingEmptySequence;
 138
 139             inline AtomicComparator::Operator operatorID() const
 140             {
 141                 return orderingEmptySequence == StaticContext::Least ? AtomicComparator::OperatorLessThanNaNLeast
 142                                                                      : AtomicComparator::OperatorLessThanNaNGreatest;
 143             }
 144
 145         };
 146
 147         OrderBy(const Stability stability,
 148                 const OrderSpec::Vector &orderSpecs,
 149                 const Expression::Ptr &operand,
 150                 ReturnOrderBy *const returnOrderBy);
 151
 152         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
 153         virtual SequenceType::Ptr staticType() const;
 154         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
 155                                           const SequenceType::Ptr &reqType);
 156         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
 157         virtual SequenceType::List expectedOperandTypes() const;
 158         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 159
 160         inline Item::Iterator::Ptr mapToSequence(const Item &i,
 161                                                  const DynamicContext::Ptr &context) const;
 162         virtual Properties properties() const;
 163
 164     private:
 165         /**
 166          * Needed when calling makeSequenceMappingIterator().
 167          */
 168         typedef QExplicitlySharedDataPointer<const OrderBy> ConstPtr;
 169
 170         const Stability             m_stability;
 171         OrderSpec::Vector           m_orderSpecs;
 172         ReturnOrderBy *const        m_returnOrderBy;
 173     };
 174
 175     /* TODO Q_DECLARE_TYPEINFO(OrderBy::OrderSpec, Q_MOVABLE_TYPE); Breaks,
 176      * probably because it's nested. */
 177 }
 178
 179 QT_END_NAMESPACE
 180
 181 QT_END_HEADER
 182
 183 #endif