src/xmlpatterns/schema/qxsdstatemachinebuilder_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_XsdStateMachineBuilder_H
       
    53 #define Patternist_XsdStateMachineBuilder_H
       
    54 
       
    55 #include "qxsdparticle_p.h"
       
    56 #include "qxsdstatemachine_p.h"
       
    57 #include "qxsdterm_p.h"
       
    58 
       
    59 #include <QtCore/QExplicitlySharedDataPointer>
       
    60 #include <QtCore/QList>
       
    61 
       
    62 QT_BEGIN_HEADER
       
    63 
       
    64 QT_BEGIN_NAMESPACE
       
    65 
       
    66 namespace QPatternist
       
    67 {
       
    68     /**
       
    69      * @short A helper class to build up validation state machines.
       
    70      *
       
    71      * @ingroup Patternist_schema
       
    72      * @author Tobias Koenig <tobias.koenig@nokia.com>
       
    73      */
       
    74     class XsdStateMachineBuilder : public QSharedData
       
    75     {
       
    76         public:
       
    77             typedef QExplicitlySharedDataPointer<XsdStateMachineBuilder> Ptr;
       
    78 
       
    79             enum Mode
       
    80             {
       
    81                 CheckingMode,
       
    82                 ValidatingMode
       
    83             };
       
    84 
       
    85             /**
       
    86              * Creates a new state machine builder.
       
    87              *
       
    88              * @param machine The state machine it should work on.
       
    89              * @param namePool The name pool used by all schema components.
       
    90              * @param mode The mode the machine shall be build for.
       
    91              */
       
    92             XsdStateMachineBuilder(XsdStateMachine<XsdTerm::Ptr> *machine, const NamePool::Ptr &namePool, Mode mode = CheckingMode);
       
    93 
       
    94             /**
       
    95              * Resets the state machine.
       
    96              *
       
    97              * @returns The initial end state.
       
    98              */
       
    99             XsdStateMachine<XsdTerm::Ptr>::StateId reset();
       
   100 
       
   101             /**
       
   102              * Prepends a start state to the given @p state.
       
   103              * That is needed to allow the conversion of the state machine from a FSA to a DFA.
       
   104              */
       
   105             XsdStateMachine<XsdTerm::Ptr>::StateId addStartState(XsdStateMachine<XsdTerm::Ptr>::StateId state);
       
   106 
       
   107             /**
       
   108              * Creates the state machine for the given @p particle that should have the
       
   109              * given @p endState.
       
   110              *
       
   111              * @returns The new start state.
       
   112              */
       
   113             XsdStateMachine<XsdTerm::Ptr>::StateId buildParticle(const XsdParticle::Ptr &particle, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
       
   114 
       
   115             /**
       
   116              * Creates the state machine for the given @p term that should have the
       
   117              * given @p endState.
       
   118              *
       
   119              * @returns The new start state.
       
   120              */
       
   121             XsdStateMachine<XsdTerm::Ptr>::StateId buildTerm(const XsdTerm::Ptr &term, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
       
   122 
       
   123             /**
       
   124              * Returns a hash that maps each term that appears inside @p particle, to the particle it belongs.
       
   125              *
       
   126              * @note These information are used by XsdParticleChecker to check particle inheritance.
       
   127              */
       
   128             static QHash<XsdTerm::Ptr, XsdParticle::Ptr> particleLookupMap(const XsdParticle::Ptr &particle);
       
   129 
       
   130         private:
       
   131             XsdStateMachine<XsdTerm::Ptr> *m_stateMachine;
       
   132             NamePool::Ptr                  m_namePool;
       
   133             Mode                           m_mode;
       
   134     };
       
   135 }
       
   136 
       
   137 QT_END_NAMESPACE
       
   138 
       
   139 QT_END_HEADER
       
   140 
       
   141 #endif