PKHeX/PKHeX.Core/PKM/Strings/StringConverter7.cs
Kurt 08ed482555 Revise gender symbol remapping
Handles Nidoran's shenanigans as well as more clear method names
- Add normalization for PK7->PK8 (no more 0xE... usage for the gender symbols... maybe more chars?)
- Not sure if Gen3 gamecube encoding needs sanitizing. Who is transferring Nidoran to CXD? :)

Requires some silly usage of Language passing as arguments. Future improvements can be made to revise the half/full encoding determination when setting a string. Probably has issues since we're just doing a naive check without considering nicknames w/ special chars.

Closes #4174
2024-05-12 10:47:55 -05:00

79 lines
3.2 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core;
/// <summary>
/// Logic for converting a <see cref="string"/> for Generation 7 games.
/// </summary>
/// <remarks>Customized Unicode glyph remapping for visual display. Chinese Species names use a special range of characters -- <see cref="StringConverter7ZH"/>.</remarks>
public static class StringConverter7
{
private const ushort TerminatorNull = 0;
/// <summary>Converts Generation 7 encoded data to decoded string.</summary>
/// <param name="data">Encoded data</param>
/// <returns>Decoded string.</returns>
public static string GetString(ReadOnlySpan<byte> data)
{
Span<char> result = stackalloc char[data.Length];
int length = LoadString(data, result);
return new string(result[..length]);
}
/// <inheritdoc cref="GetString(ReadOnlySpan{byte})"/>
/// <param name="data">Encoded data</param>
/// <param name="result">Decoded character result buffer</param>
/// <returns>Character count loaded.</returns>
public static int LoadString(ReadOnlySpan<byte> data, Span<char> result)
{
int i = 0;
int ctr = 0;
for (; i < data.Length; i += 2)
{
var value = (char)ReadUInt16LittleEndian(data[i..]);
if (value == TerminatorNull)
break;
result[ctr++] = StringConverter7ZH.IsPrivateChar(value)
? StringConverter7ZH.GetUnicodeChar(value)
: StringConverter.NormalizeGenderSymbol(value);
}
return ctr;
}
/// <summary>Gets the bytes for a Generation 7 string.</summary>
/// <param name="destBuffer">Span of bytes to write encoded string data</param>
/// <param name="value">Decoded string.</param>
/// <param name="maxLength">Maximum length of the input <see cref="value"/></param>
/// <param name="language">Language specific conversion</param>
/// <param name="option">Buffer pre-formatting option</param>
/// <param name="chinese">Chinese string remapping should be attempted (only Pokémon names, without Nickname flag set)</param>
/// <returns>Encoded data.</returns>
public static int SetString(Span<byte> destBuffer, ReadOnlySpan<char> value, int maxLength, int language,
StringConverterOption option = StringConverterOption.ClearZero, bool chinese = false)
{
if (value.Length > maxLength)
value = value[..maxLength]; // Hard cap
if (option is StringConverterOption.ClearZero)
destBuffer.Clear();
bool isHalfWidth = language == (int)LanguageID.Korean || !StringConverter.GetIsFullWidthString(value);
for (int i = 0; i < value.Length; i++)
{
var chr = value[i];
if (isHalfWidth)
chr = StringConverter.UnNormalizeGenderSymbol(chr);
if (chinese)
chr = StringConverter7ZH.GetPrivateChar(chr, language == (int)LanguageID.ChineseT);
WriteUInt16LittleEndian(destBuffer[(i * 2)..], chr);
}
int count = value.Length * 2;
if (count == destBuffer.Length)
return count;
WriteUInt16LittleEndian(destBuffer[count..], TerminatorNull);
return count + 2;
}
}