PKHeX/PKHeX.Core/Saves/Substructures/Gen6/RecordBlock6.cs
Kurt 47071b41f3
Refactoring: Span-based value writes and method signatures (#3361)
Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to.

`System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API.

The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder.

Other Fixes included:
- The Super Training UI for Gen6 has been reworked according to the latest block structure additions.
- Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list).
- Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-02 21:35:59 -08:00

85 lines
2.4 KiB
C#

using System;
using System.Collections.Generic;
using System.Diagnostics;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class RecordBlock6 : RecordBlock
{
public const int RecordCount = 200;
protected override IReadOnlyList<byte> RecordMax { get; }
// Structure:
// uint[100];
// ushort[100];
public RecordBlock6(SAV6XY sav, int offset) : base(sav)
{
Offset = offset;
RecordMax = Records.MaxType_XY;
}
public RecordBlock6(SAV6AO sav, int offset) : base(sav)
{
Offset = offset;
RecordMax = Records.MaxType_AO;
}
public RecordBlock6(SAV6AODemo sav, int offset) : base(sav)
{
Offset = offset;
RecordMax = Records.MaxType_AO;
}
public RecordBlock6(SAV7SM sav, int offset) : base(sav)
{
Offset = offset;
RecordMax = Records.MaxType_SM;
}
public RecordBlock6(SAV7USUM sav, int offset) : base(sav)
{
Offset = offset;
RecordMax = Records.MaxType_USUM;
}
public override int GetRecord(int recordID)
{
int ofs = Records.GetOffset(Offset, recordID);
switch (recordID)
{
case < 100:
return ReadInt32LittleEndian(Data.AsSpan(ofs));
case < 200:
return ReadInt16LittleEndian(Data.AsSpan(ofs));
default:
Trace.Fail(nameof(recordID));
return 0;
}
}
public override void SetRecord(int recordID, int value)
{
if ((uint)recordID >= RecordCount)
throw new ArgumentOutOfRangeException(nameof(recordID));
int ofs = GetRecordOffset(recordID);
int max = GetRecordMax(recordID);
if (value > max)
value = max;
switch (recordID)
{
case < 100:
WriteInt32LittleEndian(Data.AsSpan(ofs), value);
break;
case < 200:
WriteUInt16LittleEndian(Data.AsSpan(ofs), (ushort)value);
break;
default:
Trace.Fail(nameof(recordID));
break;
}
}
}
}