Impl IForgeBlockState.hasTileEntity and createTileEntity (#105)

* Impl IForgeBlockState.hasTileEntity and createTileEntity

* Rename methods

* Update README.MD

* Move blockentity mixins to a separate package

* Add missing @unique

* Readme.md

Author: rikka0w0

patchwork-extensions-block/README.MD

@@ -0,0 +1,52 @@
+# `IForgeBlockState.hasTileEntity` and `IForgeBlockState.createTileEntity`
+We patched all vanilla calls to those two methods so that Forge's blockstate-sensitive handlers can receive blockstate as the parameter. 
+There are around 20 patches in this group:
+```
+* OK net.minecraft.command.arguments.BlockArgumentParser
+* OK net.minecraft.block.entity.HopperBlockEntity
+* OK net.minecraft.block.entity.ChestBlockEntity
+* OK net.minecraft.block.AbstractRedstoneGateBlock (net.minecraft.block.RedstoneDiodeBlock)
+* OK net.minecraft.block.Block
+* OK net.minecraft.block.SpongeBlock
+* OK net.minecraft.block.PistonBlock
+* OK net.minecraft.client.render.chunk.ChunkRenderer (net.minecraft.client.renderer.chunk.ChunkRenderer)
+* OK net.minecraft.client.render.WorldRenderer
+* OK net.minecraft.client.MinecraftClient
+* OK net.minecraft.entity.FallingBlockEntity (net.minecraft.entity.item.FallingBlockEntity)
+* OK net.minecraft.server.world.ChunkHolder (net.minecraft.world.server.ChunkHolder)
+* OK net.minecraft.world.explosion.Explosion (net.minecraft.world.Explosion)
+* OK net.minecraft.world.chunk.WorldChunk (net.minecraft.world.chunk.Chunk)
+* OK net.minecraft.world.ChunkRegion (net.minecraft.world.gen.WorldGenRegion)
+* OK net.minecraft.world.World
+```
+Vanilla uses both `block.hasBlockEntity()` and `block instanceof BlockEntityProvider`, which is considered to be a bad practice. All of these checks are redirected to `BlockContext`.
+`BlockContext.hasBlockEntity(BlockState)` calls the patched `Block.hasBlockEntity()`, which then calls the `IForgeBlock.hasBlockEntity(BlockState)`. 
+`Block.hasBlockEntity()` will attempt to get the blockstate from a ThreadLocal managed by `BlockContext.hasBlockEntity(BlockState)` as the parameter, if the ThreadLocal is not set, 
+the default blockstate of that block will be passed to `IForgeBlock.hasBlockEntity(BlockState)`. 
+__The reason why we did not deprecate the vanilla `block.hasBlockEntity()` is that Fabric mods may call them.__
+
+
+Common patch types are:
+1. For `blockstate.getBlock().hasBlockEntity()` \
+`getBlock()` is redirected to `call BlockContext.hasBlockEntity`, if the test returns true, the mixin method will return a vanilla block which is known to always have BlockEntity, 
+otherwise it will return `Blocks.AIR`.
+1. For `block.hasBlockEntity()` \
+Similar to the previous case, but the blockstate is not directly available here. 
+Either get it from the method args or collect it from the context. \
+The latter requires ThreadLocal variables (called context here), 
+they are collected using a @Injection which captures all local variables visible to the scope. 
+The @Injection mixin set the context, the mixin which does the check consumes and then releases the context.
+__To support potential recursive calling to the mixin target function, the lifespan of the context has to be minimized.__
+1. `block instanceof BlockEntityProvider` \
+These are patched with @ModifyConstant. Some cases also require a ThreadLocal for temporary storing the blockstate. The lifespan rule from the previous case also applies here.
+
+# `IForgeBlockState.isBurning`
+```
+*   net.minecraft.world.World
+```
+
+# `IForgeBlockState.removedByPlayer and canHarvestBlock`
+```
+*   net.minecraft.server.network.ServerPlayerInteractionManager
+*   net.minecraft.client.network.ClientPlayerInteractionManager
+```

patchwork-extensions-block/src/main/java/net/patchworkmc/impl/extensions/block/BlockContext.java

@@ -0,0 +1,127 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.patchworkmc.impl.extensions.block;
+
+import net.minecraftforge.common.extensions.IForgeBlock;
+
+import net.minecraft.block.Block;
+import net.minecraft.block.BlockState;
+import net.minecraft.block.Blocks;
+
+public class BlockContext {
+	private static final ThreadLocal<Object> hasBlockEntity_blockState = createContext();
+
+	//////////////////////////////////////////////////////////////
+	/// Context helper
+	/// Pass parameters without using method args
+	/// Thread safe, but DOES NOT support recursive calls
+	/// It is the caller's responsibility to maintain the context
+	//////////////////////////////////////////////////////////////
+	private static final Object CLEAN_MARKER = new Object();
+
+	public static ThreadLocal<Object> createContext() {
+		return ThreadLocal.withInitial(() -> BlockContext.CLEAN_MARKER);
+	}
+
+	public static void setContext(ThreadLocal<Object> stack, Object value) {
+		Object oldValue = stack.get();
+
+		if (oldValue != CLEAN_MARKER) {
+			throw new IllegalStateException("The context is not clean.");
+		}
+
+		stack.set(value);
+	}
+
+	@SuppressWarnings("unchecked")
+	public static <T> T getContext(ThreadLocal<Object> stack) {
+		Object oldValue = stack.get();
+
+		if (oldValue == CLEAN_MARKER) {
+			throw new IllegalStateException("The context is not set.");
+		}
+
+		return (T) stack.get();
+	}
+
+	@SuppressWarnings("unchecked")
+	public static <T> T getContextOr(ThreadLocal<Object> stack, T defaultValue) {
+		Object value = stack.get();
+
+		if (value == CLEAN_MARKER) {
+			return defaultValue;
+		} else {
+			return (T) value;
+		}
+	}
+
+	@SuppressWarnings("unchecked")
+	public static <T> T releaseContext(ThreadLocal<Object> stack) {
+		Object oldValue = stack.get();
+
+		if (oldValue == CLEAN_MARKER) {
+			throw new IllegalStateException("The context is not set.");
+		}
+
+		stack.set(CLEAN_MARKER);
+
+		return (T) oldValue;
+	}
+
+	///////////////////////////////////////////////////////
+	/// Block.hasBlockEntity()
+	///////////////////////////////////////////////////////
+	/**
+	 * Called by mixin methods.
+	 * @param blockState
+	 * @return
+	 */
+	public static boolean hasBlockEntity(BlockState blockState) {
+		setContext(hasBlockEntity_blockState, blockState);
+		Block block = blockState.getBlock();
+		boolean ret = block.hasBlockEntity();
+		releaseContext(hasBlockEntity_blockState);
+		return ret;
+	}
+
+	/**
+	 * Called by vanilla Block Class, as a wrapper which redirects the call to Forge's BlockState sensitive version.
+	 * @param forgeBlock
+	 * @return
+	 */
+	public static boolean block_hasBlockEntity(IForgeBlock forgeBlock) {
+		BlockState blockState = getContextOr(hasBlockEntity_blockState, forgeBlock.getBlock().getDefaultState());
+
+		return forgeBlock.hasTileEntity(blockState);
+	}
+
+	/**
+	 * Called by mixin methods. The return value is used to pass the vanilla Block.hasBlockEntity or block instanceof BlockEntityProvider.
+	 * @param hasBlockEntity
+	 * @return Blocks.CHEST (Always have a BlockEntity) if hasBlockEntity is true, otherwise Blocks.AIR (impossible to host BlockEntity)
+	 */
+	public static Block hasBlockEntityBlockMarker(boolean hasBlockEntity) {
+		return hasBlockEntity ? Blocks.CHEST : Blocks.AIR;
+	}
+
+	public static Block hasBlockEntityBlockMarker(BlockState blockState) {
+		return hasBlockEntityBlockMarker(hasBlockEntity(blockState));
+	}
+}

patchwork-extensions-block/src/main/java/net/patchworkmc/impl/extensions/block/Signatures.java

@@ -0,0 +1,41 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.patchworkmc.impl.extensions.block;
+
+public class Signatures {
+	public static final String PATCHWORK_YARN_CLS_BLOCKENTITYPROVIDER = "classValue=net/minecraft/block/BlockEntityProvider";
+	public static final String PATCHWORK_REOBF_CLS_BLOCKENTITYPROVIDER = "classValue=net/minecraft/class_2343";
+
+	// Method Signatures
+	public static final String Block_hasBlockEntity = "net/minecraft/block/Block.hasBlockEntity()Z";
+	public static final String BlockState_getBlock = "net/minecraft/block/BlockState.getBlock()Lnet/minecraft/block/Block;";
+	public static final String BlockEntityProvider_createBlockEntity = "net/minecraft/block/BlockEntityProvider.createBlockEntity(Lnet/minecraft/world/BlockView;)Lnet/minecraft/block/entity/BlockEntity;";
+	public static final String Blocks_FIRE = "net/minecraft/block/Blocks.FIRE:Lnet/minecraft/block/Block;";
+	public static final String World_getBlockState = "net/minecraft/world/World.getBlockState(Lnet/minecraft/util/math/BlockPos;)Lnet/minecraft/block/BlockState;";
+	public static final String ServerPlayerInteractionManager_isCreative = "net/minecraft/server/network/ServerPlayerInteractionManager.isCreative()Z";
+	public static final String PlayerEntity_isUsingEffectiveTool = "net/minecraft/entity/player/PlayerEntity.isUsingEffectiveTool(Lnet/minecraft/block/BlockState;)Z";
+	public static final String ServerPlayerEntity_isUsingEffectiveTool = "net/minecraft/server/network/ServerPlayerEntity.isUsingEffectiveTool(Lnet/minecraft/block/BlockState;)Z";
+	public static final String Block_onBreak = "net/minecraft/block/Block.onBreak(Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;Lnet/minecraft/entity/player/PlayerEntity;)V";
+	public static final String ServerWorld_removeBlock = "net/minecraft/server/world/ServerWorld.removeBlock(Lnet/minecraft/util/math/BlockPos;Z)Z";
+	public static final String Block_onBroken = "net/minecraft/block/Block.onBroken(Lnet/minecraft/world/IWorld;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;)V";
+	public static final String ItemStack_postMine = "net/minecraft/item/ItemStack.postMine(Lnet/minecraft/world/World;Lnet/minecraft/block/BlockState;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/player/PlayerEntity;)V";
+	public static final String Block_afterBreak = "net/minecraft/block/Block.afterBreak(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;Lnet/minecraft/block/entity/BlockEntity;Lnet/minecraft/item/ItemStack;)V";
+	public static final String World_setBlockState = "net/minecraft/world/World.setBlockState(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;I)Z";
+}

patchwork-extensions-block/src/main/java/net/patchworkmc/mixin/extensions/block/blockentity/MixinAbstractRedstoneGateBlock.java

@@ -0,0 +1,40 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.patchworkmc.mixin.extensions.block.blockentity;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Redirect;
+
+import net.minecraft.block.AbstractRedstoneGateBlock;
+import net.minecraft.block.Block;
+import net.minecraft.block.BlockState;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.world.World;
+
+import net.patchworkmc.impl.extensions.block.BlockContext;
+
+@Mixin(AbstractRedstoneGateBlock.class)
+public abstract class MixinAbstractRedstoneGateBlock {
+	@Redirect(method = "neighborUpdate", at = @At(value = "INVOKE", target = "net/minecraft/block/AbstractRedstoneGateBlock.hasBlockEntity()Z", ordinal = 0))
+	private boolean patchwork_neighborUpdate_hasBlockEntity(AbstractRedstoneGateBlock dummy, BlockState state, World world, BlockPos pos, Block block, BlockPos neighborPos, boolean moved) {
+		return BlockContext.hasBlockEntity(state);
+	}
+}

patchwork-extensions-block/src/main/java/net/patchworkmc/mixin/extensions/block/blockentity/MixinBlock.java

@@ -0,0 +1,38 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.patchworkmc.mixin.extensions.block.blockentity;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+import net.minecraftforge.common.extensions.IForgeBlock;
+
+import net.minecraft.block.Block;
+
+import net.patchworkmc.impl.extensions.block.BlockContext;
+
+@Mixin(Block.class)
+public abstract class MixinBlock {
+	@Inject(method = "hasBlockEntity", at = @At("RETURN"), cancellable = true)
+	public void patchwork_hasBlockEntity(CallbackInfoReturnable<Boolean> info) {
+		info.setReturnValue(BlockContext.block_hasBlockEntity((IForgeBlock) this));
+	}
+}

patchwork-extensions-block/src/main/java/net/patchworkmc/mixin/extensions/block/blockentity/MixinBlockArgumentParser.java

@@ -0,0 +1,65 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.patchworkmc.mixin.extensions.block.blockentity;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Redirect;
+
+import net.minecraft.block.Block;
+import net.minecraft.block.BlockState;
+import net.minecraft.command.arguments.BlockArgumentParser;
+
+import net.patchworkmc.impl.extensions.block.BlockContext;
+import net.patchworkmc.impl.extensions.block.Signatures;
+
+@Mixin(BlockArgumentParser.class)
+public abstract class MixinBlockArgumentParser {
+	// First occurrence: return this.blockState.getBlock().hasBlockEntity();
+	@Redirect(method = "suggestSnbtOrBlockProperties", at = @At(value = "INVOKE", target = Signatures.Block_hasBlockEntity, ordinal = 0))
+	private boolean patchwork_suggestSnbtOrBlockProperties_hasBlockEntity(Block dummy) {
+		BlockArgumentParser me = (BlockArgumentParser) (Object) this;
+		BlockState blockState = me.getBlockState();
+		return BlockContext.hasBlockEntity(blockState);
+	}
+
+	// First occurrence: return this.blockState.getBlock().hasBlockEntity();
+	@Redirect(method = "hasBlockEntity()Z", at = @At(value = "INVOKE", target = Signatures.Block_hasBlockEntity, ordinal = 0))
+	private boolean patchwork_hasBlockEntity_hasBlockEntity(Block dummy) {
+		BlockArgumentParser me = (BlockArgumentParser) (Object) this;
+		BlockState blockState = me.getBlockState();
+		return BlockContext.hasBlockEntity(blockState);
+	}
+
+	// Second occurrence in BlockArgumentParser.hasBlockEntity()Z
+	// while(var2.hasNext()) {
+	//     Block block = (Block)var2.next();
+	//     if (block.hasBlockEntity()) return true;
+	// }
+	//
+	// Forge's patch:
+	// - if (block.getDefaultState().hasTileEntity()) {
+	// + if (block.hasBlockEntity()) {
+	//
+	// We leave it unpatched and the behavior is identical
+
+	// First occurrence in private CompletableFuture<Suggestions> suggestSnbtOrTagProperties(SuggestionsBuilder suggestionsBuilder)
+	// We leave it unpatched and the behavior is identical
+}