src/xmlpatterns/functions/qnumericfns_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_NumericFNs_H
  53 #define Patternist_NumericFNs_H
  54
  55 #include <private/qaggregator_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/#numeric-value-functions">XQuery 1.0 and
  61  * XPath 2.0 Functions and Operators, 6.4 Functions on Numeric 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:floor()</tt>.
  75      *
  76      * @ingroup Patternist_functions
  77      * @author Frans Englich <frans.englich@nokia.com>
  78      */
  79     class FloorFN : public Aggregator
  80     {
  81     public:
  82         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  83     };
  84
  85     /**
  86      * @short Implements the function <tt>fn:abs()</tt>.
  87      *
  88      * @ingroup Patternist_functions
  89      * @author Frans Englich <frans.englich@nokia.com>
  90      */
  91     class AbsFN : public Aggregator
  92     {
  93     public:
  94         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  95     };
  96
  97     /**
  98      * @short Implements the function <tt>fn:round()</tt>.
  99      *
 100      * @ingroup Patternist_functions
 101      * @author Frans Englich <frans.englich@nokia.com>
 102      */
 103     class RoundFN : public Aggregator
 104     {
 105     public:
 106         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 107     };
 108
 109     /**
 110      * @short Implements the function <tt>fn:ceiling()</tt>.
 111      *
 112      * @ingroup Patternist_functions
 113      * @author Frans Englich <frans.englich@nokia.com>
 114      */
 115     class CeilingFN : public Aggregator
 116     {
 117     public:
 118         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 119     };
 120
 121     /**
 122      * @short Implements the function <tt>fn:round-half-to-even()</tt>.
 123      *
 124      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-round-half-to-even">XQuery 1.0
 125      * and XPath 2.0 Functions and Operators, 6.4.5 fn:round-half-to-even</a>
 126      * @ingroup Patternist_functions
 127      * @author Frans Englich <frans.englich@nokia.com>
 128      */
 129     class RoundHalfToEvenFN : public Aggregator
 130     {
 131     public:
 132         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
 133     };
 134 }
 135
 136 QT_END_NAMESPACE
 137
 138 QT_END_HEADER
 139
 140 #endif