src/xmlpatterns/schema/qxsdparticlechecker_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_XsdParticleChecker_H
  53 #define Patternist_XsdParticleChecker_H
  54
  55 #include <private/qxsdelement_p.h>
  56 #include <private/qxsdparticle_p.h>
  57 #include <private/qxsdschemacontext_p.h>
  58 #include <private/qxsdwildcard_p.h>
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 namespace QPatternist
  65 {
  66     /**
  67      * @short A helper class to check validity of particles.
  68      *
  69      * @ingroup Patternist_schema
  70      * @author Tobias Koenig <tobias.koenig@nokia.com>
  71      */
  72     class XsdParticleChecker
  73     {
  74         public:
  75             /**
  76              * Checks whether the given @p particle has two or more element
  77              * declarations with the same name but different type definitions.
  78              */
  79             static bool hasDuplicatedElements(const XsdParticle::Ptr &particle, const NamePool::Ptr &namePool, XsdElement::Ptr &conflictingElement);
  80
  81             /**
  82              * Checks whether the given @p particle is valid according the
  83              * UPA (http://www.w3.org/TR/xmlschema-1/#cos-nonambig) constraint.
  84              */
  85             static bool isUPAConform(const XsdParticle::Ptr &particle, const NamePool::Ptr &namePool);
  86
  87             /**
  88              * Checks whether the given @p particle, which must be an xsd:all element,
  89              * is valid according the UPA (http://www.w3.org/TR/xmlschema-1/#cos-nonambig) constraint.
  90              * For xsd:all elements, we do not want to construct a state machine.
  91              */
  92             static bool isUPAConformXsdAll(const XsdParticle::Ptr &particle, const NamePool::Ptr &namePool);
  93
  94             /**
  95              * Checks whether the given @p particle subsumes the given @p derivedParticle.
  96              * (http://www.w3.org/TR/xmlschema-1/#cos-particle-restrict)
  97              */
  98             static bool subsumes(const XsdParticle::Ptr &particle, const XsdParticle::Ptr &derivedParticle, const XsdSchemaContext::Ptr &context, QString &errorMsg);
  99     };
 100 }
 101
 102 QT_END_NAMESPACE
 103
 104 QT_END_HEADER
 105
 106 #endif