src/xmlpatterns/data/qnodebuilder_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_NodeBuilder_H
  53 #define Patternist_NodeBuilder_H
  54
  55 #include <private/qitem_p.h>
  56 #include "qabstractxmlreceiver.h"
  57 #include <private/qautoptr_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Receives QAbstractXmlReceiver events and builds a node tree
  67      * in memory that afterwards can be retrieved via builtNode()
  68      *
  69      * @ingroup Patternist_xdm
  70      * @author Frans Englich <frans.englich@nokia.com>
  71      */
  72     class NodeBuilder : public QAbstractXmlReceiver
  73     {
  74     public:
  75         typedef AutoPtr<NodeBuilder> Ptr;
  76
  77         inline NodeBuilder()
  78         {
  79         }
  80
  81         /**
  82          * @short Returns the document that has been built.
  83          *
  84          * If this function is called before any events have been received, the result is undefined.
  85          *
  86          * The top node that was constructed can be retrieved by calling
  87          * NodeModel::root() on the returned NodeModel.
  88          *
  89          * This function is not @c const, because some implementations delay
  90          * the node construction until the node is needed. Also, text nodes are
  91          * difficult, at best, to construct until one knows that all text content
  92          * has been received(which a call to this function in a natural way
  93          * signals).
  94          */
  95         virtual QAbstractXmlNodeModel::Ptr builtDocument() = 0;
  96
  97         /**
  98          * @short Creates a copy of this NodeBuilder, that operates independently of
  99          * this NodeBuilder.
 100          *
 101          * The caller owns the returned instance.
 102          */
 103         virtual NodeBuilder::Ptr create(const QUrl &baseURI) const = 0;
 104     };
 105 }
 106
 107 QT_END_NAMESPACE
 108
 109 QT_END_HEADER
 110
 111 #endif