src/xmlpatterns/schema/qxsdinstancereader_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 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_XsdInstanceReader_H
  53 #define Patternist_XsdInstanceReader_H
  54
  55 #include "qabstractxmlnodemodel.h"
  56 #include <private/qpullbridge_p.h>
  57 #include <private/qxsdschemacontext_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short The schema instance reader.
  67      *
  68      * This class reads in a xml instance document from a QAbstractXmlNodeModel
  69      * and provides a QXmlStreamReader like interface with some additional context
  70      * information.
  71      *
  72      * @ingroup Patternist_schema
  73      * @author Tobias Koenig <tobias.koenig@nokia.com>
  74      */
  75     class XsdInstanceReader
  76     {
  77         public:
  78             typedef QExplicitlySharedDataPointer<XsdInstanceReader> Ptr;
  79
  80             /**
  81              * Creates a new instance reader that will read the data from
  82              * the given @p model.
  83              *
  84              * @param model The model the data are read from.
  85              * @param context The context that is used for error reporting etc.
  86              */
  87             XsdInstanceReader(const QAbstractXmlNodeModel *model, const XsdSchemaContext::Ptr &context);
  88
  89         protected:
  90             /**
  91              * Returns @c true if the end of the document is reached, @c false otherwise.
  92              */
  93             bool atEnd() const;
  94
  95             /**
  96              * Reads the next node from the document.
  97              */
  98             void readNext();
  99
 100             /**
 101              * Returns whether the current node is a start element.
 102              */
 103             bool isStartElement() const;
 104
 105             /**
 106              * Returns whether the current node is an end element.
 107              */
 108             bool isEndElement() const;
 109
 110             /**
 111              * Returns whether the current node has a text node among its children.
 112              */
 113             bool hasChildText() const;
 114
 115             /**
 116              * Returns whether the current node has an element node among its children.
 117              */
 118             bool hasChildElement() const;
 119
 120             /**
 121              * Returns the name of the current node.
 122              */
 123             QXmlName name() const;
 124
 125             /**
 126              * Returns whether the current node has an attribute with the given @p name.
 127              */
 128             bool hasAttribute(const QXmlName &name) const;
 129
 130             /**
 131              * Returns the attribute with the given @p name of the current node.
 132              */
 133             QString attribute(const QXmlName &name) const;
 134
 135             /**
 136              * Returns the list of attribute names of the current node.
 137              */
 138             QSet<QXmlName> attributeNames() const;
 139
 140             /**
 141              * Returns the concatenated text of all direct child text nodes.
 142              */
 143             QString text() const;
 144
 145             /**
 146              * Converts a qualified name into a QXmlName according to the namespace
 147              * mappings of the current node.
 148              */
 149             QXmlName convertToQName(const QString &name) const;
 150
 151             /**
 152              * Returns a source location object for the current position.
 153              */
 154             QSourceLocation sourceLocation() const;
 155
 156             /**
 157              * Returns the QXmlItem for the current position.
 158              */
 159             QXmlItem item() const;
 160
 161             /**
 162              * Returns the QXmlItem for the attribute with the given @p name at the current position.
 163              */
 164             QXmlItem attributeItem(const QXmlName &name) const;
 165
 166             /**
 167              * Returns the namespace bindings for the given node model @p index.
 168              */
 169             QVector<QXmlName> namespaceBindings(const QXmlNodeModelIndex &index) const;
 170
 171             /**
 172              * The shared schema context.
 173              */
 174             XsdSchemaContext::Ptr     m_context;
 175
 176         private:
 177             PullBridge                m_model;
 178             QHash<QXmlName, QString>  m_cachedAttributes;
 179             QHash<QXmlName, QXmlItem> m_cachedAttributeItems;
 180             QSourceLocation           m_cachedSourceLocation;
 181             QXmlItem                  m_cachedItem;
 182     };
 183 }
 184
 185 QT_END_NAMESPACE
 186
 187 QT_END_HEADER
 188
 189 #endif