*

*   Licensed under the Apache License, Version 2.0 (the "License");

*   you may not use this file except in compliance with the License.

*   You may obtain a copy of the License at

*

*       http://www.apache.org/licenses/LICENSE-2.0

*

*   Unless required by applicable law or agreed to in writing, software

*   distributed under the License is distributed on an "AS IS" BASIS,

*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

*   See the License for the specific language governing permissions and

*  limitations under the License.

*/

    static final int ROOT     = Cur.ROOT;

    static final int ELEM     = Cur.ELEM;

    static final int ATTR     = Cur.ATTR;

    static final int COMMENT  = Cur.COMMENT;

    static final int PROCINST = Cur.PROCINST;

    static final int TEXT     = Cur.TEXT;

    static final int WS_UNSPECIFIED = TypeStore.WS_UNSPECIFIED;

    static final int WS_PRESERVE    = TypeStore.WS_PRESERVE;

    static final int WS_REPLACE     = TypeStore.WS_REPLACE;

    static final int WS_COLLAPSE    = TypeStore.WS_COLLAPSE;

                                       

    static final String _xsi         = "http://www.w3.org/2001/XMLSchema-instance";

    static final String _schema      = "http://www.w3.org/2001/XMLSchema";

    static final String _openFragUri = "http://www.openuri.org/fragment";

    static final String _xml1998Uri  = "http://www.w3.org/XML/1998/namespace";

    static final String _xmlnsUri    = "http://www.w3.org/2000/xmlns/";

   

    static final QName _xsiNil          = new QName( _xsi, "nil", "xsi" );

    static final QName _xsiType         = new QName( _xsi, "type", "xsi" );

    static final QName _xsiLoc          = new QName( _xsi, "schemaLocation", "xsi" );

    static final QName _xsiNoLoc        = new QName( _xsi, "noNamespaceSchemaLocation", "xsi" );

    static final QName _openuriFragment = new QName( _openFragUri, "fragment", "frag" );

    static final QName _xmlFragment     = new QName( "xml-fragment" );

    private Locale ( SchemaTypeLoader stl, XmlOptions options )

    {

        options = XmlOptions.maskNull( options );

        //

        //

        //

        // TODO - add option for no=sync, or make it all thread safe

        //

        // Also - have a thread local setting for thread safety?  .. Perhaps something

        // in the type loader which defines whether ot not sync is on????

       

        _noSync = options.hasOption( XmlOptions.UNSYNCHRONIZED );

       

        _tempFrames = new Cur [ _numTempFramesLeft = 8 ];

        // BUGBUG - this cannot be thread local ....

        // BUGBUG - this cannot be thread local ....

        // BUGBUG - this cannot be thread local .... uhh what, again?

        //

        // Lazy create this (loading up a locale should use the thread locale one)

        // same goes for the qname factory .. use thread local for hte most part when loading

       

        _qnameFactory = new DefaultQNameFactory();

        _locations = new Locations( this );

        _schemaTypeLoader = stl;

        _validateOnSet = options.hasOption( XmlOptions.VALIDATE_ON_SET );

       

        //

        // Check for Saaj implementation request

        //

       

        Object saajObj = options.get( Saaj.SAAJ_IMPL );

        if (saajObj != null)

        {

            if (!(saajObj instanceof Saaj))

                throw new IllegalStateException( "Saaj impl not correct type: " + saajObj );

            _saaj = (Saaj) saajObj;

           

            _saaj.setCallback( this );

        }

    }

    //

    //

    //

    public static final String USE_SAME_LOCALE = "USE_SAME_LOCALE";

   

    static Locale getLocale ( SchemaTypeLoader stl, XmlOptions options )

    {

        if (stl == null)

            stl = XmlBeans.getContextTypeLoader();

       

        options = XmlOptions.maskNull( options );

        Locale l = null;

       

        if (options.hasOption( USE_SAME_LOCALE ))

        {

            Object source = options.get( USE_SAME_LOCALE );

            if (source instanceof Locale)

                l = (Locale) source;

            else if (source instanceof XmlTokenSource)

                l = (Locale) ((XmlTokenSource) source).monitor();

            else

                throw new IllegalArgumentException( "Source locale not understood: " + source );

            if (l._schemaTypeLoader != stl)

                throw new IllegalArgumentException( "Source locale does not support same schema type loader" );

           

            if (l._saaj != null && l._saaj != options.get( Saaj.SAAJ_IMPL ))

                throw new IllegalArgumentException( "Source locale does not support same saaj" );

            if (l._validateOnSet && !options.hasOption( XmlOptions.VALIDATE_ON_SET ))

                throw new IllegalArgumentException( "Source locale does not support same validate on set" );

            // TODO - other things to check?

        }

        else

            l = new Locale( stl, options );

        return l;

    }

    //

    //

    //

   

    static void associateSourceName ( Cur c, XmlOptions options )

    {

        String sourceName = (String) XmlOptions.safeGet( options, XmlOptions.DOCUMENT_SOURCE_NAME );

        if (sourceName != null)

            getDocProps( c, true ).setSourceName( sourceName );

    }

    //

    //

    //

   

    static void autoTypeDocument ( Cur c, SchemaType requestedType, XmlOptions options )

        throws XmlException

    {

        assert c.isRoot();

        // The type in the options overrides all sniffing

        options = XmlOptions.maskNull( options );

       

        SchemaType optionType = (SchemaType) options.get( XmlOptions.DOCUMENT_TYPE );

        if (optionType != null)

        {

            c.setType( optionType );

            return;

        }

        SchemaType type = null;

        // An xsi:type can be used to pick a type out of the loader, or used to refine

        // a type with a name.

        if (requestedType == null || requestedType.getName() != null)

        {

            QName xsiTypeName = c.getXsiTypeName();

            SchemaType xsiSchemaType =

                xsiTypeName == null ? null : c._locale._schemaTypeLoader.findType( xsiTypeName );

            if (requestedType == null || requestedType.isAssignableFrom( xsiSchemaType ))

                type = xsiSchemaType;

        }

        // Look for a document element to establish type

       

        if (type == null && (requestedType == null || requestedType.isDocumentType()))

        {

            assert c.isRoot();

           

            c.push();

            QName docElemName =

                !c.hasAttrs() && Locale.toFirstChildElement( c ) &&

                    !Locale.toNextSiblingElement( c )

                        ? c.getName() : null;

            c.pop();

            if (docElemName != null)

            {

                type = c._locale._schemaTypeLoader.findDocumentType( docElemName );

                if (type != null && requestedType != null)

                {

                    QName requesteddocElemNameName = requestedType.getDocumentElementName();

                   

                    if (!requesteddocElemNameName.equals( docElemName ) &&

                            !requestedType.isValidSubstitution( docElemName ))

                    {

                        throw

                            new XmlException(

                                "Element " + QNameHelper.pretty( docElemName ) +

                                " is not a valid " + QNameHelper.pretty( requesteddocElemNameName ) +

                                " document or a valid substitution.");

                    }

                }

            }

        }

       

        if (type == null && requestedType == null)

        {

            c.push();

            type =

                Locale.toFirstNormalAttr( c ) && !Locale.toNextNormalAttr( c )

                  ? c._locale._schemaTypeLoader.findAttributeType( c.getName() ) : null;

            c.pop();

        }

        if (type == null)

            type = requestedType;

        if (type == null)

            type = XmlBeans.NO_TYPE;

        c.setType( type );

        if (requestedType != null)

        {

            if (type.isDocumentType())

                verifyDocumentType( c, type.getDocumentElementName() );

            else if (type.isAttributeType())

                verifyAttributeType( c, type.getAttributeTypeAttributeName() );

        }

    }

   

    private static boolean namespacesSame ( QName n1, QName n2 )

    {

        if (n1 == n2)

            return true;

        if (n1 == null || n2 == null)

            return false;

        if (n1.getNamespaceURI() == n2.getNamespaceURI())

            return true;

        if (n1.getNamespaceURI() == null || n2.getNamespaceURI() == null)

            return false;

        return n1.getNamespaceURI().equals( n2.getNamespaceURI() );

    }

    private static void addNamespace ( StringBuffer sb, QName name )

    {

        if (name.getNamespaceURI() == null)

            sb.append( "<no namespace>" );

        else

        {

            sb.append( "\"" );

            sb.append( name.getNamespaceURI() );

            sb.append( "\"" );

        }

    }

    private static void verifyDocumentType ( Cur c, QName docElemName ) throws XmlException

    {

        assert c.isRoot();

       

        c.push();

        try

        {

            StringBuffer sb = null;

            if (!Locale.toFirstChildElement( c ) || Locale.toNextSiblingElement( c ))

            {

                sb = new StringBuffer();

                sb.append( "The document is not a " );

                sb.append( QNameHelper.pretty( docElemName ) );

                sb.append( c.isRoot() ? ": no document element" : ": multiple document elements" );

            }

            else

            {

                QName name = c.getName();

                if (!name.equals( docElemName ))

                {

                    sb = new StringBuffer();

                    sb.append( "The document is not a " );

                    sb.append( QNameHelper.pretty( docElemName ) );

                    if (docElemName.getLocalPart().equals( name.getLocalPart() ))

                    {

                        sb.append( ": document element namespace mismatch " );

                        sb.append( "expected " );

                        addNamespace( sb, docElemName );

                        sb.append( " got " );

                        addNamespace(sb,  name );

                    }

                    else if (namespacesSame( docElemName, name ))

                    {

                        sb.append( ": document element local name mismatch " );

                        sb.append( "expected " + docElemName.getLocalPart() );

                        sb.append( " got " + name.getLocalPart() );

                    }

                    else

                    {

                        sb.append( ": document element mismatch " );

                        sb.append( "got " );

                        sb.append( QNameHelper.pretty( name ) );

                    }

                }

            }

            if (sb != null)

            {

                XmlError err = XmlError.forCursor( sb.toString(), new Cursor( c ) );

                throw new XmlException( err.toString(), null, err );

            }

        }

        finally

        {

            c.pop();

        }

    }

    private static void verifyAttributeType ( Cur c, QName attrName ) throws XmlException

    {

        assert c.isRoot();

        c.push();

        try

        {

            StringBuffer sb = null;

            if (!Locale.toFirstNormalAttr( c ) || Locale.toNextNormalAttr( c ))

            {

                sb = new StringBuffer();

                sb.append( "The document is not a " );

                sb.append( QNameHelper.pretty( attrName ) );

                sb.append( c.isRoot() ? ": no attributes" : ": multiple attributes" );

            }

            else

            {

                QName name = c.getName();

                if (!name.equals( attrName ))

                {

                    sb = new StringBuffer();

                    sb.append( "The document is not a " );

                    sb.append( QNameHelper.pretty( attrName ) );

                    if (attrName.getLocalPart().equals( name.getLocalPart() ))

                    {

                        sb.append( ": attribute namespace mismatch " );

                        sb.append( "expected " );

                        addNamespace( sb, attrName );

                        sb.append( " got " );

                        addNamespace(sb,  name );

                    }

                    else if (namespacesSame( attrName, name ))

                    {

                        sb.append( ": attribute local name mismatch " );

                        sb.append( "expected " + attrName.getLocalPart() );

                        sb.append( " got " + name.getLocalPart() );

                    }

                    else

                    {

                        sb.append( ": attribute element mismatch " );

                        sb.append( "got " );

                        sb.append( QNameHelper.pretty( name ) );

                    }

                }

            }

            if (sb != null)

            {

                XmlError err = XmlError.forCursor( sb.toString(), new Cursor( c ) );

                throw new XmlException( err.toString(), null, err );

            }

        }

        finally

        {

            c.pop();

        }

    }

    static boolean isFragmentQName ( QName name )

    {

        return name.equals( Locale._openuriFragment ) || name.equals( Locale._xmlFragment );

    }

    static boolean isFragment ( Cur start, Cur end )

    {

        assert !end.isAttr();

        start.push();

        end.push();

        int numDocElems = 0;

        boolean isFrag = false;

       

        while ( ! start.isSamePos( end ) )

        {

            int k = start.kind();

            if (k == ATTR)

                break;

           

            if (k == TEXT && !isWhiteSpace( start.getCharsAsString( -1 )))

            {

                isFrag = true;

                break;

            }

            if (k == ELEM && ++numDocElems > 1)

            {

                isFrag = true;

                break;

            }