/*
    * Copyright (c) 2001-2004,
    * RedVerst Group, ISP RAS http://www.ispras.ru
    * 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 names "ATP", "TreeDL", "RedVerst", "ISP RAS"
   *    may not be used to endorse or promote products derived from this software
   *    without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
   * ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
   */
  package com.unitesk.atp.tree;
  
  import java.io.File;
  import java.io.FileWriter;
  import java.io.IOException;
  import java.io.Writer;
  import java.util.Iterator;
  import java.util.List;
  
  import com.unitesk.atp.dynattrs.Accessor;
  import com.unitesk.atp.text.filters.ExceptionHandler;
  import com.unitesk.atp.text.filters.IndentFilter;
  import com.unitesk.atp.text.filters.WriterTextReceiver;
  
  /***
   * Dump tree structure for debugging
   * 
   * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
   * @version $Id: TreePrinter.java,v 1.4 2005/11/30 10:06:18 all-x Exp $
   */
  public class TreePrinter
  {
      protected Writer writer;
      protected IndentFilter indentFilter;
      protected ExceptionHandler exceptionHandler;
  
      public static TreePrinter create( String file, ExceptionHandler exceptionHandler )
      {
          return create( new File( file ), exceptionHandler );
      }
  
      public static 
      TreePrinter create( String file, ExceptionHandler exceptionHandler, int indentStep )
      {
          return create( new File( file ), exceptionHandler, indentStep );
      }
  
      public static TreePrinter create( File file, ExceptionHandler exceptionHandler )
      {
          return create( file, exceptionHandler, IndentFilter.DEFAULT_INDENT_STEP );
      }
      
      public static TreePrinter create( File file, ExceptionHandler exceptionHandler, int indentStep )
      {
          try
          {
              return create( new FileWriter( file.getCanonicalPath() )
                           , exceptionHandler
                           , indentStep 
                           );
          }
          catch( IOException e )
          {
              exceptionHandler.process( e );
              return null;
          }
      }
  
      public static TreePrinter create( Writer writer
                                      , ExceptionHandler exceptionHandler
                                      )
      {
          return create( writer, exceptionHandler, IndentFilter.DEFAULT_INDENT_STEP );
      }
  
      public static TreePrinter create( Writer writer
                                      , ExceptionHandler exceptionHandler
                                      , int indentStep
                                      )
     {
         return new TreePrinter( writer, exceptionHandler, indentStep );
     }
 
     /***
      * Close output stream
      */
     public void close()
     {
         try
         {
             writer.close();
         }
         catch( IOException e )
         {
             exceptionHandler.process( e );
         }
     }
      
     /***
      * Dump tree
      * 
      * @param tree     Tree to be dumped
      */
     public void dumpTree( Tree tree )
     {
         txt( "tree " + tree.getFile() ); nl();
         block_nl();
         dumpTree( tree.getRootNode() );
         unblock_nl();
     }
      
     /***
      * Dump subtree.
      * 
      * @param node     Subtree root node.
      */
     public void dumpTree( Node node )
     {
         dumpNode( node );
     }
 
     protected TreePrinter( Writer writer, ExceptionHandler exceptionHandler, int indentStep )
     {
         this.writer = writer;
         WriterTextReceiver out = new WriterTextReceiver( writer, exceptionHandler );
         indentFilter = new IndentFilter( out, indentStep );
     }
 
     protected final void incIndent()
     {
         indentFilter.pushIndent(   indentFilter.getIndent()
                                  + indentFilter.getIndentStep()
                                );
     }
 
     protected final void popIndent()
     {
         indentFilter.popIndent();
     }
 
     protected final void txt( String s )
     {
         indentFilter.txt( s );
     }
 
     protected final void nl()
     {
         indentFilter.nl();
     }
 
     protected final void block()
     {
         txt( "{" );
         incIndent();
     }
 
     protected final void unblock()
     {
         popIndent();
         txt( "}" );
     }
 
     protected final void block_nl()
     {
         block();
         nl();
     }
 
     protected final void unblock_nl()
     {
         unblock();
         nl();
     }
 
     protected void dumpNode( Node node )
     {
         txt( node.toString() ); nl();
         block_nl();
 
         for( Iterator attr_name_iterator = Accessor.getAttributeNames( node ).iterator();
              attr_name_iterator.hasNext();
            )
         {
             String name = (String)attr_name_iterator.next();
             Object value = Accessor.getAttribute( node, name );
 
             if( value instanceof List )
             {
                 txt( name + "[" + ((List)value).size() + "] =" ); nl();
                 block_nl();
                 for( int i = 0; i < ((List)value).size(); i++ )
                 {
                     dumpAttribute( node
                                  , name + "[" + i + "]"
                                  , ((List)value).get( i )
                                  );
                 }
                 unblock_nl();
             } else {
                 dumpAttribute( node, name, value );
             }
         }
         unblock_nl();
     }
 
     protected void dumpAttribute( Node node, String name, Object value )
     {
         txt( name + " = " );
 
         if( value instanceof Node && ((Node)value).getParent() == node )
         {
             // child
             dumpNode( (Node)value );
         } else {
             txt( "'" + value + "'" );
             nl();
         }
     }
 }