src/xmlpatterns/data/qatomicmathematician_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_AtomicMathematician_H
  53 #define Patternist_AtomicMathematician_H
  54
  55 #include <QFlags>
  56
  57 #include <private/qdynamiccontext_p.h>
  58 #include <private/qitem_p.h>
  59 #include <private/qatomictypedispatch_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 namespace QPatternist
  66 {
  67     /**
  68      * @short Base class for classes that performs arithmetic operations between atomic values.
  69      *
  70      * @ingroup Patternist_xdm
  71      * @author Frans Englich <frans.englich@nokia.com>
  72      */
  73     class Q_AUTOTEST_EXPORT AtomicMathematician : public AtomicTypeVisitorResult
  74     {
  75     public:
  76         virtual ~AtomicMathematician();
  77
  78         typedef QExplicitlySharedDataPointer<AtomicMathematician> Ptr;
  79
  80         enum Operator
  81         {
  82             /**
  83              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-divide">XQuery 1.0
  84              * and XPath 2.0 Functions and Operators, 6.2.4 op:numeric-divide</a>
  85              */
  86             Div         = 1,
  87
  88             /**
  89              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-integer-divide">XQuery 1.0
  90              * and XPath 2.0 Functions and Operators, 6.2.5 op:numeric-integer-divide</a>
  91              */
  92             IDiv        = 2,
  93
  94             /**
  95              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-subtract">XQuery 1.0
  96              * and XPath 2.0 Functions and Operators, 6.2.2 op:numeric-subtract</a>
  97              */
  98             Substract   = 4,
  99
 100             /**
 101              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-mod">XQuery 1.0
 102              * and XPath 2.0 Functions and Operators, 6.2.6 op:numeric-mod</a>
 103              */
 104             Mod         = 8,
 105
 106             /**
 107              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-multiply">XQuery 1.0
 108              * and XPath 2.0 Functions and Operators, 6.2.3 op:numeric-multiply</a>
 109              */
 110             Multiply    = 16,
 111
 112             /**
 113              * @see <a href="http://www.w3.org/TR/xpath-functions/#func-numeric-add">XQuery 1.0
 114              * and XPath 2.0 Functions and Operators, 6.2.1 op:numeric-add</a>
 115              */
 116             Add         = 32
 117         };
 118
 119         typedef QFlags<Operator> Operators;
 120
 121         virtual Item calculate(const Item &operand1,
 122                                     const Operator op,
 123                                     const Item &operand2,
 124                                     const QExplicitlySharedDataPointer<DynamicContext> &context) const = 0;
 125
 126         static QString displayName(const AtomicMathematician::Operator op);
 127
 128     };
 129     Q_DECLARE_OPERATORS_FOR_FLAGS(AtomicMathematician::Operators)
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif