1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_NodeBuilder_H
51#define Patternist_NodeBuilder_H
52
53#include <private/qitem_p.h>
54#include "qabstractxmlreceiver.h"
55#include <private/qautoptr_p.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61 /**
62 * @short Receives QAbstractXmlReceiver events and builds a node tree
63 * in memory that afterwards can be retrieved via builtNode()
64 *
65 * @ingroup Patternist_xdm
66 * @author Frans Englich <frans.englich@nokia.com>
67 */
68 class NodeBuilder : public QAbstractXmlReceiver
69 {
70 public:
71 typedef AutoPtr<NodeBuilder> Ptr;
72
73 inline NodeBuilder()
74 {
75 }
76
77 /**
78 * @short Returns the document that has been built.
79 *
80 * If this function is called before any events have been received, the result is undefined.
81 *
82 * The top node that was constructed can be retrieved by calling
83 * NodeModel::root() on the returned NodeModel.
84 *
85 * This function is not @c const, because some implementations delay
86 * the node construction until the node is needed. Also, text nodes are
87 * difficult, at best, to construct until one knows that all text content
88 * has been received(which a call to this function in a natural way
89 * signals).
90 */
91 virtual QAbstractXmlNodeModel::Ptr builtDocument() = 0;
92
93 /**
94 * @short Creates a copy of this NodeBuilder, that operates independently of
95 * this NodeBuilder.
96 *
97 * The caller owns the returned instance.
98 */
99 virtual NodeBuilder::Ptr create(const QUrl &baseURI) const = 0;
100 };
101}
102
103QT_END_NAMESPACE
104
105#endif
106

source code of qtxmlpatterns/src/xmlpatterns/data/qnodebuilder_p.h