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_XsdSchemaDebugger_H |
51 | #define Patternist_XsdSchemaDebugger_H |
52 | |
53 | #include <private/qxsdschema_p.h> |
54 | |
55 | QT_BEGIN_NAMESPACE |
56 | |
57 | namespace QPatternist |
58 | { |
59 | /** |
60 | * A helper class to print out the structure of a compiled schema. |
61 | */ |
62 | class XsdSchemaDebugger |
63 | { |
64 | public: |
65 | /** |
66 | * Creates a new schema debugger. |
67 | * |
68 | * @param namePool The name pool that the schema uses. |
69 | */ |
70 | XsdSchemaDebugger(const NamePool::Ptr &namePool); |
71 | |
72 | /** |
73 | * Dumps the structure of the given @p particle. |
74 | * |
75 | * @param particle The particle to dump. |
76 | * @param level The level of indention. |
77 | */ |
78 | void dumpParticle(const XsdParticle::Ptr &particle, int level = 0); |
79 | |
80 | /** |
81 | * Dumps the inheritance path of the given @p type. |
82 | * |
83 | * @param type The type to dump. |
84 | * @param level The level of indention. |
85 | */ |
86 | void dumpInheritance(const SchemaType::Ptr &type, int level = 0); |
87 | |
88 | /** |
89 | * Dumps the structure of the given @p wildcard. |
90 | */ |
91 | void dumpWildcard(const XsdWildcard::Ptr &wildcard); |
92 | |
93 | /** |
94 | * Dumps the structure of the given @p type. |
95 | */ |
96 | void dumpType(const SchemaType::Ptr &type); |
97 | |
98 | /** |
99 | * Dumps the structure of the given @p element. |
100 | */ |
101 | void dumpElement(const XsdElement::Ptr &element); |
102 | |
103 | /** |
104 | * Dumps the structure of the given @p attribute. |
105 | */ |
106 | void dumpAttribute(const XsdAttribute::Ptr &attribute); |
107 | |
108 | /** |
109 | * Dumps the structure of the complete @p schema. |
110 | */ |
111 | void dumpSchema(const XsdSchema::Ptr &schema); |
112 | |
113 | private: |
114 | const NamePool::Ptr m_namePool; |
115 | }; |
116 | |
117 | } |
118 | |
119 | QT_END_NAMESPACE |
120 | |
121 | #endif |
122 | |