using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using static PKHeX.Core.MessageStrings;
namespace PKHeX.Core;
///
/// Extension methods for syntax sugar.
///
public static class SaveExtensions
{
///
/// Evaluates a file for compatibility to the .
///
/// that is being checked.
/// that is being tested for compatibility.
public static IReadOnlyList EvaluateCompatibility(this SaveFile sav, PKM pk)
{
return sav.GetSaveFileErrata(pk, GameInfo.Strings);
}
///
/// Checks a file for compatibility to the .
///
/// that is being checked.
/// that is being tested for compatibility.
public static bool IsCompatiblePKM(this SaveFile sav, PKM pk)
{
if (sav.PKMType != pk.GetType())
return false;
if (sav is ILangDeviantSave il && EntityConverter.IsIncompatibleGB(pk, il.Japanese, pk.Japanese))
return false;
return true;
}
private static IReadOnlyList GetSaveFileErrata(this SaveFile sav, PKM pk, IBasicStrings strings)
{
var errata = new List();
ushort held = (ushort)pk.HeldItem;
if (sav.Generation > 1 && held != 0)
{
string? msg = null;
if (held > sav.MaxItemID)
msg = MsgIndexItemGame;
else if (!pk.CanHoldItem(sav.HeldItems))
msg = MsgIndexItemHeld;
if (msg != null)
{
var itemstr = GameInfo.Strings.GetItemStrings(pk.Context, (GameVersion)pk.Version);
errata.Add($"{msg} {(held >= itemstr.Length ? held.ToString() : itemstr[held])}");
}
}
if (pk.Species > strings.Species.Count)
errata.Add($"{MsgIndexSpeciesRange} {pk.Species}");
else if (sav.MaxSpeciesID < pk.Species)
errata.Add($"{MsgIndexSpeciesGame} {strings.Species[pk.Species]}");
if (!sav.Personal[pk.Species].IsFormWithinRange(pk.Form) && !FormInfo.IsValidOutOfBoundsForm(pk.Species, pk.Form, pk.Generation))
errata.Add(string.Format(LegalityCheckStrings.LFormInvalidRange, Math.Max(0, sav.Personal[pk.Species].FormCount - 1), pk.Form));
var movestr = strings.Move;
for (int i = 0; i < 4; i++)
{
var move = pk.GetMove(i);
if ((uint)move > movestr.Count)
errata.Add($"{MsgIndexMoveRange} {move}");
else if (move > sav.MaxMoveID)
errata.Add($"{MsgIndexMoveGame} {movestr[move]}");
}
if (pk.Ability > strings.Ability.Count)
errata.Add($"{MsgIndexAbilityRange} {pk.Ability}");
else if (pk.Ability > sav.MaxAbilityID)
errata.Add($"{MsgIndexAbilityGame} {strings.Ability[pk.Ability]}");
return errata;
}
///
/// Imports compatible data to the , starting at the provided box.
///
/// Save File that will receive the data.
/// Compatible data that can be set to the without conversion.
/// Overwrite existing full slots. If true, will only overwrite empty slots.
/// First box to start loading to. All prior boxes are not modified.
/// Bypass option to not modify properties when setting to Save File.
/// Count of injected .
public static int ImportPKMs(this SaveFile sav, IEnumerable compat, bool overwrite = false, int boxStart = 0, PKMImportSetting noSetb = PKMImportSetting.UseDefault)
{
int startCount = boxStart * sav.BoxSlotCount;
int maxCount = sav.SlotCount;
int index = startCount;
int nonOverwriteImport = 0;
foreach (var pk in compat)
{
if (overwrite)
{
while (sav.IsSlotOverwriteProtected(index))
++index;
// The above will return false if out of range. We need to double-check.
if (index >= maxCount) // Boxes full!
break;
sav.SetBoxSlotAtIndex(pk, index, noSetb);
}
else
{
index = sav.NextOpenBoxSlot(index-1);
if (index < 0) // Boxes full!
break;
sav.SetBoxSlotAtIndex(pk, index, noSetb);
nonOverwriteImport++;
}
if (++index == maxCount) // Boxes full!
break;
}
return overwrite ? index - startCount : nonOverwriteImport; // actual imported count
}
public static IEnumerable GetCompatible(this SaveFile sav, IEnumerable pks)
{
var savtype = sav.PKMType;
foreach (var temp in pks)
{
var pk = EntityConverter.ConvertToType(temp, savtype, out var c);
if (pk == null)
{
Debug.WriteLine(c.GetDisplayString(temp, savtype));
continue;
}
if (sav is ILangDeviantSave il && EntityConverter.IsIncompatibleGB(temp, il.Japanese, pk.Japanese))
{
var str = EntityConverterResult.IncompatibleLanguageGB.GetIncompatibleGBMessage(pk, il.Japanese);
Debug.WriteLine(str);
continue;
}
var compat = sav.EvaluateCompatibility(pk);
if (compat.Count > 0)
continue;
yield return pk;
}
}
///
/// Gets a compatible for editing with a new .
///
/// SaveFile to receive the compatible
/// Current Pokémon being edited
/// Current Pokémon, assuming conversion is possible. If conversion is not possible, a blank will be obtained from the .
public static PKM GetCompatiblePKM(this SaveFile sav, PKM pk)
{
if (pk.Format >= 3 || sav.Generation >= 7)
return EntityConverter.ConvertToType(pk, sav.PKMType, out _) ?? sav.BlankPKM;
// gen1-2 compatibility check
if (pk.Japanese != ((ILangDeviantSave)sav).Japanese)
return sav.BlankPKM;
if (sav is SAV2 s2 && s2.Korean != pk.Korean)
return sav.BlankPKM;
return EntityConverter.ConvertToType(pk, sav.PKMType, out _) ?? sav.BlankPKM;
}
///
/// Gets a blank file for the save file. Adapts it to the save file.
///
/// Save File to fetch a template for
/// Template if it exists, or a blank from the
private static PKM LoadTemplateInternal(this SaveFile sav)
{
var pk = sav.BlankPKM;
EntityTemplates.TemplateFields(pk, sav);
return pk;
}
///
/// Gets a blank file for the save file. If the template path exists, a template load will be attempted.
///
/// Save File to fetch a template for
/// Path to look for a template in
/// Template if it exists, or a blank from the
public static PKM LoadTemplate(this SaveFile sav, string? templatePath = null)
{
if (templatePath == null || !Directory.Exists(templatePath))
return LoadTemplateInternal(sav);
var di = new DirectoryInfo(templatePath);
string path = Path.Combine(templatePath, $"{di.Name}.{sav.PKMType.Name.ToLowerInvariant()}");
if (!File.Exists(path))
return LoadTemplateInternal(sav);
var fi = new FileInfo(path);
if (!EntityDetection.IsSizePlausible(fi.Length))
return LoadTemplateInternal(sav);
var data = File.ReadAllBytes(path);
var prefer = EntityFileExtension.GetContextFromExtension(fi.Extension, sav.Context);
var pk = EntityFormat.GetFromBytes(data, prefer);
if (pk?.Species is not > 0)
return LoadTemplateInternal(sav);
return EntityConverter.ConvertToType(pk, sav.BlankPKM.GetType(), out _) ?? LoadTemplateInternal(sav);
}
}