src/xmlpatterns/data/qabstractfloat_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_AbstractFloat_H
  53 #define Patternist_AbstractFloat_H
  54
  55 #include <math.h>
  56
  57 #include <qnumeric.h>
  58
  59 #include <private/qcommonvalues_p.h>
  60 #include <private/qdecimal_p.h>
  61 #include <private/qschemanumeric_p.h>
  62 #include <private/qvalidationerror_p.h>
  63 #include <private/qbuiltintypes_p.h>
  64
  65 QT_BEGIN_HEADER
  66
  67 QT_BEGIN_NAMESPACE
  68
  69 namespace QPatternist
  70 {
  71     /**
  72      * @short Base template class for Float and Double classes.
  73      *
  74      * @author Vincent Ricard <magic@magicninja.org>
  75      * @ingroup Patternist_xdm
  76      */
  77     template <const bool isDouble>
  78     class AbstractFloat : public Numeric
  79     {
  80     public:
  81         static Numeric::Ptr fromValue(const xsDouble num);
  82         static AtomicValue::Ptr fromLexical(const QString &strNumeric);
  83
  84         /**
  85          * @todo more extensive docs.
  86          *
  87          * Performs floating point comparison.
  88          *
  89          * @returns @c true if @p a and @p are equal, otherwise @c false.
  90          */
  91         static bool isEqual(const xsDouble a, const xsDouble b);
  92
  93         /**
  94          * Determines the Effective %Boolean Value of this number.
  95          *
  96          * @returns @c false if the number is 0 or @c NaN, otherwise @c true.
  97          */
  98         bool evaluateEBV(const QExplicitlySharedDataPointer<DynamicContext> &) const;
  99
 100         /**
 101          * Returns this AbstractFloat represented as an @c xs:string.
 102          *
 103          * @note In the XPath/XQuery languages, converting @c xs:double and @c xs:float
 104          * to @c xs:string is not specified in XML Schema 1.0 Part 2: Datatypes Second Edition,
 105          * but in XQuery 1.0 and XPath 2.0 Functions and Operators. This will change with W3C XML
 106          * Schema 1.1
 107          *
 108          * @see <a href="http://www.w3.org/TR/xpath-functions/#casting-to-string">XQuery 1.0
 109          * and XPath 2.0 Functions and Operators, 17.1.2 Casting to xs:string and xdt:untypedAtomic</a>
 110          */
 111         virtual QString stringValue() const;
 112
 113         virtual xsDouble toDouble() const;
 114         virtual xsInteger toInteger() const;
 115         virtual xsFloat toFloat() const;
 116         virtual xsDecimal toDecimal() const;
 117
 118         virtual Numeric::Ptr round() const;
 119         virtual Numeric::Ptr roundHalfToEven(const xsInteger scale) const;
 120         virtual Numeric::Ptr floor() const;
 121         virtual Numeric::Ptr ceiling() const;
 122         virtual Numeric::Ptr abs() const;
 123
 124         virtual bool isNaN() const;
 125         virtual bool isInf() const;
 126
 127         virtual ItemType::Ptr type() const;
 128         virtual Item toNegated() const;
 129         virtual qulonglong toUnsignedInteger() const;
 130
 131         virtual bool isSigned() const;
 132     protected:
 133         AbstractFloat(const xsDouble num);
 134
 135     private:
 136         /**
 137          * From the Open Group's man page: "The signbit() macro shall return a
 138          * non-zero value if and only if the sign of its argument value is
 139          * negative."
 140          *
 141          * MS Windows doesn't have std::signbit() so here's
 142          * a reinvention of that function.
 143          */
 144         static inline int internalSignbit(const xsDouble v);
 145         inline bool isZero() const;
 146
 147         const xsDouble m_value;
 148     };
 149
 150     template <const bool isDouble>
 151     Numeric::Ptr createFloat(const xsDouble num);
 152
 153 #include "qabstractfloat_tpl_p.h"
 154
 155     /**
 156      * @short An instantiation of AbsbstractFloat suitable for @c xs:double.
 157      *
 158      * @ingroup Patternist_xdm
 159      */
 160     typedef AbstractFloat<true> Double;
 161
 162     /**
 163      * @short An instantiation of AbstractFloat suitable for @c xs:float.
 164      *
 165      * @ingroup Patternist_xdm
 166      */
 167     typedef AbstractFloat<false> Float;
 168 }
 169
 170 QT_END_NAMESPACE
 171
 172 QT_END_HEADER
 173
 174 #endif