Fix slot view order when recipe has linked slots

Fixes SlimeKnights/TinkersConstruct#5232

Author: mezz

Library/src/main/java/mezz/jei/library/gui/recipes/RecipeLayout.java

@@ -30,6 +30,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -49,10 +50,12 @@ public class RecipeLayout<R> implements IRecipeLayoutDrawable<R> {
 	/**
 	 * Slots handled by the recipe category directly.
 	 */
+	@Unmodifiable
 	private final List<IRecipeSlotDrawable> recipeCategorySlots;
 	/**
 	 * All slots, including slots handled by the recipe category and widgets.
 	 */
+	@Unmodifiable
 	private final List<IRecipeSlotDrawable> allSlots;
 	private final List<ISlottedRecipeWidget> slottedWidgets;
 	private final CycleTicker cycleTicker;

Library/src/main/java/mezz/jei/library/gui/recipes/layout/builder/RecipeLayoutBuilder.java

@@ -24,6 +24,7 @@
 import mezz.jei.common.util.ErrorUtil;
 import mezz.jei.common.util.ImmutablePoint2i;
 import mezz.jei.core.collect.ListMultiMap;
+import mezz.jei.core.util.Pair;
 import mezz.jei.library.gui.ingredients.CycleTicker;
 import mezz.jei.library.gui.recipes.OutputSlotTooltipCallback;
 import mezz.jei.library.gui.recipes.RecipeLayout;
@@ -35,6 +36,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Comparator;
 import java.util.HashSet;
 import java.util.IntSummaryStatistics;
 import java.util.List;
@@ -59,6 +61,7 @@ public class RecipeLayoutBuilder<T> implements IRecipeLayoutBuilder, IRecipeExtr
 	private int shapelessY = -1;
 	private int recipeTransferX = -1;
 	private int recipeTransferY = -1;
+	private int nextSlotIndex = 0;
 
 	public RecipeLayoutBuilder(IRecipeCategory<T> recipeCategory, T recipe, IIngredientManager ingredientManager) {
 		this.recipeCategory = recipeCategory;
@@ -68,7 +71,7 @@ public RecipeLayoutBuilder(IRecipeCategory<T> recipeCategory, T recipe, IIngredi
 
 	@Override
 	public IRecipeSlotBuilder addSlot(RecipeIngredientRole role, int x, int y) {
-		RecipeSlotBuilder slot = new RecipeSlotBuilder(ingredientManager, role, x, y);
+		RecipeSlotBuilder slot = new RecipeSlotBuilder(ingredientManager, nextSlotIndex++, role, x, y);
 
 		if (role == RecipeIngredientRole.OUTPUT) {
 			addOutputSlotTooltipCallback(slot);
@@ -80,7 +83,7 @@ public IRecipeSlotBuilder addSlot(RecipeIngredientRole role, int x, int y) {
 
 	@Override
 	public IRecipeSlotBuilder addSlotToWidget(RecipeIngredientRole role, ISlottedWidgetFactory<?> widgetFactory) {
-		RecipeSlotBuilder slot = new RecipeSlotBuilder(ingredientManager, role, 0, 0)
+		RecipeSlotBuilder slot = new RecipeSlotBuilder(ingredientManager, nextSlotIndex++, role, 0, 0)
 			.assignToWidgetFactory(widgetFactory);
 
 		if (role == RecipeIngredientRole.OUTPUT) {
@@ -186,9 +189,9 @@ public RecipeLayout<T> buildRecipeLayout(
 		ShapelessIcon shapelessIcon = createShapelessIcon(recipeCategory);
 		ImmutablePoint2i recipeTransferButtonPosition = getRecipeTransferButtonPosition(recipeCategory, recipeBorderPadding);
 
-		List<IRecipeSlotDrawable> recipeCategorySlots = new ArrayList<>();
-		List<IRecipeSlotDrawable> allSlots = new ArrayList<>(recipeCategorySlots);
-		ListMultiMap<ISlottedWidgetFactory<?>, IRecipeSlotDrawable> widgetSlots = new ListMultiMap<>();
+		List<Pair<Integer, IRecipeSlotDrawable>> recipeCategorySlots = new ArrayList<>();
+		List<Pair<Integer, IRecipeSlotDrawable>> allSlots = new ArrayList<>();
+		ListMultiMap<ISlottedWidgetFactory<?>, Pair<Integer, IRecipeSlotDrawable>> widgetSlots = new ListMultiMap<>();
 
 		CycleTicker cycleTicker = CycleTicker.createWithRandomOffset();
 
@@ -200,7 +203,7 @@ public RecipeLayout<T> buildRecipeLayout(
 			}
 			for (RecipeSlotBuilder slotBuilder : linkedSlots) {
 				ISlottedWidgetFactory<?> assignedWidget = slotBuilder.getAssignedWidget();
-				IRecipeSlotDrawable slotDrawable = slotBuilder.build(focusMatches, cycleTicker);
+				Pair<Integer, IRecipeSlotDrawable> slotDrawable = slotBuilder.build(focusMatches, cycleTicker);
 				if (assignedWidget == null) {
 					recipeCategorySlots.add(slotDrawable);
 				} else {
@@ -214,7 +217,7 @@ public RecipeLayout<T> buildRecipeLayout(
 		for (RecipeSlotBuilder slotBuilder : slots) {
 			if (!focusLinkedSlots.contains(slotBuilder)) {
 				ISlottedWidgetFactory<?> assignedWidget = slotBuilder.getAssignedWidget();
-				IRecipeSlotDrawable slotDrawable = slotBuilder.build(focuses, cycleTicker);
+				Pair<Integer, IRecipeSlotDrawable> slotDrawable = slotBuilder.build(focuses, cycleTicker);
 				if (assignedWidget == null) {
 					recipeCategorySlots.add(slotDrawable);
 				} else {
@@ -224,11 +227,11 @@ public RecipeLayout<T> buildRecipeLayout(
 			}
 		}
 
-		for (Map.Entry<ISlottedWidgetFactory<?>, List<IRecipeSlotDrawable>> e : widgetSlots.entrySet()) {
+		for (Map.Entry<ISlottedWidgetFactory<?>, List<Pair<Integer, IRecipeSlotDrawable>>> e : widgetSlots.entrySet()) {
 			// TODO: breaking change: add a type parameter to IRecipeLayoutBuilder to avoid this cast
 			@SuppressWarnings("unchecked")
 			ISlottedWidgetFactory<T> factory = (ISlottedWidgetFactory<T>) e.getKey();
-			List<IRecipeSlotDrawable> slots = e.getValue();
+			List<IRecipeSlotDrawable> slots = sortSlots(e.getValue());
 			factory.createWidgetForSlots(this, recipe, slots);
 		}
 
@@ -247,8 +250,8 @@ public RecipeLayout<T> buildRecipeLayout(
 			recipeBorderPadding,
 			shapelessIcon,
 			recipeTransferButtonPosition,
-			recipeCategorySlots,
-			allSlots,
+			sortSlots(recipeCategorySlots),
+			sortSlots(allSlots),
 			slottedWidgets,
 			widgets,
 			inputHandlers,
@@ -258,6 +261,13 @@ public RecipeLayout<T> buildRecipeLayout(
 		);
 	}
 
+	private static List<IRecipeSlotDrawable> sortSlots(List<Pair<Integer, IRecipeSlotDrawable>> indexedSlots) {
+		return indexedSlots.stream()
+			.sorted(Comparator.comparingInt(Pair::first))
+			.map(Pair::second)
+			.toList();
+	}
+
 	@Nullable
 	private ShapelessIcon createShapelessIcon(IRecipeCategory<?> recipeCategory) {
 		if (!shapeless) {

Library/src/main/java/mezz/jei/library/gui/recipes/layout/builder/RecipeSlotBuilder.java

@@ -19,6 +19,7 @@
 import mezz.jei.common.platform.Services;
 import mezz.jei.common.util.ErrorUtil;
 import mezz.jei.common.util.ImmutableRect2i;
+import mezz.jei.core.util.Pair;
 import mezz.jei.library.gui.ingredients.ICycler;
 import mezz.jei.library.gui.ingredients.RecipeSlot;
 import mezz.jei.library.gui.ingredients.RendererOverrides;
@@ -37,17 +38,19 @@ public class RecipeSlotBuilder implements IRecipeSlotBuilder {
 	private final DisplayIngredientAcceptor ingredients;
 	private final RecipeIngredientRole role;
 	private final List<IRecipeSlotRichTooltipCallback> tooltipCallbacks = new ArrayList<>();
+	private final int slotIndex;
 	private ImmutableRect2i rect;
 	private @Nullable RendererOverrides rendererOverrides;
 	private @Nullable IDrawable background;
 	private @Nullable IDrawable overlay;
 	private @Nullable String slotName;
 	private @Nullable ISlottedWidgetFactory<?> assignedWidgetFactory;
 
-	public RecipeSlotBuilder(IIngredientManager ingredientManager, RecipeIngredientRole role, int x, int y) {
+	public RecipeSlotBuilder(IIngredientManager ingredientManager, int slotIndex, RecipeIngredientRole role, int x, int y) {
 		this.ingredients = new DisplayIngredientAcceptor(ingredientManager);
 		this.rect = new ImmutableRect2i(x, y, 16, 16);
 		this.role = role;
+		this.slotIndex = slotIndex;
 	}
 
 	@Override
@@ -178,12 +181,12 @@ public ISlottedWidgetFactory<?> getAssignedWidget() {
 		return assignedWidgetFactory;
 	}
 
-	public IRecipeSlotDrawable build(IFocusGroup focusGroup, ICycler cycler) {
+	public Pair<Integer, IRecipeSlotDrawable> build(IFocusGroup focusGroup, ICycler cycler) {
 		Set<Integer> focusMatches = getMatches(focusGroup);
 		return build(focusMatches, cycler);
 	}
 
-	public IRecipeSlotDrawable build(Set<Integer> focusMatches, ICycler cycler) {
+	public Pair<Integer, IRecipeSlotDrawable> build(Set<Integer> focusMatches, ICycler cycler) {
 		List<Optional<ITypedIngredient<?>>> allIngredients = this.ingredients.getAllIngredients();
 
 		List<Optional<ITypedIngredient<?>>> focusedIngredients = null;
@@ -198,7 +201,7 @@ public IRecipeSlotDrawable build(Set<Integer> focusMatches, ICycler cycler) {
 			}
 		}
 
-		return new RecipeSlot(
+		RecipeSlot recipeSlot = new RecipeSlot(
 			role,
 			rect,
 			cycler,
@@ -210,6 +213,7 @@ public IRecipeSlotDrawable build(Set<Integer> focusMatches, ICycler cycler) {
 			slotName,
 			rendererOverrides
 		);
+		return new Pair<>(slotIndex, recipeSlot);
 	}
 
 	public IntSet getMatches(IFocusGroup focuses) {

Library/src/main/java/mezz/jei/library/recipes/RecipeManager.java

@@ -16,6 +16,7 @@
 import mezz.jei.api.recipe.category.extensions.IRecipeCategoryDecorator;
 import mezz.jei.api.runtime.IIngredientManager;
 import mezz.jei.common.util.ErrorUtil;
+import mezz.jei.core.util.Pair;
 import mezz.jei.library.gui.ingredients.CycleTimer;
 import mezz.jei.library.gui.recipes.RecipeLayout;
 import mezz.jei.library.gui.recipes.layout.builder.RecipeSlotBuilder;
@@ -112,10 +113,11 @@ public <T> Optional<IRecipeLayoutDrawable<T>> createRecipeLayoutDrawable(
 
 	@Override
 	public IRecipeSlotDrawable createRecipeSlotDrawable(RecipeIngredientRole role, List<Optional<ITypedIngredient<?>>> ingredients, Set<Integer> focusedIngredients, int xPos, int yPos, int ingredientCycleOffset) {
-		RecipeSlotBuilder builder = new RecipeSlotBuilder(ingredientManager, role, xPos, yPos);
+		RecipeSlotBuilder builder = new RecipeSlotBuilder(ingredientManager, 0, role, xPos, yPos);
 		builder.addOptionalTypedIngredients(ingredients);
 		CycleTimer cycleTimer = CycleTimer.create(ingredientCycleOffset);
-		return builder.build(focusedIngredients, cycleTimer);
+		Pair<Integer, IRecipeSlotDrawable> result = builder.build(focusedIngredients, cycleTimer);
+		return result.second();
 	}
 
 	@Override