PKHeX/PKHeX.Core/Util/FlagUtil.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

37 lines
1.4 KiB
C#

using System;
namespace PKHeX.Core
{
/// <summary>
/// Utility logic for dealing with bitflags in a byte array.
/// </summary>
public static class FlagUtil
{
/// <summary>
/// Gets the requested <see cref="bitIndex"/> from the byte at <see cref="offset"/>.
/// </summary>
/// <param name="arr">Buffer to read</param>
/// <param name="offset">Offset of the byte</param>
/// <param name="bitIndex">Bit to read</param>
public static bool GetFlag(ReadOnlySpan<byte> arr, int offset, int bitIndex)
{
bitIndex &= 7; // ensure bit access is 0-7
return (arr[offset] >> bitIndex & 1) != 0;
}
/// <summary>
/// Sets the requested <see cref="bitIndex"/> value to the byte at <see cref="offset"/>.
/// </summary>
/// <param name="arr">Buffer to modify</param>
/// <param name="offset">Offset of the byte</param>
/// <param name="bitIndex">Bit to write</param>
/// <param name="value">Bit flag value to set</param>
public static void SetFlag(Span<byte> arr, int offset, int bitIndex, bool value)
{
bitIndex &= 7; // ensure bit access is 0-7
var current = arr[offset] & ~(1 << bitIndex);
var newValue = current | ((value ? 1 : 0) << bitIndex);
arr[offset] = (byte)newValue;
}
}
}