Feat: add checkbox if recipe is on the page (#439)

This adds a (yellow) checkbox to recipes already added to the sheet, but
not part of the current sub-table (those are already marked with a
greencheckbx).


![afbeelding](https://github.com/user-attachments/assets/ceaeb50c-a991-4cc6-827a-4eb1b59e55e6)

Also works for the see full list:

![afbeelding](https://github.com/user-attachments/assets/77fad4cb-bf63-4025-a732-cc6463a59517)


A list of nice-to-have things:
* [x] A changelog entry.
* The link from the PR to the issue that it fixes. -> This Pr describes
the function.
* A description of what testing was done. -> Tried various recipe
combinations, including recipes part of parent nodes, sibling nodes,
also green checkbox should always override yellow.

Author: shpaass

Yafc/Widgets/ImmediateWidgets.cs

@@ -219,6 +219,9 @@ internal static bool BuildInlineObjectList<T>(this ImGui gui, IEnumerable<T> lis
             if (gui.isBuilding && (options.Checkmark?.Invoke(elem) ?? false)) {
                 gui.DrawIcon(Rect.Square(gui.lastRect.Right - 1f, gui.lastRect.Center.Y, 1.5f), Icon.Check, SchemeColor.Green);
             }
+            else if (gui.isBuilding && (options.YellowMark?.Invoke(elem) ?? false)) {
+                gui.DrawIcon(Rect.Square(gui.lastRect.Right - 1f, gui.lastRect.Center.Y, 1.5f), Icon.Check, SchemeColor.TagColorYellowText);
+            }
         }
 
         return selected != null;
@@ -235,7 +238,7 @@ public static void BuildInlineObjectListAndButton<T>(this ImGui gui, ICollection
 
             if (list.Count > options.MaxCount && gui.BuildButton("See full list") && gui.CloseDropdown()) {
                 if (options.Multiple) {
-                    SelectMultiObjectPanel.Select(list, options.Header, selectItem, options.Ordering, options.Checkmark);
+                    SelectMultiObjectPanel.Select(list, options.Header, selectItem, options.Ordering, options.Checkmark, options.YellowMark);
                 }
                 else {
                     SelectSingleObjectPanel.Select(list, options.Header, selectItem, options.Ordering);
@@ -461,9 +464,10 @@ public record DisplayAmount(float Value, UnitOfMeasure Unit = UnitOfMeasure.None
 /// Not used (treated as <see langword="false"/>) when selecting with a 'None' item.</param>
 /// <param name="Checkmark">If not <see langword="null"/>, this will be called to determine if a checkmark should be drawn on the item.
 /// Not used when selecting with a 'None' item or when <paramref name="Multiple"/> is <see langword="false"/>.</param>
+/// <param name="YellowMark">If Checkmark is not set, draw a less distinct checkmark instead.</param>
 /// <param name="ExtraText">If not <see langword="null"/>, this will be called to get extra text to be displayed right-justified after the item's name.</param>
 public sealed record ObjectSelectOptions<T>(string? Header, [AllowNull] IComparer<T> Ordering = null, int MaxCount = 6, bool Multiple = false, Predicate<T>? Checkmark = null,
-    Func<T, string>? ExtraText = null) where T : IFactorioObjectWrapper {
+    Predicate<T>? YellowMark = null, Func<T, string>? ExtraText = null) where T : IFactorioObjectWrapper {
 
     public IComparer<T> Ordering { get; init; } = Ordering ?? (IComparer<T>)DataUtils.DefaultOrdering;
 }

Yafc/Windows/SelectMultiObjectPanel.cs

@@ -9,9 +9,13 @@ namespace Yafc;
 public class SelectMultiObjectPanel : SelectObjectPanel<IEnumerable<FactorioObject>> {
     private readonly HashSet<FactorioObject> results = [];
     private readonly Predicate<FactorioObject> checkMark;
+    private readonly Predicate<FactorioObject> yellowMark;
     private bool allowAutoClose = true;
 
-    private SelectMultiObjectPanel(Predicate<FactorioObject> checkMark) => this.checkMark = checkMark;
+    private SelectMultiObjectPanel(Predicate<FactorioObject> checkMark, Predicate<FactorioObject> yellowMark) {
+        this.checkMark = checkMark;
+        this.yellowMark = yellowMark;
+    }
 
     /// <summary>
     /// Opens a <see cref="SelectMultiObjectPanel"/> to allow the user to select one or more <see cref="FactorioObject"/>s.
@@ -20,8 +24,8 @@ public class SelectMultiObjectPanel : SelectObjectPanel<IEnumerable<FactorioObje
     /// <param name="header">The string that describes to the user why they're selecting these items.</param>
     /// <param name="selectItem">An action to be called for each selected item when the panel is closed.</param>
     /// <param name="ordering">An optional ordering specifying how to sort the displayed items. If <see langword="null"/>, defaults to <see cref="DataUtils.DefaultOrdering"/>.</param>
-    public static void Select<T>(IEnumerable<T> list, string? header, Action<T> selectItem, IComparer<T>? ordering = null, Predicate<T>? checkMark = null) where T : FactorioObject {
-        SelectMultiObjectPanel panel = new(o => checkMark?.Invoke((T)o) ?? false); // This casting is messy, but pushing T all the way around the call stack and type tree was messier.
+    public static void Select<T>(IEnumerable<T> list, string? header, Action<T> selectItem, IComparer<T>? ordering = null, Predicate<T>? checkMark = null, Predicate<T>? yellowMark = null) where T : FactorioObject {
+        SelectMultiObjectPanel panel = new(o => checkMark?.Invoke((T)o) ?? false, o => yellowMark?.Invoke((T)o) ?? false); // This casting is messy, but pushing T all the way around the call stack and type tree was messier.
         panel.Select(list, header, selectItem!, ordering, (objs, mappedAction) => { // null-forgiving: selectItem will not be called with null, because allowNone is false.
             foreach (var obj in objs!) { // null-forgiving: mapResult will not be called with null, because allowNone is false.
                 mappedAction(obj);
@@ -37,9 +41,9 @@ public static void Select<T>(IEnumerable<T> list, string? header, Action<T> sele
     /// <param name="selectItem">An action to be called for each selected item when the panel is closed.</param>
     /// <param name="ordering">An optional ordering specifying how to sort the displayed items. If <see langword="null"/>, defaults to <see cref="DataUtils.DefaultOrdering"/>.</param>
     public static void SelectWithQuality<T>(IEnumerable<T> list, string header, Action<ObjectWithQuality<T>> selectItem, Quality currentQuality,
-        IComparer<T>? ordering = null, Predicate<T>? checkMark = null) where T : FactorioObject {
+        IComparer<T>? ordering = null, Predicate<T>? checkMark = null, Predicate<T>? yellowMark = null) where T : FactorioObject {
 
-        SelectMultiObjectPanel panel = new(o => checkMark?.Invoke((T)o) ?? false); // This casting is messy, but pushing T all the way around the call stack and type tree was messier.
+        SelectMultiObjectPanel panel = new(o => checkMark?.Invoke((T)o) ?? false, o => yellowMark?.Invoke((T)o) ?? false); // This casting is messy, but pushing T all the way around the call stack and type tree was messier.
         panel.SelectWithQuality(list, header, selectItem!, ordering, (objs, mappedAction) => { // null-forgiving: selectItem will not be called with null, because allowNone is false.
             foreach (var obj in objs!) { // null-forgiving: mapResult will not be called with null, because allowNone is false.
                 mappedAction(obj);
@@ -54,6 +58,9 @@ protected override void NonNullElementDrawer(ImGui gui, FactorioObject element)
         if (checkMark(element)) {
             gui.DrawIcon(Rect.SideRect(gui.lastRect.TopLeft + new Vector2(1, 0), gui.lastRect.BottomRight - new Vector2(0, 1)), Icon.Check, SchemeColor.Green);
         }
+        else if (yellowMark(element)) {
+            gui.DrawIcon(Rect.SideRect(gui.lastRect.TopLeft + new Vector2(1, 0), gui.lastRect.BottomRight - new Vector2(0, 1)), Icon.Check, SchemeColor.TagColorYellowText);
+        }
 
         if (click == Click.Left) {
             if (!results.Add(element)) {

Yafc/Workspace/ProductionTable/ProductionLinkSummaryScreen.cs

@@ -51,24 +51,14 @@ private void BuildScrollArea(ImGui gui) {
     }
 
     private void ShowRelatedLinks(ImGui gui) {
-        ModelObject o = link;
-        List<ModelObject> parents = [];
-        while (o.ownerObject is not ProjectPage) {
-            var t = o.ownerObject;
-            if (t is null) {
-                break;
-            }
-            o = t;
-            if (t == o.ownerObject) continue;
-            parents.Add(t);
-        }
-        if (o is ProductionTable page) {
-            Dictionary<IProductionLink, List<(RecipeRow row, float flow)>> childLinks = [], parentLinks = [], otherLinks = [];
-            List<(RecipeRow row, float flow)> unlinked = [], table;
+        var prodTable = FindProductionTable(link, out List<ModelObject> parents);
+        Dictionary<IProductionLink, List<(RecipeRow row, float flow)>> childLinks = [], parentLinks = [], otherLinks = [];
+        List<(RecipeRow row, float flow)> unlinked = [], table;
+        if (prodTable is not null) {
             foreach (var (row, relationLinks) in
-                page.GetAllRecipes(link.owner)
-                .Select(e => (e, IsLinkParent(e, parents) ? parentLinks : otherLinks))
-                .Concat(link.owner.GetAllRecipes().Select(e => (e, childLinks)))) {
+                    prodTable.GetAllRecipes(link.owner)
+                        .Select(e => (e, IsLinkParent(e, parents) ? parentLinks : otherLinks))
+                        .Concat(link.owner.GetAllRecipes().Select(e => (e, childLinks)))) {
                 if (isPartOfCurrentLink(row)
                     || isNotRelatedToCurrentLink(row)) {
                     continue;
@@ -87,31 +77,46 @@ private void ShowRelatedLinks(ImGui gui) {
 
                 table.Add((row, localFlow));
             }
-            var color = 1;
-            gui.spacing = 0.75f;
-            if (childLinks.Values.Any(e => e.Any())) {
-                gui.BuildText("Child links: ", Font.productionTableHeader);
-                foreach (var relTable in childLinks.Values) {
-                    BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
-                }
+        }
+        var color = 1;
+        gui.spacing = 0.75f;
+        if (childLinks.Values.Any(e => e.Any())) {
+            gui.BuildText("Child links: ", Font.productionTableHeader);
+            foreach (var relTable in childLinks.Values) {
+                BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
             }
-            if (parentLinks.Values.Any(e => e.Any())) {
-                gui.BuildText("Parent links: ", Font.productionTableHeader);
-                foreach (var relTable in parentLinks.Values) {
-                    BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
-                }
+        }
+        if (parentLinks.Values.Any(e => e.Any())) {
+            gui.BuildText("Parent links: ", Font.productionTableHeader);
+            foreach (var relTable in parentLinks.Values) {
+                BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
             }
-            if (otherLinks.Values.Any(e => e.Any())) {
-                gui.BuildText("Unrelated links: ", Font.productionTableHeader);
-                foreach (var relTable in otherLinks.Values) {
-                    BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
-                }
+        }
+        if (otherLinks.Values.Any(e => e.Any())) {
+            gui.BuildText("Unrelated links: ", Font.productionTableHeader);
+            foreach (var relTable in otherLinks.Values) {
+                BuildFlow(gui, relTable, relTable.Sum(e => Math.Abs(e.flow)), false, color++);
             }
-            if (unlinked.Any()) {
-                gui.BuildText("Unlinked: ", Font.subheader);
-                BuildFlow(gui, unlinked, 0, false);
+        }
+        if (unlinked.Any()) {
+            gui.BuildText("Unlinked: ", Font.subheader);
+            BuildFlow(gui, unlinked, 0, false);
+        }
+    }
+
+    public static ProductionTable? FindProductionTable(ModelObject link, out List<ModelObject> parents) {
+        ModelObject table = link;
+        parents = [];
+        while (table.ownerObject is not ProjectPage) {
+            var t = table.ownerObject;
+            if (t is null) {
+                break;
             }
+            table = t;
+            if (t == table.ownerObject) continue;
+            parents.Add(t);
         }
+        return table as ProductionTable;
     }
 
     private bool isNotRelatedToCurrentLink(RecipeRow? row) => (!row.Ingredients.Any(e => e.Goods == link.goods)

Yafc/Workspace/ProductionTable/ProductionTableView.cs

@@ -6,6 +6,7 @@
 using Yafc.Blueprints;
 using Yafc.Model;
 using Yafc.UI;
+using static Yafc.UI.ImGui;
 
 namespace Yafc;
 
@@ -266,11 +267,12 @@ private static void BuildRecipeButton(ImGui gui, ProductionTable table) {
             if (gui.BuildButton("Add raw recipe").WithTooltip(gui, "Ctrl-click to add a technology instead") && gui.CloseDropdown()) {
                 if (InputSystem.Instance.control) {
                     SelectMultiObjectPanel.Select(Database.technologies.all, "Select technology",
-                        r => table.AddRecipe(new(r, Quality.Normal), DefaultVariantOrdering), checkMark: r => table.recipes.Any(rr => rr.recipe.target == r));
+                        r => table.AddRecipe(new(r, Quality.Normal), DefaultVariantOrdering), checkMark: r => table.recipes.Any(rr => rr.recipe.target == r), yellowMark: r => table.GetAllRecipes().Any(rr => rr.recipe.target == r));
                 }
                 else {
+                    var prodTable = ProductionLinkSummaryScreen.FindProductionTable(table, out List<ModelObject> parents);
                     SelectMultiObjectPanel.SelectWithQuality(Database.recipes.explorable.AsEnumerable<RecipeOrTechnology>(), "Select raw recipe",
-                        r => table.AddRecipe(r, DefaultVariantOrdering), Quality.Normal, checkMark: r => table.recipes.Any(rr => rr.recipe.target == r));
+                        r => table.AddRecipe(r, DefaultVariantOrdering), Quality.Normal, checkMark: r => table.recipes.Any(rr => rr.recipe.target == r), yellowMark: r => prodTable?.GetAllRecipes().Any(rr => rr.recipe.target == r) ?? false);
                 }
             }
         }
@@ -874,9 +876,12 @@ private void OpenProductDropdown(ImGui targetGui, Rect rect, ObjectWithQuality<G
         }
 
         var comparer = DataUtils.GetRecipeComparerFor(goods.target);
-        HashSet<IObjectWithQuality<RecipeOrTechnology>> allRecipes = [.. context.recipes.Select(x => x.recipe)];
+        HashSet<IObjectWithQuality<RecipeOrTechnology>> curLevelRecipes = [.. context.recipes.Select(x => x.recipe)];
+        var prodTable = ProductionLinkSummaryScreen.FindProductionTable(context, out List<ModelObject> parents);
+        HashSet<IObjectWithQuality<RecipeOrTechnology>> allRecipes = [.. prodTable?.GetAllRecipes().Select(x => x.recipe) ?? []];
 
-        bool recipeExists(RecipeOrTechnology rec) => allRecipes.Contains(rec.With(goods.quality));
+        bool recipeExists(RecipeOrTechnology rec) => curLevelRecipes.Contains(rec.With(goods.quality));
+        bool recipeExistsAnywhere(RecipeOrTechnology rec) => allRecipes.Contains(rec.With(goods.quality));
 
         ObjectWithQuality<Goods>? selectedFuel = null;
         ObjectWithQuality<Goods>? spentFuel = null;
@@ -902,7 +907,7 @@ async void addRecipe(RecipeOrTechnology rec) {
                 }
             }
 
-            if (!allRecipes.Contains(qualityRecipe) || (await MessageBox.Show("Recipe already exists", $"Add a second copy of {rec.locName}?", "Add a copy", "Cancel")).choice) {
+            if (!curLevelRecipes.Contains(qualityRecipe) || (await MessageBox.Show("Recipe already exists", $"Add a second copy of {rec.locName}?", "Add a copy", "Cancel")).choice) {
                 context.AddRecipe(qualityRecipe, DefaultVariantOrdering, selectedFuel, spentFuel);
             }
         }
@@ -989,7 +994,7 @@ void dropDownContent(ImGui gui) {
                 }
             }
             else if (type <= ProductDropdownType.Ingredient && allProduction.Length > 0) {
-                gui.BuildInlineObjectListAndButton(allProduction, addRecipe, new("Add production recipe", comparer, 6, true, recipeExists));
+                gui.BuildInlineObjectListAndButton(allProduction, addRecipe, new("Add production recipe", comparer, 6, true, recipeExists, recipeExistsAnywhere));
                 numberOfShownRecipes += allProduction.Length;
 
                 if (iLink == null) {
@@ -1014,7 +1019,8 @@ void dropDownContent(ImGui gui) {
                     DataUtils.AlreadySortedRecipe,
                     3,
                     true,
-                    recipeExists));
+                    recipeExists,
+                    recipeExistsAnywhere));
                 numberOfShownRecipes += spentFuelRecipes.Length;
             }
 
@@ -1026,7 +1032,8 @@ void dropDownContent(ImGui gui) {
                     DataUtils.DefaultRecipeOrdering,
                     6,
                     true,
-                    recipeExists));
+                    recipeExists,
+                    recipeExistsAnywhere));
                 numberOfShownRecipes += goods.target.usages.Length;
             }
 
@@ -1038,19 +1045,20 @@ void dropDownContent(ImGui gui) {
                     DataUtils.AlreadySortedRecipe,
                     6,
                     true,
-                    recipeExists));
+                    recipeExists,
+                    recipeExistsAnywhere));
                 numberOfShownRecipes += fuelUseList.Length;
             }
 
             if (type >= ProductDropdownType.Product && Database.allSciencePacks.Contains(goods.target)
                 && gui.BuildButton("Add consumption technology") && gui.CloseDropdown()) {
                 // Select from the technologies that consume this science pack.
                 SelectMultiObjectPanel.Select(Database.technologies.all.Where(t => t.ingredients.Select(i => i.goods).Contains(goods.target)),
-                    "Add technology", addRecipe, checkMark: recipeExists);
+                    "Add technology", addRecipe, checkMark: recipeExists, yellowMark: recipeExistsAnywhere);
             }
 
             if (type >= ProductDropdownType.Product && allProduction.Length > 0) {
-                gui.BuildInlineObjectListAndButton(allProduction, addRecipe, new("Add production recipe", comparer, 1, true, recipeExists));
+                gui.BuildInlineObjectListAndButton(allProduction, addRecipe, new("Add production recipe", comparer, 1, true, recipeExists, recipeExistsAnywhere));
                 numberOfShownRecipes += allProduction.Length;
             }
 

changelog.txt

@@ -21,6 +21,7 @@ Date:
         - Open the preferences or milestones when you click on the icon for the reactor or quality warning messages.
         - Implemented Auto Save.
         - (SA) Research recipes correctly consume quality science packs, and the UI explains this.
+        - Added marker to recipes already used on the current page.
     Fixes:
         - Fix export of blueprint chests from shopping list (broken in factorio >= 2.0.35)
         - (regression) The total sushi-input/-output items display belt counts again, and allow them as input.