src/xmlpatterns/expr/qtruthpredicate_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_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