PKHeX/PKHeX.Core/Editing/BattleTemplate/BattleTemplateConfig.cs

using System;
using System.Text;

namespace PKHeX.Core;

/// <summary>
/// Grammar and prefix/suffix tokens for <see cref="IBattleTemplate"/> localization.
/// </summary>
public sealed record BattleTemplateConfig
{
    public sealed record BattleTemplateTuple(BattleTemplateToken Token, string Text);

    /// <summary> Prefix tokens - e.g. Friendship: {100} </summary>
    public required BattleTemplateTuple[] Left { get; init; }

    /// <summary> Suffix tokens - e.g. {Timid} Nature </summary>
    public required BattleTemplateTuple[] Right { get; init; }

    /// <summary> Tokens that always display the same text, with no value - e.g. Shiny: Yes </summary>
    public required BattleTemplateTuple[] Center { get; init; }

    /// <summary>
    /// Stat names, ordered with speed in the middle (not last).
    /// </summary>
    public required StatDisplayConfig StatNames { get; init; }

    /// <summary>
    /// Stat names, ordered with speed in the middle (not last).
    /// </summary>
    public required StatDisplayConfig StatNamesFull { get; init; }

    public required string Male { get; init; }
    public required string Female { get; init; }

    /// <summary>
    /// Gets the stat names in the requested format.
    /// </summary>
    /// <exception cref="ArgumentOutOfRangeException"></exception>
    public StatDisplayConfig GetStatDisplay(StatDisplayStyle style = StatDisplayStyle.Abbreviated) => style switch
    {
        StatDisplayStyle.Abbreviated => StatNames,
        StatDisplayStyle.Full => StatNamesFull,
        StatDisplayStyle.HABCDS => StatDisplayConfig.HABCDS,
        StatDisplayStyle.Raw => StatDisplayConfig.Raw,
        StatDisplayStyle.Raw00 => StatDisplayConfig.Raw00,
        _ => throw new ArgumentOutOfRangeException(nameof(style), style, null),
    };

    public static ReadOnlySpan<char> GetMoveDisplay(MoveDisplayStyle style = MoveDisplayStyle.Fill) => style switch
    {
        MoveDisplayStyle.Fill => "----",
        MoveDisplayStyle.Directional => "↑→←↓",
        _ => throw new ArgumentOutOfRangeException(nameof(style), style, null),
    };

    public static bool IsMovePrefix(char c) => c is '-' or '–' or '↑' or '←' or '↓' or '→';

    public static ReadOnlySpan<BattleTemplateToken> CommunityStandard =>
    [
        BattleTemplateToken.FirstLine,
        BattleTemplateToken.Ability,
        BattleTemplateToken.Level,
        BattleTemplateToken.Shiny,
        BattleTemplateToken.Friendship,
        BattleTemplateToken.DynamaxLevel,
        BattleTemplateToken.Gigantamax,
        BattleTemplateToken.TeraType,
        BattleTemplateToken.EVs,
        BattleTemplateToken.Nature,
        BattleTemplateToken.IVs,
        BattleTemplateToken.Moves,
    ];

    public static ReadOnlySpan<BattleTemplateToken> Showdown => CommunityStandard;

    public static ReadOnlySpan<BattleTemplateToken> ShowdownNew =>
    [
        BattleTemplateToken.FirstLine,
        BattleTemplateToken.AbilityHeldItem,
        BattleTemplateToken.Moves,
        BattleTemplateToken.EVsAppendNature,
        BattleTemplateToken.IVs,
        BattleTemplateToken.Level,
        BattleTemplateToken.Shiny,
        BattleTemplateToken.Friendship,
        BattleTemplateToken.DynamaxLevel,
        BattleTemplateToken.Gigantamax,
        BattleTemplateToken.TeraType,
    ];

    public static ReadOnlySpan<BattleTemplateToken> DefaultHover =>
    [
        // First line is handled manually.
        BattleTemplateToken.HeldItem,
        BattleTemplateToken.Ability,
        BattleTemplateToken.Level,
        BattleTemplateToken.Shiny,
        BattleTemplateToken.DynamaxLevel,
        BattleTemplateToken.Gigantamax,
        BattleTemplateToken.TeraType,
        BattleTemplateToken.EVs,
        BattleTemplateToken.IVs,
        BattleTemplateToken.Nature,
        BattleTemplateToken.Moves,

        // Other tokens are handled manually (Ganbaru, Awakening) as they are not stored by the battle template interface, only entity objects.
    ];

    /// <summary>
    /// Tries to parse the line for a token and value, if applicable.
    /// </summary>
    /// <param name="line">Line to parse</param>
    /// <param name="value">Value for the token, if applicable</param>
    /// <returns>Token type that was found</returns>
    public BattleTemplateToken TryParse(ReadOnlySpan<char> line, out ReadOnlySpan<char> value)
    {
        value = default;
        if (line.Length == 0)
            return BattleTemplateToken.None;
        foreach (var tuple in Left)
        {
            if (!line.StartsWith(tuple.Text, StringComparison.OrdinalIgnoreCase))
                continue;
            value = line[tuple.Text.Length..];
            return tuple.Token;
        }
        foreach (var tuple in Right)
        {
            if (!line.EndsWith(tuple.Text, StringComparison.OrdinalIgnoreCase))
                continue;
            value = line[..^tuple.Text.Length];
            return tuple.Token;
        }
        foreach (var tuple in Center)
        {
            if (!line.Equals(tuple.Text, StringComparison.OrdinalIgnoreCase))
                continue;
            return tuple.Token;
        }
        return BattleTemplateToken.None;
    }

    private string GetToken(BattleTemplateToken token, out bool isLeft)
    {
        foreach (var tuple in Left)
        {
            if (tuple.Token != token)
                continue;
            isLeft = true;
            return tuple.Text;
        }
        foreach (var tuple in Right)
        {
            if (tuple.Token != token)
                continue;
            isLeft = false;
            return tuple.Text;
        }
        foreach (var tuple in Center)
        {
            if (tuple.Token != token)
                continue;
            isLeft = false;
            return tuple.Text;
        }
        throw new ArgumentException($"Token {token} not found in config");
    }

    /// <summary>
    /// Gets the string representation of the token. No value is combined with it.
    /// </summary>
    public string Push(BattleTemplateToken token) => GetToken(token, out _);

    /// <summary>
    /// Gets the string representation of the token, and combines the value with it.
    /// </summary>
    public string Push<T>(BattleTemplateToken token, T value)
    {
        var str = GetToken(token, out var isLeft);
        if (isLeft)
            return $"{str}{value}";
        return $"{value}{str}";
    }

    /// <inheritdoc cref="Push{T}(BattleTemplateToken,T)"/>
    public void Push<T>(BattleTemplateToken token, T value, StringBuilder sb)
    {
        var str = GetToken(token, out var isLeft);
        if (isLeft)
            sb.Append(str).Append(value);
        else
            sb.Append(value).Append(str);
    }

    /// <summary>
    /// Checks all representations of the stat name for a match.
    /// </summary>
    /// <param name="stat">Stat name</param>
    /// <returns>-1 if not found, otherwise the index of the stat</returns>
    public int GetStatIndex(ReadOnlySpan<char> stat)
    {
        var index = StatNames.GetStatIndex(stat);
        if (index != -1)
            return index;
        index = StatNamesFull.GetStatIndex(stat);
        if (index != -1)
            return index;

        foreach (var set in StatDisplayConfig.Custom)
        {
            index = set.GetStatIndex(stat);
            if (index != -1)
                return index;
        }
        return -1;
    }

    public StatParseResult TryParseStats(ReadOnlySpan<char> message, Span<int> bestResult)
    {
        var result = ParseInternal(message, bestResult);
        ReorderSpeedNotLast(bestResult);
        return result;
    }

    private StatParseResult ParseInternal(ReadOnlySpan<char> message, Span<int> bestResult)
    {
        Span<int> original = stackalloc int[bestResult.Length];
        bestResult.CopyTo(original);

        var result = StatNames.TryParse(message, bestResult);
        if (result.IsParseClean)
            return result;

        // Check if the others get a better result
        int bestCount = result.CountParsed;
        Span<int> tmp = stackalloc int[bestResult.Length];
        // Check Long Stat names
        {
            original.CopyTo(tmp); // restore original defaults
            var other = StatNamesFull.TryParse(message, tmp);
            if (other.IsParseClean)
            {
                tmp.CopyTo(bestResult);
                return other;
            }
            if (other.CountParsed > bestCount)
            {
                bestCount = other.CountParsed;
                tmp.CopyTo(bestResult);
            }
        }
        // Check custom parsers
        foreach (var set in StatDisplayConfig.Custom)
        {
            original.CopyTo(tmp); // restore original defaults
            var other = set.TryParse(message, tmp);
            if (other.IsParseClean)
            {
                tmp.CopyTo(bestResult);
                return other;
            }
            if (other.CountParsed > bestCount)
            {
                bestCount = other.CountParsed;
                tmp.CopyTo(bestResult);
            }
        }

        return result;
    }

    private static void ReorderSpeedNotLast<T>(Span<T> arr)
    {
        ArgumentOutOfRangeException.ThrowIfLessThan(arr.Length, 6);
        var speed = arr[5];
        arr[5] = arr[4];
        arr[4] = arr[3];
        arr[3] = speed;
    }
}