src/xmlpatterns/schema/qxsdschemadebugger_p.h
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    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 "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