/*

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

 */

/*

 * Copyright 2005 The Apache Software Foundation.

 *

 * 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.

 */

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

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

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

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

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

import java.io.EOFException;

import java.io.IOException;

import javax.xml.stream.XMLInputFactory;

import javax.xml.stream.events.XMLEvent;

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

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

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

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.XMLSymbols;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import javax.xml.stream.XMLStreamConstants;

import javax.xml.stream.events.XMLEvent;

/**

 *

 * This class is responsible for scanning the structure and content

 * of document fragments.

 *

 * This class has been modified as per the new design which is more suited to

 * efficiently build pull parser. Lot of improvements have been done and

 * the code has been added to support stax functionality/features.

 *

 * @author Neeraj Bajaj SUN Microsystems

 * @author K.Venugopal SUN Microsystems

 * @author Glenn Marcy, IBM

 * @author Andy Clark, IBM

 * @author Arnaud  Le Hors, IBM

 * @author Eric Ye, IBM

 * @author Sunitha Reddy, SUN Microsystems

 * @version $Id: XMLDocumentFragmentScannerImpl.java,v 1.19 2010-11-02 19:54:55 joehw Exp $

 *

 */

public class XMLDocumentFragmentScannerImpl

        extends XMLScanner

        implements XMLDocumentScanner, XMLComponent, XMLEntityHandler, XMLBufferListener {

    //

    // Constants

    //

    protected int fElementAttributeLimit;

    /** External subset resolver. **/

    protected ExternalSubsetResolver fExternalSubsetResolver;

    // scanner states

    //XXX this should be divided into more states.

    /** Scanner state: start of markup. */

    protected static final int SCANNER_STATE_START_OF_MARKUP = 21;

    /** Scanner state: content. */

    protected static final int SCANNER_STATE_CONTENT = 22;

    /** Scanner state: processing instruction. */

    protected static final int SCANNER_STATE_PI = 23;

    /** Scanner state: DOCTYPE. */

    protected static final int SCANNER_STATE_DOCTYPE = 24;

    /** Scanner state: XML Declaration */

    protected static final int SCANNER_STATE_XML_DECL = 25;

    /** Scanner state: root element. */

    protected static final int SCANNER_STATE_ROOT_ELEMENT = 26;

    /** Scanner state: comment. */

    protected static final int SCANNER_STATE_COMMENT = 27;

    /** Scanner state: reference. */

    protected static final int SCANNER_STATE_REFERENCE = 28;

    // <book type="hard"> reading attribute name 'type'

    protected static final int SCANNER_STATE_ATTRIBUTE = 29;

    // <book type="hard"> //reading attribute value.

    protected static final int SCANNER_STATE_ATTRIBUTE_VALUE = 30;

    /** Scanner state: trailing misc. USED BY DOCUMENT_SCANNER_IMPL*/

    //protected static final int SCANNER_STATE_TRAILING_MISC = 32;

    /** Scanner state: end of input. */

    protected static final int SCANNER_STATE_END_OF_INPUT = 33;

    /** Scanner state: terminated. */

    protected static final int SCANNER_STATE_TERMINATED = 34;

    /** Scanner state: CDATA section. */

    protected static final int SCANNER_STATE_CDATA = 35;

    /** Scanner state: Text declaration. */

    protected static final int SCANNER_STATE_TEXT_DECL = 36;

    /** Scanner state: Text declaration. */

    protected static final int SCANNER_STATE_CHARACTER_DATA = 37;

    //<book type="hard">foo</book>

    protected static final int SCANNER_STATE_START_ELEMENT_TAG = 38;

    //<book type="hard">foo</book> reading </book>

    protected static final int SCANNER_STATE_END_ELEMENT_TAG = 39;

    protected static final int SCANNER_STATE_CHAR_REFERENCE = 40;

    protected static final int SCANNER_STATE_BUILT_IN_REFS = 41;

    // feature identifiers

    /** Feature identifier: notify built-in refereces. */

    protected static final String NOTIFY_BUILTIN_REFS =

            Constants.XERCES_FEATURE_PREFIX + Constants.NOTIFY_BUILTIN_REFS_FEATURE;

    /** Property identifier: entity resolver. */

    protected static final String ENTITY_RESOLVER =

            Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_RESOLVER_PROPERTY;

    // recognized features and properties

    /** Recognized features. */

    private static final String[] RECOGNIZED_FEATURES = {

                NAMESPACES,

                VALIDATION,

                NOTIFY_BUILTIN_REFS,

                NOTIFY_CHAR_REFS,

                Constants.STAX_REPORT_CDATA_EVENT

    };

    /** Feature defaults. */

    private static final Boolean[] FEATURE_DEFAULTS = {

                Boolean.TRUE,

                null,

                Boolean.FALSE,

                Boolean.FALSE,

                Boolean.TRUE

    };

    /** Recognized properties. */

    private static final String[] RECOGNIZED_PROPERTIES = {

        SYMBOL_TABLE,

                ERROR_REPORTER,

                ENTITY_MANAGER,

    };

    /** Property defaults. */

    private static final Object[] PROPERTY_DEFAULTS = {

                null,

                null,

                null,

    };

    // debugging

    /** Debug scanner state. */

    private static final boolean DEBUG_SCANNER_STATE = false;

    /** Debug driver. */

    private static final boolean DEBUG_DISPATCHER = false;

    /** Debug content driver scanning. */

    protected static final boolean DEBUG_START_END_ELEMENT = false;

    /** Debug driver next */

    protected static final boolean DEBUG_NEXT = false ;

    /** Debug driver next */

    protected static final boolean DEBUG = false;

    protected static final boolean DEBUG_COALESCE = false;

    //

    // Data

    //

    // protected data

    /** Document handler. */

    protected XMLDocumentHandler fDocumentHandler;

    protected int fScannerLastState ;

    /** Entity Storage */

    protected XMLEntityStorage fEntityStore;

    /** Entity stack. */

    protected int[] fEntityStack = new int[4];

    /** Markup depth. */

    protected int fMarkupDepth;

    //is the element empty

    protected boolean fEmptyElement ;

    //track if we are reading attributes, this is usefule while

    //there is a callback

    protected boolean fReadingAttributes = false;

    /** Scanner state. */

    protected int fScannerState;

    /** SubScanner state: inside scanContent method. */

    protected boolean fInScanContent = false;

    protected boolean fLastSectionWasCData = false;

    protected boolean fLastSectionWasEntityReference = false;

    protected boolean fLastSectionWasCharacterData = false;

    /** has external dtd */

    protected boolean fHasExternalDTD;

    /** Standalone. */

    protected boolean fStandaloneSet;

    protected boolean fStandalone;

    protected String fVersion;

    // element information

    /** Current element. */

    protected QName fCurrentElement;

    /** Element stack. */

    protected ElementStack fElementStack = new ElementStack();

    protected ElementStack2 fElementStack2 = new ElementStack2();

    // other info

    /** Document system identifier.

     * REVISIT:  So what's this used for?  - NG

     * protected String fDocumentSystemId;

     ******/

    protected String fPITarget ;

    //xxx do we need to create an extra XMLString object... look for using fTempString for collecting all the data values

    protected XMLString fPIData  = new XMLString();

    // features

    /** Notify built-in references. */

    protected boolean fNotifyBuiltInRefs = false;

    //STAX related properties

    //defaultValues.

    protected boolean fSupportDTD = true;

    protected boolean fReplaceEntityReferences = true;

    protected boolean fSupportExternalEntities = false;

    protected boolean fReportCdataEvent = false ;

    protected boolean fIsCoalesce = false ;

    protected String fDeclaredEncoding =  null;

    /** Xerces Feature: Disallow doctype declaration. */

    protected boolean fDisallowDoctype = false;

    // drivers

    /** Active driver. */

    protected Driver fDriver;

    /** Content driver. */

    protected Driver fContentDriver = createContentDriver();

    // temporary variables

    /** Element QName. */

    protected QName fElementQName = new QName();

    /** Attribute QName. */

    protected QName fAttributeQName = new QName();

    /**

     * CHANGED: Using XMLAttributesIteratorImpl instead of XMLAttributesImpl. This class

     * implements Iterator interface so we can directly give Attributes in the form of

     * iterator.

     */

    protected XMLAttributesIteratorImpl fAttributes = new XMLAttributesIteratorImpl();

    /** String. */

    protected XMLString fTempString = new XMLString();

    /** String. */

    protected XMLString fTempString2 = new XMLString();

    /** Array of 3 strings. */

    private String[] fStrings = new String[3];

    /** Making the buffer accesible to derived class -- String buffer. */

    protected XMLStringBuffer fStringBuffer = new XMLStringBuffer();

    /** Making the buffer accesible to derived class -- String buffer. */

    protected XMLStringBuffer fStringBuffer2 = new XMLStringBuffer();

    /** stores character data. */

    /** Making the buffer accesible to derived class -- stores PI data */

    protected XMLStringBuffer fContentBuffer = new XMLStringBuffer();

    /** Single character array. */

    private final char[] fSingleChar = new char[1];

    private String fCurrentEntityName = null;

    // New members

    protected boolean fScanToEnd = false;

    protected DTDGrammarUtil dtdGrammarUtil= null;

    protected boolean fAddDefaultAttr = false;

    protected boolean foundBuiltInRefs = false;

    protected SecurityManager fSecurityManager = null;

    //skip element algorithm

    static final short MAX_DEPTH_LIMIT = 5 ;

    static final short ELEMENT_ARRAY_LENGTH = 200 ;

    static final short MAX_POINTER_AT_A_DEPTH = 4 ;

    static final boolean DEBUG_SKIP_ALGORITHM = false;

    //create a elemnet array of length equal to ELEMENT_ARRAY_LENGTH

    String [] fElementArray = new String[ELEMENT_ARRAY_LENGTH] ;

    //pointer location where last element was skipped

    short fLastPointerLocation = 0 ;

    short fElementPointer = 0 ;

    //2D array to store pointer info

    short [] [] fPointerInfo = new short[MAX_DEPTH_LIMIT] [MAX_POINTER_AT_A_DEPTH] ;

    protected String fElementRawname ;

    protected boolean fShouldSkip = false;

    protected boolean fAdd = false ;

    protected boolean fSkip = false;

    /** Reusable Augmentations. */

    private Augmentations fTempAugmentations = null;

    //

    // Constructors

    //

    /** Default constructor. */

    public XMLDocumentFragmentScannerImpl() {

    } // <init>()

    //

    // XMLDocumentScanner methods

    //

    /**

     * Sets the input source.

     *

     * @param inputSource The input source.

     *

     * @throws IOException Thrown on i/o error.

     */

    public void setInputSource(XMLInputSource inputSource) throws IOException {

        fEntityManager.setEntityHandler(this);

        fEntityManager.startEntity("$fragment$", inputSource, false, true);

        // fDocumentSystemId = fEntityManager.expandSystemId(inputSource.getSystemId());

    } // setInputSource(XMLInputSource)

    /**

     * Scans a document.

     *

     * @param complete True if the scanner should scan the document

     *                 completely, pushing all events to the registered

     *                 document handler. A value of false indicates that

     *                 that the scanner should only scan the next portion

     *                 of the document and return. A scanner instance is

     *                 permitted to completely scan a document if it does

     *                 not support this "pull" scanning model.

     *

     * @return True if there is more to scan, false otherwise.

     */

   /* public boolean scanDocument(boolean complete)

    throws IOException, XNIException {

        // keep dispatching "events"

        fEntityManager.setEntityHandler(this);

        return true;

    } // scanDocument(boolean):boolean

    */

    public boolean scanDocument(boolean complete)

    throws IOException, XNIException {

        // keep dispatching "events"

        fEntityManager.setEntityHandler(this);

        //System.out.println(" get Document Handler in NSDocumentHandler " + fDocumentHandler );

        int event = next();

        do {

            switch (event) {

                case XMLStreamConstants.START_DOCUMENT :

                    //fDocumentHandler.startDocument(fEntityManager.getEntityScanner(),fEntityManager.getEntityScanner().getVersion(),fNamespaceContext,null);// not able to get

                    break;

                case XMLStreamConstants.START_ELEMENT :

                    //System.out.println(" in scann element");

                    //fDocumentHandler.startElement(getElementQName(),fAttributes,null);

                    break;

                case XMLStreamConstants.CHARACTERS :

                    fDocumentHandler.characters(getCharacterData(),null);

                    break;

                case XMLStreamConstants.SPACE:

                    //check if getCharacterData() is the right function to retrieve ignorableWhitespace information.

                    //System.out.println("in the space");

                    //fDocumentHandler.ignorableWhitespace(getCharacterData(), null);

                    break;

                case XMLStreamConstants.ENTITY_REFERENCE :

                    //entity reference callback are given in startEntity

                    break;

                case XMLStreamConstants.PROCESSING_INSTRUCTION :

                    fDocumentHandler.processingInstruction(getPITarget(),getPIData(),null);

                    break;

                case XMLStreamConstants.COMMENT :

                    //System.out.println(" in COMMENT of the XMLNSDocumentScannerImpl");

                    fDocumentHandler.comment(getCharacterData(),null);

                    break;

                case XMLStreamConstants.DTD :

                    //all DTD related callbacks are handled in DTDScanner.

                    //1. Stax doesn't define DTD states as it does for XML Document.

                    //therefore we don't need to take care of anything here. So Just break;

                    break;

                case XMLStreamConstants.CDATA:

                    fDocumentHandler.startCDATA(null);

                    //xxx: check if CDATA values comes from getCharacterData() function

                    fDocumentHandler.characters(getCharacterData(),null);

                    fDocumentHandler.endCDATA(null);

                    //System.out.println(" in CDATA of the XMLNSDocumentScannerImpl");

                    break;

                case XMLStreamConstants.NOTATION_DECLARATION :

                    break;

                case XMLStreamConstants.ENTITY_DECLARATION :

                    break;

                case XMLStreamConstants.NAMESPACE :

                    break;

                case XMLStreamConstants.ATTRIBUTE :

                    break;

                case XMLStreamConstants.END_ELEMENT :

                    //do not give callback here.

                    //this callback is given in scanEndElement function.

                    //fDocumentHandler.endElement(getElementQName(),null);

                    break;

                default :

                    throw new InternalError("processing event: " + event);

            }

            //System.out.println("here in before calling next");

            event = next();

            //System.out.println("here in after calling next");

        } while (event!=XMLStreamConstants.END_DOCUMENT && complete);

        if(event == XMLStreamConstants.END_DOCUMENT) {

            fDocumentHandler.endDocument(null);

            return false;

        }

        return true;

    } // scanDocument(boolean):boolean

    public com.sun.org.apache.xerces.internal.xni.QName getElementQName(){

        if(fScannerLastState == XMLEvent.END_ELEMENT){

            fElementQName.setValues(fElementStack.getLastPoppedElement());

        }

        return fElementQName ;

    }

    /** return the next state on the input

     * @return int

     */

    public int next() throws IOException, XNIException {

        return fDriver.next();

    }

    //

    // XMLComponent methods

    //

    /**

     * Resets the component. The component can query the component manager

     * about any features and properties that affect the operation of the