/**
* Package protected function which gets the real internal sheet index based upon the external
* sheet reference. This is used for extern sheet references which are specified in formulas
*
* @param index the external sheet reference
* @return the actual sheet index
*/
public int getLastExternalSheetIndex(int index) {
// For biff7, the whole external reference thing works differently
// Hopefully for our purposes sheet references will all be local
if (workbookBof.isBiff7()) {
return index;
}
Assert.verify(externSheet != null);
int lastTab = externSheet.getLastTabIndex(index);
return lastTab;
}
/**
* Publicly available copy constructor
*
* @param f the font to copy
*/
protected FontRecord(Font f) {
super(Type.FONT);
Assert.verify(f != null);
pointHeight = f.getPointSize();
colourIndex = f.getColour().getValue();
boldWeight = f.getBoldWeight();
scriptStyle = f.getScriptStyle().getValue();
underlineStyle = f.getUnderlineStyle().getValue();
italic = f.isItalic();
name = f.getName();
struckout = false;
initialized = false;
}
/**
* Sets the script style (eg. superscript, subscript) for this font, if the font hasn't been
* initialized
*
* @param ss the colour
*/
protected void setFontScriptStyle(int ss) {
Assert.verify(!initialized);
scriptStyle = ss;
}
/**
* Sets the colour for this font, if the font hasn't been initialized
*
* @param c the colour
*/
protected void setFontColour(int c) {
Assert.verify(!initialized);
colourIndex = c;
}
/**
* Sets the underline style for this font, if the font hasn't been initialized
*
* @param us the underline style
*/
protected void setFontUnderlineStyle(int us) {
Assert.verify(!initialized);
underlineStyle = us;
}
/**
* Sets the italic indicator for this font, if the font hasn't been initialized
*
* @param i the italic flag
*/
protected void setFontItalic(boolean i) {
Assert.verify(!initialized);
italic = i;
}
/**
* Sets the bold style for this font, if the font hasn't been initialized
*
* @param bs the bold style
*/
protected void setFontBoldStyle(int bs) {
Assert.verify(!initialized);
boldWeight = bs;
}
/**
* Sets the point size for this font, if the font hasn't been initialized
*
* @param ps the point size
*/
protected void setFontPointSize(int ps) {
Assert.verify(!initialized);
pointHeight = ps;
}
/**
* Gets the name at the specified index
*
* @param index the index into the name table
* @return the name of the cell
*/
public String getName(int index) {
Assert.verify(index >= 0 && index < nameTable.size());
return ((NameRecord) nameTable.get(index)).getName();
}
/**
* Does the hard work of building up the object graph from the excel bytes
*
* @exception BiffException
* @exception PasswordException if the workbook is password protected
*/
protected void parse() throws BiffException, PasswordException {
Record r = null;
BOFRecord bof = new BOFRecord(excelFile.next());
workbookBof = bof;
bofs++;
if (!bof.isBiff8() && !bof.isBiff7()) {
throw new BiffException(BiffException.unrecognizedBiffVersion);
}
if (!bof.isWorkbookGlobals()) {
throw new BiffException(BiffException.expectedGlobals);
}
ArrayList continueRecords = new ArrayList();
nameTable = new ArrayList();
// Skip to the first worksheet
while (bofs == 1) {
r = excelFile.next();
if (r.getType() == Type.SST) {
continueRecords.clear();
Record nextrec = excelFile.peek();
while (nextrec.getType() == Type.CONTINUE) {
continueRecords.add(excelFile.next());
nextrec = excelFile.peek();
}
// cast the array
Object[] rec = continueRecords.toArray();
Record[] records = new Record[rec.length];
System.arraycopy(rec, 0, records, 0, rec.length);
sharedStrings = new SSTRecord(r, records, settings);
} else if (r.getType() == Type.FILEPASS) {
throw new PasswordException();
} else if (r.getType() == Type.NAME) {
NameRecord nr = null;
if (bof.isBiff8()) {
nr = new NameRecord(r, settings, namedRecords.size());
} else {
nr = new NameRecord(r, settings, namedRecords.size(), NameRecord.biff7);
}
namedRecords.put(nr.getName(), nr);
nameTable.add(nr);
} else if (r.getType() == Type.FONT) {
FontRecord fr = null;
if (bof.isBiff8()) {
fr = new FontRecord(r, settings);
} else {
fr = new FontRecord(r, settings, FontRecord.biff7);
}
fonts.addFont(fr);
} else if (r.getType() == Type.PALETTE) {
PaletteRecord palette = new PaletteRecord(r);
formattingRecords.setPalette(palette);
} else if (r.getType() == Type.NINETEENFOUR) {
NineteenFourRecord nr = new NineteenFourRecord(r);
nineteenFour = nr.is1904();
} else if (r.getType() == Type.FORMAT) {
FormatRecord fr = null;
if (bof.isBiff8()) {
fr = new FormatRecord(r, settings, FormatRecord.biff8);
} else {
fr = new FormatRecord(r, settings, FormatRecord.biff7);
}
try {
formattingRecords.addFormat(fr);
} catch (NumFormatRecordsException e) {
// This should not happen. Bomb out
Assert.verify(false, e.getMessage());
}
} else if (r.getType() == Type.XF) {
XFRecord xfr = null;
if (bof.isBiff8()) {
xfr = new XFRecord(r, XFRecord.biff8);
} else {
xfr = new XFRecord(r, XFRecord.biff7);
}
try {
formattingRecords.addStyle(xfr);
} catch (NumFormatRecordsException e) {
// This should not happen. Bomb out
Assert.verify(false, e.getMessage());
}
} else if (r.getType() == Type.BOUNDSHEET) {
BoundsheetRecord br = null;
if (bof.isBiff8()) {
br = new BoundsheetRecord(r);
} else {
br = new BoundsheetRecord(r, BoundsheetRecord.biff7);
}
if (br.isSheet() || br.isChart()) {
boundsheets.add(br);
}
} else if (r.getType() == Type.EXTERNSHEET) {
if (bof.isBiff8()) {
externSheet = new ExternalSheetRecord(r, settings);
} else {
externSheet = new ExternalSheetRecord(r, settings, ExternalSheetRecord.biff7);
}
} else if (r.getType() == Type.CODEPAGE) {
CodepageRecord cr = new CodepageRecord(r);
settings.setCharacterSet(cr.getCharacterSet());
} else if (r.getType() == Type.SUPBOOK) {
SupbookRecord sr = new SupbookRecord(r, settings);
supbooks.add(sr);
} else if (r.getType() == Type.PROTECT) {
ProtectRecord pr = new ProtectRecord(r);
wbProtected = pr.isProtected();
} else if (r.getType() == Type.OBJPROJ) {
containsMacros = true;
} else if (r.getType() == Type.MSODRAWINGGROUP) {
msoDrawingGroup = new MsoDrawingGroupRecord(r);
if (drawingGroup == null) {
drawingGroup = new DrawingGroup(DrawingGroup.READ);
}
drawingGroup.add(msoDrawingGroup);
Record nextrec = excelFile.peek();
while (nextrec.getType() == Type.CONTINUE) {
drawingGroup.add(excelFile.next());
nextrec = excelFile.peek();
}
} else if (r.getType() == Type.BUTTONPROPERTYSET) {
buttonPropertySet = new ButtonPropertySetRecord(r);
} else if (r.getType() == Type.EOF) {
bofs--;
}
}
bof = null;
if (excelFile.hasNext()) {
r = excelFile.next();
if (r.getType() == Type.BOF) {
bof = new BOFRecord(r);
}
}
// Only get sheets for which there is a corresponding Boundsheet record
while (bof != null && getNumberOfSheets() < boundsheets.size()) {
if (!bof.isBiff8() && !bof.isBiff7()) {
throw new BiffException(BiffException.unrecognizedBiffVersion);
}
if (bof.isWorksheet()) {
// Read the sheet in
SheetImpl s =
new SheetImpl(
excelFile, sharedStrings, formattingRecords, bof, workbookBof, nineteenFour, this);
BoundsheetRecord br = (BoundsheetRecord) boundsheets.get(getNumberOfSheets());
s.setName(br.getName());
s.setHidden(br.isHidden());
addSheet(s);
} else if (bof.isChart()) {
// Read the sheet in
SheetImpl s =
new SheetImpl(
excelFile, sharedStrings, formattingRecords, bof, workbookBof, nineteenFour, this);
BoundsheetRecord br = (BoundsheetRecord) boundsheets.get(getNumberOfSheets());
s.setName(br.getName());
s.setHidden(br.isHidden());
addSheet(s);
} else {
logger.warn("BOF is unrecognized");
while (excelFile.hasNext() && r.getType() != Type.EOF) {
r = excelFile.next();
}
}
// The next record will normally be a BOF or empty padding until
// the end of the block is reached. In exceptionally unlucky cases,
// the last EOF will coincide with a block division, so we have to
// check there is more data to retrieve.
// Thanks to liamg for spotting this
bof = null;
if (excelFile.hasNext()) {
r = excelFile.next();
if (r.getType() == Type.BOF) {
bof = new BOFRecord(r);
}
}
}
}