1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://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 https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 //
41 //  W A R N I N G
42 //  -------------
43 //
44 // This file is not part of the Qt API.  It exists purely as an
45 // implementation detail.  This header file may change from version to
46 // version without notice, or even be removed.
47 //
48 // We mean it.
49 
50 #ifndef Patternist_NumericType_H
51 #define Patternist_NumericType_H
52 
53 #include <private/qatomictype_p.h>
54 
55 QT_BEGIN_NAMESPACE
56 
57 namespace QPatternist
58 {
59     /**
60      * @short Represents the internal and abstract type @c fs:numeric.
61      *
62      * @see <a href="http://www.w3.org/TR/xquery-semantics/#dt-fs_numeric">XQuery 1.0
63      * and XPath 2.0 Formal Semantics, Definition: fs:numeric</a>
64      * @ingroup Patternist_types
65      * @author Frans Englich <frans.englich@nokia.com>
66      */
67     class NumericType : public AtomicType
68     {
69     public:
70         virtual ~NumericType();
71 
72         bool itemMatches(const Item &item) const override;
73         bool xdtTypeMatches(const ItemType::Ptr &other) const override;
74 
75         /**
76          * @returns always "numeric". That is, no namespace prefix
77          */
78         QString displayName(const NamePool::Ptr &np) const override;
79 
80         /**
81          * @returns always @c true
82          */
83         bool isAbstract() const override;
84 
85         /**
86          * @returns always @c false
87          */
88         bool isNodeType() const override;
89 
90         /**
91          * @returns always @c true
92          */
93         bool isAtomicType() const override;
94 
95         /**
96          * @returns always xs:anyAtomicType
97          */
98         SchemaType::Ptr wxsSuperType() const override;
99 
100         /**
101          * @returns always xs:anyAtomicType
102          */
103         ItemType::Ptr xdtSuperType() const override;
104 
105         /**
106          * @returns @c null. It makes no sense to atomize the abstract type @c fs:numeric.
107          */
108         ItemType::Ptr atomizedType() const override;
109 
110         /**
111          * NumericType cannot be visited. This function is only implemented
112          * to satisfy the abstract super class's interface.
113          *
114          * @returns always a @c null pointer
115          */
116         AtomicTypeVisitorResult::Ptr accept(const AtomicTypeVisitor::Ptr &visitor,
117                                             const SourceLocationReflection *const) const override;
118 
119         /**
120          * NumericType cannot be visited. This function is only implemented
121          * to satisfy the abstract super class's interface.
122          *
123          * @returns always a @c null pointer
124          */
125         AtomicTypeVisitorResult::Ptr accept(const ParameterizedAtomicTypeVisitor::Ptr &visitor,
126                                             const qint16 op,
127                                             const SourceLocationReflection *const) const override;
128 
129         /**
130          * The type @c fs:numeric is an abstract type which therefore
131          * cannot be involved in comparisons. Hence, this function returns
132          * @c null. This function is only implemented to satisfy the abstract
133          * super class's interface.
134          *
135          * @returns always a @c null pointer
136          */
137         AtomicComparatorLocator::Ptr comparatorLocator() const override;
138 
139         /**
140          * The type @c fs:numeric is an abstract type which therefore
141          * cannot be involved in arithmetics. Hence, this function returns
142          * @c null. This function is only implemented to satisfy the abstract
143          * super class's interface.
144          *
145          * @returns always a @c null pointer
146          */
147         AtomicMathematicianLocator::Ptr mathematicianLocator() const override;
148 
149 
150         /**
151          * The type @c fs:numeric is an abstract type which therefore
152          * cannot be involved in casting. Hence, this function returns
153          * @c null. This function is only implemented to satisfy the abstract
154          * super class's interface.
155          *
156          * @returns always a @c null pointer
157          */
158         AtomicCasterLocator::Ptr casterLocator() const override;
159 
160     protected:
161         friend class BuiltinTypes;
162         NumericType();
163     };
164 }
165 
166 QT_END_NAMESPACE
167 
168 #endif
169