/* ========================================================================
    * JFiglet, a free open source java implementation of figlet and the
    * figfont specification (see http://www.figlet.org)
    * Copyright (C) 2004 Sebastien Brunot
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    * License as published by the Free Software Foundation; either
    * version 2.1 of the License, or (at your option) any later version.
   *
   * This library 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
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   * ========================================================================
   */
  package org.gnu.jfiglet.core;
  
  /***
   * A character defined by a FIGFont. For example, the character 'A' defined by
   * the <em>alphabet</em> FIGFont is the following :
   * <PRE>
   *   AA
   *  A  A
   *  AAAA
   *  A  A
   *  A  A
   * </PRE>
   *
   * @TODO : change statistics names
   * 
   * @version $Id: FIGCharacter.java,v 1.3 2004/05/02 15:24:48 sbrunot Exp $
   *
   * @author <a href="mailto:sebastien.brunot@club-internet.fr">
   *         Sebastien Brunot</a>
   * 
   */
  public class FIGCharacter
  {
      /////////////////////////////////////
      // Attributes
      /////////////////////////////////////
  
      /***
       * The lines of subcharacters the character is defined by.
       */
      private String[] characterLines = null;
  
      /***
       * @TODO : DOCUMENT ME !
       */
      private int[] numbersOfFrontSpaces = null;
  
      /***
       * @TODO : DOCUMENT ME !
       */
      private int[] numbersOfBackSpaces = null;
  
      /////////////////////////////////////
      // Constructor
      /////////////////////////////////////
  
      /***
       * A constructor which argument is an array of
       * the lines of subcharacters the character is
       * defined by. For example, the character 'A' in the
       * <em>alphabet</em> FIGFont is defined by the seven
       * following lines :
       * <PRE>
       * <em>line 0 :</em>"  AA  "
       * <em>line 1 :</em>" A  A "
       * <em>line 2 :</em>" AAAA "
       * <em>line 3 :</em>" A  A "
       * <em>line 4 :</em>" A  A "
       * <em>line 5 :</em>"      "
       * <em>line 6 :</em>"      "
       * </PRE>
       * If any &#64; subcharacters are present in a line, it
       * is automaticaly suppressed : this is because characters
       * definitions in FIGFont files are including final
       * &#64; subcharacter at the end of each line.
       * An IllegalArgumentException is thrown if theCharacterLines
       * is empty or null.
       * @param theCharacterLines an array of the lines
       * of subcharacters the character is defined by.
       */
      public FIGCharacter(String[] theCharacterLines)
      {
          // verify parameter
          if ((theCharacterLines == null) || (theCharacterLines.length == 0))
          {
              throw new IllegalArgumentException("the character lines musn't be null or empty");
          }
          this.characterLines = theCharacterLines;
          // remove extra '@' subcharacters if any
         trimArobase();
         this.numbersOfFrontSpaces = new int[theCharacterLines.length];
         this.numbersOfBackSpaces = new int[theCharacterLines.length];
         // calculate numeric informations about the FIGCharacter
         initFIGCharacterInformations();
     }
 
     /////////////////////////////////////
     // Accessors
     /////////////////////////////////////
 
     /***
      * Get an array of the lines of subcharacters the character
      * is defined by. For example, the character 'A' in the
      * <em>alphabet</em> FIGFont is defined by the seven
      * following lines :
      * <PRE>
      * <em>line 0 :</em>"  AA  "
      * <em>line 1 :</em>" A  A "
      * <em>line 2 :</em>" AAAA "
      * <em>line 3 :</em>" A  A "
      * <em>line 4 :</em>" A  A "
      * <em>line 5 :</em>"      "
      * <em>line 6 :</em>"      "
      * </PRE>
      * @return an array of the lines of subcharacters the character
      * is defined by.
      */
     public String[] getCharacterLines()
     {
         return this.characterLines;
     }
 
     /***
      * Get one of the lines of subcharacters the character is defined by.
      * @param theLineNumber the line number, the first line beeing numbered
      * 0. For example, the last line of subcharacters the character 'A' is
      * defined by in the <em>alphabet</em> FIGFont is line number 6, and
      * its value is :
      * <PRE>
      * <em>line 6 :</em>"      "
      * </PRE>
      * @return the line of subcharacters.
      */
     public String getCharacterLine(int theLineNumber)
     {
         try
         {
             return this.characterLines[theLineNumber];
         }
         catch (IndexOutOfBoundsException e)
         {
             throw new IllegalArgumentException();
         }
     }
 
     /***
      * @TODO : DOCUMENT ME !
      * @param theLineNumber
      * @return
      */
     public int getNumberOfFrontSpacesForLine(int theLineNumber)
     {
         try
         {
             return this.numbersOfFrontSpaces[theLineNumber];
         }
         catch (IndexOutOfBoundsException e)
         {
             throw new IllegalArgumentException();
         }
     }
 
     /***
      * @TODO : DOCUMENT ME !
      * @param theLineNumber
      * @return
      */
     public int getNumberOfBackSpacesForLine(int theLineNumber)
     {
         try
         {
             return this.numbersOfBackSpaces[theLineNumber];
         }
         catch (IndexOutOfBoundsException e)
         {
             throw new IllegalArgumentException();
         }
     }
 
     /***
      * @TODO : DOCUMENT ME !
      */
     private void initFIGCharacterInformations()
     {
         // Init informations about FIGCharacter front
         // and back spaces
         for (int lineNumber = 0;
             lineNumber < this.characterLines.length;
             lineNumber++)
         {
             // Count the number of front spaces of this line
             this.numbersOfFrontSpaces[lineNumber] = 0;
             String currentLine = this.characterLines[lineNumber];
             while ((this.numbersOfFrontSpaces[lineNumber]
                 < currentLine.length())
                 && (currentLine.charAt(this.numbersOfFrontSpaces[lineNumber])
                     == ' '))
             {
                 this.numbersOfFrontSpaces[lineNumber]++;
             }
             // Count the number of back spaces of this line
             int lengthOftrimedLine = currentLine.trim().length();
             this.numbersOfBackSpaces[lineNumber] =
                 currentLine.length()
                     - lengthOftrimedLine
                     - this.numbersOfFrontSpaces[lineNumber];
         }
     }
 
     /***
      * TODO : DOCUMENT ME !
      *
      */
     private void trimArobase()
     {
         for (int lineNumber = 0;
             lineNumber < this.characterLines.length;
             lineNumber++)
         {
             this.characterLines[lineNumber] =
                 this.characterLines[lineNumber].replaceAll("@", "");
         }
     }
 }