src/xmlpatterns/type/qemptysequencetype_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_EmptySequenceType_H
  53 #define Patternist_EmptySequenceType_H
  54
  55 #include <private/qatomictype_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     /**
  66      * @short Represents the <tt>empty-sequence()</tt> type.
  67      *
  68      * @ingroup Patternist_types
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      */
  71     class EmptySequenceType : public ItemType,
  72                               public SequenceType
  73     {
  74     public:
  75         typedef QExplicitlySharedDataPointer<EmptySequenceType> Ptr;
  76
  77         /**
  78          * Possibly surprisingly, this function also returns true for the @c none type.
  79          *
  80          * @returns @c true if @p other is NoneType or EmptySequenceType, otherwise @c false.
  81          */
  82         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
  83
  84         /**
  85          * @returns always @c false
  86          */
  87         virtual bool itemMatches(const Item &item) const;
  88
  89         /**
  90          * @returns always "empty-sequence()"
  91          */
  92         virtual QString displayName(const NamePool::Ptr &np) const;
  93
  94         virtual ItemType::Ptr xdtSuperType() const;
  95
  96         virtual bool isNodeType() const;
  97         virtual bool isAtomicType() const;
  98
  99         /**
 100          * @return always Cardinality::empty()
 101          */
 102         virtual Cardinality cardinality() const;
 103
 104         /**
 105          * @returns always 'this' since it is also an ItemType
 106          */
 107         virtual ItemType::Ptr itemType() const;
 108
 109         /**
 110          * @returns always @c xs:anyAtomicType
 111          */
 112         virtual ItemType::Ptr atomizedType() const;
 113
 114     protected:
 115         friend class CommonSequenceTypes;
 116         EmptySequenceType();
 117     };
 118 }
 119
 120 QT_END_NAMESPACE
 121
 122 QT_END_HEADER
 123
 124 #endif