src/xmlpatterns/type/qnonetype_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_NoneType_H
  53 #define Patternist_NoneType_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 special <tt>none</tt> type.
  67      *
  68      * @ingroup Patternist_types
  69      * @see <a href="http://www.w3.org/TR/xquery-semantics/#sec_content_models">XQuery 1.0 and
  70      * XPath 2.0 Formal Semantics, 2.4.3 Content models</a>
  71      * @see <a href="http://www.w3.org/TR/xquery-semantics/#sec_fnerror">XQuery 1.0 and XPath 2.0
  72      * Formal Semantics, 7.2.9 The fn:error function</a>
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      */
  75     class NoneType : public ItemType,
  76                      public SequenceType
  77     {
  78     public:
  79         typedef QExplicitlySharedDataPointer<NoneType> Ptr;
  80
  81         virtual bool itemMatches(const Item &item) const;
  82         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
  83
  84         /**
  85          * @returns always "none". That is, no namespace prefix
  86          */
  87         virtual QString displayName(const NamePool::Ptr &np) const;
  88
  89         /**
  90          * @note The semantical meaning of this type's item type can
  91          * surely be discussed. The function is provided due to
  92          * it being mandated by the SequenceType base class.
  93          *
  94          * @returns always 'this' since NoneType is also an ItemType
  95          */
  96         virtual ItemType::Ptr itemType() const;
  97
  98         /**
  99          * @note The semantical meaning of this type's cardinality
 100          * can surely be discussed. The function is provided due to
 101          * it being mandated by the SequenceType base class.
 102          *
 103          * @returns always Cardinality::zeroOrMore()
 104          */
 105         virtual Cardinality cardinality() const;
 106
 107         /**
 108          * @returns always @c false
 109          */
 110         virtual bool isAtomicType() const;
 111
 112         /**
 113          * This can be thought to be a weird function for this type(none). There
 114          * is no atomized type for none, perhaps the best from a conceptual perspective
 115          * would be to return @c null.
 116          *
 117          * This function returns BuiltinTypes::xsAnyAtomicType because
 118          * the generic type checking code inserts an Atomizer in the AST
 119          * when an error() function(or other node which has type none) is part of
 120          * an operator expression(value/general comparison, arithmetics). The Atomizer
 121          * returns the atomizedType() of its child, and by here returning xsAnyAtomicType,
 122          * static operator lookup is postponed to runtime. Subsequently, expressions like error()
 123          * works properly with other XPath expressions.
 124          */
 125         virtual ItemType::Ptr atomizedType() const;
 126
 127         /**
 128          * @returns always @c false
 129          */
 130         virtual bool isNodeType() const;
 131
 132         /**
 133          * @returns always item()
 134          */
 135         virtual ItemType::Ptr xdtSuperType() const;
 136
 137         /**
 138          * @returns always @p other. The none type can be thought as
 139          * disappearing when attempting to find the union of it and
 140          * another type.
 141          */
 142         virtual const ItemType &operator|(const ItemType &other) const;
 143
 144     protected:
 145
 146         friend class CommonSequenceTypes;
 147         NoneType();
 148     };
 149 }
 150
 151 QT_END_NAMESPACE
 152
 153 QT_END_HEADER
 154
 155 #endif