using System; namespace PKHeX.Core; /// /// Logic for converting a for Generation 3. /// public static class StringConverter3 { public const byte TerminatorByte = 0xFF; private const char Terminator = (char)TerminatorByte; private const char Apostrophe = '\''; // ’ private const byte ApostropheByte = 0xB4; private const byte QuoteLeftByte = 0xB1; private const byte QuoteRightByte = 0xB2; /// /// Converts a Generation 3 encoded value array to string. /// /// Byte array containing string data. /// Language specific conversion /// Decoded string. public static string GetString(ReadOnlySpan data, int language) { Span result = stackalloc char[data.Length]; int i = LoadString(data, result, language); return new string(result[..i]); } /// /// Byte array containing string data. /// Value source is Japanese font. public static string GetString(ReadOnlySpan data, bool jp) => GetString(data, jp ? (int)LanguageID.Japanese : (int)LanguageID.English); /// /// Converts a Generation 3 encoded value array to string. /// /// Encoded data /// Decoded character result buffer /// Language specific conversion /// Character count loaded. public static int LoadString(ReadOnlySpan data, Span result, int language) { var table = (language == (int)LanguageID.Japanese) ? G3_JP : G3_EN; int i = 0; for (; i < data.Length; i++) { var value = data[i]; var c = value switch { QuoteLeftByte => GetQuoteLeft(language), QuoteRightByte => GetQuoteRight(language), _ => table[value], }; // Convert to Unicode if (c == Terminator) // Stop if Terminator/Invalid break; c = StringConverter.SanitizeChar(c); result[i] = c; } return i; } /// /// Encoded data /// Decoded character result buffer /// Value source is Japanese font. public static int LoadString(ReadOnlySpan data, Span result, bool jp) => LoadString(data, result, jp ? (int)LanguageID.Japanese : (int)LanguageID.English); /// /// Converts a string to a Generation 3 encoded value array. /// /// /// Decoded string. /// Maximum length of the input /// Language specific conversion /// Buffer pre-formatting option /// Encoded data. public static int SetString(Span buffer, ReadOnlySpan value, int maxLength, int language, StringConverterOption option = StringConverterOption.ClearFF) { if (value.Length > maxLength) value = value[..maxLength]; // Hard cap if (option is StringConverterOption.ClearFF) buffer.Fill(TerminatorByte); else if (option is StringConverterOption.ClearZero) buffer.Clear(); var table = (language == (int)LanguageID.Japanese) ? G3_JP : G3_EN; int i = 0; for (; i < value.Length; i++) { var c = StringConverter.UnSanitizeChar5(value[i]); if (!TryGetIndex(table, c, language, out var b)) break; buffer[i] = b; } int count = i; if (count < buffer.Length) buffer[count++] = TerminatorByte; return count; } public static int SetString(Span buffer, ReadOnlySpan value, int maxLength, bool jp, StringConverterOption option = StringConverterOption.ClearFF) => SetString(buffer, value, maxLength, jp ? (int)LanguageID.Japanese : (int)LanguageID.English, option); private static bool TryGetIndex(in ReadOnlySpan dict, char c, int language, out byte result) { var index = dict.IndexOf(c); if (index == -1 || c == '“') return TryGetUserFriendlyRemap(c, language, out result); result = (byte)index; return index != TerminatorByte; } /// /// Decodes a character from a Generation 3 encoded value. /// /// Generation 4 decoded character. /// Language specific conversion /// Generation 3 encoded value. public static char GetG3Char(byte chr, int language) { var table = (language == (int)LanguageID.Japanese) ? G3_JP : G3_EN; return chr switch { QuoteLeftByte => GetQuoteLeft(language), QuoteRightByte => GetQuoteRight(language), _ => table[chr], }; } /// /// Encodes a character to a Generation 3 encoded value. /// /// Generation 4 decoded character. /// Language specific conversion /// Generation 3 encoded value. public static byte SetG3Char(char chr, int language) { var table = (language == (int)LanguageID.Japanese) ? G3_JP : G3_EN; TryGetIndex(table, chr, language, out var b); return b; } // Quotation marks are displayed differently based on the Gen3 game language. // Pal Park converts these to the appropriate ones based on the PKM language. private static char GetQuoteLeft(int language) => language switch { (int)LanguageID.English or (int)LanguageID.Italian or (int)LanguageID.Spanish => '“', (int)LanguageID.French => '«', (int)LanguageID.German => '„', _ => '『', // Invalid languages use JP quote }; private static char GetQuoteRight(int language) => language switch { (int)LanguageID.English or (int)LanguageID.Italian or (int)LanguageID.Spanish => '”', (int)LanguageID.French => '»', (int)LanguageID.German => '“', _ => '』', // Invalid languages use JP quote }; /// /// Tries to remap the user input to a valid character. /// private static bool TryGetUserFriendlyRemap(char c, int language, out byte result) { result = c switch { Apostrophe => ApostropheByte, '“' => language != (int)LanguageID.German ? QuoteLeftByte : QuoteRightByte, '”' => QuoteRightByte, '«' => QuoteLeftByte, '»' => QuoteRightByte, '„' => QuoteLeftByte, '『' => QuoteLeftByte, '』' => QuoteRightByte, _ => TerminatorByte, }; return result != TerminatorByte; } private static ReadOnlySpan G3_EN => [ ' ', 'À', 'Á', 'Â', 'Ç', 'È', 'É', 'Ê', 'Ë', 'Ì', 'こ', 'Î', 'Ï', 'Ò', 'Ó', 'Ô', // 0 'Œ', 'Ù', 'Ú', 'Û', 'Ñ', 'ß', 'à', 'á', 'ね', 'Ç', 'È', 'é', 'ê', 'ë', 'ì', 'í', // 1 'î', 'ï', 'ò', 'ó', 'ô', 'œ', 'ù', 'ú', 'û', 'ñ', 'º', 'ª', '⒅', '&', '+', 'あ', // 2 'ぃ', 'ぅ', 'ぇ', 'ぉ', 'ゃ', '=', 'ょ', 'が', 'ぎ', 'ぐ', 'げ', 'ご', 'ざ', 'じ', 'ず', 'ぜ', // 3 'ぞ', 'だ', 'ぢ', 'づ', 'で', 'ど', 'ば', 'び', 'ぶ', 'べ', 'ぼ', 'ぱ', 'ぴ', 'ぷ', 'ぺ', 'ぽ', // 4 'っ', '¿', '¡', '⒆', '⒇', 'オ', 'カ', 'キ', 'ク', 'ケ', 'Í', 'コ', 'サ', 'ス', 'セ', 'ソ', // 5 'タ', 'チ', 'ツ', 'テ', 'ト', 'ナ', 'ニ', 'ヌ', 'â', 'ノ', 'ハ', 'ヒ', 'フ', 'ヘ', 'ホ', 'í', // 6 'ミ', 'ム', 'メ', 'モ', 'ヤ', 'ユ', 'ヨ', 'ラ', 'リ', 'ル', 'レ', 'ロ', 'ワ', 'ヲ', 'ン', 'ァ', // 7 'ィ', 'ゥ', 'ェ', 'ォ', 'ャ', 'ュ', 'ョ', 'ガ', 'ギ', 'グ', 'ゲ', 'ゴ', 'ザ', 'ジ', 'ズ', 'ゼ', // 8 'ゾ', 'ダ', 'ヂ', 'ヅ', 'デ', 'ド', 'バ', 'ビ', 'ブ', 'ベ', 'ボ', 'パ', 'ピ', 'プ', 'ペ', 'ポ', // 9 'ッ', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '!', '?', '.', '-', '・',// A '⑬', '“', '”', '‘', '’', '⑭', '⑮', '$', ',', '⑧', '/', 'A', 'B', 'C', 'D', 'E', // B 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', // C 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', // D 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '►', // E ':', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', // F // Make the total length 256 so that any byte access is always within the array Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, ]; private static ReadOnlySpan G3_JP => [ ' ', 'あ', 'い', 'う', 'え', 'お', 'か', 'き', 'く', 'け', 'こ', 'さ', 'し', 'す', 'せ', 'そ', // 0 'た', 'ち', 'つ', 'て', 'と', 'な', 'に', 'ぬ', 'ね', 'の', 'は', 'ひ', 'ふ', 'へ', 'ほ', 'ま', // 1 'み', 'む', 'め', 'も', 'や', 'ゆ', 'よ', 'ら', 'り', 'る', 'れ', 'ろ', 'わ', 'を', 'ん', 'ぁ', // 2 'ぃ', 'ぅ', 'ぇ', 'ぉ', 'ゃ', 'ゅ', 'ょ', 'が', 'ぎ', 'ぐ', 'げ', 'ご', 'ざ', 'じ', 'ず', 'ぜ', // 3 'ぞ', 'だ', 'ぢ', 'づ', 'で', 'ど', 'ば', 'び', 'ぶ', 'べ', 'ぼ', 'ぱ', 'ぴ', 'ぷ', 'ぺ', 'ぽ', // 4 'っ', 'ア', 'イ', 'ウ', 'エ', 'オ', 'カ', 'キ', 'ク', 'ケ', 'コ', 'サ', 'シ', 'ス', 'セ', 'ソ', // 5 'タ', 'チ', 'ツ', 'テ', 'ト', 'ナ', 'ニ', 'ヌ', 'ネ', 'ノ', 'ハ', 'ヒ', 'フ', 'ヘ', 'ホ', 'マ', // 6 'ミ', 'ム', 'メ', 'モ', 'ヤ', 'ユ', 'ヨ', 'ラ', 'リ', 'ル', 'レ', 'ロ', 'ワ', 'ヲ', 'ン', 'ァ', // 7 'ィ', 'ゥ', 'ェ', 'ォ', 'ャ', 'ュ', 'ョ', 'ガ', 'ギ', 'グ', 'ゲ', 'ゴ', 'ザ', 'ジ', 'ズ', 'ゼ', // 8 'ゾ', 'ダ', 'ヂ', 'ヅ', 'デ', 'ド', 'バ', 'ビ', 'ブ', 'ベ', 'ボ', 'パ', 'ピ', 'プ', 'ペ', 'ポ', // 9 'ッ', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '!', '?', '。', 'ー', '・', // A '…', '『', '』', '「', '」', '♂', '♀', '円', '.', '×', '/', 'A', 'B', 'C', 'D', 'E', // B 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', // C 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', // D 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '►', // E ':', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', // F // Make the total length 256 so that any byte access is always within the array Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, Terminator, ]; }