internal void XmlSerialize(XmlWriter xw)
{
string def = $"{DisplayType} {InternalName}";
if (ParamUtil.IsBitType(DisplayType) && BitSize != -1)
{
def += $":{BitSize}";
}
else if (ParamUtil.IsArrayType(DisplayType))
{
def += $"[{ArrayLength}]";
}
if (Default != 0)
{
def += $" = {Default.ToString("R", CultureInfo.InvariantCulture)}";
}
xw.WriteAttributeString("Def", def);
xw.WriteDefaultElement(nameof(DisplayName), DisplayName, InternalName);
xw.WriteDefaultElement("Enum", InternalType, DisplayType.ToString());
xw.WriteDefaultElement(nameof(Description), Description, null);
xw.WriteDefaultElement(nameof(DisplayFormat), DisplayFormat, ParamUtil.GetDefaultFormat(DisplayType));
xw.WriteDefaultElement(nameof(EditFlags), EditFlags.ToString(), ParamUtil.GetDefaultEditFlags(DisplayType).ToString());
xw.WriteDefaultElement(nameof(Minimum), Minimum, ParamUtil.GetDefaultMinimum(DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement(nameof(Maximum), Maximum, ParamUtil.GetDefaultMaximum(DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement(nameof(Increment), Increment, ParamUtil.GetDefaultIncrement(DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement(nameof(SortID), SortID, 0);
}
private static void SerializeField(Field field, XmlWriter xw)
{
string def = $"{field.DisplayType} {field.InternalName}";
if (ParamUtil.IsBitType(field.DisplayType) && field.BitSize != -1)
{
def += $":{field.BitSize}";
}
else if (ParamUtil.IsArrayType(field.DisplayType))
{
def += $"[{field.ArrayLength}]";
}
if (field.Default != 0)
{
def += $" = {field.Default.ToString("R", CultureInfo.InvariantCulture)}";
}
xw.WriteAttributeString("Def", def);
xw.WriteDefaultElement("DisplayName", field.DisplayName, field.InternalName);
xw.WriteDefaultElement("Enum", field.InternalType, field.DisplayType.ToString());
xw.WriteDefaultElement("Description", field.Description, null);
xw.WriteDefaultElement("DisplayFormat", field.DisplayFormat, ParamUtil.GetDefaultFormat(field.DisplayType));
xw.WriteDefaultElement("EditFlags", field.EditFlags.ToString(), ParamUtil.GetDefaultEditFlags(field.DisplayType).ToString());
xw.WriteDefaultElement("Minimum", field.Minimum, ParamUtil.GetDefaultMinimum(field.DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement("Maximum", field.Maximum, ParamUtil.GetDefaultMaximum(field.DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement("Increment", field.Increment, ParamUtil.GetDefaultIncrement(field.DisplayType), "R", CultureInfo.InvariantCulture);
xw.WriteDefaultElement("SortID", field.SortID, 0);
xw.WriteDefaultElement("UnkB8", field.UnkB8, null);
xw.WriteDefaultElement("UnkC0", field.UnkC0, null);
xw.WriteDefaultElement("UnkC8", field.UnkC8, null);
}
internal void Write(BinaryWriterEx bw, PARAMDEF def, int index)
{
if (def.Unicode)
{
bw.WriteFixStrW(DisplayName, 0x40, (byte)(def.Version >= 104 ? 0x00 : 0x20));
}
else
{
bw.WriteFixStr(DisplayName, 0x40, (byte)(def.Version >= 104 ? 0x00 : 0x20));
}
byte padding = (byte)(def.Version >= 201 ? 0x00 : 0x20);
bw.WriteFixStr(DisplayType.ToString(), 8, padding);
bw.WriteFixStr(DisplayFormat, 8, padding);
bw.WriteSingle(Default);
bw.WriteSingle(Minimum);
bw.WriteSingle(Maximum);
bw.WriteSingle(Increment);
bw.WriteInt32((int)EditFlags);
bw.WriteInt32(ParamUtil.GetValueSize(DisplayType) * (ParamUtil.IsArrayType(DisplayType) ? ArrayLength : 1));
if (def.Version >= 201)
{
bw.ReserveInt64($"DescriptionOffset{index}");
}
else
{
bw.ReserveInt32($"DescriptionOffset{index}");
}
bw.WriteFixStr(InternalType, 0x20, padding);
if (def.Version >= 102)
{
string internalName = InternalName;
// This is accurate except for "hasTarget : 1" in SpEffect
if (BitSize != -1)
{
internalName = $"{internalName}:{BitSize}";
}
// BB is not consistent about including [1] or not, but PTDE always does
else if (ParamUtil.IsArrayType(DisplayType))
{
internalName = $"{internalName}[{ArrayLength}]";
}
bw.WriteFixStr(internalName, 0x20, padding);
}
if (def.Version >= 104)
{
bw.WriteInt32(SortID);
}
if (def.Version >= 201)
{
bw.WritePattern(0x1C, 0x00);
}
}
/// <summary>
/// Returns a string representation of the field.
/// </summary>
public override string ToString()
{
if (ParamUtil.IsBitType(DisplayType) && BitSize != -1)
{
return($"{DisplayType} {InternalName}:{BitSize}");
}
else if (ParamUtil.IsArrayType(DisplayType))
{
return($"{DisplayType} {InternalName}[{ArrayLength}]");
}
else
{
return($"{DisplayType} {InternalName}");
}
}
private static Field DeserializeField(XmlNode node)
{
var field = new Field();
string def = node.Attributes["Def"].InnerText;
Match outerMatch = defOuterRx.Match(def);
field.DisplayType = (DefType)Enum.Parse(typeof(DefType), outerMatch.Groups["type"].Value.Trim());
if (outerMatch.Groups["default"].Success)
{
field.Default = float.Parse(outerMatch.Groups["default"].Value, CultureInfo.InvariantCulture);
}
string internalName = outerMatch.Groups["name"].Value.Trim();
Match bitMatch = defBitRx.Match(internalName);
Match arrayMatch = defArrayRx.Match(internalName);
field.BitSize = -1;
field.ArrayLength = 1;
if (ParamUtil.IsBitType(field.DisplayType) && bitMatch.Success)
{
field.BitSize = int.Parse(bitMatch.Groups["size"].Value);
internalName = bitMatch.Groups["name"].Value;
}
else if (ParamUtil.IsArrayType(field.DisplayType))
{
field.ArrayLength = int.Parse(arrayMatch.Groups["length"].Value);
internalName = arrayMatch.Groups["name"].Value;
}
field.InternalName = internalName;
field.DisplayName = node.ReadStringOrDefault("DisplayName", field.InternalName);
field.InternalType = node.ReadStringOrDefault("Enum", field.DisplayType.ToString());
field.Description = node.ReadStringIfExist("Description");
field.DisplayFormat = node.ReadStringOrDefault("DisplayFormat", ParamUtil.GetDefaultFormat(field.DisplayType));
field.EditFlags = (EditFlags)Enum.Parse(typeof(EditFlags),
node.ReadStringOrDefault("EditFlags", ParamUtil.GetDefaultEditFlags(field.DisplayType).ToString()));
field.Minimum = node.ReadSingleOrDefault("Minimum", ParamUtil.GetDefaultMinimum(field.DisplayType), CultureInfo.InvariantCulture);
field.Maximum = node.ReadSingleOrDefault("Maximum", ParamUtil.GetDefaultMaximum(field.DisplayType), CultureInfo.InvariantCulture);
field.Increment = node.ReadSingleOrDefault("Increment", ParamUtil.GetDefaultIncrement(field.DisplayType), CultureInfo.InvariantCulture);
field.SortID = node.ReadInt32OrDefault("SortID", 0);
field.UnkB8 = node.ReadStringIfExist("UnkB8");
field.UnkC0 = node.ReadStringIfExist("UnkC0");
field.UnkC8 = node.ReadStringIfExist("UnkC8");
return(field);
}
private string MakeInternalName()
{
// This formatting is almost 100% accurate in DS1, less so in BB, and a complete crapshoot in DS3
// C'est la vie.
if (BitSize != -1)
{
return($"{InternalName}:{BitSize}");
}
else if (ParamUtil.IsArrayType(DisplayType))
{
return($"{InternalName}[{ArrayLength}]");
}
else
{
return(InternalName);
}
}
internal Field(XmlNode node)
{
string def = node.Attributes["Def"].InnerText;
Match outerMatch = defOuterRx.Match(def);
DisplayType = (DefType)Enum.Parse(typeof(DefType), outerMatch.Groups["type"].Value.Trim());
if (outerMatch.Groups["default"].Success)
{
Default = float.Parse(outerMatch.Groups["default"].Value, CultureInfo.InvariantCulture);
}
string internalName = outerMatch.Groups["name"].Value.Trim();
Match bitMatch = defBitRx.Match(internalName);
Match arrayMatch = defArrayRx.Match(internalName);
BitSize = -1;
ArrayLength = 1;
if (ParamUtil.IsBitType(DisplayType) && bitMatch.Success)
{
BitSize = int.Parse(bitMatch.Groups["size"].Value);
internalName = bitMatch.Groups["name"].Value;
}
else if (ParamUtil.IsArrayType(DisplayType))
{
ArrayLength = int.Parse(arrayMatch.Groups["length"].Value);
internalName = arrayMatch.Groups["name"].Value;
}
InternalName = internalName;
DisplayName = node.ReadStringOrDefault(nameof(DisplayName), InternalName);
InternalType = node.ReadStringOrDefault("Enum", DisplayType.ToString());
Description = node.ReadStringOrDefault(nameof(Description), null);
DisplayFormat = node.ReadStringOrDefault(nameof(DisplayFormat), ParamUtil.GetDefaultFormat(DisplayType));
EditFlags = (EditFlags)Enum.Parse(typeof(EditFlags),
node.ReadStringOrDefault(nameof(EditFlags), ParamUtil.GetDefaultEditFlags(DisplayType).ToString()));
Minimum = node.ReadSingleOrDefault(nameof(Minimum), ParamUtil.GetDefaultMinimum(DisplayType), CultureInfo.InvariantCulture);
Maximum = node.ReadSingleOrDefault(nameof(Maximum), ParamUtil.GetDefaultMaximum(DisplayType), CultureInfo.InvariantCulture);
Increment = node.ReadSingleOrDefault(nameof(Increment), ParamUtil.GetDefaultIncrement(DisplayType), CultureInfo.InvariantCulture);
SortID = node.ReadInt32OrDefault(nameof(SortID), 0);
}
/// <summary>
/// Calculates the size of cell data for each row.
/// </summary>
public int GetRowSize()
{
int size = 0;
for (int i = 0; i < Fields.Count; i++)
{
Field field = Fields[i];
DefType type = field.DisplayType;
if (ParamUtil.IsArrayType(type))
{
size += ParamUtil.GetValueSize(type) * field.ArrayLength;
}
else
{
size += ParamUtil.GetValueSize(type);
}
if (ParamUtil.IsBitType(type) && field.BitSize != -1)
{
int bitOffset = field.BitSize;
DefType bitType = type == DefType.dummy8 ? DefType.u8 : type;
int bitLimit = ParamUtil.GetBitLimit(bitType);
for (; i < Fields.Count - 1; i++)
{
Field nextField = Fields[i + 1];
DefType nextType = nextField.DisplayType;
if (!ParamUtil.IsBitType(nextType) || nextField.BitSize == -1 || bitOffset + nextField.BitSize > bitLimit ||
(nextType == DefType.dummy8 ? DefType.u8 : nextType) != bitType)
{
break;
}
bitOffset += nextField.BitSize;
}
}
}
return(size);
}
internal Field(BinaryReaderEx br, PARAMDEF def)
{
Parent = def;
if (def.Unicode)
{
DisplayName = br.ReadFixStrW(0x40);
}
else
{
DisplayName = br.ReadFixStr(0x40);
}
DisplayType = (DefType)Enum.Parse(typeof(DefType), br.ReadFixStr(8));
DisplayFormat = br.ReadFixStr(8);
Default = br.ReadSingle();
Minimum = br.ReadSingle();
Maximum = br.ReadSingle();
Increment = br.ReadSingle();
EditFlags = (EditFlags)br.ReadInt32();
int byteCount = br.ReadInt32();
if (!ParamUtil.IsArrayType(DisplayType) && byteCount != ParamUtil.GetValueSize(DisplayType) ||
ParamUtil.IsArrayType(DisplayType) && byteCount % ParamUtil.GetValueSize(DisplayType) != 0)
{
throw new InvalidDataException($"Unexpected byte count {byteCount} for type {DisplayType}.");
}
ArrayLength = byteCount / ParamUtil.GetValueSize(DisplayType);
long descriptionOffset;
if (def.Version >= 201)
{
descriptionOffset = br.ReadInt64();
}
else
{
descriptionOffset = br.ReadInt32();
}
InternalType = br.ReadFixStr(0x20);
BitSize = -1;
if (def.Version >= 102)
{
// A few fields in DS1 FaceGenParam have a trailing space in the name
InternalName = br.ReadFixStr(0x20).Trim();
Match match = bitSizeRx.Match(InternalName);
if (match.Success)
{
InternalName = match.Groups["name"].Value;
BitSize = int.Parse(match.Groups["size"].Value);
}
if (ParamUtil.IsArrayType(DisplayType))
{
match = arrayLengthRx.Match(InternalName);
int length = match.Success ? int.Parse(match.Groups["length"].Value) : 1;
if (length != ArrayLength)
{
throw new InvalidDataException($"Mismatched array length in {InternalName} with byte count {byteCount}.");
}
if (match.Success)
{
InternalName = match.Groups["name"].Value;
}
}
}
if (def.Version >= 104)
{
SortID = br.ReadInt32();
}
if (def.Version >= 201)
{
br.AssertPattern(0x1C, 0x00);
}
if (descriptionOffset != 0)
{
if (def.Unicode)
{
Description = br.GetUTF16(descriptionOffset);
}
else
{
Description = br.GetShiftJIS(descriptionOffset);
}
}
}
internal void Write(BinaryWriterEx bw, PARAMDEF def, int index)
{
if (def.FormatVersion >= 202)
{
bw.ReserveInt64($"DisplayNameOffset{index}");
}
else if (def.Unicode)
{
bw.WriteFixStrW(DisplayName, 0x40, (byte)(def.FormatVersion >= 104 ? 0x00 : 0x20));
}
else
{
bw.WriteFixStr(DisplayName, 0x40, (byte)(def.FormatVersion >= 104 ? 0x00 : 0x20));
}
byte padding = (byte)(def.FormatVersion >= 200 ? 0x00 : 0x20);
bw.WriteFixStr(DisplayType.ToString(), 8, padding);
bw.WriteFixStr(DisplayFormat, 8, padding);
bw.WriteSingle(Default);
bw.WriteSingle(Minimum);
bw.WriteSingle(Maximum);
bw.WriteSingle(Increment);
bw.WriteInt32((int)EditFlags);
bw.WriteInt32(ParamUtil.GetValueSize(DisplayType) * (ParamUtil.IsArrayType(DisplayType) ? ArrayLength : 1));
if (def.FormatVersion >= 200)
{
bw.ReserveInt64($"DescriptionOffset{index}");
}
else
{
bw.ReserveInt32($"DescriptionOffset{index}");
}
if (def.FormatVersion >= 202)
{
bw.ReserveInt64($"InternalTypeOffset{index}");
}
else
{
bw.WriteFixStr(InternalType, 0x20, padding);
}
if (def.FormatVersion >= 202)
{
bw.ReserveInt64($"InternalNameOffset{index}");
}
else if (def.FormatVersion >= 102)
{
bw.WriteFixStr(MakeInternalName(), 0x20, padding);
}
if (def.FormatVersion >= 104)
{
bw.WriteInt32(SortID);
}
if (def.FormatVersion >= 200)
{
bw.WriteInt32(0);
bw.ReserveInt64($"UnkB8Offset{index}");
bw.ReserveInt64($"UnkC0Offset{index}");
bw.ReserveInt64($"UnkC8Offset{index}");
}
}