src/xmlpatterns/type/qbasictypesfactory_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_BuiltinTypesFactory_H
  53 #define Patternist_BuiltinTypesFactory_H
  54
  55 #include <QHash>
  56 #include <private/qschematypefactory_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64
  65     /**
  66      * @short Factory for creating schema types for the types defined in XSL-T 2.0.
  67      *
  68      * Theses types are essentially the builtin primitive types, plus @c xs:integer,
  69      * and the types defined in the XPath Data Model.
  70      *
  71      * @ingroup Patternist_types
  72      * @see <a href="http://www.w3.org/TR/xpath-datamodel/#types-predefined">XQuery 1.0 and
  73      * XPath 2.0 Data Model, 2.6.2 Predefined Types</a>
  74      * @see <a href="http://www.w3.org/TR/xslt20/#built-in-types">XSL Transformations (XSLT)
  75      * Version 2.0, 3.13 Built-in Types</a>
  76      * @see <a href="http://www.w3.org/TR/xmlschema-2/#built-in-primitive-datatypes">XML Schema
  77      * Part 2: Datatypes Second Edition, 3.2 Primitive datatypes</a>
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      */
  80     class BasicTypesFactory : public SchemaTypeFactory
  81     {
  82     public:
  83
  84         /**
  85          * Creates a primitive type for @p name. If @p name is not supported,
  86          * @c null is returned.
  87          * The intened supported types are the builtin primitive and derived types.
  88          * That is, the 19 W3C XML Schema types, and the additional 5 in the XPath Data MOdel.
  89          *
  90          * @note This does not handle user defined types, only builtin types.
  91          * @todo Update documentation, proportionally with progress.
  92          */
  93         virtual SchemaType::Ptr createSchemaType(const QXmlName ) const;
  94
  95         virtual SchemaType::Hash types() const;
  96
  97         /**
  98          * @returns the singleton instance of BasicTypesFactory.
  99          */
 100         static SchemaTypeFactory::Ptr self(const NamePool::Ptr &np);
 101
 102     protected:
 103         /**
 104          * This constructor is protected. Use the static self() function
 105          * to retrieve a singleton instance.
 106          */
 107         BasicTypesFactory(const NamePool::Ptr &np);
 108
 109     private:
 110         /**
 111          * A dictonary of builtin primitive and derived primitives.
 112          */
 113         SchemaType::Hash m_types;
 114     };
 115 }
 116
 117 QT_END_NAMESPACE
 118
 119 QT_END_HEADER
 120
 121 #endif