Make recipe placing from recipe book working with custom ingredients

src/main/java/org/spongepowered/common/bridge/world/item/crafting/PlacementInfoBridge.java

@@ -0,0 +1,37 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.common.bridge.world.item.crafting;
+
+import net.minecraft.world.entity.player.StackedContents;
+import net.minecraft.world.item.ItemStack;
+
+import java.util.List;
+
+public interface PlacementInfoBridge {
+
+    boolean bridge$hasCustomIngredients();
+
+    List<StackedContents.IngredientInfo<ItemStack>> bridge$getStackIngredientInfos();
+}

src/main/java/org/spongepowered/common/item/recipe/book/RecipeBookUtil.java

@@ -0,0 +1,55 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.common.item.recipe.book;
+
+import net.minecraft.core.Holder;
+import net.minecraft.world.entity.player.Inventory;
+import net.minecraft.world.item.ItemStack;
+
+public final class RecipeBookUtil {
+
+    /**
+     * Copied from {@link Inventory#findSlotMatchingCraftingIngredient(Holder, ItemStack)}
+     * and adjusted to use exemplary {@link ItemStack} instead of just item type.
+     */
+    public static int findSlotMatchingCraftingIngredient(
+        final Inventory inventory, final ItemStack exemplaryStackToMove, final ItemStack craftInputStack
+    ) {
+        for (int i = 0; i < inventory.items.size(); i++) {
+            final ItemStack stack = inventory.items.get(i);
+            if (!stack.isEmpty()
+                && Inventory.isUsableForCrafting(stack)
+                && ItemStack.isSameItemSameComponents(exemplaryStackToMove, stack)
+                && (craftInputStack.isEmpty() || ItemStack.isSameItemSameComponents(craftInputStack, stack))) {
+                return i;
+            }
+        }
+
+        return -1;
+    }
+
+    private RecipeBookUtil() {
+    }
+}

src/main/java/org/spongepowered/common/item/recipe/book/SpongeStackedItemContents.java

@@ -0,0 +1,129 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.common.item.recipe.book;
+
+import it.unimi.dsi.fastutil.Hash;
+import it.unimi.dsi.fastutil.objects.Object2ReferenceMap;
+import it.unimi.dsi.fastutil.objects.Object2ReferenceOpenCustomHashMap;
+import net.minecraft.core.Holder;
+import net.minecraft.world.entity.player.StackedContents;
+import net.minecraft.world.entity.player.StackedItemContents;
+import net.minecraft.world.item.Item;
+import net.minecraft.world.item.ItemStack;
+import net.minecraft.world.item.crafting.PlacementInfo;
+import net.minecraft.world.item.crafting.Recipe;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.common.bridge.world.item.crafting.PlacementInfoBridge;
+
+import java.util.List;
+import java.util.function.Function;
+
+public class SpongeStackedItemContents extends StackedItemContents {
+
+    private static final Hash.Strategy<ItemStack> STACK_HASH_STRATEGY = new Hash.Strategy<>() {
+        @Override
+        public int hashCode(final ItemStack o) {
+            return ItemStack.hashItemAndComponents(o);
+        }
+
+        @Override
+        public boolean equals(final @Nullable ItemStack a, final @Nullable ItemStack b) {
+            return (a == b) || (a != null && b != null && ItemStack.isSameItemSameComponents(a, b));
+        }
+    };
+
+    private final Object2ReferenceMap<ItemStack, ItemStack> stackInterner = new Object2ReferenceOpenCustomHashMap<>(STACK_HASH_STRATEGY);
+    private final StackedContents<ItemStack> stackedContents = new StackedContents<>();
+
+    private StackedContents.@Nullable Output<ItemStack> stackOutput;
+
+    @Override
+    public void accountStack(final ItemStack stack, final int maxStackSize) {
+        if (!stack.isEmpty()) {
+            // StackedContents works on Reference2IntMap, so if we meet stack which "same" copy
+            // has already been accounted we would need to provide the stack that was met first.
+            final ItemStack stackToAccount = this.stackInterner.computeIfAbsent(stack, Function.identity());
+            this.stackedContents.account(stackToAccount, Math.min(stack.getCount(), maxStackSize));
+        }
+    }
+
+    @Override
+    public boolean canCraft(
+        final Recipe<?> recipe, final int amount,
+        final StackedContents.@Nullable Output<Holder<Item>> output
+    ) {
+        final PlacementInfo placement = recipe.placementInfo();
+        return !placement.isImpossibleToPlace()
+            && this.stackedContents.tryPick(
+                ((PlacementInfoBridge) placement).bridge$getStackIngredientInfos(),
+                amount, this.createStackOutput(output));
+    }
+
+    @Override
+    public boolean canCraft(
+        final List<? extends StackedContents.IngredientInfo<Holder<Item>>> ingredients,
+        final StackedContents.@Nullable Output<Holder<Item>> output
+    ) {
+        // By default, this method is not called in the context the instance of this class is created.
+        // If this happens, it's either error in Sponge impl or
+        // mixin from some mod (which should be inspected instead of silently doing something that impl does not expect).
+        throw new UnsupportedOperationException("This method should not have been called, please report about it");
+    }
+
+    @Override
+    public int getBiggestCraftableStack(
+        final Recipe<?> recipe, final int maxCount,
+        final StackedContents.@Nullable Output<Holder<Item>> output
+    ) {
+        return this.stackedContents.tryPickAll(
+            ((PlacementInfoBridge) recipe.placementInfo()).bridge$getStackIngredientInfos(),
+            maxCount, this.createStackOutput(output));
+    }
+
+    @Override
+    public void clear() {
+        this.stackInterner.clear();
+        this.stackedContents.clear();
+    }
+
+    public void setStackOutput(final StackedContents.@Nullable Output<ItemStack> stackOutput) {
+        this.stackOutput = stackOutput;
+    }
+
+    private StackedContents.@Nullable Output<ItemStack> createStackOutput(
+        final StackedContents.@Nullable Output<Holder<Item>> output
+    ) {
+        if (output == null) {
+            return null;
+        } else if (this.stackOutput == null) {
+            return stack -> output.accept(stack.getItemHolder());
+        } else {
+            return stack -> {
+                output.accept(stack.getItemHolder());
+                this.stackOutput.accept(stack);
+            };
+        }
+    }
+}

src/main/java/org/spongepowered/common/item/recipe/crafting/shapeless/SpongeShapelessRecipe.java

@@ -33,7 +33,7 @@
 import net.minecraft.world.item.crafting.ShapelessRecipe;
 import net.minecraft.world.level.Level;
 import org.spongepowered.common.accessor.world.item.crafting.ShapelessRecipeAccessor;
-import org.spongepowered.common.item.recipe.ingredient.SpongeIngredient;
+import org.spongepowered.common.bridge.world.item.crafting.PlacementInfoBridge;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -50,8 +50,6 @@
  */
 public class SpongeShapelessRecipe extends ShapelessRecipe {
 
-    private final boolean onlyVanillaIngredients;
-
     private final Function<CraftingInput, ItemStack> resultFunction;
     private final Function<CraftingInput, NonNullList<net.minecraft.world.item.ItemStack>> remainingItemsFunction;
 
@@ -62,14 +60,13 @@ public SpongeShapelessRecipe(final String groupIn,
             final Function<CraftingInput, net.minecraft.world.item.ItemStack> resultFunction,
             final Function<CraftingInput, NonNullList<ItemStack>> remainingItemsFunction) {
         super(groupIn, category, spongeResultStack, recipeItemsIn);
-        this.onlyVanillaIngredients = recipeItemsIn.stream().noneMatch(i -> i instanceof SpongeIngredient);
         this.resultFunction = resultFunction;
         this.remainingItemsFunction = remainingItemsFunction;
     }
 
     @Override
     public boolean matches(final CraftingInput $$0, final Level $$1) {
-        if (this.onlyVanillaIngredients) {
+        if (!((PlacementInfoBridge) this.placementInfo()).bridge$hasCustomIngredients()) {
             return super.matches($$0, $$1);
         }
         return SpongeShapelessRecipe.matches($$0.items(), ((ShapelessRecipeAccessor) this).accessor$ingredients());

src/main/java/org/spongepowered/common/item/recipe/ingredient/IngredientUtil.java

@@ -79,6 +79,7 @@ public static org.spongepowered.api.item.recipe.crafting.Ingredient of(ResourceK
         return IngredientUtil.fromNative(ingredient);
     }
 
-
-
+    public static boolean isCustom(final @Nullable Ingredient ingredient) {
+        return ingredient instanceof SpongeIngredient;
+    }
 }

src/mixins/java/org/spongepowered/common/mixin/core/recipebook/ServerPlaceRecipeMixin.java

@@ -0,0 +1,126 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.common.mixin.core.recipebook;
+
+import com.llamalad7.mixinextras.injector.wrapmethod.WrapMethod;
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import net.minecraft.core.Holder;
+import net.minecraft.recipebook.ServerPlaceRecipe;
+import net.minecraft.world.entity.player.Inventory;
+import net.minecraft.world.entity.player.StackedItemContents;
+import net.minecraft.world.inventory.Slot;
+import net.minecraft.world.item.Item;
+import net.minecraft.world.item.ItemStack;
+import net.minecraft.world.item.crafting.RecipeHolder;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.asm.mixin.Final;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+import org.spongepowered.common.bridge.world.item.crafting.PlacementInfoBridge;
+import org.spongepowered.common.item.recipe.book.RecipeBookUtil;
+import org.spongepowered.common.item.recipe.book.SpongeStackedItemContents;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Makes recipe placing to work with sponge custom ingredients.
+ * Fallbacks to the original logic if recipe does not have any custom ingredient.
+ */
+@Mixin(ServerPlaceRecipe.class)
+public abstract class ServerPlaceRecipeMixin {
+
+    @Shadow @Final private Inventory inventory;
+
+    private @Nullable List<ItemStack> impl$stackList;
+
+    @WrapOperation(
+        method = "placeRecipe(Lnet/minecraft/recipebook/ServerPlaceRecipe$CraftingMenuAccess;IILjava/util/List;Ljava/util/List;Lnet/minecraft/world/entity/player/Inventory;Lnet/minecraft/world/item/crafting/RecipeHolder;ZZ)Lnet/minecraft/world/inventory/RecipeBookMenu$PostPlaceAction;",
+        at = @At(
+            value = "NEW",
+            target = "()Lnet/minecraft/world/entity/player/StackedItemContents;"
+        )
+    )
+    private static StackedItemContents impl$useCustomStackedItemContents(
+        final Operation<StackedItemContents> original,
+        final ServerPlaceRecipe.CraftingMenuAccess<?> menu,
+        final int gridWidth, final int gridHeight,
+        final List<Slot> inputGridSlots, final List<Slot> slotsToClear,
+        final Inventory inventory, final RecipeHolder<?> recipe,
+        final boolean useMaxItems, final boolean isCreative
+    ) {
+        return ((PlacementInfoBridge) recipe.value().placementInfo()).bridge$hasCustomIngredients()
+            ? new SpongeStackedItemContents()
+            : original.call();
+    }
+
+    @WrapMethod(method = "placeRecipe(Lnet/minecraft/world/item/crafting/RecipeHolder;Lnet/minecraft/world/entity/player/StackedItemContents;)V")
+    private void impl$handleApplicableStacks(
+        final RecipeHolder<?> recipe, final StackedItemContents contents, final Operation<Void> original
+    ) {
+        if (contents instanceof final SpongeStackedItemContents spongeContents) {
+            this.impl$stackList = new ArrayList<>();
+            // In wrapped method the used output (if not null) is always List<Holder<Item>>::add
+            spongeContents.setStackOutput(this.impl$stackList::add);
+            original.call(recipe, contents);
+            spongeContents.setStackOutput(null);
+            this.impl$stackList = null;
+        } else {
+            original.call(recipe, contents);
+        }
+    }
+
+    @Inject(
+        method = "placeRecipe(Lnet/minecraft/world/item/crafting/RecipeHolder;Lnet/minecraft/world/entity/player/StackedItemContents;)V",
+        at = @At(
+            value = "INVOKE",
+            target = "Ljava/util/List;clear()V"
+        )
+    )
+    private void impl$clearStackList(final CallbackInfo ci) {
+        if (this.impl$stackList != null) {
+            this.impl$stackList.clear();
+        }
+    }
+
+    @WrapOperation(
+        method = "moveItemToGrid",
+        at = @At(
+            value = "INVOKE",
+            target = "Lnet/minecraft/world/entity/player/Inventory;findSlotMatchingCraftingIngredient(Lnet/minecraft/core/Holder;Lnet/minecraft/world/item/ItemStack;)I"
+        )
+    )
+    private int impl$adjustMatchingSlotFinder(
+        final Inventory instance, final Holder<Item> exemplaryItem, final ItemStack craftInputStack, final Operation<Integer> original
+    ) {
+        return this.impl$stackList == null
+            ? original.call(instance, exemplaryItem, craftInputStack)
+            : RecipeBookUtil.findSlotMatchingCraftingIngredient(inventory, this.impl$stackList.removeFirst(), craftInputStack);
+    }
+}