cvs commit: jakarta-velocity/src/java/org/apache/velocity/test/view TemplateNodeView.java

[jvanzyl]

jvanzyl     00/10/26 20:42:06

  Added:       src/java/org/apache/velocity/test/view TemplateNodeView.java
  Log:
  - tool to view AST dumps.
  
  Revision  Changes    Path
  1.1                  
jakarta-velocity/src/java/org/apache/velocity/test/view/TemplateNodeView.java
  
  Index: TemplateNodeView.java
  ===================================================================
  package org.apache.velocity.test.view;
  
  /*
   * 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 acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Velocity", 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 [EMAIL PROTECTED]
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * 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.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  import java.io.IOException;
  import java.io.PrintWriter;
  import java.io.FileInputStream;
  
  import org.apache.velocity.runtime.Runtime;
  
  import org.apache.velocity.runtime.visitor.NodeViewMode;
  import org.apache.velocity.runtime.parser.node.SimpleNode;
  
  /**
   * Simple class for dumping the AST for a template.
   * Good for debugging and writing new directives.
   */
  public class TemplateNodeView
  {
      /** 
       * Root of the AST node structure that results from
       * parsing a template.
       */
      private SimpleNode document;
      
      /**
       * Visitor used to traverse the AST node structure
       * and produce a visual representation of the
       * node structure. Very good for debugging and
       * writing new directives.
       */
      private NodeViewMode visitor;
  
      /**
       * Default constructor: sets up the Velocity
       * Runtime, creates the visitor for traversing
       * the node structure and then produces the
       * visual representation by the visitation.
       */
      public TemplateNodeView(String template)
      {
          try
          {
              Runtime.init("velocity.properties");
              document = Runtime.parse(new FileInputStream(template));
              visitor = new NodeViewMode();
              visitor.setContext(null);
              visitor.setWriter(new PrintWriter(System.out));
              document.jjtAccept(visitor, null);
          }
          catch (Exception e)
          {
              System.out.println(e);
              e.printStackTrace();
          }
      }
  
      /** For testing */
      public static void main(String args[])
      {
          TemplateNodeView v = new TemplateNodeView(args[0]);
      }        
  }