src/xmlpatterns/type/qebvtype_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_EBVType_H
  53 #define Patternist_EBVType_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 type for which a value of can an Effective %Boolean Value
  67      * be extracted from.
  68      *
  69      * EBVType is an artificial type. It is not available to users of any host language
  70      * or is specified in any specification. It is used for implementing static type
  71      * checking for expressions such as IfThenClause and AndExpression.
  72      *
  73      * @ingroup Patternist_types
  74      * @author Frans Englich <frans.englich@nokia.com>
  75      */
  76     class EBVType : public ItemType,
  77                     public SequenceType
  78     {
  79     public:
  80         typedef QExplicitlySharedDataPointer<EBVType> Ptr;
  81
  82         /**
  83          * @todo docs if it's an ebvable type, etc.
  84          */
  85         virtual bool itemMatches(const Item &item) const;
  86         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
  87
  88         virtual QString displayName(const NamePool::Ptr &np) const;
  89
  90         /**
  91          * @note The semantical meaning of this type's item type can
  92          * surely be discussed. The function is provided due to
  93          * it being mandated by the SequenceType base class.
  94          *
  95          * @returns always 'this' since EBVType is also an ItemType
  96          */
  97         virtual ItemType::Ptr itemType() const;
  98
  99         /**
 100          * @note The semantical meaning of this type's cardinality
 101          * can surely be discussed. The function is provided due to
 102          * it being mandated by the SequenceType base class.
 103          *
 104          * @returns always Cardinality::zeroOrMore()
 105          */
 106         virtual Cardinality cardinality() const;
 107
 108         virtual bool isAtomicType() const;
 109
 110         /**
 111          * @returns always @c null
 112          */
 113         virtual ItemType::Ptr atomizedType() const;
 114
 115         /**
 116          * @returns always BuiltinTypes::item
 117          */
 118         virtual ItemType::Ptr xdtSuperType() const;
 119
 120         /**
 121          * @returns always @c false
 122          */
 123         virtual bool isNodeType() const;
 124
 125     protected:
 126         friend class CommonSequenceTypes;
 127         EBVType();
 128     };
 129 }
 130
 131 QT_END_NAMESPACE
 132
 133 QT_END_HEADER
 134
 135 #endif