Files
SabreTools/SabreTools.DatItems/Formats/DataArea.cs

152 lines
4.7 KiB
C#
Raw Normal View History

using System.Xml.Serialization;
2020-09-04 14:10:35 -07:00
using Newtonsoft.Json;
2022-11-03 12:22:17 -07:00
using SabreTools.Core;
using SabreTools.Core.Tools;
2024-03-05 01:42:42 -05:00
using SabreTools.Filter;
2020-09-04 14:10:35 -07:00
2021-02-02 10:23:43 -08:00
namespace SabreTools.DatItems.Formats
2020-09-04 14:10:35 -07:00
{
/// <summary>
/// SoftwareList dataarea information
/// </summary>
/// <remarks>One DataArea can contain multiple Rom items</remarks>
2020-09-08 10:12:41 -07:00
[JsonObject("dataarea"), XmlRoot("dataarea")]
2020-09-04 14:10:35 -07:00
public class DataArea : DatItem
{
#region Fields
/// <summary>
/// Name of the item
/// </summary>
2022-11-03 12:22:17 -07:00
[JsonProperty("name", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("name")]
public string? Name
{
2023-09-04 23:51:37 -04:00
get => _internal.ReadString(Models.Metadata.DataArea.NameKey);
set => _internal[Models.Metadata.DataArea.NameKey] = value;
}
2020-09-04 14:10:35 -07:00
/// <summary>
/// Total size of the area
/// </summary>
2022-11-03 12:22:17 -07:00
[JsonProperty("size", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("size")]
public long? Size
{
2023-09-04 23:51:37 -04:00
get => _internal.ReadLong(Models.Metadata.DataArea.SizeKey);
set => _internal[Models.Metadata.DataArea.SizeKey] = value;
}
2020-09-04 14:10:35 -07:00
2020-09-07 22:00:02 -07:00
[JsonIgnore]
public bool SizeSpecified { get { return Size != null; } }
2020-09-04 14:10:35 -07:00
/// <summary>
/// Word width for the area
/// </summary>
2022-11-03 12:22:17 -07:00
[JsonProperty("width", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("width")]
public long? Width
{
2023-09-04 23:51:37 -04:00
get => _internal.ReadLong(Models.Metadata.DataArea.WidthKey);
set => _internal[Models.Metadata.DataArea.WidthKey] = value;
}
2020-09-04 14:10:35 -07:00
2020-09-07 22:00:02 -07:00
[JsonIgnore]
public bool WidthSpecified { get { return Width != null; } }
2020-09-04 14:10:35 -07:00
/// <summary>
/// Byte endianness of the area
/// </summary>
2022-11-03 12:22:17 -07:00
[JsonProperty("endianness", DefaultValueHandling = DefaultValueHandling.Ignore), XmlElement("endianness")]
public Endianness Endianness
{
2024-03-05 15:24:11 -05:00
get => _internal.ReadString(Models.Metadata.DataArea.WidthKey).AsEnumValue<Endianness>();
set => _internal[Models.Metadata.DataArea.WidthKey] = value.AsStringValue<Endianness>();
}
2020-09-04 14:10:35 -07:00
2020-09-07 22:00:02 -07:00
[JsonIgnore]
public bool EndiannessSpecified { get { return Endianness != Endianness.NULL; } }
2020-09-04 14:10:35 -07:00
#endregion
#region Accessors
/// <inheritdoc/>
public override string? GetName() => Name;
2020-09-04 14:10:35 -07:00
/// <inheritdoc/>
public override void SetName(string? name) => Name = name;
2020-09-04 14:10:35 -07:00
#endregion
#region Constructors
/// <summary>
/// Create a default, empty DataArea object
/// </summary>
public DataArea()
{
2023-09-04 23:51:37 -04:00
_internal = new Models.Metadata.DataArea();
2023-08-15 01:38:01 -04:00
Machine = new Machine();
2020-09-04 14:10:35 -07:00
Name = string.Empty;
ItemType = ItemType.DataArea;
}
#endregion
#region Cloning Methods
2022-11-03 12:22:17 -07:00
/// <inheritdoc/>
2020-09-04 14:10:35 -07:00
public override object Clone()
{
return new DataArea()
{
ItemType = this.ItemType,
DupeType = this.DupeType,
2023-08-15 01:38:01 -04:00
Machine = this.Machine.Clone() as Machine ?? new Machine(),
Source = this.Source?.Clone() as Source,
2020-09-04 14:10:35 -07:00
Remove = this.Remove,
2024-02-28 19:19:50 -05:00
_internal = this._internal?.Clone() as Models.Metadata.DataArea ?? [],
2020-09-04 14:10:35 -07:00
};
}
#endregion
2024-03-05 01:42:42 -05:00
#region Manipulation
/// <inheritdoc/>
public override bool RemoveField(DatItemField datItemField)
{
// Get the correct internal field name
string? fieldName = datItemField switch
{
DatItemField.AreaEndianness => Models.Metadata.DataArea.EndiannessKey,
DatItemField.AreaSize => Models.Metadata.DataArea.SizeKey,
DatItemField.AreaWidth => Models.Metadata.DataArea.WidthKey,
_ => null,
};
// Remove the field and return
return FieldManipulator.RemoveField(_internal, fieldName);
}
2024-03-05 02:20:12 -05:00
/// <inheritdoc/>
public override bool SetField(DatItemField datItemField, string value)
{
// Get the correct internal field name
string? fieldName = datItemField switch
{
DatItemField.AreaEndianness => Models.Metadata.DataArea.EndiannessKey,
DatItemField.AreaSize => Models.Metadata.DataArea.SizeKey,
DatItemField.AreaWidth => Models.Metadata.DataArea.WidthKey,
_ => null,
};
// Set the field and return
return FieldManipulator.SetField(_internal, fieldName, value);
}
2024-03-05 01:42:42 -05:00
#endregion
2020-09-04 14:10:35 -07:00
}
}