src/xmlpatterns/expr/qorderby_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/expr/qorderby_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,183 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** 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, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $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_OrderBy_H
+#define Patternist_OrderBy_H
+
+#include "qatomiccomparator_p.h"
+#include "qcomparisonplatform_p.h"
+#include "qsinglecontainer_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    class ReturnOrderBy;
+
+    /**
+     * @short Performs the sorting by being a parent to ForClause.
+     *
+     * The child of the ForClause is a ReturnOrderBy expression, which collects
+     * the sort keys and values.
+     *
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_expressions
+     */
+    class OrderBy : public SingleContainer
+    {
+    public:
+        enum Stability
+        {
+            StableOrder,
+            UnstableOrder
+        };
+
+        /**
+         * This class is value based.
+         */
+        class OrderSpec : public ComparisonPlatform<OrderBy::OrderSpec,
+                                                    true, /* Yes, issue errors. */
+                                                    AtomicComparator::AsValueComparison>
+        {
+        public:
+            /**
+             * We want this guy to be public.
+             */
+            using ComparisonPlatform<OrderBy::OrderSpec, true, AtomicComparator::AsValueComparison>::detailedFlexibleCompare;
+
+            typedef QVector<OrderSpec> Vector;
+
+            enum Direction
+            {
+                Ascending,
+                Descending
+            };
+
+            /**
+             * @short Default constructor, which is needed by QVector.
+             */
+            inline OrderSpec()
+            {
+            }
+
+            inline OrderSpec(const Direction dir,
+                             const StaticContext::OrderingEmptySequence orderingEmpty) : direction(dir),
+                                                                                         orderingEmptySequence(orderingEmpty)
+            {
+            }
+
+            void prepare(const Expression::Ptr &source,
+                         const StaticContext::Ptr &context);
+
+            const SourceLocationReflection *actualReflection() const
+            {
+                return m_expr.data();
+            }
+
+        private:
+            Expression::Ptr m_expr;
+
+        public:
+            /**
+             * We place these afterwards, such that m_expr gets aligned at the
+             * start of the address.
+             */
+            Direction direction;
+
+            StaticContext::OrderingEmptySequence orderingEmptySequence;
+
+            inline AtomicComparator::Operator operatorID() const
+            {
+                return orderingEmptySequence == StaticContext::Least ? AtomicComparator::OperatorLessThanNaNLeast
+                                                                     : AtomicComparator::OperatorLessThanNaNGreatest;
+            }
+
+        };
+
+        OrderBy(const Stability stability,
+                const OrderSpec::Vector &orderSpecs,
+                const Expression::Ptr &operand,
+                ReturnOrderBy *const returnOrderBy);
+
+        virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
+        virtual SequenceType::Ptr staticType() const;
+        virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
+                                          const SequenceType::Ptr &reqType);
+        virtual Expression::Ptr compress(const StaticContext::Ptr &context);
+        virtual SequenceType::List expectedOperandTypes() const;
+        virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
+
+        inline Item::Iterator::Ptr mapToSequence(const Item &i,
+                                                 const DynamicContext::Ptr &context) const;
+        virtual Properties properties() const;
+
+    private:
+        /**
+         * Needed when calling makeSequenceMappingIterator().
+         */
+        typedef QExplicitlySharedDataPointer<const OrderBy> ConstPtr;
+
+        const Stability             m_stability;
+        OrderSpec::Vector           m_orderSpecs;
+        ReturnOrderBy *const        m_returnOrderBy;
+    };
+
+    /* TODO Q_DECLARE_TYPEINFO(OrderBy::OrderSpec, Q_MOVABLE_TYPE); Breaks,
+     * probably because it's nested. */
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif