src/xmlpatterns/expr/qorderby_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    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 "qatomiccomparator_p.h"
       
    56 #include "qcomparisonplatform_p.h"
       
    57 #include "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