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_AtomicType_H
51 #define Patternist_AtomicType_H
52 
53 #include <private/qanysimpletype_p.h>
54 #include <private/qatomiccasterlocator_p.h>
55 #include <private/qatomiccomparatorlocator_p.h>
56 #include <private/qatomicmathematicianlocator_p.h>
57 #include <private/qatomictypedispatch_p.h>
58 #include <private/qitemtype_p.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 namespace QPatternist
63 {
64     class Item;
65     class SourceLocationReflection;
66 
67     /**
68      * @short Base class for all classes that implements atomic types.
69      *
70      * AtomicType does not implement @c xs:anyAtomicType, it is the C++
71      * base class for classes that implement atomic types, such as @c xs:anyAtomicType.
72      *
73      * @ingroup Patternist_types
74      * @author Frans Englich <frans.englich@nokia.com>
75      */
76     class AtomicType : public ItemType,
77                        public AnySimpleType
78     {
79     public:
80 
81         typedef QExplicitlySharedDataPointer<AtomicType> Ptr;
82 
83         virtual ~AtomicType();
84 
85         /**
86          * Implements a generic algorithm which relies on wxsTypeMatches().
87          *
88          * @returns @c true depending on if @p item is an atomic type, and that
89          * AtomicValue::itemType()'s SequenceType::itemType() matches this type.
90          */
91         bool itemMatches(const Item &item) const override;
92 
93         /**
94          * @returns the result of SharedQXmlName::displayName(), of the SharedQName
95          * object returned from the name() function.
96          */
97         QString displayName(const NamePool::Ptr &np) const override;
98 
99         /**
100          * returns always @c false
101          */
102         bool isNodeType() const override;
103 
104         /**
105          * returns always @c true
106          */
107         bool isAtomicType() const override;
108 
109         /**
110          * Determines whether @p other is equal to this type, or is a
111          * sub-type of this type.
112          *
113          * The implementation is generic, relying on operator==()
114          * and xdtSuperType().
115          */
116         bool xdtTypeMatches(const ItemType::Ptr &other) const override;
117 
118         /**
119          * @returns always 'this'
120          */
121         ItemType::Ptr atomizedType() const override;
122 
123         /**
124          * @returns always SchemaType::SimpleTypeAtomic
125          */
126         TypeCategory category() const override;
127 
128         /**
129          * @returns DerivationRestriction
130          */
131         DerivationMethod derivationMethod() const override;
132 
133         virtual AtomicTypeVisitorResult::Ptr
134         accept(const QExplicitlySharedDataPointer<AtomicTypeVisitor> &visitor,
135                const SourceLocationReflection *const) const = 0;
136 
137         virtual AtomicTypeVisitorResult::Ptr
138         accept(const ParameterizedAtomicTypeVisitor::Ptr &visitor,
139                const qint16 param,
140                const SourceLocationReflection *const) const = 0;
141 
142         virtual AtomicComparatorLocator::Ptr comparatorLocator() const = 0;
143         virtual AtomicMathematicianLocator::Ptr mathematicianLocator() const = 0;
144         virtual AtomicCasterLocator::Ptr casterLocator() const = 0;
145 
146     protected:
147         AtomicType();
148 
149     };
150 }
151 
152 QT_END_NAMESPACE
153 
154 #endif
155