1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 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_XsdSchemaDebugger_H 53 #define Patternist_XsdSchemaDebugger_H 54 55 #include "qxsdschema_p.h" 56 57 QT_BEGIN_HEADER 58 59 QT_BEGIN_NAMESPACE 60 61 namespace QPatternist 62 { 63 /** 64 * A helper class to print out the structure of a compiled schema. 65 */ 66 class XsdSchemaDebugger 67 { 68 public: 69 /** 70 * Creates a new schema debugger. 71 * 72 * @param namePool The name pool that the schema uses. 73 */ 74 XsdSchemaDebugger(const NamePool::Ptr &namePool); 75 76 /** 77 * Dumps the structure of the given @p particle. 78 * 79 * @param particle The particle to dump. 80 * @param level The level of indention. 81 */ 82 void dumpParticle(const XsdParticle::Ptr &particle, int level = 0); 83 84 /** 85 * Dumps the inheritance path of the given @p type. 86 * 87 * @param type The type to dump. 88 * @param level The level of indention. 89 */ 90 void dumpInheritance(const SchemaType::Ptr &type, int level = 0); 91 92 /** 93 * Dumps the structure of the given @p wildcard. 94 */ 95 void dumpWildcard(const XsdWildcard::Ptr &wildcard); 96 97 /** 98 * Dumps the structure of the given @p type. 99 */ 100 void dumpType(const SchemaType::Ptr &type); 101 102 /** 103 * Dumps the structure of the given @p element. 104 */ 105 void dumpElement(const XsdElement::Ptr &element); 106 107 /** 108 * Dumps the structure of the given @p attribute. 109 */ 110 void dumpAttribute(const XsdAttribute::Ptr &attribute); 111 112 /** 113 * Dumps the structure of the complete @p schema. 114 */ 115 void dumpSchema(const XsdSchema::Ptr &schema); 116 117 private: 118 const NamePool::Ptr m_namePool; 119 }; 120 121 } 122 123 QT_END_NAMESPACE 124 125 QT_END_HEADER 126 127 #endif 128