/*

 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.org.apache.xerces.internal.impl;

import com.sun.xml.internal.stream.Entity;

import com.sun.xml.internal.stream.StaxErrorReporter;

import com.sun.xml.internal.stream.XMLEntityStorage;

import com.sun.xml.internal.stream.events.EntityDeclarationImpl;

import com.sun.xml.internal.stream.events.NotationDeclarationImpl;

import javax.xml.namespace.NamespaceContext;

import com.sun.org.apache.xerces.internal.xni.XNIException;

import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;

import javax.xml.XMLConstants;

import javax.xml.namespace.QName;

import javax.xml.stream.Location;

import javax.xml.stream.events.XMLEvent;

import com.sun.org.apache.xerces.internal.util.NamespaceContextWrapper;

import com.sun.org.apache.xerces.internal.util.SymbolTable;

import com.sun.xml.internal.stream.dtd.nonvalidating.XMLNotationDecl;

import com.sun.xml.internal.stream.dtd.nonvalidating.DTDGrammar;

import java.io.BufferedInputStream;

import java.io.BufferedReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.Reader;

import java.util.ArrayList;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.List;

import javax.xml.stream.XMLInputFactory;

import javax.xml.stream.XMLStreamConstants;

import javax.xml.stream.XMLStreamException;

import com.sun.org.apache.xerces.internal.impl.msg.XMLMessageFormatter;

import com.sun.org.apache.xerces.internal.util.XMLChar;

import com.sun.org.apache.xerces.internal.util.XMLStringBuffer;

import com.sun.org.apache.xerces.internal.util.NamespaceSupport;

import com.sun.org.apache.xerces.internal.util.XMLAttributesImpl;

import com.sun.org.apache.xerces.internal.impl.Constants;

import com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler;

import com.sun.xml.internal.stream.dtd.DTDGrammarUtil;

/** This class implements javax.xml.stream.XMLStreamReader. It makes use of XML*Scanner classes to

 * derive most of its functionality. If desired, Application can reuse this instance by calling

 * reset() and setInputSource().

 *

 * @author Neeraj Bajaj Sun Microsystems,Inc.

 * @author K.Venugopal Sun Microsystems,Inc.

 * @author Sunitha Reddy Sun Microsystems,Inc.

 */

public class XMLStreamReaderImpl implements javax.xml.stream.XMLStreamReader {

    /** Property identifier: entity manager. */

    protected static final String ENTITY_MANAGER =

    Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_MANAGER_PROPERTY;

    /** Property identifier: Error Reporter. */

    protected static final String ERROR_REPORTER =

    Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY;

    /** Property identifier: Symbol table. */

    protected static final String SYMBOL_TABLE =

    Constants.XERCES_PROPERTY_PREFIX + Constants.SYMBOL_TABLE_PROPERTY;

    protected static final String READER_IN_DEFINED_STATE =

    Constants.READER_IN_DEFINED_STATE;

    private SymbolTable fSymbolTable = new SymbolTable();

    /** Document scanner. */

    protected XMLDocumentScannerImpl fScanner = new XMLNSDocumentScannerImpl();

    //make Global NamespaceContextWrapper object,  fScanner.getNamespaceContext() is dynamic object and ita value changes

    //as per the state of the parser.

    protected NamespaceContextWrapper fNamespaceContextWrapper = new NamespaceContextWrapper((NamespaceSupport)fScanner.getNamespaceContext()) ;

    protected XMLEntityManager fEntityManager = new XMLEntityManager();

    protected StaxErrorReporter fErrorReporter = new StaxErrorReporter();

    /** Entity scanner, this alwasy works on last entity that was opened. */

    protected XMLEntityScanner fEntityScanner = null;

    /** Input Source */

    protected XMLInputSource fInputSource = null;

    /** Store properties*/

    protected PropertyManager fPropertyManager = null ;

    /** current event type */

    private int fEventType ;

    /** debug flag*/

    static final boolean DEBUG = false ;

    /** more to scan */

    private boolean fReuse = true;

    private boolean fReaderInDefinedState = true ;

    private boolean fBindNamespaces = true;

    private String fDTDDecl = null;

    private String versionStr = null;

    /**

     * @param inputStream

     * @param props

     * @throws XMLStreamException

     */

    public XMLStreamReaderImpl(InputStream inputStream, PropertyManager props) throws  XMLStreamException {

        init(props);

        //publicId, systemid, baseSystemId, inputStream, enocding

        XMLInputSource inputSource = new XMLInputSource(null,null,null,inputStream,null);

        //pass the input source to document scanner impl.

        setInputSource(inputSource);

    }

    public XMLDocumentScannerImpl getScanner(){

        System.out.println("returning scanner");

        return fScanner;

    }

    /**

     * @param systemid

     * @param props

     * @throws XMLStreamException

     */

    public XMLStreamReaderImpl(String systemid, PropertyManager props) throws  XMLStreamException {

        init(props);

        //publicId, systemid, baseSystemId, inputStream, enocding

        XMLInputSource inputSource = new XMLInputSource(null,systemid,null);

        //pass the input source to document scanner impl.

        setInputSource(inputSource);

    }

    /**

     * @param inputStream

     * @param encoding

     * @param props

     * @throws XMLStreamException

     */

    public XMLStreamReaderImpl(InputStream inputStream, String encoding, PropertyManager props ) throws  XMLStreamException {

        init(props);

        //publicId, systemid, baseSystemId, inputStream, enocding

        XMLInputSource inputSource = new XMLInputSource(null,null,null, new BufferedInputStream(inputStream),encoding );

        //pass the input source to document scanner impl.

        setInputSource(inputSource);

    }

    /**

     * @param reader

     * @param props

     * @throws XMLStreamException

     */

    public XMLStreamReaderImpl(Reader reader, PropertyManager props) throws  XMLStreamException {

        init(props);

        //publicId, systemid, baseSystemId, inputStream, enocding

        //xxx: Using buffered reader

        XMLInputSource inputSource = new XMLInputSource(null,null,null,new BufferedReader(reader),null);

        //pass the input source to document scanner impl.

        setInputSource(inputSource);

    }

    /**

     * @param inputSource

     * @param props

     * @throws XMLStreamException

     */

    public XMLStreamReaderImpl(XMLInputSource inputSource, PropertyManager props) throws  XMLStreamException {

        init(props);

        //pass the input source to document scanner impl.

        setInputSource(inputSource);

    }

    /**

     * @param inputSource

     * @throws XMLStreamException

     */

    public void setInputSource(XMLInputSource inputSource ) throws XMLStreamException {

        //once setInputSource() is called this instance is busy parsing the inputsource supplied

        //this instances is free for reuse if parser has reached END_DOCUMENT state or application has

        //called close()

        fReuse = false;

        try{

            fScanner.setInputSource(inputSource) ;

            //XMLStreamReader should be in defined state

            if(fReaderInDefinedState){

                fEventType = fScanner.next();

                if (versionStr == null)

                    versionStr = getVersion();

                if (fEventType == XMLStreamConstants.START_DOCUMENT && versionStr != null && versionStr.equals("1.1")){

                    switchToXML11Scanner();

                }

            }

        }catch(java.io.IOException ex){

            throw new XMLStreamException(ex);

        } catch(XNIException ex){ //Issue 56 XNIException not caught

            throw new XMLStreamException(ex.getMessage(), getLocation(), ex.getException());

        }

    }//setInputSource

    void init(PropertyManager propertyManager) throws XMLStreamException {

        fPropertyManager = propertyManager;

        //set Stax internal properties -- Note that these instances are being created in XMLReaderImpl.

        //1.SymbolTable

        //2.XMLMessageFormatter

        //3.XMLEntityManager

        //4. call reset()

        //1.

        propertyManager.setProperty(SYMBOL_TABLE,  fSymbolTable ) ;

        //2.

        propertyManager.setProperty(ERROR_REPORTER,  fErrorReporter ) ;

        //3.

        propertyManager.setProperty(ENTITY_MANAGER, fEntityManager);

        //4.

        reset();

    }

    /** This function tells if this instances is available for reuse.

     * One must call reset() and setInputSource() to be able to reuse

     * this instance.

     */

    public boolean canReuse(){

        if(DEBUG){

            System.out.println("fReuse = " + fReuse);

            System.out.println("fEventType = " + getEventTypeString(fEventType) );

        }

        //when parsing begins, fReuse is set to false

        //fReuse is set to 'true' when application calls close()

        return fReuse;

    }

    /**

     * Resets this instance so that this instance is ready for reuse.

     */

    public void reset(){

        fReuse = true;

        fEventType = 0 ;

        //reset entity manager

        fEntityManager.reset(fPropertyManager);

        //reset the scanner

        fScanner.reset(fPropertyManager);

        //REVISIT:this is too ugly -- we are getting XMLEntityManager and XMLEntityReader from

        //property manager, it should be only XMLEntityManager

        fDTDDecl = null;

        fEntityScanner = (XMLEntityScanner)fEntityManager.getEntityScanner()  ;

        //default value for this property is true. However, this should be false when using XMLEventReader... Ugh..

        //because XMLEventReader should not have defined state.

        fReaderInDefinedState = ((Boolean)fPropertyManager.getProperty(READER_IN_DEFINED_STATE)).booleanValue();

        fBindNamespaces = ((Boolean)fPropertyManager.getProperty(XMLInputFactory.IS_NAMESPACE_AWARE)).booleanValue();

        versionStr = null;

    }

    /** Frees any resources associated with this Reader. This method does not close the underlying input source.

     * @throws XMLStreamException if there are errors freeing associated resources

     */

    public void close() throws XMLStreamException {

        //xxx: Check what this function is intended to do.

        //reset();

        fReuse = true ;

    }

    /** Returns the character encoding declared on the xml declaration Returns null if none was declared

     * @return the encoding declared in the document or null

     */

    public String getCharacterEncodingScheme() {

        return fScanner.getCharacterEncodingScheme();

    }

    /**

     * @return

     */

    public int getColumnNumber() {

        return fEntityScanner.getColumnNumber();

    }//getColumnNumber

    /** Return input encoding if known or null if unknown.

     * @return the encoding of this instance or null

     */

    public String getEncoding() {

        return fEntityScanner.getEncoding();

    }//getEncoding

    /** Returns the current value of the parse event as a string, this returns the string value of a CHARACTERS event, returns the value of a COMMENT, the replacement value for an ENTITY_REFERENCE, the string value of a CDATA section, the string value for a SPACE event, or the String value of the internal subset of the DTD. If an ENTITY_REFERENCE has been resolved, any character data will be reported as CHARACTERS events.

     * @return the current text or null

     */

    public int getEventType() {

        return fEventType ;

    }//getEventType

    /**

     * @return

     */

    public int getLineNumber() {

        return fEntityScanner.getLineNumber() ;

    }//getLineNumber

    public String getLocalName() {

        if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT){

            //xxx check whats the value of fCurrentElement

            return fScanner.getElementQName().localpart ;

        }

        else if(fEventType == XMLEvent.ENTITY_REFERENCE){

            return fScanner.getEntityName();

        }

        throw new IllegalStateException("Method getLocalName() cannot be called for " +

            getEventTypeString(fEventType) + " event.");

    }//getLocalName()

    /**

     * @return

     */

    public String getNamespaceURI() {

        //doesn't take care of Attribute as separte event

        if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT){

            return fScanner.getElementQName().uri ;

        }

        return null ;

    }//getNamespaceURI

    /** Get the data section of a processing instruction

     * @return the data or null

     */

    public String getPIData() {

        if( fEventType == XMLEvent.PROCESSING_INSTRUCTION){

            return fScanner.getPIData().toString();

        }

        else throw new java.lang.IllegalStateException("Current state of the parser is " + getEventTypeString(fEventType) +

        " But Expected state is " + XMLEvent.PROCESSING_INSTRUCTION  ) ;

    }//getPIData

    /** Get the target of a processing instruction

     * @return the target or null

     */

    public String getPITarget() {

        if( fEventType == XMLEvent.PROCESSING_INSTRUCTION){

            return fScanner.getPITarget();

        }

        else throw new java.lang.IllegalStateException("Current state of the parser is " + getEventTypeString(fEventType) +

        " But Expected state is " + XMLEvent.PROCESSING_INSTRUCTION  ) ;

    }//getPITarget

    /**

    * @return the prefix of the current event, or null if the event does

    * not have a prefix. For START_ELEMENT and END_ELEMENT, return

    * XMLConstants.DEFAULT_NS_PREFIX when no prefix is available.

    */

    public String getPrefix() {

        if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT){

            String prefix = fScanner.getElementQName().prefix;

            return prefix == null ? XMLConstants.DEFAULT_NS_PREFIX : prefix;

        }

        return null ;

    }//getPrefix()

    /**

     * @return

     */

    public char[] getTextCharacters() {

        if( fEventType == XMLEvent.CHARACTERS || fEventType == XMLEvent.COMMENT

                 || fEventType == XMLEvent.CDATA || fEventType == XMLEvent.SPACE){

             return fScanner.getCharacterData().ch;

         } else{

             throw new IllegalStateException("Current state = " + getEventTypeString(fEventType)

             + " is not among the states " + getEventTypeString(XMLEvent.CHARACTERS) + " , "

                     + getEventTypeString(XMLEvent.COMMENT) + " , " + getEventTypeString(XMLEvent.CDATA)

                     + " , " + getEventTypeString(XMLEvent.SPACE) +" valid for getTextCharacters() " ) ;

         }

    }

    /**

     * @return

     */

    public int getTextLength() {

        if( fEventType == XMLEvent.CHARACTERS || fEventType == XMLEvent.COMMENT

                 || fEventType == XMLEvent.CDATA || fEventType == XMLEvent.SPACE){

             return fScanner.getCharacterData().length;

         } else{

             throw new IllegalStateException("Current state = " + getEventTypeString(fEventType)

             + " is not among the states " + getEventTypeString(XMLEvent.CHARACTERS) + " , "

                     + getEventTypeString(XMLEvent.COMMENT) + " , " + getEventTypeString(XMLEvent.CDATA)

                     + " , " + getEventTypeString(XMLEvent.SPACE) +" valid for getTextLength() " ) ;

         }

   }

    /**

     * @return

     */

    public int getTextStart() {

        if( fEventType == XMLEvent.CHARACTERS || fEventType == XMLEvent.COMMENT || fEventType == XMLEvent.CDATA || fEventType == XMLEvent.SPACE){

             return  fScanner.getCharacterData().offset;

         } else{

             throw new IllegalStateException("Current state = " + getEventTypeString(fEventType)

             + " is not among the states " + getEventTypeString(XMLEvent.CHARACTERS) + " , "

                     + getEventTypeString(XMLEvent.COMMENT) + " , " + getEventTypeString(XMLEvent.CDATA)

                     + " , " + getEventTypeString(XMLEvent.SPACE) +" valid for getTextStart() " ) ;

         }

    }

    /**

     * @return

     */

    public String getValue() {

        if(fEventType == XMLEvent.PROCESSING_INSTRUCTION){

            return fScanner.getPIData().toString();

        } else if(fEventType == XMLEvent.COMMENT){

            return fScanner.getComment();

        } else if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT){

            return fScanner.getElementQName().localpart ;

        } else if(fEventType == XMLEvent.CHARACTERS){

            return fScanner.getCharacterData().toString();

        }

        return null;

    }//getValue()

    /** Get the XML language version of the current document being parsed */

    public String getVersion() {

    }

    /**

     * @return

     */

    public boolean hasAttributes() {

        return fScanner.getAttributeIterator().getLength() > 0 ? true : false ;

    }

    /** this Funtion returns true if the current event has name */

    public boolean hasName() {

        if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT) {

            return true;

        }  else {

            return false;

        }

    }//hasName()

    /**

     * @throws XMLStreamException

     * @return

     */

    public boolean hasNext() throws XMLStreamException {

        //the scanner returns -1 when it detects a broken stream

        if (fEventType == -1) return false;

        //we can check in scanners if the scanner state is not set to

        //terminating, we still have more events.

        return fEventType != XMLEvent.END_DOCUMENT;

    }

    /**

     * @return

     */

    public boolean hasValue() {

        if(fEventType == XMLEvent.START_ELEMENT || fEventType == XMLEvent.END_ELEMENT

        || fEventType == XMLEvent.ENTITY_REFERENCE || fEventType == XMLEvent.PROCESSING_INSTRUCTION

        || fEventType == XMLEvent.COMMENT || fEventType == XMLEvent.CHARACTERS) {

            return true;

        } else {

            return false;

        }

    }

    /**

     * @return

     */

    public boolean isEndElement() {

        return fEventType == XMLEvent.END_ELEMENT;

    }

    /**

     * @return

     */

    public boolean isStandalone() {

        return fScanner.isStandAlone();

    }

    /**

     * @return

     */

    public boolean isStartElement() {

        return fEventType == XMLEvent.START_ELEMENT;

    }

    /**

     *  Returns true if the cursor points to a character data event that consists of all whitespace

     *  Application calling this method needs to cache the value and avoid calling this method again

     *  for the same event.

     * @return

     */

    public boolean isWhiteSpace() {