Impl Forge's selective resource reloader (#107)

* Implement ISelectiveResourceReloadListener

* Add other ResourceTypes, add readme, remove patchwork-fml dependency

* Apply suggestions from code review

Co-authored-by: Glitch <glitchieproductionsofficial@gmail.com>

* Made lambda injection working by disabling remap

* Fix json indentation

* Update patchwork-resource/src/main/java/net/patchworkmc/mixin/resource/MixinLanguageOptionsScreen.java

Co-authored-by: Glitch <glitchieproductionsofficial@gmail.com>

Co-authored-by: Glitch <glitchieproductionsofficial@gmail.com>

Author: rikka0w0

patchwork-resource/build.gradle

@@ -0,0 +1,2 @@
+archivesBaseName = "patchwork-resource"
+version = getSubprojectVersion(project, "0.1.0")

patchwork-resource/readme.md

@@ -0,0 +1,11 @@
+This module contains Forge's "Selective Resource Reload Listener" (`ISelectiveResourceReloadListener`), which is used by Forge mods and Forge itself.
+
+
+The ISelectiveResourceReloadListener is designed to reload only specific resources to save time. 
+However, Forge's vanilla patches are not finished yet; vanilla in-game reloading still reloads everything. 
+For example, when you switch the Gui language, it also reloads sounds and models which is considered to be surplus.
+`ISelectiveResourceReloadListener` of Forge mods and Forge itself handles selective resource reloading correctly.
+
+__This feature is toggleable in Forge, which indicates that Forge mods and Forge itself should be able to reload everything flawlessly in both cases.__
+
+In Patchwork, we don't change the vanilla behavior and all reloads are not selective, at least for now, or until Forge implements this properly.

patchwork-resource/src/main/java/net/minecraftforge/resource/IResourceType.java

@@ -0,0 +1,26 @@
+/*
+ * 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.minecraftforge.resource;
+
+/**
+ * Represents a generic type of reloadable resource. Used for resource reload filtering.
+ */
+public interface IResourceType {
+}

patchwork-resource/src/main/java/net/minecraftforge/resource/ISelectiveResourceReloadListener.java

@@ -0,0 +1,45 @@
+/*
+ * 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.minecraftforge.resource;
+
+import java.util.function.Predicate;
+
+import net.minecraft.resource.ResourceManager;
+import net.minecraft.resource.SynchronousResourceReloadListener;
+
+public interface ISelectiveResourceReloadListener extends SynchronousResourceReloadListener {
+	@Override
+	default void apply(ResourceManager resourceManager) {
+		// For compatibility, call the selective version from the non-selective function
+		onResourceManagerReload(resourceManager, SelectiveReloadStateHandler.INSTANCE.get());
+	}
+
+	/**
+	 * A version of onResourceManager that selectively chooses
+	 * {@link net.minecraftforge.resource.IResourceType}s to reload. When using
+	 * this, the given predicate should be called to ensure the relevant resources
+	 * should be reloaded at this time.
+	 *
+	 * @param resourceManager   the resource manager being reloaded
+	 * @param resourcePredicate predicate to test whether any given resource type
+	 *                          should be reloaded
+	 */
+	void onResourceManagerReload(ResourceManager resourceManager, Predicate<IResourceType> resourcePredicate);
+}

patchwork-resource/src/main/java/net/minecraftforge/resource/ReloadRequirements.java

@@ -0,0 +1,52 @@
+/*
+ * 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.minecraftforge.resource;
+
+import java.util.Set;
+import java.util.function.Predicate;
+
+import com.google.common.collect.Sets;
+
+import net.fabricmc.api.EnvType;
+import net.fabricmc.api.Environment;
+
+@Environment(EnvType.CLIENT)
+public final class ReloadRequirements {
+	/**
+	 * Creates a reload predicate accepting all resource types.
+	 *
+	 * @return a predicate accepting all types
+	 */
+	public static Predicate<IResourceType> all() {
+		return type -> true;
+	}
+
+	/**
+	 * Creates an inclusive reload predicate. Only given resource types will be
+	 * loaded along with this.
+	 *
+	 * @param inclusion the set of resource types to be included in the reload
+	 * @return an inclusion predicate based on the given types
+	 */
+	public static Predicate<IResourceType> include(IResourceType... inclusion) {
+		Set<IResourceType> inclusionSet = Sets.newHashSet(inclusion);
+		return inclusionSet::contains;
+	}
+}

patchwork-resource/src/main/java/net/minecraftforge/resource/SelectiveReloadStateHandler.java

@@ -0,0 +1,83 @@
+/*
+ * 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.minecraftforge.resource;
+
+import java.util.function.Predicate;
+
+import javax.annotation.Nullable;
+
+import net.minecraft.resource.SynchronousResourceReloadListener;
+//import net.minecraftforge.common.ForgeConfig;
+import net.patchworkmc.impl.resource.TypedResourceLoader;
+
+/**
+ * Handles reload parameters for selective loaders.
+ */
+public enum SelectiveReloadStateHandler {
+	INSTANCE;
+
+	@Nullable
+	private Predicate<IResourceType> currentPredicate = null;
+
+	/**
+	 * Pushes a resource type predicate for the current reload. Should only be
+	 * called when initiating a resource reload. If a reload is already in progress
+	 * when this is called, an exception will be thrown.
+	 *
+	 * @param resourcePredicate the resource requirement predicate for the current
+	 *                          reload
+	 */
+	public void beginReload(Predicate<IResourceType> resourcePredicate) {
+		if (this.currentPredicate != null) {
+			throw new IllegalStateException("Recursive resource reloading detected");
+		}
+
+		this.currentPredicate = resourcePredicate;
+	}
+
+	/**
+	 * Gets the current reload resource predicate for the initiated reload.
+	 *
+	 * @return the active reload resource predicate, or an accepting one if none in
+	 *         progress
+	 */
+	public Predicate<IResourceType> get() {
+		if (this.currentPredicate == null) { // || !ForgeConfig.CLIENT.selectiveResourceReloadEnabled.get()) {
+			return ReloadRequirements.all();
+		}
+
+		return this.currentPredicate;
+	}
+
+	/**
+	 * Finishes the current reload and deletes the previously added reload
+	 * predicate.
+	 */
+	public void endReload() {
+		this.currentPredicate = null;
+	}
+
+	// Helpder function for testing if vanilla listeners should reload.
+	public boolean test(SynchronousResourceReloadListener listener) {
+		IResourceType type = listener instanceof TypedResourceLoader
+				? ((TypedResourceLoader) listener).getResourceType() : null;
+		return type == null || get() == null || get().test(type);
+	}
+}

patchwork-resource/src/main/java/net/minecraftforge/resource/VanillaResourceType.java

@@ -0,0 +1,54 @@
+/*
+ * 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.minecraftforge.resource;
+
+/**
+ * An enum of all {@link IResourceType}s used by the Vanilla game. These should
+ * be used if handling vanilla-related resources.
+ */
+public enum VanillaResourceType implements IResourceType {
+	/**
+	 * Used when block and item models are reloaded and rebaked. This also includes
+	 * the texture-stitching from that phase.
+	 */
+	MODELS,
+
+	/**
+	 * Used when textures from the
+	 * {@link net.minecraft.client.renderer.texture.TextureManager} are reloaded.
+	 * Does not effect block or item textures on the texture atlas.
+	 */
+	TEXTURES,
+
+	/**
+	 * Used when all game sounds are reloaded.
+	 */
+	SOUNDS,
+
+	/**
+	 * Used when the current language is reloaded.
+	 */
+	LANGUAGES,
+
+	/**
+	 * Used when all shaders are reloaded.
+	 */
+	SHADERS,
+}

patchwork-resource/src/main/java/net/patchworkmc/impl/resource/TypedResourceLoader.java

@@ -0,0 +1,52 @@
+/*
+ * 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.resource;
+
+import java.util.concurrent.CompletableFuture;
+
+import javax.annotation.Nullable;
+
+import net.minecraftforge.resource.IResourceType;
+import net.minecraftforge.resource.ReloadRequirements;
+import net.minecraftforge.resource.SelectiveReloadStateHandler;
+import net.minecraftforge.resource.VanillaResourceType;
+
+import net.minecraft.client.MinecraftClient;
+
+public interface TypedResourceLoader {
+	default IResourceType getResourceType() {
+		return null;
+	}
+
+	/**
+	 * Called by vanilla hooks and ForgeHooksClient.
+	 */
+	static CompletableFuture<Void> patchwork$refreshResources(MinecraftClient mc, VanillaResourceType... types) {
+		SelectiveReloadStateHandler.INSTANCE.beginReload(ReloadRequirements.include(types));
+		CompletableFuture<Void> ret = mc.reloadResources();
+		SelectiveReloadStateHandler.INSTANCE.endReload();
+		return ret;
+	}
+
+	@Nullable
+	static IResourceType patchwork$getResourceType(Object obj) {
+		return obj instanceof TypedResourceLoader ? ((TypedResourceLoader) obj).getResourceType() : null;
+	}
+}

patchwork-resource/src/main/java/net/patchworkmc/mixin/resource/MixinBakedModelManager.java

@@ -0,0 +1,36 @@
+/*
+ * 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.resource;
+
+import org.spongepowered.asm.mixin.Mixin;
+import net.minecraftforge.resource.IResourceType;
+import net.minecraftforge.resource.VanillaResourceType;
+
+import net.minecraft.client.render.model.BakedModelManager;
+
+import net.patchworkmc.impl.resource.TypedResourceLoader;
+
+@Mixin(BakedModelManager.class)
+public abstract class MixinBakedModelManager implements TypedResourceLoader {
+	@Override
+	public IResourceType getResourceType() {
+		return VanillaResourceType.MODELS;
+	}
+}