/****************************************************************************

**

** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_XsdSchemaParser_H

#define Patternist_XsdSchemaParser_H

#include "qnamespacesupport_p.h"

#include "qxsdalternative_p.h"

#include "qxsdattribute_p.h"

#include "qxsdattributegroup_p.h"

#include "qxsdattributeterm_p.h"

#include "qxsdcomplextype_p.h"

#include "qxsdelement_p.h"

#include "qxsdidcache_p.h"

#include "qxsdmodelgroup_p.h"

#include "qxsdnotation_p.h"

#include "qxsdsimpletype_p.h"

#include "qxsdschemacontext_p.h"

#include "qxsdschemaparsercontext_p.h"

#include "qxsdstatemachine_p.h"

#include <QtCore/QHash>

#include <QtCore/QSet>

#include <QtCore/QUrl>

#include <QtXml/QXmlStreamReader>

#include <QtXmlPatterns/QXmlNamePool>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short Implements the parsing of XML schema file.

     *

     * This class parses a XML schema in XML presentation from an QIODevice

     * and returns object representation as XsdSchema.

     *

     * @ingroup Patternist_schema

     * @author Tobias Koenig <tobias.koenig@nokia.com>

     */

    class XsdSchemaParser : public MaintainingReader<XsdSchemaToken, XsdTagScope::Type>

    {

        friend class ElementNamespaceHandler;

        friend class TagValidationHandler;

        public:

            enum ParserType

            {

                TopLevelParser,

                IncludeParser,

                ImportParser,

                RedefineParser

            };

            /**

             * Creates a new schema parser object.

             */

            XsdSchemaParser(const XsdSchemaContext::Ptr &context, const XsdSchemaParserContext::Ptr &parserContext, QIODevice *device);

            /**

             * Parses the XML schema file.

             *

             * @return @c true on success, @c false if the schema is somehow invalid.

             */

            bool parse(ParserType parserType = TopLevelParser);

            /**

             * Describes a set of namespace URIs

             */

            typedef QSet<QUrl> NamespaceSet;

            /**

             * Sets which @p schemas have been included already, so the parser

             * can detect circular includes.

             */

            void setIncludedSchemas(const NamespaceSet &schemas);

            /**

             * Sets which @p schemas have been imported already, so the parser

             * can detect circular imports.

             */

            void setImportedSchemas(const NamespaceSet &schemas);

            /**

             * Sets which @p schemas have been redefined already, so the parser

             * can detect circular redefines.

             */

            void setRedefinedSchemas(const NamespaceSet &schemas);

            /**

             * Sets the target namespace of the schema to parse.

             */

            void setTargetNamespace(const QString &targetNamespace);

            /**

             * Sets the document URI of the schema to parse.

             */

            void setDocumentURI(const QUrl &uri);

            /**

             * Returns the document URI of the schema to parse.

             */

            QUrl documentURI() const;

            /**

             * Reimplemented from MaintainingReader, always returns @c false.

             */

            bool isAnyAttributeAllowed() const;

        private:

            /**

             * Used internally to report any kind of parsing error or

             * schema inconsistency.

             */

            virtual void error(const QString &msg);

            void attributeContentError(const char *attributeName, const char *elementName, const QString &value, const SchemaType::Ptr &type = SchemaType::Ptr());

            /**

             * Sets the target namespace of the schema to parse.

             */

            void setTargetNamespaceExtended(const QString &targetNamespace);

            /**

             * This method is called for parsing the top-level <em>schema</em> object.

             */

            void parseSchema(ParserType parserType);

            /**

             * This method is called for parsing any top-level <em>include</em> object.

             */

            void parseInclude();

            /**

             * This method is called for parsing any top-level <em>import</em> object.

             */

            void parseImport();

            /**

             * This method is called for parsing any top-level <em>redefine</em> object.

             */

            void parseRedefine();

            /**

             * This method is called for parsing any <em>annotation</em> object everywhere

             * in the schema.

             */

            XsdAnnotation::Ptr parseAnnotation();

            /**

             * This method is called for parsing an <em>appinfo</em> object as child of

             * an <em>annotation</em> object.

             */

            XsdApplicationInformation::Ptr parseAppInfo();

            /**

             * This method is called for parsing a <em>documentation</em> object as child of

             * an <em>annotation</em> object.

             */

            XsdDocumentation::Ptr parseDocumentation();

            /**

             * This method is called for parsing a <em>defaultOpenContent</em> object.

             */

            void parseDefaultOpenContent();

            /**

             * This method is called for parsing any top-level <em>simpleType</em> object.

             */

            XsdSimpleType::Ptr parseGlobalSimpleType();

            /**

             * This method is called for parsing any <em>simpleType</em> object as descendant

             * of an <em>element</em> or <em>complexType</em> object.

             */

            XsdSimpleType::Ptr parseLocalSimpleType();

            /**

             * This method is called for parsing a <em>restriction</em> object as child

             * of a <em>simpleType</em> object.

             */

            void parseSimpleRestriction(const XsdSimpleType::Ptr &ptr);

            /**

             * This method is called for parsing a <em>list</em> object as child

             * of a <em>simpleType</em> object.

             */

            void parseList(const XsdSimpleType::Ptr &ptr);

            /**

             * This method is called for parsing a <em>union</em> object as child

             * of a <em>simpleType</em> object.

             */

            void parseUnion(const XsdSimpleType::Ptr &ptr);

            /**

             * This method is called for parsing a <em>minExclusive</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMinExclusiveFacet();

            /**

             * This method is called for parsing a <em>minInclusive</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMinInclusiveFacet();

            /**

             * This method is called for parsing a <em>maxExclusive</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMaxExclusiveFacet();

            /**

             * This method is called for parsing a <em>maxInclusive</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMaxInclusiveFacet();

            /**

             * This method is called for parsing a <em>totalDigits</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseTotalDigitsFacet();

            /**

             * This method is called for parsing a <em>fractionDigits</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseFractionDigitsFacet();

            /**

             * This method is called for parsing a <em>length</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseLengthFacet();

            /**

             * This method is called for parsing a <em>minLength</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMinLengthFacet();

            /**

             * This method is called for parsing a <em>maxLength</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseMaxLengthFacet();

            /**

             * This method is called for parsing an <em>enumeration</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseEnumerationFacet();

            /**

             * This method is called for parsing a <em>whiteSpace</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseWhiteSpaceFacet();

            /**

             * This method is called for parsing a <em>pattern</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parsePatternFacet();

            /**

             * This method is called for parsing an <em>assertion</em> object as child

             * of a <em>restriction</em> object.

             */

            XsdFacet::Ptr parseAssertionFacet();

            /**

             * This method is called for parsing any top-level <em>complexType</em> object.

             */

            XsdComplexType::Ptr parseGlobalComplexType();

            /**

             * This method is called for parsing any <em>complexType</em> object as descendant

             * of an <em>element</em> object.

             */

            XsdComplexType::Ptr parseLocalComplexType();

            /**

             * This method resolves the content type of the @p complexType for the given

             * @p effectiveMixed value.

             */

            void resolveComplexContentType(const XsdComplexType::Ptr &complexType, bool effectiveMixed);

            /**

             * This method is called for parsing a <em>simpleContent</em> object as child

             * of a <em>complexType</em> object.

             */

            void parseSimpleContent(const XsdComplexType::Ptr &complexType);

            /**

             * This method is called for parsing a <em>restriction</em> object as child

             * of a <em>simpleContent</em> object.

             */

            void parseSimpleContentRestriction(const XsdComplexType::Ptr &complexType);

            /**

             * This method is called for parsing an <em>extension</em> object as child

             * of a <em>simpleContent</em> object.

             */

            void parseSimpleContentExtension(const XsdComplexType::Ptr &complexType);

            /**

             * This method is called for parsing a <em>complexContent</em> object as child

             * of a <em>complexType</em> object.

             *

             * @param complexType The complex type the complex content belongs to.

             * @param mixed The output parameter for the mixed value.

             */

            void parseComplexContent(const XsdComplexType::Ptr &complexType, bool *mixed);

            /**

             * This method is called for parsing a <em>restriction</em> object as child

             * of a <em>complexContent</em> object.

             */

            void parseComplexContentRestriction(const XsdComplexType::Ptr &complexType);

            /**

             * This method is called for parsing an <em>extension</em> object as child

             * of a <em>complexContent</em> object.

             */

            void parseComplexContentExtension(const XsdComplexType::Ptr &complexType);

            /**

             * This method is called for parsing an <em>assert</em> object as child

             * of a <em>complexType</em> or parsing a <em>assertion</em> facet object as

             * child of a <em>simpleType</em>.

             *

             * @param nodeName Either XsdSchemaToken::Assert or XsdSchemaToken::Assertion.

             * @param tag Either XsdTagScope::Assert or XsdTagScope::Assertion.

             */

            XsdAssertion::Ptr parseAssertion(const XsdSchemaToken::NodeName &nodeName, const XsdTagScope::Type &tag);

            /**

             * This method is called for parsing an <em>openContent</em> object.

             */

            XsdComplexType::OpenContent::Ptr parseOpenContent();

            /**

             * This method is called for parsing a top-level <em>group</em> object.

             */

            XsdModelGroup::Ptr parseNamedGroup();

            /**

             * This method is called for parsing a non-top-level <em>group</em> object

             * that contains a <em>ref</em> attribute.

             */

            XsdTerm::Ptr parseReferredGroup(const XsdParticle::Ptr &particle);

            /**

             * This method is called for parsing an <em>all</em> object as child

             * of a top-level <em>group</em> object.

             *

             * @param parent The schema component the <em>all</em> object is part of.

             */

            XsdModelGroup::Ptr parseAll(const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing an <em>all</em> object as descendant

             * of a <em>complexType</em> object.

             *

             * @param particle The particle the <em>all</em> object belongs to.

             * @param parent The schema component the <em>all</em> object is part of.

             */

            XsdModelGroup::Ptr parseLocalAll(const XsdParticle::Ptr &particle, const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a <em>choice</em> object as child

             * of a top-level <em>group</em> object.

             *

             * @param parent The schema component the <em>choice</em> object is part of.

             */

            XsdModelGroup::Ptr parseChoice(const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a <em>choice</em> object as descendant

             * of a <em>complexType</em> object or a <em>choice</em> object.

             *

             * @param particle The particle the <em>choice</em> object belongs to.

             * @param parent The schema component the <em>choice</em> object is part of.

             */

            XsdModelGroup::Ptr parseLocalChoice(const XsdParticle::Ptr &particle, const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a <em>sequence</em> object as child

             * of a top-level <em>group</em> object.

             *

             * @param parent The schema component the <em>sequence</em> object is part of.

             */

            XsdModelGroup::Ptr parseSequence(const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a <em>sequence</em> object as descendant

             * of a <em>complexType</em> object or a <em>sequence</em> object.

             *

             * @param particle The particle the <em>sequence</em> object belongs to.

             * @param parent The schema component the <em>sequence</em> object is part of.

             */

            XsdModelGroup::Ptr parseLocalSequence(const XsdParticle::Ptr &particle, const NamedSchemaComponent::Ptr &parent);

            /**

             * A helper method that parses the minOccurs and maxOccurs constraints for

             * the given @p particle that has the given @p tagName.

             */

            bool parseMinMaxConstraint(const XsdParticle::Ptr &particle, const char* tagName);

            /**

             * This method is called for parsing any top-level <em>attribute</em> object.

             */

            XsdAttribute::Ptr parseGlobalAttribute();

            /**

             * This method is called for parsing any non-top-level <em>attribute</em> object as a

             * descendant of a <em>complexType</em> object or an <em>attributeGroup</em> object.

             *

             * @param parent The parent component the <em>attribute</em> object is part of.

             */

            XsdAttributeUse::Ptr parseLocalAttribute(const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a top-level <em>attributeGroup</em> object.

             */

            XsdAttributeGroup::Ptr parseNamedAttributeGroup();

            /**

             * This method is called for parsing a non-top-level <em>attributeGroup</em> object

             * that contains a <em>ref</em> attribute.

             */

            XsdAttributeUse::Ptr parseReferredAttributeGroup();

            /**

             * This method is called for parsing any top-level <em>element</em> object.

             */

            XsdElement::Ptr parseGlobalElement();

            /**

             * This method is called for parsing any non-top-level <em>element</em> object as a

             * descendant of a <em>complexType</em> object or a <em>group</em> object.

             *

             * @param particle The particle the <em>element</em> object belongs to.

             * @param parent The parent component the <em>element</em> object is part of.

             */

            XsdTerm::Ptr parseLocalElement(const XsdParticle::Ptr &particle, const NamedSchemaComponent::Ptr &parent);

            /**

             * This method is called for parsing a <em>unique</em> object as child of an <em>element</em> object.

             */

            XsdIdentityConstraint::Ptr parseUnique();

            /**

             * This method is called for parsing a <em>key</em> object as child of an <em>element</em> object.

             */

            XsdIdentityConstraint::Ptr parseKey();

            /**

             * This method is called for parsing a <em>keyref</em> object as child of an <em>element</em> object.

             */

            XsdIdentityConstraint::Ptr parseKeyRef(const XsdElement::Ptr &element);

            /**

             * This method is called for parsing a <em>selector</em> object as child of an <em>unique</em> object,

             * <em>key</em> object or <em>keyref</em> object,

             *

             * @param ptr The identity constraint it belongs to.

             */

            void parseSelector(const XsdIdentityConstraint::Ptr &ptr);

            /**

             * This method is called for parsing a <em>field</em> object as child of an <em>unique</em> object,

             * <em>key</em> object or <em>keyref</em> object,

             *

             * @param ptr The identity constraint it belongs to.