1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
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_NumericType_H
53 #define Patternist_NumericType_H
54 
55 #include "qatomictype_p.h"
56 
57 QT_BEGIN_HEADER
58 
59 QT_BEGIN_NAMESPACE
60 
61 namespace QPatternist
62 {
63     /**
64      * @short Represents the internal and abstract type @c fs:numeric.
65      *
66      * @see <a href="http://www.w3.org/TR/xquery-semantics/#dt-fs_numeric">XQuery 1.0
67      * and XPath 2.0 Formal Semantics, Definition: fs:numeric</a>
68      * @ingroup Patternist_types
69      * @author Frans Englich <frans.englich@nokia.com>
70      */
71     class NumericType : public AtomicType
72     {
73     public:
74         virtual ~NumericType();
75 
76         virtual bool itemMatches(const Item &item) const;
77         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
78 
79         /**
80          * @returns always "numeric". That is, no namespace prefix
81          */
82         virtual QString displayName(const NamePool::Ptr &np) const;
83 
84         /**
85          * @returns always @c true
86          */
87         virtual bool isAbstract() const;
88 
89         /**
90          * @returns always @c false
91          */
92         virtual bool isNodeType() const;
93 
94         /**
95          * @returns always @c true
96          */
97         virtual bool isAtomicType() const;
98 
99         /**
100          * @returns always xs:anyAtomicType
101          */
102         virtual SchemaType::Ptr wxsSuperType() const;
103 
104         /**
105          * @returns always xs:anyAtomicType
106          */
107         virtual ItemType::Ptr xdtSuperType() const;
108 
109         /**
110          * @returns @c null. It makes no sense to atomize the abstract type @c fs:numeric.
111          */
112         virtual ItemType::Ptr atomizedType() const;
113 
114         /**
115          * NumericType cannot be visited. This function is only implemented
116          * to satisfy the abstract super class's interface.
117          *
118          * @returns always a @c null pointer
119          */
120         virtual AtomicTypeVisitorResult::Ptr accept(const AtomicTypeVisitor::Ptr &visitor,
121                                                     const SourceLocationReflection *const) const;
122 
123         /**
124          * NumericType cannot be visited. This function is only implemented
125          * to satisfy the abstract super class's interface.
126          *
127          * @returns always a @c null pointer
128          */
129         virtual AtomicTypeVisitorResult::Ptr accept(const ParameterizedAtomicTypeVisitor::Ptr &visitor,
130                                                     const qint16 op,
131                                                     const SourceLocationReflection *const) const;
132 
133         /**
134          * The type @c fs:numeric is an abstract type which therefore
135          * cannot be involved in comparisons. Hence, this function returns
136          * @c null. This function is only implemented to satisfy the abstract
137          * super class's interface.
138          *
139          * @returns always a @c null pointer
140          */
141         virtual AtomicComparatorLocator::Ptr comparatorLocator() const;
142 
143         /**
144          * The type @c fs:numeric is an abstract type which therefore
145          * cannot be involved in arithmetics. Hence, this function returns
146          * @c null. This function is only implemented to satisfy the abstract
147          * super class's interface.
148          *
149          * @returns always a @c null pointer
150          */
151         virtual AtomicMathematicianLocator::Ptr mathematicianLocator() const;
152 
153 
154         /**
155          * The type @c fs:numeric is an abstract type which therefore
156          * cannot be involved in casting. Hence, this function returns
157          * @c null. This function is only implemented to satisfy the abstract
158          * super class's interface.
159          *
160          * @returns always a @c null pointer
161          */
162         virtual AtomicCasterLocator::Ptr casterLocator() const;
163 
164     protected:
165         friend class BuiltinTypes;
166         NumericType();
167     };
168 }
169 
170 QT_END_NAMESPACE
171 
172 QT_END_HEADER
173 
174 #endif
175