src/xmlpatterns/type/qatomictype_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  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_AtomicType_H
  53 #define Patternist_AtomicType_H
  54
  55 #include <private/qanysimpletype_p.h>
  56 #include <private/qatomiccasterlocator_p.h>
  57 #include <private/qatomiccomparatorlocator_p.h>
  58 #include <private/qatomicmathematicianlocator_p.h>
  59 #include <private/qatomictypedispatch_p.h>
  60 #include <private/qitemtype_p.h>
  61
  62 QT_BEGIN_HEADER
  63
  64 QT_BEGIN_NAMESPACE
  65
  66 namespace QPatternist
  67 {
  68     class Item;
  69     class SourceLocationReflection;
  70
  71     /**
  72      * @short Base class for all classes that implements atomic types.
  73      *
  74      * AtomicType does not implement @c xs:anyAtomicType, it is the C++
  75      * base class for classes that implement atomic types, such as @c xs:anyAtomicType.
  76      *
  77      * @ingroup Patternist_types
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      */
  80     class AtomicType : public ItemType,
  81                        public AnySimpleType
  82     {
  83     public:
  84
  85         typedef QExplicitlySharedDataPointer<AtomicType> Ptr;
  86
  87         virtual ~AtomicType();
  88
  89         /**
  90          * Implements a generic algorithm which relies on wxsTypeMatches().
  91          *
  92          * @returns @c true depending on if @p item is an atomic type, and that
  93          * AtomicValue::itemType()'s SequenceType::itemType() matches this type.
  94          */
  95         virtual bool itemMatches(const Item &item) const;
  96
  97         /**
  98          * @returns the result of SharedQXmlName::displayName(), of the SharedQName
  99          * object returned from the name() function.
 100          */
 101         virtual QString displayName(const NamePool::Ptr &np) const;
 102
 103         /**
 104          * returns always @c false
 105          */
 106         virtual bool isNodeType() const;
 107
 108         /**
 109          * returns always @c true
 110          */
 111         virtual bool isAtomicType() const;
 112
 113         /**
 114          * Determines whether @p other is equal to this type, or is a
 115          * sub-type of this type.
 116          *
 117          * The implementation is generic, relying on operator==()
 118          * and xdtSuperType().
 119          */
 120         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
 121
 122         /**
 123          * @returns always 'this'
 124          */
 125         virtual ItemType::Ptr atomizedType() const;
 126
 127         /**
 128          * @returns always SchemaType::SimpleTypeAtomic
 129          */
 130         virtual TypeCategory category() const;
 131
 132         /**
 133          * @returns DerivationRestriction
 134          */
 135         virtual DerivationMethod derivationMethod() const;
 136
 137         virtual AtomicTypeVisitorResult::Ptr
 138         accept(const QExplicitlySharedDataPointer<AtomicTypeVisitor> &visitor,
 139                const SourceLocationReflection *const) const = 0;
 140
 141         virtual AtomicTypeVisitorResult::Ptr
 142         accept(const ParameterizedAtomicTypeVisitor::Ptr &visitor,
 143                const qint16 param,
 144                const SourceLocationReflection *const) const = 0;
 145
 146         virtual AtomicComparatorLocator::Ptr comparatorLocator() const = 0;
 147         virtual AtomicMathematicianLocator::Ptr mathematicianLocator() const = 0;
 148         virtual AtomicCasterLocator::Ptr casterLocator() const = 0;
 149
 150     protected:
 151         AtomicType();
 152
 153     };
 154 }
 155
 156 QT_END_NAMESPACE
 157
 158 QT_END_HEADER
 159
 160 #endif