src/xmlpatterns/expr/qgenericpredicate_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_GenericPredicate_H
  53 #define Patternist_GenericPredicate_H
  54
  55 #include <private/qpaircontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short A predicate that can handle all kinds of predicates and
  65      * is therefore not very efficient, but can cope with all the tricky scenarios.
  66      *
  67      * @see FirstItemPredicate
  68      * @see TruthPredicate
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      * @ingroup Patternist_expressions
  71      */
  72     class GenericPredicate : public PairContainer
  73     {
  74     public:
  75
  76         /**
  77          * Creates a predicate expression that filters the items gained
  78          * from evaluating @p sourceExpression through the filter @p predicateExpression.
  79          *
  80          * This function performs type analyzis on the passed expressions, and may
  81          * return more specialized expressions depending on the analyzis.
  82          *
  83          * If @p predicateExpression is an invalid predicate, an error is issued
  84          * via the @p context.
  85          */
  86         static Expression::Ptr create(const Expression::Ptr &sourceExpression,
  87                                       const Expression::Ptr &predicateExpression,
  88                                       const StaticContext::Ptr &context,
  89                                       const QSourceLocation &location);
  90
  91         static Expression::Ptr createFirstItem(const Expression::Ptr &sourceExpression);
  92
  93         /**
  94          * Creates a source iterator which is passed to the ItemMappingIterator
  95          * and the Focus. The ItemMappingIterator modifies it with
  96          * its QAbstractXmlForwardIterator::next() calls, and since the Focus references the same QAbstractXmlForwardIterator,
  97          * the focus is automatically moved.
  98          */
  99         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
 100
 101         /**
 102          * Doesn't return the first item from calling evaluateSequence(), but does the mapping
 103          * manually. This avoid allocating an ItemMappingIterator.
 104          */
 105         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 106
 107         inline Item mapToItem(const Item &subject,
 108                                    const DynamicContext::Ptr &) const;
 109
 110         virtual SequenceType::List expectedOperandTypes() const;
 111         virtual SequenceType::Ptr staticType() const;
 112         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 113         virtual ID id() const;
 114
 115         /**
 116          * @returns always CreatesFocusForLast.
 117          */
 118         virtual Properties properties() const;
 119
 120         virtual QString description() const;
 121
 122     protected:
 123
 124         /**
 125          * Creates a GenericPredicate which filters the items from the @p sourceExpression
 126          * through @p predicate.
 127          *
 128          * This constructor is protected. The proper way to create predicates is via the static
 129          * create() function.
 130          */
 131         GenericPredicate(const Expression::Ptr &sourceExpression,
 132                          const Expression::Ptr &predicate);
 133
 134         /**
 135          * @returns the ItemType of the first operand's staticType().
 136          */
 137         virtual ItemType::Ptr newFocusType() const;
 138
 139     private:
 140         typedef QExplicitlySharedDataPointer<const GenericPredicate> ConstPtr;
 141     };
 142 }
 143
 144 QT_END_NAMESPACE
 145
 146 QT_END_HEADER
 147
 148 #endif