src/xmlpatterns/expr/qnodesort_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_NodeSortExpression_H
  53 #define Patternist_NodeSortExpression_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short De-duplicates and sorts in document order the content that its
  65      * operand returns.
  66      *
  67      * @author Frans Englich <frans.englich@nokia.com>
  68      * @ingroup Patternist_expressions
  69      */
  70     class NodeSortExpression : public SingleContainer
  71     {
  72     public:
  73         NodeSortExpression(const Expression::Ptr &operand);
  74
  75         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  76         virtual SequenceType::Ptr staticType() const;
  77         virtual SequenceType::List expectedOperandTypes() const;
  78         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  79         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  80         virtual Properties properties() const;
  81
  82         /**
  83          * Ensures that result delivered from @p operand, is in document order.
  84          */
  85         static Expression::Ptr wrapAround(const Expression::Ptr &operand,
  86                                           const StaticContext::Ptr &context);
  87
  88     private:
  89         static inline bool lessThanUsingNodeModel(const Item &n1,
  90                                                   const Item &n2);
  91     };
  92 }
  93
  94 QT_END_NAMESPACE
  95
  96 QT_END_HEADER
  97
  98 #endif