src/xmlpatterns/functions/qbooleanfns_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 ** 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_BooleanFNs_H
  53 #define Patternist_BooleanFNs_H
  54
  55 #include "qfunctioncall_p.h"
  56
  57 /**
  58  * @file
  59  * @short Contains classes implementing the functions found in
  60  * <a href="http://www.w3.org/TR/xpath-functions/#boolean-functions">XQuery 1.0 and
  61  * XPath 2.0 Functions and Operators, 9 Functions and Operators on Boolean Values</a>.
  62  *
  63  * @ingroup Patternist_functions
  64  */
  65
  66 QT_BEGIN_HEADER
  67
  68 QT_BEGIN_NAMESPACE
  69
  70 namespace QPatternist
  71 {
  72
  73     /**
  74      * @short Implements the function <tt>fn:true()</tt>.
  75      *
  76      * The implementation always rewrites itself to a boolean value at compile time.
  77      *
  78      * @ingroup Patternist_functions
  79      * @author Frans Englich <frans.englich@nokia.com>
  80      */
  81     class TrueFN : public FunctionCall
  82     {
  83     public:
  84         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  85     };
  86
  87     /**
  88      * @short Implements the function <tt>fn:false()</tt>.
  89      *
  90      * The implementation always rewrites itself to a boolean value at compile time.
  91      *
  92      * @ingroup Patternist_functions
  93      * @author Frans Englich <frans.englich@nokia.com>
  94      */
  95     class FalseFN : public FunctionCall
  96     {
  97     public:
  98         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  99     };
 100
 101     /**
 102      * @short Implements the function <tt>fn:not()</tt>.
 103      *
 104      * @ingroup Patternist_functions
 105      * @author Frans Englich <frans.englich@nokia.com>
 106      */
 107     class NotFN : public FunctionCall
 108     {
 109     public:
 110         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
 111         virtual QList<QExplicitlySharedDataPointer<OptimizationPass> > optimizationPasses() const;
 112     };
 113 }
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif