mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-24 11:23:11 +00:00
9166d0eb64
Rewrites a good amount of legality APIs pertaining to: * Legal moves that can be learned * Evolution chains & cross-generation paths * Memory validation with forgotten moves In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data. The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space. The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation. * `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game. * `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`). * Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
279 lines
9.4 KiB
C#
279 lines
9.4 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Windows.Forms;
|
|
using PKHeX.Core;
|
|
using PKHeX.WinForms.Controls;
|
|
using static PKHeX.Core.MessageStrings;
|
|
|
|
namespace PKHeX.WinForms;
|
|
|
|
public partial class BatchEditor : Form
|
|
{
|
|
private readonly SaveFile SAV;
|
|
|
|
// Mass Editing
|
|
private Core.BatchEditor editor = new();
|
|
private readonly EntityInstructionBuilder UC_Builder;
|
|
|
|
public BatchEditor(PKM pk, SaveFile sav)
|
|
{
|
|
InitializeComponent();
|
|
WinFormsUtil.TranslateInterface(this, Main.CurrentLanguage);
|
|
var above = FLP_RB.Location;
|
|
UC_Builder = new EntityInstructionBuilder(() => pk)
|
|
{
|
|
Location = new() { Y = above.Y + FLP_RB.Height + 6, X = above.X + 1 },
|
|
Anchor = AnchorStyles.Top | AnchorStyles.Left | AnchorStyles.Right,
|
|
Width = B_Add.Location.X - above.X - 6,
|
|
};
|
|
Controls.Add(UC_Builder);
|
|
SAV = sav;
|
|
DragDrop += TabMain_DragDrop;
|
|
DragEnter += TabMain_DragEnter;
|
|
}
|
|
|
|
private void B_Open_Click(object sender, EventArgs e)
|
|
{
|
|
if (!B_Go.Enabled) return;
|
|
using var fbd = new FolderBrowserDialog();
|
|
if (fbd.ShowDialog() != DialogResult.OK)
|
|
return;
|
|
|
|
TB_Folder.Text = fbd.SelectedPath;
|
|
TB_Folder.Visible = true;
|
|
}
|
|
|
|
private void B_SAV_Click(object sender, EventArgs e)
|
|
{
|
|
TB_Folder.Text = string.Empty;
|
|
TB_Folder.Visible = false;
|
|
}
|
|
|
|
private void B_Go_Click(object sender, EventArgs e)
|
|
{
|
|
RunBackgroundWorker();
|
|
}
|
|
|
|
private void B_Add_Click(object sender, EventArgs e)
|
|
{
|
|
var s = UC_Builder.Create();
|
|
if (s.Length == 0)
|
|
{ WinFormsUtil.Alert(MsgBEPropertyInvalid); return; }
|
|
|
|
if (RTB_Instructions.Lines.Length != 0 && RTB_Instructions.Lines[^1].Length > 0)
|
|
s = Environment.NewLine + s;
|
|
|
|
RTB_Instructions.AppendText(s);
|
|
}
|
|
|
|
private static void TabMain_DragEnter(object? sender, DragEventArgs? e)
|
|
{
|
|
if (e?.Data is null)
|
|
return;
|
|
if (e.Data.GetDataPresent(DataFormats.FileDrop))
|
|
e.Effect = DragDropEffects.Copy;
|
|
}
|
|
|
|
private void TabMain_DragDrop(object? sender, DragEventArgs? e)
|
|
{
|
|
if (e?.Data?.GetData(DataFormats.FileDrop) is not string[] {Length: not 0} files)
|
|
return;
|
|
if (!Directory.Exists(files[0]))
|
|
return;
|
|
|
|
TB_Folder.Text = files[0];
|
|
TB_Folder.Visible = true;
|
|
RB_Boxes.Checked = RB_Party.Checked = false;
|
|
RB_Path.Checked = true;
|
|
}
|
|
|
|
private void RunBackgroundWorker()
|
|
{
|
|
var lines = RTB_Instructions.Lines;
|
|
if (Array.Exists(lines, line => line.Length == 0))
|
|
{ WinFormsUtil.Error(MsgBEInstructionInvalid); return; }
|
|
|
|
var sets = StringInstructionSet.GetBatchSets(lines).ToArray();
|
|
if (Array.Exists(sets, s => s.Filters.Any(z => string.IsNullOrWhiteSpace(z.PropertyValue))))
|
|
{ WinFormsUtil.Error(MsgBEFilterEmpty); return; }
|
|
|
|
if (Array.Exists(sets, z => z.Instructions.Count == 0))
|
|
{ WinFormsUtil.Error(MsgBEInstructionNone); return; }
|
|
|
|
var emptyVal = sets.SelectMany(s => s.Instructions.Where(z => string.IsNullOrWhiteSpace(z.PropertyValue))).ToArray();
|
|
if (emptyVal.Length > 0)
|
|
{
|
|
string props = string.Join(", ", emptyVal.Select(z => z.PropertyName));
|
|
string invalid = MsgBEPropertyEmpty + Environment.NewLine + props;
|
|
if (DialogResult.Yes != WinFormsUtil.Prompt(MessageBoxButtons.YesNo, invalid, MsgContinue))
|
|
return;
|
|
}
|
|
|
|
string? destPath = null;
|
|
if (RB_Path.Checked)
|
|
{
|
|
WinFormsUtil.Alert(MsgExportFolder, MsgExportFolderAdvice);
|
|
using var fbd = new FolderBrowserDialog();
|
|
var dr = fbd.ShowDialog();
|
|
if (dr != DialogResult.OK)
|
|
return;
|
|
|
|
destPath = fbd.SelectedPath;
|
|
}
|
|
|
|
FLP_RB.Enabled = RTB_Instructions.Enabled = B_Go.Enabled = false;
|
|
|
|
foreach (var set in sets)
|
|
{
|
|
BatchEditing.ScreenStrings(set.Filters);
|
|
BatchEditing.ScreenStrings(set.Instructions);
|
|
}
|
|
RunBatchEdit(sets, TB_Folder.Text, destPath);
|
|
}
|
|
|
|
private void RunBatchEdit(StringInstructionSet[] sets, string source, string? destination)
|
|
{
|
|
editor = new Core.BatchEditor();
|
|
bool finished = false, displayed = false; // hack cuz DoWork event isn't cleared after completion
|
|
b.DoWork += (sender, e) =>
|
|
{
|
|
if (finished)
|
|
return;
|
|
if (RB_Boxes.Checked)
|
|
RunBatchEditSaveFile(sets, boxes: true);
|
|
else if (RB_Party.Checked)
|
|
RunBatchEditSaveFile(sets, party: true);
|
|
else if (destination != null)
|
|
RunBatchEditFolder(sets, source, destination);
|
|
finished = true;
|
|
};
|
|
b.ProgressChanged += (sender, e) => SetProgressBar(e.ProgressPercentage);
|
|
b.RunWorkerCompleted += (sender, e) =>
|
|
{
|
|
string result = editor.GetEditorResults(sets);
|
|
if (!displayed) WinFormsUtil.Alert(result);
|
|
displayed = true;
|
|
FLP_RB.Enabled = RTB_Instructions.Enabled = B_Go.Enabled = true;
|
|
SetupProgressBar(0);
|
|
};
|
|
b.RunWorkerAsync();
|
|
}
|
|
|
|
private void RunBatchEditFolder(IReadOnlyCollection<StringInstructionSet> sets, string source, string destination)
|
|
{
|
|
var files = Directory.GetFiles(source, "*", SearchOption.AllDirectories);
|
|
SetupProgressBar(files.Length * sets.Count);
|
|
foreach (var set in sets)
|
|
ProcessFolder(files, destination, set.Filters, set.Instructions);
|
|
}
|
|
|
|
private void RunBatchEditSaveFile(IReadOnlyCollection<StringInstructionSet> sets, bool boxes = false, bool party = false)
|
|
{
|
|
var data = new List<SlotCache>();
|
|
if (party)
|
|
{
|
|
SlotInfoLoader.AddPartyData(SAV, data);
|
|
process(data);
|
|
SAV.PartyData = data.ConvertAll(z => z.Entity);
|
|
}
|
|
if (boxes)
|
|
{
|
|
SlotInfoLoader.AddBoxData(SAV, data);
|
|
process(data);
|
|
SAV.BoxData = data.ConvertAll(z => z.Entity);
|
|
}
|
|
void process(IList<SlotCache> d)
|
|
{
|
|
SetupProgressBar(d.Count * sets.Count);
|
|
foreach (var set in sets)
|
|
ProcessSAV(d, set.Filters, set.Instructions);
|
|
}
|
|
}
|
|
|
|
// Progress Bar
|
|
private void SetupProgressBar(int count)
|
|
{
|
|
MethodInvoker mi = () => { PB_Show.Minimum = 0; PB_Show.Step = 1; PB_Show.Value = 0; PB_Show.Maximum = count; };
|
|
if (PB_Show.InvokeRequired)
|
|
PB_Show.Invoke(mi);
|
|
else
|
|
mi.Invoke();
|
|
}
|
|
|
|
private void SetProgressBar(int position)
|
|
{
|
|
if (PB_Show.InvokeRequired)
|
|
PB_Show.Invoke((MethodInvoker)(() => PB_Show.Value = position));
|
|
else
|
|
PB_Show.Value = position;
|
|
}
|
|
|
|
private void ProcessSAV(IList<SlotCache> data, IReadOnlyList<StringInstruction> Filters, IReadOnlyList<StringInstruction> Instructions)
|
|
{
|
|
if (data.Count == 0)
|
|
return;
|
|
|
|
var filterMeta = Filters.Where(f => BatchFilters.FilterMeta.Any(z => z.IsMatch(f.PropertyName))).ToArray();
|
|
if (filterMeta.Length != 0)
|
|
Filters = Filters.Except(filterMeta).ToArray();
|
|
|
|
var max = data[0].Entity.MaxSpeciesID;
|
|
|
|
for (int i = 0; i < data.Count; i++)
|
|
{
|
|
var entry = data[i];
|
|
var pk = data[i].Entity;
|
|
|
|
var spec = pk.Species;
|
|
if (spec <= 0 || spec > max)
|
|
continue;
|
|
|
|
if (entry.Source is SlotInfoBox info && SAV.GetSlotFlags(info.Box, info.Slot).IsOverwriteProtected())
|
|
editor.AddSkipped();
|
|
else if (!BatchEditing.IsFilterMatchMeta(filterMeta, entry))
|
|
editor.AddSkipped();
|
|
else
|
|
editor.Process(pk, Filters, Instructions);
|
|
|
|
b.ReportProgress(i);
|
|
}
|
|
}
|
|
|
|
private void ProcessFolder(IReadOnlyList<string> files, string destDir, IReadOnlyList<StringInstruction> pkFilters, IReadOnlyList<StringInstruction> instructions)
|
|
{
|
|
var filterMeta = pkFilters.Where(f => BatchFilters.FilterMeta.Any(z => z.IsMatch(f.PropertyName))).ToArray();
|
|
if (filterMeta.Length != 0)
|
|
pkFilters = pkFilters.Except(filterMeta).ToArray();
|
|
|
|
for (int i = 0; i < files.Count; i++)
|
|
{
|
|
TryProcess(files[i], destDir, filterMeta, pkFilters, instructions);
|
|
b.ReportProgress(i);
|
|
}
|
|
}
|
|
|
|
private void TryProcess(string source, string destDir, IReadOnlyList<StringInstruction> metaFilters, IReadOnlyList<StringInstruction> pkFilters, IReadOnlyList<StringInstruction> instructions)
|
|
{
|
|
var fi = new FileInfo(source);
|
|
if (!EntityDetection.IsSizePlausible(fi.Length))
|
|
return;
|
|
|
|
byte[] data = File.ReadAllBytes(source);
|
|
_ = FileUtil.TryGetPKM(data, out var pk, fi.Extension, SAV);
|
|
if (pk == null)
|
|
return;
|
|
|
|
var info = new SlotInfoFile(source);
|
|
var entry = new SlotCache(info, pk);
|
|
if (!BatchEditing.IsFilterMatchMeta(metaFilters, entry))
|
|
{
|
|
editor.AddSkipped();
|
|
return;
|
|
}
|
|
|
|
if (editor.Process(pk, pkFilters, instructions))
|
|
File.WriteAllBytes(Path.Combine(destDir, Path.GetFileName(source)), pk.DecryptedPartyData);
|
|
}
|
|
}
|