/*
    * 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.generation;
  
  import java.util.Stack;
  
  import com.unitesk.atp.tree.Node;
  import com.unitesk.atp.text.generation.BasicGenerator;
  import com.unitesk.atp.text.filters.TextReceiver;
  import com.unitesk.atp.text.filters.LineSplitFilter;
  import com.unitesk.atp.text.filters.IndentFilter;
  
  /***
   * Text Generator Server implements {@link TextGenerator} functionality.
   *
   * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
   * @version $Id: TextGeneratorServer.java,v 1.1 2004/10/09 06:28:48 all-x Exp $
   */
  public class TextGeneratorServer extends BasicGenerator implements TextGenerator
  {
      /***
       * Constructs Text Generator Server with the given client
       * and default indent step.
       *
       * @param  client  The client receiving results of text generation.
       */
      public TextGeneratorServer( TextReceiver client )
      {
          this( client, IndentFilter.DEFAULT_INDENT_STEP );
      }
  
      /***
       * Constructs Text Generator Server with the given client and indent step.
       *
       * @param  client     The client receiving results of text generation.
       * @param  indentStep Indent step.
       */
      public TextGeneratorServer( TextReceiver client, int indentStep )
      {
          super( new LineSplitFilter( new IndentFilter( client, indentStep ) ) );
  
          lineSplitFilter = (LineSplitFilter)this.client;
          indentFilter = (IndentFilter)lineSplitFilter.getClient();
          out = client;
  
          setFunction( DEFAULT_NAME, new TreeDefaultFunction() );
      }
  
      /***
       * {@inheritDoc}
       */
      public void pushNode( Node node )
      {
          setVariable( DEFAULT_NAME, node );
          nodeStack.push( node );
      }
  
      /***
       * {@inheritDoc}
       */
      public Node getNode()
      {
  
          return (Node)nodeStack.peek();
      }
  
      /***
       * {@inheritDoc}
       */
      public void popNode()
     {
         nodeStack.pop();
 
         if( nodeStack.empty() )
         {
             setVariable( DEFAULT_NAME, null );
         } else {
             setVariable( DEFAULT_NAME, nodeStack.peek() );
         }
     }
 
     /***
      * {@inheritDoc}
      */
     public void pushIndent( int indent )
     {
         indentFilter.pushIndent( indent );
     }
 
     /***
      * {@inheritDoc}
      */
     public int getIndent()
     {
         return indentFilter.getIndent();
     }
 
     /***
      * {@inheritDoc}
      */
     public void incIndent()
     {
         indentFilter.pushIndent(   indentFilter.getIndent()
                                  + indentFilter.getIndentStep()
                                );
     }
 
     /***
      * {@inheritDoc}
      */
     public void decIndent()
     {
         indentFilter.pushIndent(   indentFilter.getIndent()
                                  - indentFilter.getIndentStep()
                                );
     }
 
     /***
      * {@inheritDoc}
      */
     public void popIndent()
     {
         indentFilter.popIndent();
     }
 
     /***
      * {@inheritDoc}
      */
     public void list( String index
                     , int start
                     , int end
                     , String str
                     , String separator
                     )
     {
         int from;
         int to;
         int step;
 
         if( start < end )
         {
             from = start;
             to = end;
             step = 1;
         } else
         if( end < start )
         {
             from = start - 1;
             to = end - 1;
             step = -1;
         } else {
             return;
         }
         for( int i = from; i != to; i += step )
         {
             Object old_var = setVariable( index, new Integer( i ) );
 
             txt( str );
 
             if( i + step != to && separator != null )
             {
                 txt( separator );
             }
 
             setVariable( index, old_var );
         }
     }
 
     /***
      * {@inheritDoc}
      */
     public void nl()
     {
         lineSplitFilter.nl();
     }
 
     /***
      * Print string as is, don't treat it as pattern and don't split lines.
      * This method is used for printing values of parameters.
      *
      * @param str   The string to pass as is.
      */
     public void txtAsIs( String str )
     {
         indentFilter.txt( str );
     }
 
     /***
      * Line splitter.
      */
     protected LineSplitFilter lineSplitFilter;
     /***
      * Indent manager filter. Client of {@link #lineSplitFilter}
      */
     protected IndentFilter indentFilter;
     /***
      * Client receiving results of text generation.
      * Client of {@link #indentFilter}
      */
     protected TextReceiver out;
 
     /***
      * Stack of used nodes. The top element is current node.
      */
     private Stack/*Node*/ nodeStack = new Stack/*Node*/();
 }