src/xmlpatterns/expr/qtruthpredicate_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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_TruthPredicate_H
  53 #define Patternist_TruthPredicate_H
  54
  55 #include "qgenericpredicate_p.h"
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short A predicate which is optimized for filter expressions that
  65      * are of type @c xs:boolean.
  66      *
  67      * @author Frans Englich <frans.englich@nokia.com>
  68      * @ingroup Patternist_expressions
  69      */
  70     class TruthPredicate : public GenericPredicate
  71     {
  72     public:
  73         /**
  74          * Creates a TruthPredicate which filters the items from the @p sourceExpression
  75          * through @p predicate.
  76          *
  77          * This constructor is protected. The proper way to create predicates is via the static
  78          * create() function.
  79          */
  80         TruthPredicate(const Expression::Ptr &sourceExpression,
  81                        const Expression::Ptr &predicate);
  82
  83         inline Item mapToItem(const Item &item, const DynamicContext::Ptr &context) const
  84         {
  85             Q_ASSERT_X(false, Q_FUNC_INFO, "This is practically dead code because it never gets called in GenericPredicate, "
  86                                            "which binds to its own mapToItem for completely legitime reasons.");
  87             if(m_operand2->evaluateEBV(context))
  88                 return item;
  89             else
  90                 return Item();
  91         }
  92
  93         inline Item::Iterator::Ptr map(const Item &item,
  94                                        const DynamicContext::Ptr &context) const
  95         {
  96             Q_ASSERT_X(false, Q_FUNC_INFO, "I don't expect this function to be called, for the same reasons as above.");
  97             if(m_operand2->evaluateEBV(context))
  98                 return makeSingletonIterator(item);
  99             else
 100                 return CommonValues::emptyIterator;
 101         }
 102
 103         virtual SequenceType::List expectedOperandTypes() const;
 104         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 105     };
 106 }
 107
 108 QT_END_NAMESPACE
 109
 110 QT_END_HEADER
 111
 112 #endif