/**
* Constructs this object from the raw data. We need to use the excelFile
* to retrieve the string record which follows this formula record
*
* @param t the raw data
* @param excelFile the excel file
* @param fr the formatting records
* @param es the external sheet records
* @param nt the workbook
* @param si the sheet impl
* @param ws the workbook settings
*/
public StringFormulaRecord(Record t, File excelFile,
FormattingRecords fr,
ExternalSheet es,
WorkbookMethods nt,
SheetImpl si,
WorkbookSettings ws)
: base(t, fr, si)
{
externalSheet = es;
nameTable = nt;
data = getRecord().getData();
int pos = excelFile.getPos();
// Look for the string record in one of the records after the
// formula. Put a cap on it to prevent looping
Record nextRecord = excelFile.next();
int count = 0;
while (nextRecord.getType() != Type.STRING && count < 4)
{
nextRecord = excelFile.next();
count++;
}
Assert.verify(count < 4, " @ " + pos);
byte[] stringData = nextRecord.getData();
// Read in any continuation records
nextRecord = excelFile.peek();
while (nextRecord.getType() == Type.CONTINUE)
{
nextRecord = excelFile.next(); // move the pointer within the data
byte[] d = new byte[stringData.Length + nextRecord.getLength() - 1];
System.Array.Copy(stringData, 0, d, 0, stringData.Length);
System.Array.Copy(nextRecord.getData(), 1, d,
stringData.Length, nextRecord.getLength() - 1);
stringData = d;
nextRecord = excelFile.peek();
}
readString(stringData, ws);
}
/**
* Constructor
*
* @param f the excel file
* @param sst the shared string table
* @param fr formatting records
* @param sb the bof record which indicates the start of the sheet
* @param wb the bof record which indicates the start of the sheet
* @param nf the 1904 flag
* @param wp the workbook which this sheet belongs to
* @exception BiffException
*/
public SheetImpl(File f,
SSTRecord sst,
FormattingRecords fr,
BOFRecord sb,
BOFRecord wb,
bool nf,
WorkbookParser wp)
{
excelFile = f;
sharedStrings = sst;
formattingRecords = fr;
sheetBof = sb;
workbookBof = wb;
columnInfosArray = new ArrayList();
sharedFormulas = new ArrayList();
hyperlinks = new ArrayList();
rowProperties = new ArrayList(10);
columnInfosInitialized = false;
rowRecordsInitialized = false;
nineteenFour = nf;
workbook = wp;
workbookSettings = workbook.getSettings();
// Mark the position in the stream, and then skip on until the end
startPosition = f.getPos();
if (sheetBof.isChart())
{
// Set the start pos to include the bof so the sheet reader can handle it
startPosition -= (sheetBof.getLength() + 4);
}
Record r = null;
int bofs = 1;
while (bofs >= 1)
{
r = f.next();
// use this form for quick performance
if (r.getCode() == Type.EOF.value)
{
bofs--;
}
if (r.getCode() == Type.BOF.value)
{
bofs++;
}
}
}
/**
* 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 override void parse()
{
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();
ArrayList localNames = new ArrayList();
nameTable = new ArrayList();
addInFunctions = 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
Record[] records = new Record[continueRecords.Count];
int pos = 0;
foreach (Record record in continueRecords)
{
records[pos++] = record;
}
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, nameTable.Count);
}
else
{
nr = new NameRecord(r, settings, nameTable.Count,
NameRecord.biff7);
}
// Add all local and global names to the name table in order to
// preserve the indexing
nameTable.Add(nr);
if (nr.isGlobal())
{
namedRecords.Add(nr.getName(), nr);
}
else
{
localNames.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)
{
CSharpJExcel.Jxl.Biff.PaletteRecord palette = new CSharpJExcel.Jxl.Biff.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.Message);
}
}
else if (r.getType() == Type.XF)
{
XFRecord xfr = null;
if (bof.isBiff8())
{
xfr = new XFRecord(r, settings, XFRecord.biff8);
}
else
{
xfr = new XFRecord(r, settings, XFRecord.biff7);
}
try
{
formattingRecords.addStyle(xfr);
}
catch (NumFormatRecordsException e)
{
// This should not happen. Bomb out
Assert.verify(false, e.Message);
}
}
else if (r.getType() == Type.BOUNDSHEET)
{
BoundsheetRecord br = null;
if (bof.isBiff8())
{
br = new BoundsheetRecord(r, settings);
}
else
{
br = new BoundsheetRecord(r, BoundsheetRecord.biff7);
}
if (br.isSheet())
{
boundsheets.Add(br);
}
else if (br.isChart() && !settings.getDrawingsDisabled())
{
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.XCT)
{
XCTRecord xctr = new XCTRecord(r);
xctRecords.Add(xctr);
}
else if (r.getType() == Type.CODEPAGE)
{
CodepageRecord cr = new CodepageRecord(r);
settings.setCharacterSet(cr.getCharacterSet());
}
else if (r.getType() == Type.SUPBOOK)
{
Record nextrec = excelFile.peek();
while (nextrec.getType() == Type.CONTINUE)
{
r.addContinueRecord(excelFile.next());
nextrec = excelFile.peek();
}
SupbookRecord sr = new SupbookRecord(r, settings);
supbooks.Add(sr);
}
else if (r.getType() == Type.EXTERNNAME)
{
ExternalNameRecord enr = new ExternalNameRecord(r, settings);
if (enr.isAddInFunction())
{
addInFunctions.Add(enr.getName());
}
}
else if (r.getType() == Type.PROTECT)
{
ProtectRecord pr = new ProtectRecord(r);
wbProtected = pr.isProtected();
}
else if (r.getType() == Type.OBJPROJ)
{
doesContainMacros = true;
}
else if (r.getType() == Type.COUNTRY)
{
countryRecord = new CountryRecord(r);
}
else if (r.getType() == Type.MSODRAWINGGROUP)
{
if (!settings.getDrawingsDisabled())
{
msoDrawingGroup = new MsoDrawingGroupRecord(r);
if (drawingGroup == null)
{
drawingGroup = new DrawingGroup(Origin.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--;
}
else if (r.getType() == Type.REFRESHALL)
{
RefreshAllRecord rfm = new RefreshAllRecord(r);
settings.setRefreshAll(rfm.getRefreshAll());
}
else if (r.getType() == Type.TEMPLATE)
{
TemplateRecord rfm = new TemplateRecord(r);
settings.setTemplate(rfm.getTemplate());
}
else if (r.getType() == Type.EXCEL9FILE)
{
Excel9FileRecord e9f = new Excel9FileRecord(r);
settings.setExcel9File(e9f.getExcel9File());
}
else if (r.getType() == Type.WINDOWPROTECT)
{
WindowProtectedRecord winp = new WindowProtectedRecord(r);
settings.setWindowProtected(winp.getWindowProtected());
}
else if (r.getType() == Type.HIDEOBJ)
{
HideobjRecord hobj = new HideobjRecord(r);
settings.setHideobj(hobj.getHideMode());
}
else if (r.getType() == Type.WRITEACCESS)
{
WriteAccessRecord war = new WriteAccessRecord(r, bof.isBiff8(), settings);
settings.setWriteAccess(war.getWriteAccess());
}
else
{
// logger.info("Unsupported record type: " +
// Integer.toHexString(r.getCode())+"h");
}
}
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.Count)
{
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[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[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);
}
}
}
// Add all the local names to the specific sheets
foreach (NameRecord nr in localNames)
{
if (nr.getBuiltInName() == null)
{
//logger.warn("Usage of a local non-builtin name");
}
else if (nr.getBuiltInName() == BuiltInName.PRINT_AREA ||
nr.getBuiltInName() == BuiltInName.PRINT_TITLES)
{
// appears to use the internal tab number rather than the
// external sheet index
SheetImpl s = (SheetImpl)sheets[nr.getSheetRef() - 1];
s.addLocalName(nr);
}
}
}
/**
* Constructs this string formula
*
* @param t the record
* @param excelFile the excel file
* @param fr the formatting record
* @param es the external sheet
* @param nt the workbook
* @param si the sheet
* @param ws the workbook settings
*/
public SharedStringFormulaRecord(Record t,
File excelFile,
FormattingRecords fr,
ExternalSheet es,
WorkbookMethods nt,
SheetImpl si,
WorkbookSettings ws)
: base(t, fr, es, nt, si, excelFile.getPos())
{
int pos = excelFile.getPos();
// Save the position in the excel file
int filepos = excelFile.getPos();
// Look for the string record in one of the records after the
// formula. Put a cap on it to prevent ednas
Record nextRecord = excelFile.next();
int count = 0;
while (nextRecord.getType() != Type.STRING && count < 4)
{
nextRecord = excelFile.next();
count++;
}
Assert.verify(count < 4, " @ " + pos);
byte[] stringData = nextRecord.getData();
// Read in any continuation records
nextRecord = excelFile.peek();
while (nextRecord.getType() == Type.CONTINUE)
{
nextRecord = excelFile.next(); // move the pointer within the data
byte[] d = new byte[stringData.Length + nextRecord.getLength() - 1];
System.Array.Copy(stringData, 0, d, 0, stringData.Length);
System.Array.Copy(nextRecord.getData(), 1, d,
stringData.Length, nextRecord.getLength() - 1);
stringData = d;
nextRecord = excelFile.peek();
}
int chars = IntegerHelper.getInt(stringData[0], stringData[1]);
bool unicode = false;
int startpos = 3;
if (stringData.Length == chars + 2)
{
// string might only consist of a one byte length indicator, instead
// of the more normal 2
startpos = 2;
unicode = false;
}
else if (stringData[2] == 0x1)
{
// unicode string, two byte length indicator
startpos = 3;
unicode = true;
}
else
{
// ascii string, two byte length indicator
startpos = 3;
unicode = false;
}
if (!unicode)
{
value = StringHelper.getString(stringData, chars, startpos, ws);
}
else
{
value = StringHelper.getUnicodeString(stringData, chars, startpos);
}
// Restore the position in the excel file, to enable the SHRFMLA
// record to be picked up
excelFile.setPos(filepos);
}