* The Apache Software License, Version 1.1

*

*

* Copyright (c) 1999,2000 The Apache Software Foundation.  All rights

* reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

*

* 1. Redistributions of source code must retain the above copyright

*    notice, this list of conditions and the following disclaimer.

*

* 2. Redistributions in binary form must reproduce the above copyright

*    notice, this list of conditions and the following disclaimer in

*    the documentation and/or other materials provided with the

*    distribution.

*

* 3. The end-user documentation included with the redistribution,

*    if any, must include the following acknowledgment: 

*       "This product includes software developed by the

*        Apache Software Foundation (http://www.apache.org/)."

*    Alternately, this acknowledgment may appear in the software itself,

*    if and wherever such third-party acknowledgments normally appear.

*

* 4. The names "Xerces" and "Apache Software Foundation" must

*    not be used to endorse or promote products derived from this

*    software without prior written permission. For written

*    permission, please contact apache@apache.org.

*

* 5. Products derived from this software may not be called "Apache",

*    nor may "Apache" appear in their name, without prior written

*    permission of the Apache Software Foundation.

*

* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

* DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

* SUCH DAMAGE.

* ====================================================================

*

* This software consists of voluntary contributions made by many

* individuals on behalf of the Apache Software Foundation and was

* originally based on software copyright (c) 1999, International

* Business Machines, Inc., http://www.apache.org.  For more

* information on the Apache Software Foundation, please see

* <http://www.apache.org/>.

*/

* This class is the super all-in-one validator used by the parser.

*

* @version $Id: XMLValidator.java,v 1.77 2000/08/31 00:41:57 jeffreyr Exp $

*/

XMLEntityHandler.CharDataHandler,

XMLDocumentScanner.EventHandler,

NamespacesScope.NamespacesHandler {

    //

    // Constants

    //

    // debugging

    private static final boolean PRINT_EXCEPTION_STACK_TRACE = false;

    private static final boolean DEBUG_PRINT_ATTRIBUTES = false;

    private static final boolean DEBUG_PRINT_CONTENT = false;

    private static final boolean DEBUG_SCHEMA_VALIDATION = false;

    private static final boolean DEBUG_ELEMENT_CHILDREN = false;

    // Chunk size constants

    private static final int CHUNK_SHIFT = 8;           // 2^8 = 256

    private static final int CHUNK_SIZE = (1 << CHUNK_SHIFT);

    private static final int CHUNK_MASK = CHUNK_SIZE - 1;

    private static final int INITIAL_CHUNK_COUNT = (1 << (10 - CHUNK_SHIFT));   // 2^10 = 1k

    private Hashtable fIdDefs = null;

    private  StateMessageDatatype fStoreIDRef = new StateMessageDatatype() {

        private Hashtable fIdDefs;

        public Object getDatatypeObject(){

            return(Object) fIdDefs;

        }

        public int    getDatatypeState(){

            return IDREFDatatypeValidator.IDREF_STORE;

        }

        public void setDatatypeObject( Object data ){

            fIdDefs = (Hashtable) data;

        }

    };

    private StateMessageDatatype fResetID = new StateMessageDatatype() {

        public Object getDatatypeObject(){

            return(Object) null;

        }

        public int    getDatatypeState(){

            return IDDatatypeValidator.ID_CLEAR;

        }

        public void setDatatypeObject( Object data ){

        }

    };

    private StateMessageDatatype fResetIDRef = new StateMessageDatatype() {

        public Object getDatatypeObject(){

            return(Object) null;

        }

        public int    getDatatypeState(){

            return IDREFDatatypeValidator.IDREF_CLEAR;

        }

        public void setDatatypeObject( Object data ){

        }

    };

    private  StateMessageDatatype fValidateIDRef = new StateMessageDatatype() {

        public Object getDatatypeObject(){

            return(Object) null;

        }

        public int    getDatatypeState(){

            return IDREFDatatypeValidator.IDREF_VALIDATE;

        }

        public void setDatatypeObject( Object data ){

        }

    };

    private  StateMessageDatatype fValidateENTITYMsg = new StateMessageDatatype() {

        private  Object  packagedMessage = null;

        public Object getDatatypeObject(){

            return packagedMessage;

        }

        public int    getDatatypeState(){

            return ENTITYDatatypeValidator.ENTITY_INITIALIZE;//No state

        }

        public void setDatatypeObject( Object data ){

            packagedMessage = data;// Set Entity Handler

        }

    };

    /*

    private  StateMessageDatatype fValidateNOTATIONMsg = new StateMessageDatatype() {

        private  Object  packagedMessage = null;

        public Object getDatatypeObject(){

            return packagedMessage;

        }

        public int    getDatatypeState(){

            return NOTATIONDatatypeValidator.ENTITY_INITIALIZE;//No state

        }

        public void setDatatypeObject( Object data ){

            packagedMessage = data;// Set Entity Handler

        }

    };

    */

    //

    // Data

    //

    // REVISIT: The data should be regrouped and re-organized so that

    //          it's easier to find a meaningful field.

    // debugging

//    private static boolean DEBUG = false;

    // other

    // attribute validators

    private AttributeValidator fAttValidatorNOTATION = new AttValidatorNOTATION();

    private AttributeValidator fAttValidatorENUMERATION = new AttValidatorENUMERATION();

    private AttributeValidator fAttValidatorDATATYPE = null;

    // Package access for use by AttributeValidator classes.

    StringPool fStringPool = null;

    boolean fValidating = false;

    boolean fInElementContent = false;

    int fStandaloneReader = -1;

    // settings

    private boolean fValidationEnabled = false;

    private boolean fDynamicValidation = false;

    private boolean fSchemaValidation = true;

    private boolean fValidationEnabledByDynamic = false;

    private boolean fDynamicDisabledByValidation = false;

    private boolean fWarningOnDuplicateAttDef = false;

    private boolean fWarningOnUndeclaredElements = false;

    private boolean fLoadDTDGrammar = true;

    // declarations

    private int fDeclaration[];

    private XMLErrorReporter fErrorReporter = null;

    private DefaultEntityHandler fEntityHandler = null;

    private QName fCurrentElement = new QName();

    private ContentLeafNameTypeVector[] fContentLeafStack = new ContentLeafNameTypeVector[8];

    private int[] fValidationFlagStack = new int[8];

    private int[] fScopeStack = new int[8];

    private int[] fGrammarNameSpaceIndexStack = new int[8];

    private int[] fElementEntityStack = new int[8];

    private int[] fElementIndexStack = new int[8];

    private int[] fContentSpecTypeStack = new int[8];

    private static final int sizeQNameParts      = 8;

    private QName[] fElementQNamePartsStack      = new QName[sizeQNameParts];

    private QName[] fElementChildren = new QName[32];

    private int fElementChildrenLength = 0;

    private int[] fElementChildrenOffsetStack = new int[32];

    private int fElementDepth = -1;

    private boolean fNamespacesEnabled = false;

    private NamespacesScope fNamespacesScope = null;

    private int fNamespacesPrefix = -1;

    private QName fRootElement = new QName();

    private int fAttrListHandle = -1;

    private int fCurrentElementEntity = -1;

    private int fCurrentElementIndex = -1;

    private int fCurrentContentSpecType = -1;