PKHeX/PKHeX.Core/Saves/Substructures/Gen7/QR7.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

100 lines
3.8 KiB
C#

using System;
using System.Collections.Generic;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
// anatomy of a QR7:
// u32 magic; // POKE
// u32 _0xFF;
// u32 box;
// u32 slot;
// u32 num_copies;
// u8 reserved[0x1C];
// u8 ek7[0x104];
// u8 dex_data[0x60];
// u16 crc16
// sizeof(QR7) == 0x1A2
/// <summary>
/// Generation 7 QR format (readable by the in-game QR Scanner feature)
/// </summary>
public static class QR7
{
private static readonly HashSet<int> GenderDifferences = new()
{
003, 012, 019, 020, 025, 026, 041, 042, 044, 045,
064, 065, 084, 085, 097, 111, 112, 118, 119, 123,
129, 130, 154, 165, 166, 178, 185, 186, 190, 194,
195, 198, 202, 203, 207, 208, 212, 214, 215, 217,
221, 224, 229, 232, 255, 256, 257, 267, 269, 272,
274, 275, 307, 308, 315, 316, 317, 322, 323, 332,
350, 369, 396, 397, 398, 399, 400, 401, 402, 403,
404, 405, 407, 415, 417, 418, 419, 424, 443, 444,
445, 449, 450, 453, 454, 456, 457, 459, 460, 461,
464, 465, 473, 521, 592, 593, 668, 678,
};
private static readonly byte[] BaseQR =
{
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xD2, 0x02, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
};
private static byte[] GetRawQR(int species, int form, bool shiny, int gender)
{
var basedata = (byte[])BaseQR.Clone();
WriteUInt16LittleEndian(basedata.AsSpan(0x28), (ushort)species);
var pi = PersonalTable.USUM.GetFormEntry(species, form);
bool biGender = false;
if (pi.OnlyMale)
gender = 0;
else if (pi.OnlyFemale)
gender = 1;
else if (pi.Genderless)
gender = 2;
else
biGender = !GenderDifferences.Contains(species);
basedata[0x2A] = (byte)form;
basedata[0x2B] = (byte)gender;
basedata[0x2C] = shiny ? (byte)1 : (byte)0;
basedata[0x2D] = biGender ? (byte)1 : (byte)0;
return basedata;
}
public static byte[] GenerateQRData(PK7 pk7, int box = 0, int slot = 0, int num_copies = 1)
{
if (box > 31)
box = 31;
if (slot > 29)
slot = 29;
if (box < 0)
box = 0;
if (slot < 0)
slot = 0;
if (num_copies < 0)
num_copies = 1;
byte[] data = new byte[0x1A2];
var span = data.AsSpan();
WriteUInt32LittleEndian(span, 0x454B4F50); // POKE magic
data[0x4] = 0xFF; // QR Type
WriteInt32LittleEndian(span[0x08..], box);
WriteInt32LittleEndian(span[0x0C..], slot);
WriteInt32LittleEndian(span[0x10..], num_copies); // No need to check max num_copies, payload parser handles it on-console.
pk7.EncryptedPartyData.CopyTo(span[0x30..]); // Copy in pokemon data
GetRawQR(pk7.Species, pk7.Form, pk7.IsShiny, pk7.Gender).CopyTo(span[0x140..]);
var chk = Checksums.CRC16Invert(span[..0x1A0]);
WriteUInt16LittleEndian(span[0x1A0..], chk);
return data;
}
}
}