////////////////////////////////////////////////////////////////////////////////
   // MillScript-Excel: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2006 Open World Ltd, Kevin Rogers
   //
   // This file is part of MillScript-Excel.
   //
   // MillScript-Excel 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-Excel 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-Excel; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.office.excel;
  
  import org.millscript.commons.alert.alerts.Fault;
  import org.millscript.office.excel.alerts.BIFFAlert;
  import org.millscript.office.excel.records.BOF;
  import org.millscript.office.excel.records.EOF;
  import org.millscript.office.spreadsheet.Workbook;
  import org.millscript.office.spreadsheet.Worksheet;
  
  /**
   * This class parses BIFF records from the underlying tokenizer.
   */
  public abstract class RecordParser {
  
      private final RecordTokenizer recordTokenizer;
  
      private ExcelWorkbook currentWorkbook;
  
      private ExcelWorksheet currentWorksheet;
  
      public RecordParser( final RecordTokenizer tokenizer ) {
          this.recordTokenizer = tokenizer;
      }
  
      public ExcelWorkbook getCurrentWorkbook() {
          return this.currentWorkbook;
      }
  
      public ExcelWorksheet getCurrentWorksheet() {
          return this.currentWorksheet;
      }
  
      public String getSharedString( final int index ) {
          // Shared strings are not supported in most BIFF versions
          throw new Fault(
              "Shared strings are not available in the current BIFF version"
          ).mishap();
      }
  
      public Workbook readWorkbook() {
          // First read the workbook globals BOF record
          final BOF workbookGlobalsBOF = this.readWorkbookGlobalsBOF();
          // Make the workbook object
          this.currentWorkbook = new ExcelWorkbook();
          // Now we can continue with the globals workbook records
          while ( !( this.peekRecord() instanceof EOF ) ) {
              final Record record = this.nextRecord();
              record.handle( this );
          }
          // record is EOF now
          final Record workbookGlobalsEOF = this.nextRecord();
          // Read the worksheets in the workbook
          while ( this.hasMoreRecords() && this.peekRecord() instanceof BOF ) {
              this.currentWorkbook.addLast( this.readWorksheet() );
          }
          // We've got to the end of the workbook, so return it
          return this.currentWorkbook;
      }
  
      public Worksheet readWorksheet() {
          // Read worksheet BOF record
          final Record worksheetBof = this.nextRecord();
          // Make the worksheet object
          this.currentWorksheet = new ExcelWorksheet();
          // Read each sheets records
          while ( !( this.peekRecord() instanceof EOF ) ) {
              final Record record = this.nextRecord();
              record.handle( this );
          }
          // record is EOF now, so read it
          final Record eof = this.nextRecord();
          // We've got to the end of the worksheet, so return it
          return this.currentWorksheet;
      }
  
      /**
       * @see org.millscript.office.excel.RecordTokenizer#hasMoreRecords()
       */
      public boolean hasMoreRecords() {
         return this.recordTokenizer.hasMoreRecords();
     }
 
     /**
      * @see org.millscript.office.excel.RecordTokenizer#nextRecord()
      */
     public Record nextRecord() {
         return this.recordTokenizer.nextRecord();
     }
 
     /**
      * @see org.millscript.office.excel.RecordTokenizer#peekRecord()
      */
     public Record peekRecord() {
         return recordTokenizer.peekRecord();
     }
 
     public BOF readWorkbookGlobalsBOF() {
         final Record record = this.recordTokenizer.nextRecord();
         // Check it's a BOF record
         if ( record instanceof BOF ) {
             final BOF bof = (BOF) record;
             // and that it is a workbook globals BOF record
             if ( bof.getType() == BOF.Type.WorkbookGlobals ) {
                 return bof;
             }
         }
         // Oh dear, it's not a workbook globals BOF record
         throw new BIFFAlert(
             "Workbook Globals BOF record expected"
         ).decorate( record ).mishap();
     }
 
     public BOF readWorksheetBOF() {
         final Record record = this.recordTokenizer.nextRecord();
         // Check it's a BOF record
         if ( record instanceof BOF ) {
             final BOF bof = (BOF) record;
             // and that it is a worksheet BOF record
             if ( bof.getType() == BOF.Type.Worksheet ) {
                 return bof;
             }
         }
         // Oh dear, it's not a Worksheet BOF record
         throw new BIFFAlert(
             "Worksheet BOF record expected"
         ).decorate( record ).mishap();
     }
 
     public void setSharedStringTable( final String[] strings ) {
         // Shared strings are not supported in most BIFF versions
         throw new Fault(
             "Shared strings are not available in the current BIFF version"
         ).mishap();
     }
 
 }