325N/A/*
325N/A * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.xsom.impl.parser.state;
325N/A
325N/Aimport org.xml.sax.Attributes;
325N/Aimport org.xml.sax.SAXException;
325N/A
325N/A/**
325N/A * Dispatches incoming events into sub handlers appropriately
325N/A * so that the interleaving semantics will be correctly realized.
325N/A *
325N/A * @author Kohsuke Kawaguchi (kk@kohsuke.org)
325N/A */
325N/Apublic abstract class NGCCInterleaveFilter implements NGCCEventSource, NGCCEventReceiver {
325N/A protected NGCCInterleaveFilter( NGCCHandler parent, int cookie ) {
325N/A this._parent = parent;
325N/A this._cookie = cookie;
325N/A }
325N/A
325N/A protected void setHandlers( NGCCEventReceiver[] receivers ) {
325N/A this._receivers = receivers;
325N/A }
325N/A
325N/A /** event receiverse. */
325N/A protected NGCCEventReceiver[] _receivers;
325N/A
325N/A public int replace(NGCCEventReceiver oldHandler, NGCCEventReceiver newHandler) {
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]==oldHandler ) {
325N/A _receivers[i]=newHandler;
325N/A return i;
325N/A }
325N/A throw new InternalError(); // a bug in RelaxNGCC.
325N/A }
325N/A
325N/A
325N/A /** Parent handler. */
325N/A private final NGCCHandler _parent;
325N/A /** Cookie given by the parent. */
325N/A private final int _cookie;
325N/A
325N/A
325N/A
325N/A//
325N/A//
325N/A// event handler
325N/A//
325N/A//
325N/A /**
325N/A * Receiver that is being locked and therefore receives all the events.
325N/A * <pre><xmp>
325N/A * <interleave>
325N/A * <element name="foo"/>
325N/A * <element name="bar">
325N/A * <element name="foo"/>
325N/A * </element>
325N/A * </interlaeve>
325N/A * </xmp></pre>
325N/A * When processing inside the bar element, this receiver is
325N/A * "locked" so that it can correctly receive its child foo element.
325N/A */
325N/A private int lockedReceiver;
325N/A /**
325N/A * Nest level. Lock will be release when the lockCount becomes 0.
325N/A */
325N/A private int lockCount=0;
325N/A
325N/A public void enterElement(
325N/A String uri, String localName, String qname,Attributes atts) throws SAXException {
325N/A
325N/A if(isJoining) return; // ignore any token if we are joining. See joinByXXXX.
325N/A
325N/A if(lockCount++==0) {
325N/A lockedReceiver = findReceiverOfElement(uri,localName);
325N/A if(lockedReceiver==-1) {
325N/A // we can't process this token. join.
325N/A joinByEnterElement(null,uri,localName,qname,atts);
325N/A return;
325N/A }
325N/A }
325N/A
325N/A _receivers[lockedReceiver].enterElement(uri,localName,qname,atts);
325N/A }
325N/A public void leaveElement(String uri, String localName, String qname) throws SAXException {
325N/A if(isJoining) return; // ignore any token if we are joining. See joinByXXXX.
325N/A
325N/A if( lockCount-- == 0 )
325N/A joinByLeaveElement(null,uri,localName,qname);
325N/A else
325N/A _receivers[lockedReceiver].leaveElement(uri,localName,qname);
325N/A }
325N/A public void enterAttribute(String uri, String localName, String qname) throws SAXException {
325N/A if(isJoining) return; // ignore any token if we are joining. See joinByXXXX.
325N/A
325N/A if(lockCount++==0) {
325N/A lockedReceiver = findReceiverOfAttribute(uri,localName);
325N/A if(lockedReceiver==-1) {
325N/A // we can't process this token. join.
325N/A joinByEnterAttribute(null,uri,localName,qname);
325N/A return;
325N/A }
325N/A }
325N/A
325N/A _receivers[lockedReceiver].enterAttribute(uri,localName,qname);
325N/A }
325N/A public void leaveAttribute(String uri, String localName, String qname) throws SAXException {
325N/A if(isJoining) return; // ignore any token if we are joining. See joinByXXXX.
325N/A
325N/A if( lockCount-- == 0 )
325N/A joinByLeaveAttribute(null,uri,localName,qname);
325N/A else
325N/A _receivers[lockedReceiver].leaveAttribute(uri,localName,qname);
325N/A }
325N/A public void text(String value) throws SAXException {
325N/A if(isJoining) return; // ignore any token if we are joining. See joinByXXXX.
325N/A
325N/A if(lockCount!=0)
325N/A _receivers[lockedReceiver].text(value);
325N/A else {
325N/A int receiver = findReceiverOfText();
325N/A if(receiver!=-1) _receivers[receiver].text(value);
325N/A else joinByText(null,value);
325N/A }
325N/A }
325N/A
325N/A
325N/A
325N/A /**
325N/A * Implemented by the generated code to determine the handler
325N/A * that can receive the given element.
325N/A *
325N/A * @return
325N/A * Thread ID of the receiver that can handle this event,
325N/A * or -1 if none.
325N/A */
325N/A protected abstract int findReceiverOfElement( String uri, String local );
325N/A
325N/A /**
325N/A * Returns the handler that can receive the given attribute, or null.
325N/A */
325N/A protected abstract int findReceiverOfAttribute( String uri, String local );
325N/A
325N/A /**
325N/A * Returns the handler that can receive text events, or null.
325N/A */
325N/A protected abstract int findReceiverOfText();
325N/A
325N/A
325N/A
325N/A
325N/A//
325N/A//
325N/A// join method
325N/A//
325N/A//
325N/A
325N/A
325N/A /**
325N/A * Set to true when this handler is in the process of
325N/A * joining all branches.
325N/A */
325N/A private boolean isJoining = false;
325N/A
325N/A /**
325N/A * Joins all the child receivers.
325N/A *
325N/A * <p>
325N/A * This method is called by a child receiver when it sees
325N/A * something that it cannot handle, or by this object itself
325N/A * when it sees an event that it can't process.
325N/A *
325N/A * <p>
325N/A * This method forces children to move to its final state,
325N/A * then revert to the parent.
325N/A *
325N/A * @param source
325N/A * If this method is called by one of the child receivers,
325N/A * the receiver object. If this method is called by itself,
325N/A * null.
325N/A */
325N/A public void joinByEnterElement( NGCCEventReceiver source,
325N/A String uri, String local, String qname, Attributes atts ) throws SAXException {
325N/A
325N/A if(isJoining) return; // we are already in the process of joining. ignore.
325N/A isJoining = true;
325N/A
325N/A // send special token to the rest of the branches.
325N/A // these branches don't understand this token, so they will
325N/A // try to move to a final state and send the token back to us,
325N/A // which this object will ignore (because isJoining==true)
325N/A // Otherwise branches will find an error.
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]!=source )
325N/A _receivers[i].enterElement(uri,local,qname,atts);
325N/A
325N/A // revert to the parent
325N/A _parent._source.replace(this,_parent);
325N/A _parent.onChildCompleted(null,_cookie,true);
325N/A // send this event to the parent
325N/A _parent.enterElement(uri,local,qname,atts);
325N/A }
325N/A
325N/A public void joinByLeaveElement( NGCCEventReceiver source,
325N/A String uri, String local, String qname ) throws SAXException {
325N/A
325N/A if(isJoining) return; // we are already in the process of joining. ignore.
325N/A isJoining = true;
325N/A
325N/A // send special token to the rest of the branches.
325N/A // these branches don't understand this token, so they will
325N/A // try to move to a final state and send the token back to us,
325N/A // which this object will ignore (because isJoining==true)
325N/A // Otherwise branches will find an error.
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]!=source )
325N/A _receivers[i].leaveElement(uri,local,qname);
325N/A
325N/A // revert to the parent
325N/A _parent._source.replace(this,_parent);
325N/A _parent.onChildCompleted(null,_cookie,true);
325N/A // send this event to the parent
325N/A _parent.leaveElement(uri,local,qname);
325N/A }
325N/A
325N/A public void joinByEnterAttribute( NGCCEventReceiver source,
325N/A String uri, String local, String qname ) throws SAXException {
325N/A
325N/A if(isJoining) return; // we are already in the process of joining. ignore.
325N/A isJoining = true;
325N/A
325N/A // send special token to the rest of the branches.
325N/A // these branches don't understand this token, so they will
325N/A // try to move to a final state and send the token back to us,
325N/A // which this object will ignore (because isJoining==true)
325N/A // Otherwise branches will find an error.
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]!=source )
325N/A _receivers[i].enterAttribute(uri,local,qname);
325N/A
325N/A // revert to the parent
325N/A _parent._source.replace(this,_parent);
325N/A _parent.onChildCompleted(null,_cookie,true);
325N/A // send this event to the parent
325N/A _parent.enterAttribute(uri,local,qname);
325N/A }
325N/A
325N/A public void joinByLeaveAttribute( NGCCEventReceiver source,
325N/A String uri, String local, String qname ) throws SAXException {
325N/A
325N/A if(isJoining) return; // we are already in the process of joining. ignore.
325N/A isJoining = true;
325N/A
325N/A // send special token to the rest of the branches.
325N/A // these branches don't understand this token, so they will
325N/A // try to move to a final state and send the token back to us,
325N/A // which this object will ignore (because isJoining==true)
325N/A // Otherwise branches will find an error.
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]!=source )
325N/A _receivers[i].leaveAttribute(uri,local,qname);
325N/A
325N/A // revert to the parent
325N/A _parent._source.replace(this,_parent);
325N/A _parent.onChildCompleted(null,_cookie,true);
325N/A // send this event to the parent
325N/A _parent.leaveAttribute(uri,local,qname);
325N/A }
325N/A
325N/A public void joinByText( NGCCEventReceiver source,
325N/A String value ) throws SAXException {
325N/A
325N/A if(isJoining) return; // we are already in the process of joining. ignore.
325N/A isJoining = true;
325N/A
325N/A // send special token to the rest of the branches.
325N/A // these branches don't understand this token, so they will
325N/A // try to move to a final state and send the token back to us,
325N/A // which this object will ignore (because isJoining==true)
325N/A // Otherwise branches will find an error.
325N/A for( int i=0; i<_receivers.length; i++ )
325N/A if( _receivers[i]!=source )
325N/A _receivers[i].text(value);
325N/A
325N/A // revert to the parent
325N/A _parent._source.replace(this,_parent);
325N/A _parent.onChildCompleted(null,_cookie,true);
325N/A // send this event to the parent
325N/A _parent.text(value);
325N/A }
325N/A
325N/A
325N/A
325N/A//
325N/A//
325N/A// event dispatching methods
325N/A//
325N/A//
325N/A
325N/A public void sendEnterAttribute( int threadId,
325N/A String uri, String local, String qname) throws SAXException {
325N/A
325N/A _receivers[threadId].enterAttribute(uri,local,qname);
325N/A }
325N/A
325N/A public void sendEnterElement( int threadId,
325N/A String uri, String local, String qname, Attributes atts) throws SAXException {
325N/A
325N/A _receivers[threadId].enterElement(uri,local,qname,atts);
325N/A }
325N/A
325N/A public void sendLeaveAttribute( int threadId,
325N/A String uri, String local, String qname) throws SAXException {
325N/A
325N/A _receivers[threadId].leaveAttribute(uri,local,qname);
325N/A }
325N/A
325N/A public void sendLeaveElement( int threadId,
325N/A String uri, String local, String qname) throws SAXException {
325N/A
325N/A _receivers[threadId].leaveElement(uri,local,qname);
325N/A }
325N/A
325N/A public void sendText(int threadId, String value) throws SAXException {
325N/A _receivers[threadId].text(value);
325N/A }
325N/A
325N/A}