Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-12-18 08:23:12 +00:00
Code Issues Projects Releases Packages Wiki Activity
PKHeX/PKHeX.Core/PKM/Strings/StringConverter3.cs

175 lines
9.6 KiB
C#
Raw Normal View History

Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
using System;
using System.Text;
namespace PKHeX.Core
{
/// <summary>
/// Logic for converting a <see cref="string"/> for Generation 3.
/// </summary>
public static class StringConverter3
{
/// <summary>
/// Converts a Generation 3 encoded value array to string.
/// </summary>
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
/// <param name="data">Byte array containing string data.</param>
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
/// <param name="offset">Offset to read from</param>
/// <param name="count">Length of data to read.</param>
/// <param name="jp">Value source is Japanese font.</param>
/// <returns>Decoded string.</returns>
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
public static string GetString3(byte[] data, int offset, int count, bool jp)
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
{
Set initial capacity for stringbuilder to reduce reallocation Default capacity is 16 so it's rarely an issue, but sometimes we don't need that much. Update xmldoc for more clarity
2021-01-17 01:31:05 +00:00
var s = new StringBuilder(count);
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
for (int i = 0; i < count; i++)
{
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
var val = data[offset + i];
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
var c = GetG3Char(val, jp); // Convert to Unicode
if (c == 0xFF) // Stop if Terminator/Invalid
break;
s.Append(c);
}
Use StringConverter api consistently; use stringbuilder when possible Retain a stringbuilder to mutate the string rather than finalizing temporary strings yields some speed improvements (less gen0 string objects allocated)
2021-01-15 06:50:13 +00:00
StringConverter.SanitizeString(s);
return s.ToString();
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
/// <summary>
/// Converts a string to a Generation 3 encoded value array.
/// </summary>
/// <param name="value">Decoded string.</param>
Set initial capacity for stringbuilder to reduce reallocation Default capacity is 16 so it's rarely an issue, but sometimes we don't need that much. Update xmldoc for more clarity
2021-01-17 01:31:05 +00:00
/// <param name="maxLength">Maximum length of the input <see cref="value"/></param>
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
/// <param name="jp">String destination is Japanese font.</param>
Set initial capacity for stringbuilder to reduce reallocation Default capacity is 16 so it's rarely an issue, but sometimes we don't need that much. Update xmldoc for more clarity
2021-01-17 01:31:05 +00:00
/// <param name="padTo">Pad the input <see cref="value"/> to given length</param>
/// <param name="padWith">Pad the input <see cref="value"/> with this character value</param>
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
/// <returns></returns>
public static byte[] SetString3(string value, int maxLength, bool jp, int padTo = 0, ushort padWith = 0)
{
if (value.Length > maxLength)
value = value.Substring(0, maxLength); // Hard cap
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
var data = new byte[value.Length + 1]; // +1 for 0xFF
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
for (int i = 0; i < value.Length; i++)
{
var chr = value[i];
var val = SetG3Char(chr, jp);
if (val == 0xFF) // end
{
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
Array.Resize(ref data, i + 1);
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
break;
}
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
data[i] = val;
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
if (data.Length > 0)
data[data.Length - 1] = 0xFF;
if (data.Length > maxLength && padTo <= maxLength)
Array.Resize(ref data, maxLength);
if (data.Length < padTo)
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
{
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
var start = data.Length;
Array.Resize(ref data, padTo);
for (int i = start; i < data.Length; i++)
data[i] = (byte)padWith;
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
return data;
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
/// <summary>Converts Big Endian encoded data to decoded string.</summary>
/// <param name="data">Encoded data</param>
/// <param name="offset">Offset to read from</param>
/// <param name="count">Length of data to read.</param>
/// <returns>Decoded string.</returns>
public static string GetBEString3(byte[] data, int offset, int count)
{
Use StringConverter api consistently; use stringbuilder when possible Retain a stringbuilder to mutate the string rather than finalizing temporary strings yields some speed improvements (less gen0 string objects allocated)
2021-01-15 06:50:13 +00:00
var raw = Encoding.BigEndianUnicode.GetString(data, offset, count);
var sb = new StringBuilder(raw);
Util.TrimFromZero(sb);
return sb.ToString();
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
/// <summary>Gets the bytes for a Big Endian string.</summary>
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
/// <param name="value">Decoded string.</param>
Set initial capacity for stringbuilder to reduce reallocation Default capacity is 16 so it's rarely an issue, but sometimes we don't need that much. Update xmldoc for more clarity
2021-01-17 01:31:05 +00:00
/// <param name="maxLength">Maximum length of the input <see cref="value"/></param>
/// <param name="padTo">Pad the input <see cref="value"/> to given length</param>
/// <param name="padWith">Pad the input <see cref="value"/> with this character value</param>
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
/// <returns>Encoded data.</returns>
public static byte[] SetBEString3(string value, int maxLength, int padTo = 0, ushort padWith = 0)
{
if (value.Length > maxLength)
value = value.Substring(0, maxLength); // Hard cap
Use StringConverter api consistently; use stringbuilder when possible Retain a stringbuilder to mutate the string rather than finalizing temporary strings yields some speed improvements (less gen0 string objects allocated)
2021-01-15 06:50:13 +00:00
var sb = new StringBuilder(value);
StringConverter.SanitizeString(sb);
sb.Append('\0');
var delta = padTo - value.Length;
if (delta > 0)
sb.Append((char)padWith, delta);
var result = sb.ToString();
return Encoding.BigEndianUnicode.GetBytes(result);
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
}
/// <summary>
/// Decodes a character from a Generation 3 encoded value.
/// </summary>
/// <param name="chr">Generation 4 decoded character.</param>
/// <param name="jp">Character destination is Japanese font.</param>
/// <returns>Generation 3 encoded value.</returns>
private static char GetG3Char(byte chr, bool jp)
{
var table = jp ? G3_JP : G3_EN;
if (chr >= table.Length)
return (char)0xFF;
return table[chr];
}
/// <summary>
/// Encodes a character to a Generation 3 encoded value.
/// </summary>
/// <param name="chr">Generation 4 decoded character.</param>
/// <param name="jp">Character destination is Japanese font.</param>
/// <returns>Generation 3 encoded value.</returns>
private static byte SetG3Char(char chr, bool jp)
{
Handle ’ ' edge case #2412
2019-11-17 00:21:17 +00:00
if (chr == '\'') // ’
return 0xB4;
Split StringConverter into smaller pieces reduces loading time (don't have to allocate conversion arrays when launching a gen7 game), and separates things to easier to manage locations reworks gen3 string encode/decode, no longer does 3->4->5 and 5->4->3; instead goes straight to the end result without an intermediary format. String sanitization should probably be broken up rather than reused, oh well.
2019-03-21 04:50:44 +00:00
var table = jp ? G3_JP : G3_EN;
var index = Array.IndexOf(table, chr);
return (byte)(index > -1 ? index : 0xFF);
}
private static readonly char[] 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', '0', // E
':', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', // F
};
private static readonly char[] G3_JP =
{
'　', 'あ', 'い', 'う', 'え', 'お', 'か', 'き', 'く', 'け', 'こ', 'さ', 'し', 'す', 'せ', 'そ', // 0
'た', 'ち', 'つ', 'て', 'と', 'な', 'に', 'ぬ', 'ね', 'の', 'は', 'ひ', 'ふ', 'へ', 'ほ', 'ま', // 1
'み', 'む', 'め', 'も', 'や', 'ゆ', 'よ', 'ら', 'り', 'る', 'れ', 'ろ', 'わ', 'を', 'ん', 'ぁ', // 2
'ぃ', 'ぅ', 'ぇ', 'ぉ', 'ゃ', 'ゅ', 'ょ', 'が', 'ぎ', 'ぐ', 'げ', 'ご', 'ざ', 'じ', 'ず', 'ぜ', // 3
'ぞ', 'だ', 'ぢ', 'づ', 'で', 'ど', 'ば', 'び', 'ぶ', 'べ', 'ぼ', 'ぱ', 'ぴ', 'ぷ', 'ぺ', 'ぽ', // 4
'っ', 'ア', 'イ', 'ウ', 'エ', 'オ', 'カ', 'キ', 'ク', 'ケ', 'コ', 'サ', 'シ', 'ス', 'セ', 'ソ', // 5
'タ', 'チ', 'ツ', 'テ', 'ト', 'ナ', 'ニ', 'ヌ', 'ネ', 'ノ', 'ハ', 'ヒ', 'フ', 'ヘ', 'ホ', 'マ', // 6
'ミ', 'ム', 'メ', 'モ', 'ヤ', 'ユ', 'ヨ', 'ラ', 'リ', 'ル', 'レ', 'ロ', 'ワ', 'ヲ', 'ン', 'ァ', // 7
'ィ', 'ゥ', 'ェ', 'ォ', 'ャ', 'ュ', 'ョ', 'ガ', 'ギ', 'グ', 'ゲ', 'ゴ', 'ザ', 'ジ', 'ズ', 'ゼ', // 8
'ゾ', 'ダ', 'ヂ', 'ヅ', 'デ', 'ド', 'バ', 'ビ', 'ブ', 'ベ', 'ボ', 'パ', 'ピ', 'プ', 'ペ', 'ポ', // 9
'ッ', '０', '１', '２', '３', '４', '５', '６', '７', '８', '９', '！', '？', '。', 'ー', '・', // A
'⋯', '『', '』', '「', '」', '♂', '♀', '$', '.', '⑧', '/', 'Ａ', 'Ｂ', 'Ｃ', 'Ｄ', 'Ｅ', // B
'Ｆ', 'Ｇ', 'Ｈ', 'Ｉ', 'Ｊ', 'Ｋ', 'Ｌ', 'Ｍ', 'Ｎ', 'Ｏ', 'Ｐ', 'Ｑ', 'Ｒ', 'Ｓ', 'Ｔ', 'Ｕ', // C
'Ｖ', 'Ｗ', 'Ｘ', 'Ｙ', 'Ｚ', 'ａ', 'ｂ', 'ｃ', 'ｄ', 'ｅ', 'ｆ', 'ｇ', 'ｈ', 'ｉ', 'ｊ', 'ｋ', // D
'ｌ', 'ｍ', 'ｎ', 'ｏ', 'ｐ', 'ｑ', 'ｒ', 'ｓ', 'ｔ', 'ｕ', 'ｖ', 'ｗ', 'ｘ', 'ｙ', 'ｚ', '0', // E
':', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', // F
};
}
}
Reference in a new issue Copy permalink