PKHeX/PKHeX.Core/Legality/Verifiers/FormArgumentVerifier.cs

using System;
using System.Diagnostics.CodeAnalysis;
using static PKHeX.Core.LegalityCheckResultCode;
using static PKHeX.Core.Species;

namespace PKHeX.Core;

public sealed class FormArgumentVerifier : Verifier
{
    protected override CheckIdentifier Identifier => CheckIdentifier.Form;

    public override void Verify(LegalityAnalysis data)
    {
        var pk = data.Entity;
        if (pk is not IFormArgument f)
            return;

        var result = VerifyFormArgument(data, f);
        data.AddLine(result);
    }

    private CheckResult VerifyFormArgument(LegalityAnalysis data, IFormArgument f)
    {
        var pk = data.Entity;
        var enc = data.EncounterMatch;
        var arg = f.FormArgument;

        var unusedMask = pk.Format == 6 ? 0xFFFF_FF00 : 0xFF00_0000;
        if ((arg & unusedMask) != 0)
            return GetInvalid(FormArgumentLEQ_0);

        return (Species)pk.Species switch
        {
            // Transfer Edge Cases -- Bank wipes the form but keeps old FormArgument value.
            Furfrou when pk is { Context: EntityContext.Gen7, Form: 0 } &&
                                 ((enc.Generation == 6 && f.FormArgument <= byte.MaxValue) || IsFormArgumentDayCounterValid(f, 5, true))
                => GetValid(FormArgumentValid),

            Furfrou when pk.Form != 0 => !IsFormArgumentDayCounterValid(f, 5, true) ? GetInvalid(FormArgumentInvalid) : GetValid(FormArgumentValid),
            Hoopa when pk.Form == 1 => data.Info.EvoChainsAllGens switch
            {
                { HasVisitedZA:   true } when arg == 0 => GetValid(FormArgumentValid), // Value not applied on form change, and reset when reverted.
                { HasVisitedGen9: true } when arg == 0 => GetValid(FormArgumentValid), // Value not applied on form change, and reset when reverted.
                { HasVisitedGen6: true } when IsFormArgumentDayCounterValid(f, 3) => GetValid(FormArgumentValid), // 0-3 via OR/AS
                { HasVisitedGen7: true } when IsFormArgumentDayCounterValid(f, 3) && f.FormArgumentRemain != 0 => GetValid(FormArgumentValid), // 1-3 via Gen7
                _ => GetInvalid(FormArgumentInvalid),
            },
            Yamask when pk.Form == 1 => arg switch
            {
                not 0 when pk.IsEgg => GetInvalid(FormArgumentNotAllowed),
                > 9_999 => GetInvalid(FormArgumentLEQ_0, 9999),
                _ => GetValid(FormArgumentValid),
            },
            Basculin when pk.Form is 2 => arg switch
            {
                not 0 when pk.IsEgg => GetInvalid(FormArgumentNotAllowed),
                > 9_999 => GetInvalid(FormArgumentLEQ_0, 9999),
                _ => GetValid(FormArgumentValid),
            },
            Farfetchd when pk.Form is 1 => CheckFarfetchd(data, pk, arg), // Galar
            Sirfetchd => CheckSirfetchd(data, arg, enc),
            Qwilfish when pk.Form is 1 => CheckQwilfish(data, pk, arg),
            Overqwil => CheckOverqwil(data, pk, arg, enc),
            Stantler => arg switch
            {
                not 0 when pk.IsEgg => GetInvalid(FormArgumentNotAllowed),
                not 0 when pk.CurrentLevel < 31 => GetInvalid(FormArgumentLEQ_0, 0),
                > 9_999 => GetInvalid(FormArgumentLEQ_0, 9999),
                _ => arg == 0 || HasVisitedPLA(data, Stantler) ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentNotAllowed),
            },
            Primeape => CheckPrimeape(data, pk, arg, enc),
            Bisharp => arg switch
            {
                > 9_999 => GetInvalid(FormArgumentLEQ_0, 9999),
                _ => arg == 0 || HasVisitedSV(data, Bisharp) ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentNotAllowed),
            },
            Gimmighoul => arg switch
            {
                // Z-A evolutions do not set form argument to Gimmighoul.
                0 when data.Info.EvoChainsAllGens.HasVisitedZA => GetValid(FormArgumentValid),

                // When leveled up, the game copies the save file's current coin count to the arg (clamped to <=999). If >=999, evolution is triggered.
                // Without being leveled up at least once, it cannot have a form arg value.
                >= 999 => GetInvalid(FormArgumentLEQ_0, 999),
                0 => GetValid(FormArgumentValid),

                // S/V sets form argument to match coin count.
                _ when !data.Info.EvoChainsAllGens.HasVisitedGen9 => GetInvalid(FormArgumentInvalid),
                _ => pk.CurrentLevel != pk.MetLevel ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentNotAllowed),
            },
            Gholdengo when !data.Info.EvoChainsAllGens.HasVisitedGen9 => arg == 0 ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentInvalid),
            Gholdengo => VerifyFormArgumentRange(enc.Species, Gholdengo, arg, 999, 999),

            Runerigus   => VerifyFormArgumentRange(enc.Species, Runerigus,   arg,  49, 9999),
            Alcremie    => VerifyFormArgumentRange(enc.Species, Alcremie,    arg,   0, (ushort)AlcremieDecoration.Ribbon),
            Wyrdeer when enc.Species != (int)Wyrdeer && pk.CurrentLevel < 31 => GetInvalid(EvoInvalid),
            Wyrdeer     => VerifyFormArgumentRange(enc.Species, Wyrdeer,     arg,  20, 9999),
            Basculegion => VerifyFormArgumentRange(enc.Species, Basculegion, arg, 294, 9999),
            Annihilape  => VerifyFormArgumentRange(enc.Species, Annihilape,  arg,  20, 9999),
            Kingambit   => VerifyFormArgumentRange(enc.Species, Kingambit,   arg,   3, 9999),
            Koraidon or Miraidon => enc switch
            {
                // Starter Legend has '1' when present in party, to differentiate.
                // Cannot be traded to other games.
                EncounterStatic9 { StarterBoxLegend: true } x when ParseSettings.ActiveTrainer is { } tr && (tr is not SAV9SV sv || sv.Version != x.Version) => GetInvalid(TradeNotAvailable),
                EncounterStatic9 { StarterBoxLegend: true } => arg switch
                {
                  < EncounterStatic9.RideLegendFormArg => GetInvalid(FormArgumentGEQ_0, EncounterStatic9.RideLegendFormArg),
                    EncounterStatic9.RideLegendFormArg => !data.IsStoredSlot(StorageSlotType.Ride) ? GetInvalid(FormParty) : GetValid(FormArgumentValid),
                  > EncounterStatic9.RideLegendFormArg => GetInvalid(FormArgumentLEQ_0, EncounterStatic9.RideLegendFormArg),
                },
                _ => arg switch
                {
                    not 0 => GetInvalid(FormArgumentNotAllowed),
                    _ => GetValid(FormArgumentValid),
                },
            },
            _ => VerifyFormArgumentNone(pk, f),
        };
    }

    private CheckResult CheckPrimeape(LegalityAnalysis data, PKM pk, uint arg, IEncounterTemplate enc)
    {
        if (arg == 0)
            return GetValid(FormArgumentValid);
        if (arg > 9_999)
            return GetInvalid(FormArgumentLEQ_0, 9999);

        if (HasVisitedSV(data, Primeape) || HasVisitedZA(data, Primeape))
        {
            const ushort move = (ushort)Move.RageFist;
            // Eager check
            if (pk.HasMove(move) || pk.HasRelearnMove(move))
                return GetValid(FormArgumentValid);

            var head = LearnGroupUtil.GetCurrentGroup(pk);
            if (MemoryPermissions.GetCanKnowMove(enc, move, data.Info.EvoChainsAllGens, pk, head))
                return GetValid(FormArgumentValid);
        }
        return GetInvalid(FormArgumentLEQ_0, 0); // Can't increase from 0.
    }

    private CheckResult CheckFarfetchd(LegalityAnalysis data, PKM pk, uint arg)
    {
        if (arg == 0)
            return GetValid(FormArgumentValid);
        if (arg > 9_999)
            return GetInvalid(FormArgumentLEQ_0, 9999);
        if (pk.IsEgg)
            return GetInvalid(FormArgumentNotAllowed);

        var history = data.Info.EvoChainsAllGens;
        if (history.HasVisitedZA) // Can increase.
            return GetValid(FormArgumentValid);
        return GetInvalid(FormArgumentLEQ_0, 0); // Can't increase from 0.
    }

    private CheckResult CheckSirfetchd(LegalityAnalysis data, uint arg, IEncounterTemplate enc)
    {
        var history = data.Info.EvoChainsAllGens;
        if (arg is 0)
        {
            if (enc.Species is (ushort)Sirfetchd)
                return GetValid(FormArgumentValid);
            if (history.HasVisitedGen9 || history.HasVisitedSWSH)
                return GetValid(FormArgumentValid);
        }
        else if (arg > 9999)
        {
            return GetInvalid(FormArgumentLEQ_0, 9999);
        }

        if (history.HasVisitedZA && arg >= 3) // Can increase.
            return GetValid(FormArgumentValid);
        return GetInvalid(FormArgumentLEQ_0, 0); // Can't increase from 0.
    }

    private CheckResult CheckQwilfish(LegalityAnalysis data, PKM pk, uint arg)
    {
        if (arg == 0)
            return GetValid(FormArgumentValid);
        if (arg > 9_999)
            return GetInvalid(FormArgumentLEQ_0, 9999);
        if (pk.IsEgg)
            return GetInvalid(FormArgumentNotAllowed);

        const int lowestLearnBarbBarrageHOME = 15; // level 15 via PLA learnset
        var current = pk.CurrentLevel;
        var history = data.Info.EvoChainsAllGens;
        if (history.HasVisitedPLA)
        {
            const int min = 25; // mastered
            if (current < min)
                return GetInvalid(FormArgumentLEQ_0, 0); // Can't get requisite move
            return GetValid(FormArgumentValid);
        }
        if (history.HasVisitedZA)
        {
            var min = pk is IHomeTrack { HasTracker: false } ? 28 : lowestLearnBarbBarrageHOME;
            if (current < min)
                return GetInvalid(FormArgumentLEQ_0, 0); // Can't get requisite move
            return GetValid(FormArgumentValid);
        }

        return GetInvalid(FormArgumentLEQ_0, 0); // Can't get requisite move
    }

    private CheckResult CheckOverqwil(LegalityAnalysis data, PKM pk, uint arg, IEncounterTemplate enc)
    {
        if (arg is 0)
        {
            if (enc.Species is (ushort)Overqwil)
                return GetValid(FormArgumentValid);
        }
        else if (arg > 9999)
        {
            return GetInvalid(FormArgumentLEQ_0, 9999);
        }

        const int lowestLearnBarbBarrageHOME = 15; // level 15 via PLA learnset
        var history = data.Info.EvoChainsAllGens;
        var current = pk.CurrentLevel;
        if (history.HasVisitedGen9)
        {
            // Evolution requires only knowing the move.
            const ushort move = (ushort)Move.BarbBarrage;
            var hasMove = pk.HasMove(move) || pk.HasRelearnMove(move);
            if (hasMove || current >= (history.HasVisitedPLA ? lowestLearnBarbBarrageHOME : 28))
            {
                if (arg == 0 || history.HasVisitedPLA || history.HasVisitedZA)
                    return GetValid(FormArgumentValid);
            }
        }
        if (history.HasVisitedPLA && arg >= 20)
        {
            // Evolution requires mastering the move and using it.
            if (current >= 25)
                return GetValid(FormArgumentValid);
        }
        if (history.HasVisitedZA && arg >= 20)
        {
            if (current >= 28)
                return GetValid(FormArgumentValid);
        }
        return GetInvalid(EvoInvalid);
    }

    private static bool HasVisitedAs(ReadOnlySpan<EvoCriteria> evos, Species species) => EvolutionHistory.HasVisited(evos, (ushort)species);
    private static bool HasVisitedPLA(LegalityAnalysis data, Species species) => HasVisitedAs(data.Info.EvoChainsAllGens.Gen8a, species);
    private static bool HasVisitedSV(LegalityAnalysis data, Species species) => HasVisitedAs(data.Info.EvoChainsAllGens.Gen9, species);
    private static bool HasVisitedZA(LegalityAnalysis data, Species species) => HasVisitedAs(data.Info.EvoChainsAllGens.Gen9a, species);

    /// <summary>
    /// Check if the <see cref="value"/> is within the range of the inclusive <see cref="min"/> and inclusive <see cref="max"/>.
    /// </summary>
    /// <param name="encSpecies">Original species. If evolved, can have a non-zero value.</param>
    /// <param name="check">Current Species</param>
    /// <param name="value">Current Form Argument value</param>
    /// <param name="min">Minimum value allowed</param>
    /// <param name="max">Maximum value allowed</param>
    private CheckResult VerifyFormArgumentRange(ushort encSpecies, Species check, uint value, [ConstantExpected] ushort min, [ConstantExpected] ushort max)
    {
        // If was never the Form Argument accruing species (never evolved from it), then it must be zero.
        if (encSpecies == (ushort)check)
        {
            if (value == 0)
                return GetValid(FormArgumentValid);
            return GetInvalid(FormArgumentNotAllowed);
        }

        // Evolved, must be within the range.
        if (value < min)
            return GetInvalid(FormArgumentGEQ_0, min);
        if (value > max)
            return GetInvalid(FormArgumentLEQ_0, max);
        return GetValid(FormArgumentValid);
    }

    private CheckResult VerifyFormArgumentNone(PKM pk, IFormArgument f)
    {
        if (pk is not PK6 pk6)
        {
            if (f.FormArgument != 0)
            {
                if (pk is { Species: (int)Furfrou, Form: 0 } && (f.FormArgument & ~0xFF_00_00u) == 0)
                    return GetValid(FormArgumentValid);
                return GetInvalid(FormArgumentNotAllowed);
            }
            return GetValid(FormArgumentValid);
        }

        if (f.FormArgument != 0)
        {
            if (pk is { Species: (int)Furfrou, Form: 0 } && (f.FormArgument & ~0xFFu) == 0)
                return GetValid(FormArgumentValid);
            return GetInvalid(FormArgumentNotAllowed);
        }

        // Stored separately from main form argument value
        if (pk6.FormArgumentRemain != 0)
            return GetInvalid(FormArgumentNotAllowed);
        if (pk6.FormArgumentElapsed != 0)
            return GetInvalid(FormArgumentNotAllowed);

        return GetValid(FormArgumentValid);
    }

    private static bool IsFormArgumentDayCounterValid(IFormArgument f, uint maxSeed, bool canRefresh = false)
    {
        var remain = f.FormArgumentRemain;
        var elapsed = f.FormArgumentElapsed;
        var maxElapsed = f.FormArgumentMaximum;
        if (canRefresh)
        {
            if (maxElapsed < elapsed)
                return false;

            if (remain + elapsed < maxSeed)
                return false;
        }
        else
        {
            if (maxElapsed != 0)
                return false;

            if (remain + elapsed != maxSeed)
                return false;
        }
        if (remain > maxSeed)
            return false;
        return remain != 0;
    }
}