src/xmlpatterns/type/qbuiltinatomictype_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_BuiltinAtomicType_H
  53 #define Patternist_BuiltinAtomicType_H
  54
  55 #include <private/qatomictype_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Instances of this class represents types that are sub-classes
  66      * of @c xs:anyAtomicType.
  67      *
  68      * Retrieving instances of builtin types is done
  69      * via BuiltinTypesFactory::createSchemaType(), not by instantiating this
  70      * class manually.
  71      *
  72      * @ingroup Patternist_types
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      */
  75     class BuiltinAtomicType : public AtomicType
  76     {
  77     public:
  78
  79         typedef QExplicitlySharedDataPointer<BuiltinAtomicType> Ptr;
  80
  81         /**
  82          * @returns always @c false
  83          */
  84         virtual bool isAbstract() const;
  85
  86         /**
  87          * @returns the base type as specified in the constructors baseType argument.
  88          */
  89         virtual SchemaType::Ptr wxsSuperType() const;
  90
  91         /**
  92          * @returns the same type as wxsSuperType(), except for the type @c xs:anyAtomicType, which
  93          * returns item()
  94          */
  95         virtual ItemType::Ptr xdtSuperType() const;
  96
  97         virtual AtomicComparatorLocator::Ptr comparatorLocator() const;
  98         virtual AtomicMathematicianLocator::Ptr mathematicianLocator() const;
  99         virtual AtomicCasterLocator::Ptr casterLocator() const;
 100
 101     protected:
 102         friend class BuiltinTypes;
 103
 104         /**
 105          * @param baseType the type that is the super type of the constructed
 106          * atomic type. In the case of AnyAtomicType, @c null is passed.
 107          * @param comp the AtomicComparatorLocator this type should return. May be @c null.
 108          * @param mather similar to @p comp, this is the AtomicMathematicianLocator
 109          * that's appropriate for this type May be @c null.
 110          * @param casterLocator the CasterLocator that locates classes performing
 111          * casting with this type. May be @c null.
 112          */
 113         BuiltinAtomicType(const AtomicType::Ptr &baseType,
 114                           const AtomicComparatorLocator::Ptr &comp,
 115                           const AtomicMathematicianLocator::Ptr &mather,
 116                           const AtomicCasterLocator::Ptr &casterLocator);
 117
 118     private:
 119         const AtomicType::Ptr                   m_superType;
 120         const AtomicComparatorLocator::Ptr      m_comparatorLocator;
 121         const AtomicMathematicianLocator::Ptr   m_mathematicianLocator;
 122         const AtomicCasterLocator::Ptr          m_casterLocator;
 123     };
 124 }
 125
 126 QT_END_NAMESPACE
 127
 128 QT_END_HEADER
 129
 130 #endif