You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by jo...@apache.org on 2008/05/16 20:46:04 UTC
svn commit: r657166 -
/poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java
Author: josh
Date: Fri May 16 11:46:04 2008
New Revision: 657166
URL: http://svn.apache.org/viewvc?rev=657166&view=rev
Log:
Simplification of BiffViewer. Made easier to send results to file.
Modified:
poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java
Modified: poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java?rev=657166&r1=657165&r2=657166&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java Fri May 16 11:46:04 2008
@@ -15,22 +15,20 @@
limitations under the License.
==================================================================== */
-/*
- * BiffViewer.java
- *
- * Created on November 13, 2001, 9:23 AM
- */
package org.apache.poi.hssf.dev;
-import org.apache.poi.hssf.record.*;
-import org.apache.poi.poifs.filesystem.POIFSFileSystem;
-import org.apache.poi.util.HexDump;
-
+import java.io.File;
import java.io.FileInputStream;
-import java.io.IOException;
+import java.io.FileOutputStream;
import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.PrintStream;
import java.util.ArrayList;
+import org.apache.poi.hssf.record.*;
+import org.apache.poi.poifs.filesystem.POIFSFileSystem;
+import org.apache.poi.util.HexDump;
+
/**
* Utillity for reading in BIFF8 records and displaying data from them.
*
@@ -38,38 +36,26 @@
*@author Glen Stampoultzis (glens at apache.org)
*@see #main
*/
-
-public class BiffViewer {
- String filename;
+public final class BiffViewer {
+ private final File _inputFile;
private boolean dump;
+ private final PrintStream _ps;
- /**
- * Creates new BiffViewer
- *
- *@param args
- */
-
- public BiffViewer(String[] args) {
- if (args.length > 0) {
- filename = args[0];
- } else {
- System.out.println("BIFFVIEWER REQUIRES A FILENAME***");
- }
+ public BiffViewer(File inFile, PrintStream ps) {
+ _inputFile = inFile;
+ _ps = ps;
}
/**
* Method run starts up BiffViewer...
*/
-
public void run() {
try {
- POIFSFileSystem fs =
- new POIFSFileSystem(new FileInputStream(filename));
- InputStream stream =
- fs.createDocumentInputStream("Workbook");
- createRecords(stream, dump);
+ POIFSFileSystem fs = new POIFSFileSystem(new FileInputStream(_inputFile));
+ InputStream stream = fs.createDocumentInputStream("Workbook");
+ createRecords(stream, dump, _ps);
} catch (Exception e) {
e.printStackTrace();
}
@@ -86,451 +72,306 @@
* InputStream
*@exception RecordFormatException on error processing the InputStream
*/
-
- public static Record[] createRecords(InputStream in, boolean dump)
+ public static Record[] createRecords(InputStream in, boolean dump, PrintStream ps)
throws RecordFormatException {
ArrayList records = new ArrayList();
RecordDetails activeRecord = null;
- try {
- BiffviewRecordInputStream recStream = new BiffviewRecordInputStream(in);
- while (recStream.hasNextRecord()) {
+ BiffviewRecordInputStream recStream = new BiffviewRecordInputStream(in);
+ while (recStream.hasNextRecord()) {
recStream.nextRecord();
if (recStream.getSid() != 0) {
- Record record = createRecord (recStream);
+ Record record = createRecord (recStream);
if (record.getSid() != ContinueRecord.sid)
{
records.add(record);
if (activeRecord != null)
- activeRecord.dump();
- activeRecord = new RecordDetails(recStream.getSid(), recStream.getLength(), (int)recStream.getPos(), record);
+ activeRecord.dump(ps);
+ activeRecord = new RecordDetails(recStream.getSid(), recStream.getLength(), (int)recStream.getPos(), record);
}
if (dump) {
- recStream.dumpBytes();
- }
+ recStream.dumpBytes(ps);
}
- }
- activeRecord.dump();
- } catch (IOException e) {
- throw new RecordFormatException("Error reading bytes", e);
+ }
+ }
+ if (activeRecord != null) {
+ activeRecord.dump(ps);
}
Record[] retval = new Record[records.size()];
-
- retval = (Record[]) records.toArray(retval);
+ records.toArray(retval);
return retval;
}
- private static void dumpNormal(Record record, int startloc, short rectype, short recsize)
- {
- System.out.println("Offset 0x" + Integer.toHexString(startloc) + " (" + startloc + ")");
- System.out.println( "recordid = 0x" + Integer.toHexString( rectype ) + ", size = " + recsize );
- System.out.println( record.toString() );
-
- }
/**
- * Essentially a duplicate of RecordFactory. Kept seperate as not to screw
+ * Essentially a duplicate of RecordFactory. Kept separate as not to screw
* up non-debug operations.
*
*/
private static Record createRecord( RecordInputStream in )
{
- Record retval = null;
-
switch ( in.getSid() )
{
-
case ChartRecord.sid:
- retval = new ChartRecord( in );
- break;
+ return new ChartRecord( in );
case ChartFormatRecord.sid:
- retval = new ChartFormatRecord( in );
- break;
+ return new ChartFormatRecord( in );
case SeriesRecord.sid:
- retval = new SeriesRecord( in );
- break;
+ return new SeriesRecord( in );
case BeginRecord.sid:
- retval = new BeginRecord( in );
- break;
+ return new BeginRecord( in );
case EndRecord.sid:
- retval = new EndRecord( in );
- break;
+ return new EndRecord( in );
case BOFRecord.sid:
- retval = new BOFRecord( in );
- break;
+ return new BOFRecord( in );
case InterfaceHdrRecord.sid:
- retval = new InterfaceHdrRecord( in );
- break;
+ return new InterfaceHdrRecord( in );
case MMSRecord.sid:
- retval = new MMSRecord( in );
- break;
+ return new MMSRecord( in );
case InterfaceEndRecord.sid:
- retval = new InterfaceEndRecord( in );
- break;
+ return new InterfaceEndRecord( in );
case WriteAccessRecord.sid:
- retval = new WriteAccessRecord( in );
- break;
+ return new WriteAccessRecord( in );
case CodepageRecord.sid:
- retval = new CodepageRecord( in );
- break;
+ return new CodepageRecord( in );
case DSFRecord.sid:
- retval = new DSFRecord( in );
- break;
+ return new DSFRecord( in );
case TabIdRecord.sid:
- retval = new TabIdRecord( in );
- break;
+ return new TabIdRecord( in );
case FnGroupCountRecord.sid:
- retval = new FnGroupCountRecord( in );
- break;
+ return new FnGroupCountRecord( in );
case WindowProtectRecord.sid:
- retval = new WindowProtectRecord( in );
- break;
+ return new WindowProtectRecord( in );
case ProtectRecord.sid:
- retval = new ProtectRecord( in );
- break;
+ return new ProtectRecord( in );
case PasswordRecord.sid:
- retval = new PasswordRecord( in );
- break;
+ return new PasswordRecord( in );
case ProtectionRev4Record.sid:
- retval = new ProtectionRev4Record( in );
- break;
+ return new ProtectionRev4Record( in );
case PasswordRev4Record.sid:
- retval = new PasswordRev4Record( in );
- break;
+ return new PasswordRev4Record( in );
case WindowOneRecord.sid:
- retval = new WindowOneRecord( in );
- break;
+ return new WindowOneRecord( in );
case BackupRecord.sid:
- retval = new BackupRecord( in );
- break;
+ return new BackupRecord( in );
case HideObjRecord.sid:
- retval = new HideObjRecord( in );
- break;
+ return new HideObjRecord( in );
case DateWindow1904Record.sid:
- retval = new DateWindow1904Record( in );
- break;
+ return new DateWindow1904Record( in );
case PrecisionRecord.sid:
- retval = new PrecisionRecord( in );
- break;
+ return new PrecisionRecord( in );
case RefreshAllRecord.sid:
- retval = new RefreshAllRecord( in );
- break;
+ return new RefreshAllRecord( in );
case BookBoolRecord.sid:
- retval = new BookBoolRecord( in );
- break;
+ return new BookBoolRecord( in );
case FontRecord.sid:
- retval = new FontRecord( in );
- break;
+ return new FontRecord( in );
case FormatRecord.sid:
- retval = new FormatRecord( in );
- break;
+ return new FormatRecord( in );
case ExtendedFormatRecord.sid:
- retval = new ExtendedFormatRecord( in );
- break;
+ return new ExtendedFormatRecord( in );
case StyleRecord.sid:
- retval = new StyleRecord( in );
- break;
+ return new StyleRecord( in );
case UseSelFSRecord.sid:
- retval = new UseSelFSRecord( in );
- break;
+ return new UseSelFSRecord( in );
case BoundSheetRecord.sid:
- retval = new BoundSheetRecord( in );
- break;
+ return new BoundSheetRecord( in );
case CountryRecord.sid:
- retval = new CountryRecord( in );
- break;
+ return new CountryRecord( in );
case SSTRecord.sid:
- retval = new SSTRecord( in );
- break;
+ return new SSTRecord( in );
case ExtSSTRecord.sid:
- retval = new ExtSSTRecord( in );
- break;
+ return new ExtSSTRecord( in );
case EOFRecord.sid:
- retval = new EOFRecord( in );
- break;
+ return new EOFRecord( in );
case IndexRecord.sid:
- retval = new IndexRecord( in );
- break;
+ return new IndexRecord( in );
case CalcModeRecord.sid:
- retval = new CalcModeRecord( in );
- break;
+ return new CalcModeRecord( in );
case CalcCountRecord.sid:
- retval = new CalcCountRecord( in );
- break;
+ return new CalcCountRecord( in );
case RefModeRecord.sid:
- retval = new RefModeRecord( in );
- break;
+ return new RefModeRecord( in );
case IterationRecord.sid:
- retval = new IterationRecord( in );
- break;
+ return new IterationRecord( in );
case DeltaRecord.sid:
- retval = new DeltaRecord( in );
- break;
+ return new DeltaRecord( in );
case SaveRecalcRecord.sid:
- retval = new SaveRecalcRecord( in );
- break;
+ return new SaveRecalcRecord( in );
case PrintHeadersRecord.sid:
- retval = new PrintHeadersRecord( in );
- break;
+ return new PrintHeadersRecord( in );
case PrintGridlinesRecord.sid:
- retval = new PrintGridlinesRecord( in );
- break;
+ return new PrintGridlinesRecord( in );
case GridsetRecord.sid:
- retval = new GridsetRecord( in );
- break;
+ return new GridsetRecord( in );
case DrawingGroupRecord.sid:
- retval = new DrawingGroupRecord( in );
- break;
+ return new DrawingGroupRecord( in );
case DrawingRecordForBiffViewer.sid:
- retval = new DrawingRecordForBiffViewer( in );
- break;
+ return new DrawingRecordForBiffViewer( in );
case DrawingSelectionRecord.sid:
- retval = new DrawingSelectionRecord( in );
- break;
+ return new DrawingSelectionRecord( in );
case GutsRecord.sid:
- retval = new GutsRecord( in );
- break;
+ return new GutsRecord( in );
case DefaultRowHeightRecord.sid:
- retval = new DefaultRowHeightRecord( in );
- break;
+ return new DefaultRowHeightRecord( in );
case WSBoolRecord.sid:
- retval = new WSBoolRecord( in );
- break;
+ return new WSBoolRecord( in );
case HeaderRecord.sid:
- retval = new HeaderRecord( in );
- break;
+ return new HeaderRecord( in );
case FooterRecord.sid:
- retval = new FooterRecord( in );
- break;
+ return new FooterRecord( in );
case HCenterRecord.sid:
- retval = new HCenterRecord( in );
- break;
+ return new HCenterRecord( in );
case VCenterRecord.sid:
- retval = new VCenterRecord( in );
- break;
+ return new VCenterRecord( in );
case PrintSetupRecord.sid:
- retval = new PrintSetupRecord( in );
- break;
+ return new PrintSetupRecord( in );
case DefaultColWidthRecord.sid:
- retval = new DefaultColWidthRecord( in );
- break;
+ return new DefaultColWidthRecord( in );
case DimensionsRecord.sid:
- retval = new DimensionsRecord( in );
- break;
+ return new DimensionsRecord( in );
case RowRecord.sid:
- retval = new RowRecord( in );
- break;
+ return new RowRecord( in );
case LabelSSTRecord.sid:
- retval = new LabelSSTRecord( in );
- break;
+ return new LabelSSTRecord( in );
case RKRecord.sid:
- retval = new RKRecord( in );
- break;
+ return new RKRecord( in );
case NumberRecord.sid:
- retval = new NumberRecord( in );
- break;
+ return new NumberRecord( in );
case DBCellRecord.sid:
- retval = new DBCellRecord( in );
- break;
+ return new DBCellRecord( in );
case WindowTwoRecord.sid:
- retval = new WindowTwoRecord( in );
- break;
+ return new WindowTwoRecord( in );
case SelectionRecord.sid:
- retval = new SelectionRecord( in );
- break;
+ return new SelectionRecord( in );
case ContinueRecord.sid:
- retval = new ContinueRecord( in );
- break;
+ return new ContinueRecord( in );
case LabelRecord.sid:
- retval = new LabelRecord( in );
- break;
+ return new LabelRecord( in );
case MulRKRecord.sid:
- retval = new MulRKRecord( in );
- break;
+ return new MulRKRecord( in );
case MulBlankRecord.sid:
- retval = new MulBlankRecord( in );
- break;
+ return new MulBlankRecord( in );
case BlankRecord.sid:
- retval = new BlankRecord( in );
- break;
+ return new BlankRecord( in );
case BoolErrRecord.sid:
- retval = new BoolErrRecord( in );
- break;
+ return new BoolErrRecord( in );
case ColumnInfoRecord.sid:
- retval = new ColumnInfoRecord( in );
- break;
+ return new ColumnInfoRecord( in );
case MergeCellsRecord.sid:
- retval = new MergeCellsRecord( in );
- break;
+ return new MergeCellsRecord( in );
case AreaRecord.sid:
- retval = new AreaRecord( in );
- break;
+ return new AreaRecord( in );
case DataFormatRecord.sid:
- retval = new DataFormatRecord( in );
- break;
+ return new DataFormatRecord( in );
case BarRecord.sid:
- retval = new BarRecord( in );
- break;
+ return new BarRecord( in );
case DatRecord.sid:
- retval = new DatRecord( in );
- break;
+ return new DatRecord( in );
case PlotGrowthRecord.sid:
- retval = new PlotGrowthRecord( in );
- break;
+ return new PlotGrowthRecord( in );
case UnitsRecord.sid:
- retval = new UnitsRecord( in );
- break;
+ return new UnitsRecord( in );
case FrameRecord.sid:
- retval = new FrameRecord( in );
- break;
+ return new FrameRecord( in );
case ValueRangeRecord.sid:
- retval = new ValueRangeRecord( in );
- break;
+ return new ValueRangeRecord( in );
case SeriesListRecord.sid:
- retval = new SeriesListRecord( in );
- break;
+ return new SeriesListRecord( in );
case FontBasisRecord.sid:
- retval = new FontBasisRecord( in );
- break;
+ return new FontBasisRecord( in );
case FontIndexRecord.sid:
- retval = new FontIndexRecord( in );
- break;
+ return new FontIndexRecord( in );
case LineFormatRecord.sid:
- retval = new LineFormatRecord( in );
- break;
+ return new LineFormatRecord( in );
case AreaFormatRecord.sid:
- retval = new AreaFormatRecord( in );
- break;
+ return new AreaFormatRecord( in );
case LinkedDataRecord.sid:
- retval = new LinkedDataRecord( in );
- break;
+ return new LinkedDataRecord( in );
case FormulaRecord.sid:
- retval = new FormulaRecord( in );
- break;
+ return new FormulaRecord( in );
case SheetPropertiesRecord.sid:
- retval = new SheetPropertiesRecord( in );
- break;
+ return new SheetPropertiesRecord( in );
case DefaultDataLabelTextPropertiesRecord.sid:
- retval = new DefaultDataLabelTextPropertiesRecord( in );
- break;
+ return new DefaultDataLabelTextPropertiesRecord( in );
case TextRecord.sid:
- retval = new TextRecord( in );
- break;
+ return new TextRecord( in );
case AxisParentRecord.sid:
- retval = new AxisParentRecord( in );
- break;
+ return new AxisParentRecord( in );
case AxisLineFormatRecord.sid:
- retval = new AxisLineFormatRecord( in );
- break;
+ return new AxisLineFormatRecord( in );
case SupBookRecord.sid:
- retval = new SupBookRecord( in );
- break;
+ return new SupBookRecord( in );
case ExternSheetRecord.sid:
- retval = new ExternSheetRecord( in );
- break;
+ return new ExternSheetRecord( in );
case SCLRecord.sid:
- retval = new SCLRecord( in );
- break;
+ return new SCLRecord( in );
case SeriesToChartGroupRecord.sid:
- retval = new SeriesToChartGroupRecord( in );
- break;
+ return new SeriesToChartGroupRecord( in );
case AxisUsedRecord.sid:
- retval = new AxisUsedRecord( in );
- break;
+ return new AxisUsedRecord( in );
case AxisRecord.sid:
- retval = new AxisRecord( in );
- break;
+ return new AxisRecord( in );
case CategorySeriesAxisRecord.sid:
- retval = new CategorySeriesAxisRecord( in );
- break;
+ return new CategorySeriesAxisRecord( in );
case AxisOptionsRecord.sid:
- retval = new AxisOptionsRecord( in );
- break;
+ return new AxisOptionsRecord( in );
case TickRecord.sid:
- retval = new TickRecord( in );
- break;
+ return new TickRecord( in );
case SeriesTextRecord.sid:
- retval = new SeriesTextRecord( in );
- break;
+ return new SeriesTextRecord( in );
case ObjectLinkRecord.sid:
- retval = new ObjectLinkRecord( in );
- break;
+ return new ObjectLinkRecord( in );
case PlotAreaRecord.sid:
- retval = new PlotAreaRecord( in );
- break;
+ return new PlotAreaRecord( in );
case SeriesIndexRecord.sid:
- retval = new SeriesIndexRecord( in );
- break;
+ return new SeriesIndexRecord( in );
case LegendRecord.sid:
- retval = new LegendRecord( in );
- break;
+ return new LegendRecord( in );
case LeftMarginRecord.sid:
- retval = new LeftMarginRecord( in );
- break;
+ return new LeftMarginRecord( in );
case RightMarginRecord.sid:
- retval = new RightMarginRecord( in );
- break;
+ return new RightMarginRecord( in );
case TopMarginRecord.sid:
- retval = new TopMarginRecord( in );
- break;
+ return new TopMarginRecord( in );
case BottomMarginRecord.sid:
- retval = new BottomMarginRecord( in );
- break;
+ return new BottomMarginRecord( in );
case PaletteRecord.sid:
- retval = new PaletteRecord( in );
- break;
+ return new PaletteRecord( in );
case StringRecord.sid:
- retval = new StringRecord( in );
- break;
+ return new StringRecord( in );
case NameRecord.sid:
- retval = new NameRecord( in );
- break;
+ return new NameRecord( in );
case PaneRecord.sid:
- retval = new PaneRecord( in );
- break;
+ return new PaneRecord( in );
case SharedFormulaRecord.sid:
- retval = new SharedFormulaRecord( in);
- break;
+ return new SharedFormulaRecord( in);
case ObjRecord.sid:
- retval = new ObjRecord( in);
- break;
+ return new ObjRecord( in);
case TextObjectRecord.sid:
- retval = new TextObjectRecord( in);
- break;
+ return new TextObjectRecord( in);
case HorizontalPageBreakRecord.sid:
- retval = new HorizontalPageBreakRecord( in);
- break;
+ return new HorizontalPageBreakRecord( in);
case VerticalPageBreakRecord.sid:
- retval = new VerticalPageBreakRecord( in);
- break;
+ return new VerticalPageBreakRecord( in);
case WriteProtectRecord.sid:
- retval = new WriteProtectRecord( in);
- break;
+ return new WriteProtectRecord( in);
case FilePassRecord.sid:
- retval = new FilePassRecord(in);
- break;
+ return new FilePassRecord(in);
case NoteRecord.sid:
- retval = new NoteRecord( in );
- break;
+ return new NoteRecord( in );
case FileSharingRecord.sid:
- retval = new FileSharingRecord( in );
- break;
+ return new FileSharingRecord( in );
case HyperlinkRecord.sid:
- retval = new HyperlinkRecord( in );
- break;
- default:
- retval = new UnknownRecord( in );
+ return new HyperlinkRecord( in );
}
- return retval;
+ return new UnknownRecord( in );
}
/**
* Method setDump - hex dump out data or not.
- *
- *@param dump
*/
-
public void setDump(boolean dump) {
this.dump = dump;
}
@@ -552,33 +393,44 @@
*
*/
public static void main(String[] args) {
+
+ System.setProperty("poi.deserialize.escher", "true");
+
+ if (args.length == 0) {
+ System.out.println( "Biff viewer needs a filename" );
+ return;
+ }
+
try {
- System.setProperty("poi.deserialize.escher", "true");
+ String inFileName = args[0];
+ File inputFile = new File(inFileName);
+ if(!inputFile.exists()) {
+ throw new RuntimeException("specified inputFile '" + inFileName + "' does not exist");
+ }
+ PrintStream ps;
+ if (false) { // set to true to output to file
+ OutputStream os = new FileOutputStream(inFileName + ".out");
+ ps = new PrintStream(os);
+ } else {
+ ps = System.out;
+ }
+ BiffViewer viewer = new BiffViewer(inputFile, ps);
- if (args.length == 0)
- {
- System.out.println( "Biff viewer needs a filename" );
+ if (args.length > 1 && args[1].equals("on")) {
+ viewer.setDump(true);
}
- else
- {
- BiffViewer viewer = new BiffViewer(args);
- if ((args.length > 1) && args[1].equals("on")) {
- viewer.setDump(true);
- }
- if ((args.length > 1) && args[1].equals("bfd")) {
- POIFSFileSystem fs =
- new POIFSFileSystem(new FileInputStream(args[0]));
- InputStream stream =
- fs.createDocumentInputStream("Workbook");
- int size = stream.available();
- byte[] data = new byte[size];
-
- stream.read(data);
- HexDump.dump(data, 0, System.out, 0);
- } else {
- viewer.run();
- }
+ if (args.length > 1 && args[1].equals("bfd")) {
+ POIFSFileSystem fs = new POIFSFileSystem(new FileInputStream(inputFile));
+ InputStream stream = fs.createDocumentInputStream("Workbook");
+ int size = stream.available();
+ byte[] data = new byte[size];
+
+ stream.read(data);
+ HexDump.dump(data, 0, System.out, 0);
+ } else {
+ viewer.run();
}
+ ps.close();
} catch (Exception e) {
e.printStackTrace();
}
@@ -587,7 +439,7 @@
/**
* This record supports dumping of completed continue records.
*/
- static class RecordDetails
+ private static final class RecordDetails
{
short rectype, recsize;
int startloc;
@@ -616,18 +468,19 @@
return record;
}
- public void dump() throws IOException
- {
- dumpNormal(record, startloc, rectype, recsize);
+ public void dump(PrintStream ps) {
+ ps.println("Offset 0x" + Integer.toHexString(startloc) + " (" + startloc + ")");
+ ps.println( "recordid = 0x" + Integer.toHexString( rectype ) + ", size = " + recsize );
+ ps.println( record.toString() );
}
}
- static class BiffviewRecordInputStream extends RecordInputStream {
+ private static final class BiffviewRecordInputStream extends RecordInputStream {
public BiffviewRecordInputStream(InputStream in) {
super(in);
}
- public void dumpBytes() {
- HexDump.dump(this.data, 0, this.currentLength);
+ public void dumpBytes(PrintStream ps) {
+ ps.println(HexDump.dump(this.data, 0, this.currentLength));
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org