src/xmlpatterns/type/qgenericsequencetype_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_GenericSequenceType_H
  53 #define Patternist_GenericSequenceType_H
  54
  55 #include <private/qcommonsequencetypes_p.h>
  56 #include <private/qsequencetype_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @todo Documentation is missing.
  66      *
  67      * @ingroup Patternist_types
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      */
  70     class GenericSequenceType : public SequenceType
  71     {
  72     public:
  73         GenericSequenceType(const ItemType::Ptr &itemType, const Cardinality &card);
  74
  75         /**
  76          * Generates a name for the sequence type for display purposes. The
  77          * prefix used for the QName identifying the schema type is conventional.
  78          * An example of a display name for a GenericSequenceType is "xs:integer?".
  79          */
  80         virtual QString displayName(const NamePool::Ptr &np) const;
  81
  82         virtual Cardinality cardinality() const;
  83
  84         virtual ItemType::Ptr itemType() const;
  85
  86     private:
  87         const ItemType::Ptr m_itemType;
  88         const Cardinality m_cardinality;
  89     };
  90
  91     /**
  92      * @short An object generator for GenericSequenceType.
  93      *
  94      * makeGenericSequenceType() is a convenience function for avoiding invoking
  95      * the @c new operator, and wrapping the result in GenericSequenceType::Ptr.
  96      *
  97      * @returns a smart pointer to to a GenericSequenceType instaniated from @p itemType and @p cardinality.
  98      * @relates GenericSequenceType
  99      */
 100     static inline SequenceType::Ptr
 101     makeGenericSequenceType(const ItemType::Ptr &itemType, const Cardinality &cardinality)
 102     {
 103         /* An empty sequence of say integers, is the empty-sequence(). */
 104         if(cardinality.isEmpty())
 105             return CommonSequenceTypes::Empty;
 106         else
 107             return SequenceType::Ptr(new GenericSequenceType(itemType, cardinality));
 108     }
 109 }
 110
 111 QT_END_NAMESPACE
 112
 113 QT_END_HEADER
 114
 115 #endif