PKHeX/PKHeX.Core/Saves/SAV_BEEF.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

50 lines
1.8 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
/// <summary>
/// Footer checksum block layout <see cref="SaveFile"/>, marked with "BEEF" magic number.
/// </summary>
/// <remarks>Shared logic is used by Gen6 and Gen7 save files.</remarks>
public abstract class SAV_BEEF : SaveFile, ISecureValueStorage
{
protected SAV_BEEF(byte[] data, int biOffset) : base(data)
{
BlockInfoOffset = biOffset;
}
protected SAV_BEEF(int size, int biOffset) : base(size)
{
BlockInfoOffset = biOffset;
}
public abstract IReadOnlyList<BlockInfo> AllBlocks { get; }
protected override void SetChecksums() => AllBlocks.SetChecksums(Data);
public override bool ChecksumsValid => AllBlocks.GetChecksumsValid(Data);
public override string ChecksumInfo => AllBlocks.GetChecksumInfo(Data);
public override string MiscSaveInfo() => string.Join(Environment.NewLine, AllBlocks.Select(b => b.Summary));
protected readonly int BlockInfoOffset;
/// <summary>
/// Timestamp that the save file was last saved at (Secure Value)
/// </summary>
public ulong TimeStampCurrent
{
get => ReadUInt64LittleEndian(Data.AsSpan(BlockInfoOffset));
set => WriteUInt64LittleEndian(Data.AsSpan(BlockInfoOffset), value);
}
/// <summary>
/// Timestamp that the save file was saved at prior to the <see cref="TimeStampCurrent"/> (Secure Value)
/// </summary>
public ulong TimeStampPrevious
{
get => ReadUInt64LittleEndian(Data.AsSpan(BlockInfoOffset));
set => WriteUInt64LittleEndian(Data.AsSpan(BlockInfoOffset), value);
}
}
}