////////////////////////////////////////////////////////////////////////////////
   // MillScript: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2001-2005 Open World Ltd
   // Copyright (C) 2005 Kevin Rogers
   //
   // This file is part of MillScript.
   //
   // MillScript is free software; you can redistribute it and/or modify it under
   // the terms of the GNU General Public License as published by the Free
  // Software Foundation; either version 2 of the License, or (at your option)
  // any later version.
  //
  // MillScript is distributed in the hope that it will be useful, but WITHOUT
  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  // more details.
  //
  // You should have received a copy of the GNU General Public License along with
  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.millscript.render;
  
  import org.millscript.commons.util.IList;
  import org.millscript.commons.util.MapIterator;
  import org.millscript.millscript.datatypes.CDATA;
  import org.millscript.millscript.datatypes.XmlComment;
  import org.millscript.millscript.datatypes.XmlElement;
  import org.millscript.millscript.tools.StringTools;
  
  import java.io.IOException;
  import java.util.Iterator;
  import java.util.List;
  
  /**
   * This renderer is used for rendering the CDATA content of an element in XML.
   * As such it delegates most of it's rendering methods to a normal XML
   * renderer.
   */
  public final class XMLCDATARenderer implements Renderer {
  
      /**
       * The parent XML renderer to delegate rendering calls to.
       */
      private final Renderer parentRenderer;
  
      /**
       * Constructs a new XML CDATA renderer, to use the specified XML renderer
       * for rendering.
       *
       * @param hr    the XML renderer to delegate to
       */
      public XMLCDATARenderer( final Renderer hr ) {
          this.parentRenderer = hr;
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#append(char)
       */
      public void append( final char ch ) throws IOException {
          parentRenderer.append( ch );
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#append(java.lang.CharSequence)
       */
      public void append( final CharSequence cs ) throws IOException {
          parentRenderer.append( cs );
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#appendEscapeFor(char)
       */
      public void appendEscapeFor( final char ch ) throws IOException {
          parentRenderer.appendEscapeFor( ch );
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#appendNoEscape(char)
       */
      public void appendNoEscape( final char ch ) throws IOException {
          parentRenderer.appendNoEscape( ch );
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#appendNoEscape(java.lang.CharSequence)
       */
      public void appendNoEscape( final CharSequence cs ) throws IOException {
          parentRenderer.appendNoEscape( cs );
      }
  
      /**
       * @see org.millscript.millscript.render.Renderer#canEncode(char)
       */
      public boolean canEncode( final char ch ) {
          return parentRenderer.canEncode( ch );
      }
  
      /**
      * @see org.millscript.millscript.render.Renderer#render(java.lang.Object)
      */
     public void render( final Object o ) throws IOException {
         if ( o == null ) {
             return;
         } else if ( o instanceof Renderable ) {
             ((Renderable) o).render( this );
         } else if ( o instanceof IList ) {
             MapIterator it = ((IList) o).iterator( true );
             while ( it.hasNext() ) {
                 this.render( it.nextValue() );
             }
         } else if ( o instanceof List ) {
             Iterator it = ((List)o).iterator();
             while ( it.hasNext() ) {
                 this.render( it.next() );
             }
         } else {
             // FIXME - This code should use the standard
             // AbstractRenderer.append(CharSequence) but we need to provide a way to
             // parse database content into an XmlElement before we can change
             // it.
             this.renderObject( o );
         }
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderAsDocument(java.lang.Object)
      */
     public void renderAsDocument( final Object o ) {
         parentRenderer.renderAsDocument( o );
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderAsFragment(org.millscript.commons.util.IList)
      */
     public void renderAsFragment( final IList l ) {
         parentRenderer.renderAsFragment( l );
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderCDATA(org.millscript.millscript.datatypes.CDATA)
      */
     public void renderCDATA( final CDATA c ) throws IOException {
         parentRenderer.appendNoEscape( "<![CDATA[" );
         final Object[] kids = c.getStore();
         final int nkids = kids.length;
         for ( int i = 0; i < nkids; i++ ) {
             this.render( kids[ i ] );
         }
         parentRenderer.appendNoEscape( "]]>" );
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderDocumentFooter()
      */
     public void renderDocumentFooter() throws IOException {
         parentRenderer.renderDocumentFooter();
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderDocumentHeader()
      */
     public void renderDocumentHeader() throws IOException {
         parentRenderer.renderDocumentHeader();
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderObject(java.lang.Object)
      */
     public void renderObject( final Object o ) throws IOException {
         // TODO - This isn't the most efficient way to deal with this problem
         // but it's the easiest. This won't be on the critical path when
         // rendering anyway.
         parentRenderer.appendNoEscape(
             StringTools.substituteAll(
                 o.toString(),
                 "]]>",
                 "]]]]><![CDATA[>"
             )
         );
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderXMLComment(org.millscript.millscript.datatypes.XmlComment)
      */
     public void renderXMLComment( final XmlComment c ) throws IOException {
         parentRenderer.renderXMLComment( c );
     }
 
     /**
      * @see org.millscript.millscript.render.Renderer#renderXMLElement(org.millscript.millscript.datatypes.XmlElement)
      */
     public void renderXMLElement( final XmlElement x ) throws IOException {
         parentRenderer.appendNoEscape( '<' );
         parentRenderer.appendNoEscape( x.tagName() );
 
         MapIterator it = x.getAttributes().iterator( true );
         while ( it.hasNext() ) {
             Object key = it.nextKey();
             Object val = it.currentValue();
             if ( key != null ) {
                 parentRenderer.appendNoEscape( ' ' );
                 parentRenderer.appendNoEscape( key.toString() );
                 // All attributes have the equals and quotes even if there is
                 // no value.
                 parentRenderer.appendNoEscape( "=\"" );
                 if ( val != null ) {
                     parentRenderer.appendNoEscape( val.toString() );
                 }
                 parentRenderer.appendNoEscape( '"' );
             }
         }
 
         final Object[] kids = x.getChildren();
         final int nkids = kids.length;
 
         if ( nkids == 0 ) {
             parentRenderer.appendNoEscape( " />" );
         } else {
             parentRenderer.appendNoEscape( '>' );
             for ( int i = 0; i < nkids; i++ ) {
                 this.render( kids[ i ] );
             }
             parentRenderer.appendNoEscape( "</" );
             parentRenderer.appendNoEscape( x.tagName() );
             parentRenderer.appendNoEscape( '>' );
         }
     }
 
 }