src/xmlpatterns/type/qanynodetype_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   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_AnyNodeType_H
  53 #define Patternist_AnyNodeType_H
  54
  55 #include <private/qatomictype_p.h>
  56 #include <private/qitem_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Represents the <tt>node()</tt> item type.
  66      *
  67      * @ingroup Patternist_types
  68      * @see BuiltinNodeType
  69      * @author Frans Englich <frans.englich@nokia.com>
  70      */
  71     class AnyNodeType : public ItemType
  72     {
  73     public:
  74
  75         typedef QExplicitlySharedDataPointer<AnyNodeType> Ptr;
  76
  77         virtual bool xdtTypeMatches(const ItemType::Ptr &other) const;
  78         virtual bool itemMatches(const Item &item) const;
  79         virtual QString displayName(const NamePool::Ptr &np) const;
  80
  81         virtual ItemType::Ptr xdtSuperType() const;
  82
  83         virtual bool isNodeType() const;
  84         virtual bool isAtomicType() const;
  85
  86         /**
  87          * @see <a href="http://www.w3.org/TR/xpath-datamodel/#acc-summ-typed-value">XQuery 1.0
  88          * and XPath 2.0 Data Model, G.15 dm:typed-value Accessor</a>
  89          */
  90         virtual ItemType::Ptr atomizedType() const;
  91
  92         /**
  93          * @returns the node kind this node ItemType tests for. If it matches any node, zero is returned.
  94          */
  95         virtual QXmlNodeModelIndex::NodeKind nodeKind() const;
  96
  97         virtual PatternPriority patternPriority() const;
  98
  99     protected:
 100         friend class BuiltinTypes;
 101
 102         inline AnyNodeType()
 103         {
 104         }
 105
 106     };
 107 }
 108
 109 QT_END_NAMESPACE
 110
 111 QT_END_HEADER
 112
 113 #endif