package org.apache.maven.doxia.siterenderer.sink;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
   * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  
  import java.io.StringWriter;
  import java.io.Writer;
  import java.util.ArrayList;
  import java.util.HashSet;
  import java.util.List;
  import java.util.Set;
  
  import javax.swing.text.html.HTML.Attribute;
  
  import org.apache.maven.doxia.markup.HtmlMarkup;
  import org.apache.maven.doxia.module.xhtml5.Xhtml5Sink;
  import org.apache.maven.doxia.sink.Sink;
  import org.apache.maven.doxia.sink.SinkEventAttributes;
  import org.apache.maven.doxia.siterenderer.DocumentContent;
  import org.apache.maven.doxia.siterenderer.RenderingContext;
  import org.apache.maven.doxia.util.HtmlTools;
  import org.codehaus.plexus.util.StringUtils;
  
  /**
   * Sink for site rendering of a document, to allow later merge document's output with a template.
   * During raw Doxia rendering, content is stored in multiple fields for later use when incorporating
   * into skin or template: title, date, authors, head, body 
   *
   * @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
   */
  @SuppressWarnings( "checkstyle:methodname" )
  public class SiteRendererSink
      extends Xhtml5Sink
      implements Sink, org.codehaus.doxia.sink.Sink, DocumentContent
  {
      private String date = "";
  
      private String title = "";
  
      private List<String> authors = new ArrayList<String>();
  
      private final StringWriter headWriter;
  
      private StringBuilder sectionTitleBuffer;
  
      private StringBuilder sectionTitleWriteBuffer;
  
      private boolean sectionHasID;
  
      private boolean isSectionTitle;
  
      private Set<String> anchorsInSectionTitle;
  
      private final Writer writer;
  
      private RenderingContext renderingContext;
  
      /**
       * Construct a new SiteRendererSink for a document.
       *
       * @param renderingContext the document's RenderingContext.
       */
      public SiteRendererSink( RenderingContext renderingContext )
      {
          this( new StringWriter(), renderingContext );
      }
  
      /**
       * Construct a new SiteRendererSink for a document.
       *
       * @param writer the writer for the sink.
       * @param renderingContext the document's RenderingContext.
       */
      private SiteRendererSink( StringWriter writer, RenderingContext renderingContext )
      {
          super( writer );
  
          this.writer = writer;
          this.headWriter = new StringWriter();
          this.renderingContext = renderingContext;
  
          /* the template is expected to have used the main tag, which can be used only once */
          super.contentStack.push( HtmlMarkup.MAIN );
     }
 
     /** {@inheritDoc} */
     @Override
     public void title_()
     {
         if ( getTextBuffer().length() > 0 )
         {
             title = getTextBuffer().toString();
         }
 
         resetTextBuffer();
     }
 
     /**
      * {@inheritDoc}
      *
      * Reset text buffer, since text content before title mustn't be in title.
      * @see org.apache.maven.doxia.module.xhtml5.Xhtml5Sink#title()
      */
     @Override
     public void title()
     {
         resetTextBuffer();
     }
 
     /** {@inheritDoc} */
     @Override
     public void author()
     {
         resetTextBuffer();
     }
 
     /** {@inheritDoc} */
     @Override
     public void author_()
     {
         if ( getTextBuffer().length() > 0 )
         {
             String text = HtmlTools.escapeHTML( getTextBuffer().toString() );
             text = StringUtils.replace( text, "&amp;#", "&#" );
             authors.add( text.trim() );
         }
 
         resetTextBuffer();
     }
 
     /** {@inheritDoc} */
     @Override
     public void date()
     {
         resetTextBuffer();
     }
 
     /** {@inheritDoc} */
     @Override
     public void date_()
     {
         if ( getTextBuffer().length() > 0 )
         {
             date = getTextBuffer().toString().trim();
         }
 
         resetTextBuffer();
     }
 
     /**
      * {@inheritDoc}
      *
      * Do nothing.
      * @see org.apache.maven.doxia.module.xhtml5.Xhtml5Sink#body_()
      */
     @Override
     public void body_()
     {
         // nop
     }
 
     /**
      * {@inheritDoc}
      *
      * Do nothing.
      * @see org.apache.maven.doxia.module.xhtml5.Xhtml5Sink#body()
      */
     @Override
     public void body()
     {
         // nop
     }
 
     /** {@inheritDoc} */
     @Override
     public void head_()
     {
         setHeadFlag( false );
     }
 
     /** {@inheritDoc} */
     @Override
     public void head()
     {
         setHeadFlag( true );
     }
 
     /** {@inheritDoc} */
     @Override
     public void anchor( String name, SinkEventAttributes attributes )
     {
         super.anchor( name, attributes );
         if ( isSectionTitle )
         {
             if ( anchorsInSectionTitle == null )
             {
                 anchorsInSectionTitle = new HashSet<String>();
             }
             anchorsInSectionTitle.add( name );
         }
     }
 
     /** {@inheritDoc} */
     @Override
     protected void onSectionTitle( int depth, SinkEventAttributes attributes )
     {
         sectionHasID = ( attributes != null && attributes.isDefined ( Attribute.ID.toString() ) );
         isSectionTitle = true;
 
         super.onSectionTitle( depth, attributes );
 
         this.sectionTitleBuffer = new StringBuilder();
         this.sectionTitleWriteBuffer = new StringBuilder();
     }
 
     /** {@inheritDoc} */
     @Override
     protected void onSectionTitle_( int depth )
     {
         String sectionTitle = sectionTitleBuffer.toString();
         this.sectionTitleBuffer = null;
         String sectionWriteTitle = sectionTitleWriteBuffer.toString();
         this.sectionTitleWriteBuffer = null;
 
         if ( !StringUtils.isEmpty( sectionTitle ) )
         {
             if ( sectionHasID )
             {
                 sectionHasID = false;
             }
             else
             {
                 String id = HtmlTools.encodeId( sectionTitle );
                 if ( ( anchorsInSectionTitle == null ) || ( !anchorsInSectionTitle.contains( id ) ) )
                 {
                     anchor( id );
                     anchor_();
                 }
             }
         }
 
         super.write( sectionWriteTitle );
 
         this.isSectionTitle = false;
         anchorsInSectionTitle = null;
         super.onSectionTitle_( depth );
     }
 
     /** {@inheritDoc} */
     @Override
     public void text( String text )
     {
         if ( sectionTitleBuffer != null )
         {
             // this implies we're inside a section title, collect text events for anchor generation
             sectionTitleBuffer.append( text );
         }
 
         super.text( text );
     }
 
     /** {@inheritDoc} */
     @Override
     protected void write( String text )
     {
         String txt = text;
 
         if ( isHeadFlag() )
         {
             headWriter.write( unifyEOLs( txt ) );
 
             return;
         }
 
         if ( renderingContext != null )
         {
             String relativePathToBasedir = renderingContext.getRelativePath();
 
             if ( relativePathToBasedir == null )
             {
                 txt = StringUtils.replace( txt, "$relativePath", "." );
             }
             else
             {
                 txt = StringUtils.replace( txt, "$relativePath", relativePathToBasedir );
             }
         }
 
         if ( sectionTitleWriteBuffer != null )
         {
             // this implies we're inside a section title, collect text events for anchor generation
             sectionTitleWriteBuffer.append( txt );
         }
         else
         {
             super.write( txt );
         }
     }
 
     // DocumentContent interface
 
     /** {@inheritDoc} */
     public String getTitle()
     {
         return title;
     }
 
     /** {@inheritDoc} */
     public List<String> getAuthors()
     {
         return authors;
     }
 
     /** {@inheritDoc} */
     public String getDate()
     {
         return date;
     }
 
     /** {@inheritDoc} */
     public String getBody()
     {
         return writer.toString();
     }
 
     /** {@inheritDoc} */
     public String getHead()
     {
         return headWriter.toString();
     }
 
     /** {@inheritDoc} */
     public RenderingContext getRenderingContext()
     {
         return renderingContext;
     }
 }