src/xmlpatterns/schema/qxsdschemadebugger_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2008 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_XsdSchemaDebugger_H
  53 #define Patternist_XsdSchemaDebugger_H
  54
  55 #include <private/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