You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by le...@apache.org on 2001/02/08 20:26:13 UTC

cvs commit: xml-xerces/java/tests/dom/events DeferredDOM.java EventReporter.java Makefile Test.java

lehors      01/02/08 11:26:11

  Modified:    java/tests/dom/events Makefile Test.java
  Added:       java/tests/dom/events DeferredDOM.java EventReporter.java
  Log:
  added a test to check that no mutation events are fired
  when performing synchronization in the Deferred DOM
  
  Revision  Changes    Path
  1.2       +1 -1      xml-xerces/java/tests/dom/events/Makefile
  
  Index: Makefile
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/tests/dom/events/Makefile,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- Makefile	2000/08/29 22:20:48	1.1
  +++ Makefile	2001/02/08 19:25:52	1.2
  @@ -1,5 +1,5 @@
   
  -TARGETS= Test.class
  +TARGETS= Test.class EventReporter.class DeferredDom.class
   
   DIRS =
   
  
  
  
  1.3       +1 -50     xml-xerces/java/tests/dom/events/Test.java
  
  Index: Test.java
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/tests/dom/events/Test.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- Test.java	2000/10/02 22:06:27	1.2
  +++ Test.java	2001/02/08 19:25:55	1.3
  @@ -1,4 +1,4 @@
  -/* $Id: Test.java,v 1.2 2000/10/02 22:06:27 lehors Exp $ */
  +/* $Id: Test.java,v 1.3 2001/02/08 19:25:55 lehors Exp $ */
   /*
    * The Apache Software License, Version 1.1
    * 
  @@ -154,54 +154,5 @@
               t.addEventListener(evtNames[i], sharedReporter, false);
           }
   
  -    }
  -}
  -
  -class EventReporter implements EventListener
  -{
  -    boolean silent=false; // Toggle this to mask reports you don't care about
  -    int count=0;
  -    String[] phasename={"?","BUBBLING","CAPTURING","AT_TARGET","?"};
  -    
  -    public void on()
  -    {
  -        System.out.println("\nEventReporter awakened:\n");
  -        silent=false;
  -    }
  -    public void off()
  -    {
  -        System.out.println("\nEventReporter muted\n");
  -        silent=true;
  -    }
  -    
  -    public void handleEvent(Event evt)
  -    {
  -        ++count;
  -        if(silent)
  -            return;
  -            
  -        System.out.print("EVT "+count+": '"+
  -            evt.getType()+
  -            "' listener '"+((Node)evt.getCurrentTarget()).getNodeName()+
  -            "' target '"+((Node)evt.getTarget()).getNodeName()+
  -            "' while "+phasename[evt.getEventPhase()] +
  -            "... ");
  -        if(evt.getBubbles()) System.out.print("will bubble");
  -        if(evt.getCancelable()) System.out.print("can cancel");
  -        System.out.print("\n");
  -        if(evt instanceof MutationEvent)
  -        {
  -            MutationEvent me=(MutationEvent)evt;
  -            System.out.print("\t");
  -            if(me.getRelatedNode()!=null)
  -                System.out.print(" relatedNode='"+me.getRelatedNode()+"'");
  -            if(me.getAttrName()!=null)
  -                System.out.print(" attrName='"+me.getAttrName()+"'");
  -            System.out.print("\n");
  -            if(me.getPrevValue()!=null)
  -                System.out.println("\t prevValue='"+me.getPrevValue()+"'");
  -            if(me.getNewValue()!=null)
  -                System.out.println("\t newValue='"+me.getNewValue()+"'");
  -        }
       }
   }
  
  
  
  1.1                  xml-xerces/java/tests/dom/events/DeferredDOM.java
  
  Index: DeferredDOM.java
  ===================================================================
  /* $Id: DeferredDOM.java,v 1.1 2001/02/08 19:25:48 lehors Exp $ */
  /*
   * The Apache Software License, Version 1.1
   * 
   * Copyright (c) 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.ibm.com .  For more information
   * on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package dom.events;
  
  import org.w3c.dom.*;
  import org.w3c.dom.events.*;
  
  import util.Arguments;
  import dom.DOMParserWrapper;
  import java.io.OutputStreamWriter;
  import java.io.PrintWriter;
  import java.io.UnsupportedEncodingException;
  
  import org.apache.xerces.dom.TextImpl;
  
  import org.w3c.dom.Attr;
  import org.w3c.dom.Document;
  import org.w3c.dom.NamedNodeMap;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  
  /*
   * This program is actually meant to test that we DO NOT fire any mutation
   * events while the Deferred DOM is being synchronized.
   */
  public class DeferredDom
  {
      //
      // Constants
      //
  
      /** Default parser name. */
      private static final String
      DEFAULT_PARSER_NAME = "dom.wrappers.DOMParser";
  
      private static boolean setValidation    = false; //defaults
      private static boolean setNameSpaces    = true;
      private static boolean setSchemaSupport = true;
      private static boolean setDeferredDOM   = true;
  
  
  
      //
      // Data
      //
  
      /** Elements. */
      private long elements;
  
      /** Attributes. */
      private long attributes;
  
      /** Characters. */
      private long characters;
  
      /** Ignorable whitespace. */
      private long ignorableWhitespace;
  
  
      //
      // Public static methods
      //
  
      /** Traverse the resulting document tree to trigger the synchronization. */
      public static void traverse(String parserWrapperName, String uri) {
  
          try {
              DOMParserWrapper parser =
              (DOMParserWrapper)Class.forName(parserWrapperName).newInstance();
              DeferredDom test = new DeferredDom();
  
              parser.setFeature( "http://apache.org/xml/features/dom/defer-node-expansion",
  
                                 setDeferredDOM );
              parser.setFeature( "http://xml.org/sax/features/validation", 
                                 setValidation );
              parser.setFeature( "http://xml.org/sax/features/namespaces",
                                 setNameSpaces );
              parser.setFeature( "http://apache.org/xml/features/validation/schema",
                                 setSchemaSupport );
  
              Document document = parser.parse(uri);
              test.reportAllMutations(document);
              test.traverse(document);
          } catch (org.xml.sax.SAXParseException spe) {
          } catch (org.xml.sax.SAXNotRecognizedException ex ){
          } catch (org.xml.sax.SAXNotSupportedException ex ){
          } catch (org.xml.sax.SAXException se) {
              if (se.getException() != null)
                  se.getException().printStackTrace(System.err);
              else
                  se.printStackTrace(System.err);
          } catch (Exception e) {
              e.printStackTrace(System.err);
          }
  
      } // print(String,String,boolean)
  
      //
      // Public methods
      //
  
      /** Traverses the specified node, recursively. */
      public void traverse(Node node) {
  
          // is there anything to do?
          if (node == null) {
              return;
          }
  
          int type = node.getNodeType();
          switch (type) {
          // print document
          case Node.DOCUMENT_NODE: {
                  elements            = 0;
                  attributes          = 0;
                  characters          = 0;
                  ignorableWhitespace = 0;
                  traverse(((Document)node).getDocumentElement());
                  break;
              }
  
              // print element with attributes
          case Node.ELEMENT_NODE: {
                  elements++;
                  NamedNodeMap attrs = node.getAttributes();
                  if (attrs != null) {
                      attributes += attrs.getLength();
                  }
                  NodeList children = node.getChildNodes();
                  if (children != null) {
                      int len = children.getLength();
                      for (int i = 0; i < len; i++) {
                          traverse(children.item(i));
                      }
                  }
                  break;
              }
  
              // handle entity reference nodes
          case Node.ENTITY_REFERENCE_NODE: {
                  NodeList children = node.getChildNodes();
                  if (children != null) {
                      int len = children.getLength();
                      for (int i = 0; i < len; i++) {
                          traverse(children.item(i));
                      }
                  }
                  break;
              }
  
              // print text
          case Node.CDATA_SECTION_NODE: {
                  characters += node.getNodeValue().length();
                  break;
              }
          case Node.TEXT_NODE: {
                  if (node instanceof TextImpl) {
                      if (((TextImpl)node).isIgnorableWhitespace())
                          ignorableWhitespace += node.getNodeValue().length();
                      else
                          characters += node.getNodeValue().length();
                  } else
                      characters += node.getNodeValue().length();
                  break;
              }
          }
  
      } // traverse(Node)
  
      //
      // Main
      //
  
      /** Main program entry point. */
      public static void main(String argv[]) {
  
          Arguments argopt = new Arguments();
          argopt.setUsage( new String[] {
                               "usage: java dom.DOMCount (options) uri ...",
                               "",
                               "options:",
                               "  -p name  Specify DOM parser wrapper by name.",
                               "  -n | -N  Turn on/off namespace [default=on]",
                               "  -v | -V  Turn on/off validation [default=off]",
                               "  -s | -S  Turn on/off Schema support [default=on]",
                               "  -d | -D  Turn on/off deferred DOM [default=on]",
                               "  -h       This help screen."} );
  
  
          // is there anything to do?
          if (argv.length == 0) {
              argopt.printUsage();
              System.exit(1);
          }
  
          // vars
          String  parserName = DEFAULT_PARSER_NAME;
  
          argopt.parseArgumentTokens(argv , new char[] { 'p'} );
  
          int   c;
          String arg = null; 
          while ( ( arg =  argopt.getlistFiles() ) != null ) {
  outer:
              while ( (c =  argopt.getArguments()) != -1 ){
                  switch (c) {
                  case 'v':
                      setValidation = true;
                      //System.out.println( "v" );
                      break;
                  case 'V':
                      setValidation = false;
                      //System.out.println( "V" );
                      break;
                  case 'N':
                      setNameSpaces = false;
                      break;
                  case 'n':
                      setNameSpaces = true;
                      break;
                  case 'p':
                      //System.out.println('p');
                      parserName = argopt.getStringParameter();
                      //System.out.println( "parserName = " + parserName );
                      break;
                  case 'd':
                      setDeferredDOM = true;
                      break;
                  case 'D':
                      setDeferredDOM = false;
                      break;
                  case 's':
                      //System.out.println("s" );
                      setSchemaSupport = true;
                      break;
                  case 'S':
                      //System.out.println("S" );
                      setSchemaSupport = false;
                      break;
                  case '?':
                  case 'h':
                  case '-':
                      argopt.printUsage();
                      System.exit(1);
                      break;
                  case  -1:
                      //System.out.println( "-1" );
                      break outer;
                  default:
                      
                      break;
                  }
              }
  
              traverse(parserName, arg ); // parse and traverse uri
          }
  
      } // main(String[])
  
  
      EventReporter sharedReporter=new EventReporter();
      
      void reportAllMutations(Node n)
      {
          String[] evtNames={
              "DOMSubtreeModified","DOMAttrModified","DOMCharacterDataModified",
              "DOMNodeInserted","DOMNodeRemoved",
              "DOMNodeInsertedIntoDocument","DOMNodeRemovedFromDocument",
              };
              
          EventTarget t=(EventTarget)n;
          
          for(int i=evtNames.length-1;
              i>=0;
              --i)
          {
              t.addEventListener(evtNames[i], sharedReporter, true);
              t.addEventListener(evtNames[i], sharedReporter, false);
          }
  
      }
  }
  
  
  
  1.1                  xml-xerces/java/tests/dom/events/EventReporter.java
  
  Index: EventReporter.java
  ===================================================================
  /* $Id: EventReporter.java,v 1.1 2001/02/08 19:25:51 lehors Exp $ */
  /*
   * The Apache Software License, Version 1.1
   * 
   * Copyright (c) 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.ibm.com .  For more information
   * on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package dom.events;
  
  import org.w3c.dom.*;
  import org.w3c.dom.events.*;
  
  class EventReporter implements EventListener
  {
      boolean silent=false; // Toggle this to mask reports you don't care about
      int count=0;
      String[] phasename={"?","BUBBLING","CAPTURING","AT_TARGET","?"};
      
      public void on()
      {
          System.out.println("\nEventReporter awakened:\n");
          silent=false;
      }
      public void off()
      {
          System.out.println("\nEventReporter muted\n");
          silent=true;
      }
      
      public void handleEvent(Event evt)
      {
          ++count;
          if(silent)
              return;
              
          System.out.print("EVT "+count+": '"+
              evt.getType()+
              "' listener '"+((Node)evt.getCurrentTarget()).getNodeName()+
              "' target '"+((Node)evt.getTarget()).getNodeName()+
              "' while "+phasename[evt.getEventPhase()] +
              "... ");
          if(evt.getBubbles()) System.out.print("will bubble");
          if(evt.getCancelable()) System.out.print("can cancel");
          System.out.print("\n");
          if(evt instanceof MutationEvent)
          {
              MutationEvent me=(MutationEvent)evt;
              System.out.print("\t");
              if(me.getRelatedNode()!=null)
                  System.out.print(" relatedNode='"+me.getRelatedNode()+"'");
              if(me.getAttrName()!=null)
                  System.out.print(" attrName='"+me.getAttrName()+"'");
              System.out.print("\n");
              if(me.getPrevValue()!=null)
                  System.out.println("\t prevValue='"+me.getPrevValue()+"'");
              if(me.getNewValue()!=null)
                  System.out.println("\t newValue='"+me.getNewValue()+"'");
          }
      }
  }