/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for Additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
namespace HH.WMS.Utils.NPOI.DDF
{
using System;
using System.IO;
using System.Text;
using System.Collections;
using HH.WMS.Utils.NPOI.Util;
using System.Collections.Generic;
///
/// Escher container records store other escher records as children.
/// The container records themselves never store any information beyond
/// the standard header used by all escher records. This one record is
/// used to represent many different types of records.
/// @author Glen Stampoultzis
///
public class EscherContainerRecord : EscherRecord
{
public const short DGG_CONTAINER = unchecked((short)0xF000);
public const short BSTORE_CONTAINER = unchecked((short)0xF001);
public const short DG_CONTAINER = unchecked((short)0xF002);
public const short SPGR_CONTAINER = unchecked((short)0xF003);
public const short SP_CONTAINER = unchecked((short)0xF004);
public const short SOLVER_CONTAINER = unchecked((short)0xF005);
private List childRecords = new List();
///
/// The contract of this method is to deSerialize an escher record including
/// it's children.
///
/// The byte array containing the Serialized escher
/// records.
/// The offset into the byte array.
/// A factory for creating new escher records
/// The number of bytes written.
public override int FillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
{
int bytesRemaining = ReadHeader(data, offset);
int bytesWritten = 8;
offset += 8;
while (bytesRemaining > 0 && offset < data.Length)
{
EscherRecord child = recordFactory.CreateRecord(data, offset);
int childBytesWritten = child.FillFields(data, offset, recordFactory);
bytesWritten += childBytesWritten;
offset += childBytesWritten;
bytesRemaining -= childBytesWritten;
AddChildRecord(child);
if (offset >= data.Length && bytesRemaining > 0)
{
Console.WriteLine("WARNING: " + bytesRemaining + " bytes remaining but no space left");
}
}
return bytesWritten;
}
///
/// Serializes to an existing byte array without serialization listener.
/// This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
///
/// the offset within the data byte array.
/// the data array to Serialize to.
/// a listener for begin and end serialization events.
/// The number of bytes written.
public override int Serialize(int offset, byte[] data, EscherSerializationListener listener)
{
listener.BeforeRecordSerialize(offset, RecordId, this);
LittleEndian.PutShort(data, offset, Options);
LittleEndian.PutShort(data, offset + 2, RecordId);
int remainingBytes = 0;
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord r = (EscherRecord)iterator.Current;
remainingBytes += r.RecordSize;
}
LittleEndian.PutInt(data, offset + 4, remainingBytes);
int pos = offset + 8;
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord r = (EscherRecord)iterator.Current;
pos += r.Serialize(pos, data,listener);
}
listener.AfterRecordSerialize(pos, RecordId, pos - offset, this);
return pos - offset;
}
///
/// Subclasses should effeciently return the number of bytes required to
/// Serialize the record.
///
/// number of bytes
public override int RecordSize
{
get
{
int childRecordsSize = 0;
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord r = (EscherRecord)iterator.Current;
childRecordsSize += r.RecordSize;
}
return 8 + childRecordsSize;
}
}
///
/// Do any of our (top level) children have the
/// given recordId?
///
/// The record id.
///
/// true if [has child of type] [the specified record id]; otherwise, false.
///
public bool HasChildOfType(short recordId)
{
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord r = (EscherRecord)iterator.Current;
if (r.RecordId == recordId)
{
return true;
}
}
return false;
}
///
/// Returns a list of all the child (escher) records
/// of the container.
///
///
public override List ChildRecords
{
get { return new List(childRecords); }
set {
if (value == childRecords)
{
throw new InvalidOperationException("Child records private data member has escaped");
}
childRecords.Clear();
childRecords.AddRange(value);
}
}
public bool RemoveChildRecord(EscherRecord toBeRemoved)
{
return childRecords.Remove(toBeRemoved);
}
public List.Enumerator GetChildIterator()
{
return childRecords.GetEnumerator();
}
///
/// Returns all of our children which are also
/// EscherContainers (may be 0, 1, or vary rarely
/// 2 or 3)
///
/// The child containers.
public IList ChildContainers
{
get
{
IList containers = new List();
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord r = (EscherRecord)iterator.Current;
if (r is EscherContainerRecord)
{
containers.Add((EscherContainerRecord)r);
}
}
return containers;
}
}
///
/// Subclasses should return the short name for this escher record.
///
///
public override String RecordName
{
get
{
switch ((short)RecordId)
{
case DGG_CONTAINER:
return "DggContainer";
case BSTORE_CONTAINER:
return "BStoreContainer";
case DG_CONTAINER:
return "DgContainer";
case SPGR_CONTAINER:
return "SpgrContainer";
case SP_CONTAINER:
return "SpContainer";
case SOLVER_CONTAINER:
return "SolverContainer";
default:
return "Container 0x" + HexDump.ToHex(RecordId);
}
}
}
///
/// The display methods allows escher variables to print the record names
/// according to their hierarchy.
///
/// The current indent level.
public override void Display(int indent)
{
base.Display(indent);
for (IEnumerator iterator = childRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord escherRecord = (EscherRecord)iterator.Current;
escherRecord.Display(indent + 1);
}
}
///
/// Adds the child record.
///
/// The record.
public void AddChildRecord(EscherRecord record)
{
this.childRecords.Add(record);
}
///
/// Returns a that represents the current .
///
///
/// A that represents the current .
///
public override string ToString()
{
return ToString("");
}
///
/// Toes the string.
///
/// The indent.
///
public String ToString(String indent)
{
String nl = Environment.NewLine;
StringBuilder children = new StringBuilder();
if (ChildRecords.Count> 0)
{
children.Append(" children: " + nl);
int count = 0;
for (IEnumerator iterator = ChildRecords.GetEnumerator(); iterator.MoveNext(); )
{
String newIndent = indent + " ";
EscherRecord record = (EscherRecord)iterator.Current;
children.Append(newIndent + "Child " + count + ":" + nl);
if (record is EscherContainerRecord)
{
EscherContainerRecord ecr = (EscherContainerRecord)record;
children.Append(ecr.ToString(newIndent));
}
else
{
children.Append(record.ToString());
}
count++;
}
}
return
indent + this.GetType().Name + " (" + RecordName + "):" + nl +
indent + " isContainer: " + IsContainerRecord + nl +
indent + " options: 0x" + HexDump.ToHex(Options) + nl +
indent + " recordId: 0x" + HexDump.ToHex(RecordId) + nl +
indent + " numchildren: " + ChildRecords.Count + nl +
indent + children.ToString();
}
///
/// Gets the child by id.
///
/// The record id.
///
public EscherSpRecord GetChildById(short recordId)
{
for (IEnumerator iterator = childRecords.GetEnumerator(); iterator.MoveNext(); )
{
EscherRecord escherRecord = (EscherRecord)iterator.Current;
if (escherRecord.RecordId == recordId)
return (EscherSpRecord)escherRecord;
}
return null;
}
///
/// Recursively find records with the specified record ID
///
///
/// list to store found records
public void GetRecordsById(short recordId, ref ArrayList out1)
{
for (IEnumerator it = ChildRecords.GetEnumerator(); it.MoveNext(); )
{
Object er = it.Current;
EscherRecord r = (EscherRecord)er;
if (r is EscherContainerRecord)
{
EscherContainerRecord c = (EscherContainerRecord)r;
c.GetRecordsById(recordId, ref out1);
}
else if (r.RecordId == recordId)
{
out1.Add(er);
}
}
}
}
}