src/xmlpatterns/data/qinteger_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_Integer_H
  53 #define Patternist_Integer_H
  54
  55 #include <private/qschemanumeric_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Implements the value instance of the @c xs:integer type.
  65      *
  66      * @author Frans Englich <frans.englich@nokia.com>
  67      * @ingroup Patternist_xdm
  68      * @todo Documentation is missing
  69      */
  70     class Integer : public Numeric
  71     {
  72     public:
  73
  74         typedef Numeric::Ptr Ptr;
  75
  76         /**
  77          * Constructs an instance from the lexical
  78          * representation @p strNumeric.
  79          *
  80          * @todo Type error handling.
  81          */
  82         static AtomicValue::Ptr fromLexical(const QString &strNumeric);
  83
  84         static Item fromValue(const xsInteger num);
  85
  86         /**
  87          * Determines the Effective %Boolean Value of this number.
  88          *
  89          * @returns @c false if the number is 0, otherwise @c true.
  90          */
  91         bool evaluateEBV(const QExplicitlySharedDataPointer<DynamicContext> &) const;
  92
  93         virtual QString stringValue() const;
  94
  95         /**
  96          * @returns always BuiltinTypes::xsInteger
  97          */
  98         virtual ItemType::Ptr type() const;
  99
 100         virtual xsDouble toDouble() const;
 101         virtual xsInteger toInteger() const;
 102         virtual xsFloat toFloat() const;
 103         virtual xsDecimal toDecimal() const;
 104
 105         virtual Numeric::Ptr round() const;
 106         virtual Numeric::Ptr roundHalfToEven(const xsInteger scale) const;
 107         virtual Numeric::Ptr floor() const;
 108         virtual Numeric::Ptr ceiling() const;
 109         virtual Numeric::Ptr abs() const;
 110         virtual qulonglong toUnsignedInteger() const;
 111
 112         /**
 113          * @returns always @c false, @c xs:integer doesn't have
 114          * not-a-number in its value space.
 115          */
 116         virtual bool isNaN() const;
 117
 118         /**
 119          * @returns always @c false, @c xs:integer doesn't have
 120          * infinity in its value space.
 121          */
 122         virtual bool isInf() const;
 123         virtual Item toNegated() const;
 124
 125         /**
 126          * @short Returns always @c true.
 127          */
 128         virtual bool isSigned() const;
 129     protected:
 130         Integer(const xsInteger num);
 131
 132     private:
 133         const xsInteger m_value;
 134     };
 135 }
 136
 137 QT_END_NAMESPACE
 138
 139 QT_END_HEADER
 140
 141 #endif