From 6278e4d5752e68927d4efd172ff76b6b68acfb7c Mon Sep 17 00:00:00 2001 From: Alexdoru <57050655+Alexdoru@users.noreply.github.com> Date: Sat, 28 Jun 2025 17:58:51 +0200 Subject: [PATCH] [Memory-opti:fix leak] Fix WorldClient leak in WailaTickHandler and RayTracing (#31) Co-authored-by: Martin Robertz --- src/main/java/mcp/mobius/waila/Waila.java | 3 +- .../mcp/mobius/waila/client/KeyEvent.java | 12 + .../mcp/mobius/waila/client/ProxyClient.java | 4 +- .../mobius/waila/overlay/OverlayRenderer.java | 29 +-- .../mcp/mobius/waila/overlay/RayTracing.java | 13 +- .../waila/overlay/WailaTickHandler.java | 219 ++++++++---------- 6 files changed, 127 insertions(+), 153 deletions(-) diff --git a/src/main/java/mcp/mobius/waila/Waila.java b/src/main/java/mcp/mobius/waila/Waila.java index 2b6a6e1..0bb8cd1 100644 --- a/src/main/java/mcp/mobius/waila/Waila.java +++ b/src/main/java/mcp/mobius/waila/Waila.java @@ -79,8 +79,7 @@ public class Waila { if (FMLCommonHandler.instance().getEffectiveSide() == Side.CLIENT) { MinecraftForge.EVENT_BUS.register(new DecoratorRenderer()); FMLCommonHandler.instance().bus().register(new KeyEvent()); - FMLCommonHandler.instance().bus().register(WailaTickHandler.instance()); - + FMLCommonHandler.instance().bus().register(new WailaTickHandler()); } FMLCommonHandler.instance().bus().register(new NetworkHandler()); } diff --git a/src/main/java/mcp/mobius/waila/client/KeyEvent.java b/src/main/java/mcp/mobius/waila/client/KeyEvent.java index e23a548..b1e593b 100644 --- a/src/main/java/mcp/mobius/waila/client/KeyEvent.java +++ b/src/main/java/mcp/mobius/waila/client/KeyEvent.java @@ -10,6 +10,7 @@ import cpw.mods.fml.client.registry.ClientRegistry; import cpw.mods.fml.common.Loader; import cpw.mods.fml.common.eventhandler.SubscribeEvent; import cpw.mods.fml.common.gameevent.InputEvent.KeyInputEvent; +import cpw.mods.fml.common.gameevent.TickEvent; import mcp.mobius.waila.api.impl.ConfigHandler; import mcp.mobius.waila.gui.screens.config.ScreenConfig; import mcp.mobius.waila.handlers.nei.NEIHandler; @@ -70,4 +71,15 @@ public class KeyEvent { } } + @SubscribeEvent + public void tickClient(TickEvent.ClientTickEvent event) { + if (event.phase == TickEvent.Phase.START) return; + if (!KeyEvent.key_show.getIsKeyPressed() + && !ConfigHandler.instance().getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_MODE, false) + && ConfigHandler.instance() + .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHOW, false)) { + ConfigHandler.instance().setConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHOW, false); + } + } + } diff --git a/src/main/java/mcp/mobius/waila/client/ProxyClient.java b/src/main/java/mcp/mobius/waila/client/ProxyClient.java index 8cda936..100f4ed 100644 --- a/src/main/java/mcp/mobius/waila/client/ProxyClient.java +++ b/src/main/java/mcp/mobius/waila/client/ProxyClient.java @@ -68,7 +68,9 @@ public class ProxyClient extends ProxyServer { @SubscribeEvent public void onWorldUnload(WorldEvent.Unload event) { - DataAccessorCommon.instance = new DataAccessorCommon(); + if (event.world.isRemote) { + DataAccessorCommon.instance = new DataAccessorCommon(); + } } } } diff --git a/src/main/java/mcp/mobius/waila/overlay/OverlayRenderer.java b/src/main/java/mcp/mobius/waila/overlay/OverlayRenderer.java index a597ed8..86a9b94 100644 --- a/src/main/java/mcp/mobius/waila/overlay/OverlayRenderer.java +++ b/src/main/java/mcp/mobius/waila/overlay/OverlayRenderer.java @@ -11,16 +11,11 @@ import mcp.mobius.waila.api.impl.ConfigHandler; public class OverlayRenderer { - protected static boolean hasBlending; - protected static boolean hasLight; - protected static boolean hasDepthTest; - protected static boolean hasLight0; - protected static boolean hasLight1; - protected static boolean hasRescaleNormal; - protected static boolean hasColorMaterial; - protected static int boundTexIndex; + private static boolean hasBlending; + private static boolean hasDepthTest; + private static int boundTexIndex; - public static void renderOverlay() { + public static void renderOverlay(Tooltip tooltip) { Minecraft mc = Minecraft.getMinecraft(); if (!(mc.currentScreen == null && mc.theWorld != null && Minecraft.isGuiEnabled() @@ -31,16 +26,16 @@ public class OverlayRenderer { if (RayTracing.instance().getTarget().typeOfHit == MovingObjectPosition.MovingObjectType.BLOCK && RayTracing.instance().getTargetStack() != null) { - renderOverlay(WailaTickHandler.instance().tooltip); + doRenderOverlay(tooltip); } if (RayTracing.instance().getTarget().typeOfHit == MovingObjectPosition.MovingObjectType.ENTITY && ConfigHandler.instance().getConfig("general.showents")) { - renderOverlay(WailaTickHandler.instance().tooltip); + doRenderOverlay(tooltip); } } - public static void renderOverlay(Tooltip tooltip) { + private static void doRenderOverlay(Tooltip tooltip) { GL11.glPushMatrix(); saveGLState(); @@ -80,26 +75,23 @@ public class OverlayRenderer { } - public static void saveGLState() { + private static void saveGLState() { hasBlending = GL11.glGetBoolean(GL11.GL_BLEND); - hasLight = GL11.glGetBoolean(GL11.GL_LIGHTING); hasDepthTest = GL11.glGetBoolean(GL11.GL_DEPTH_TEST); boundTexIndex = GL11.glGetInteger(GL11.GL_TEXTURE_BINDING_2D); GL11.glPushAttrib(GL11.GL_CURRENT_BIT); } - public static void loadGLState() { + private static void loadGLState() { if (hasBlending) GL11.glEnable(GL11.GL_BLEND); else GL11.glDisable(GL11.GL_BLEND); - if (hasLight1) GL11.glEnable(GL11.GL_LIGHT1); - else GL11.glDisable(GL11.GL_LIGHT1); if (hasDepthTest) GL11.glEnable(GL11.GL_DEPTH_TEST); else GL11.glDisable(GL11.GL_DEPTH_TEST); GL11.glBindTexture(GL11.GL_TEXTURE_2D, boundTexIndex); GL11.glPopAttrib(); } - public static void drawTooltipBox(int x, int y, int w, int h, int bg, int grad1, int grad2) { + private static void drawTooltipBox(int x, int y, int w, int h, int bg, int grad1, int grad2) { DisplayUtil.drawGradientRect(x + 1, y, w - 1, 1, bg, bg); DisplayUtil.drawGradientRect(x + 1, y + h, w - 1, 1, bg, bg); DisplayUtil.drawGradientRect(x + 1, y + 1, w - 1, h - 1, bg, bg);// center @@ -107,7 +99,6 @@ public class OverlayRenderer { DisplayUtil.drawGradientRect(x + w, y + 1, 1, h - 1, bg, bg); DisplayUtil.drawGradientRect(x + 1, y + 2, 1, h - 3, grad1, grad2); DisplayUtil.drawGradientRect(x + w - 1, y + 2, 1, h - 3, grad1, grad2); - DisplayUtil.drawGradientRect(x + 1, y + 1, w - 1, 1, grad1, grad1); DisplayUtil.drawGradientRect(x + 1, y + h - 1, w - 1, 1, grad2, grad2); } diff --git a/src/main/java/mcp/mobius/waila/overlay/RayTracing.java b/src/main/java/mcp/mobius/waila/overlay/RayTracing.java index 175010f..3a33687 100644 --- a/src/main/java/mcp/mobius/waila/overlay/RayTracing.java +++ b/src/main/java/mcp/mobius/waila/overlay/RayTracing.java @@ -26,6 +26,7 @@ import mcp.mobius.waila.utils.Constants; public class RayTracing { + private MovingObjectPosition target = null; private static RayTracing _instance; private RayTracing() {} @@ -35,22 +36,22 @@ public class RayTracing { return _instance; } - private MovingObjectPosition target = null; - private final Minecraft mc = Minecraft.getMinecraft(); - public void fire() { + final Minecraft mc = Minecraft.getMinecraft(); if (mc.objectMouseOver != null && mc.objectMouseOver.typeOfHit == MovingObjectPosition.MovingObjectType.ENTITY && !shouldHidePlayer(mc.objectMouseOver.entityHit)) { this.target = mc.objectMouseOver; return; } - EntityLivingBase viewpoint = mc.renderViewEntity; if (viewpoint == null) return; - this.target = this.rayTrace(viewpoint, mc.playerController.getBlockReachDistance(), 0); } + public void clear() { + target = null; + } + private static boolean shouldHidePlayer(Entity targetEnt) { // Check if entity is player with invisibility effect if (targetEnt instanceof EntityPlayer thePlayer) { @@ -116,7 +117,7 @@ public class RayTracing { if (this.target == null) return items; - World world = mc.theWorld; + World world = Minecraft.getMinecraft().theWorld; int x = this.target.blockX; int y = this.target.blockY; diff --git a/src/main/java/mcp/mobius/waila/overlay/WailaTickHandler.java b/src/main/java/mcp/mobius/waila/overlay/WailaTickHandler.java index 5a32d05..ba7733b 100644 --- a/src/main/java/mcp/mobius/waila/overlay/WailaTickHandler.java +++ b/src/main/java/mcp/mobius/waila/overlay/WailaTickHandler.java @@ -12,169 +12,138 @@ import net.minecraft.util.MovingObjectPosition; import net.minecraft.world.World; import net.minecraftforge.common.config.Configuration; -import org.lwjgl.input.Keyboard; - import cpw.mods.fml.common.eventhandler.SubscribeEvent; import cpw.mods.fml.common.gameevent.TickEvent; -import cpw.mods.fml.relauncher.Side; -import cpw.mods.fml.relauncher.SideOnly; import mcp.mobius.waila.api.impl.ConfigHandler; import mcp.mobius.waila.api.impl.DataAccessorCommon; import mcp.mobius.waila.api.impl.MetaDataProvider; import mcp.mobius.waila.api.impl.TipList; import mcp.mobius.waila.cbcore.Layout; -import mcp.mobius.waila.client.KeyEvent; import mcp.mobius.waila.utils.Constants; public class WailaTickHandler { - public Tooltip tooltip = null; - public MetaDataProvider handler = new MetaDataProvider(); - private final Minecraft mc = Minecraft.getMinecraft(); - - private static WailaTickHandler _instance; - - private WailaTickHandler() {} - - public static WailaTickHandler instance() { - if (_instance == null) _instance = new WailaTickHandler(); - return _instance; - } + private Tooltip tooltip = null; + private final MetaDataProvider handler = new MetaDataProvider(); @SubscribeEvent - @SideOnly(Side.CLIENT) public void tickRender(TickEvent.RenderTickEvent event) { if (event.phase == TickEvent.Phase.END) { - OverlayRenderer.renderOverlay(); + OverlayRenderer.renderOverlay(tooltip); } } @SubscribeEvent - @SideOnly(Side.CLIENT) public void tickClient(TickEvent.ClientTickEvent event) { if (event.phase == TickEvent.Phase.START) return; - if (!Keyboard.isKeyDown(KeyEvent.key_show.getKeyCode()) - && !ConfigHandler.instance().getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_MODE, false) - && ConfigHandler.instance() - .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHOW, false)) { - ConfigHandler.instance().setConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHOW, false); - } - + Minecraft mc = Minecraft.getMinecraft(); World world = mc.theWorld; EntityPlayer player = mc.thePlayer; - if (world != null && player != null) { - RayTracing.instance().fire(); - MovingObjectPosition target = RayTracing.instance().getTarget(); + if (world == null || player == null) { + this.tooltip = null; + RayTracing.instance().clear(); + return; + } - List currenttip; - List currenttipHead; - List currenttipBody; - List currenttipTail; - if (target != null && target.typeOfHit == MovingObjectPosition.MovingObjectType.BLOCK) { - DataAccessorCommon accessor = DataAccessorCommon.instance; - accessor.set(world, player, target); - ItemStack targetStack = RayTracing.instance().getTargetStack(); // Here we get either the proper stack - // or the override + RayTracing.instance().fire(); + MovingObjectPosition target = RayTracing.instance().getTarget(); - if (targetStack != null) { - currenttip = new TipList(); - currenttipHead = new TipList(); - currenttipBody = new TipList(); - currenttipTail = new TipList(); + List currenttip; + List currenttipHead; + List currenttipBody; + List currenttipTail; + if (target != null && target.typeOfHit == MovingObjectPosition.MovingObjectType.BLOCK) { + DataAccessorCommon accessor = DataAccessorCommon.instance; + accessor.set(world, player, target); + ItemStack targetStack = RayTracing.instance().getTargetStack(); // Here we get either the proper stack + // or the override - currenttipHead = handler.handleBlockTextData( - targetStack, - world, - player, - target, - accessor, - currenttipHead, - Layout.HEADER); - currenttipBody = handler.handleBlockTextData( - targetStack, - world, - player, - target, - accessor, - currenttipBody, - Layout.BODY); - currenttipTail = handler.handleBlockTextData( - targetStack, - world, - player, - target, - accessor, - currenttipTail, - Layout.FOOTER); + if (targetStack != null) { + currenttip = new TipList(); + currenttipHead = new TipList(); + currenttipBody = new TipList(); + currenttipTail = new TipList(); - if (ConfigHandler.instance() - .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHIFTBLOCK, false) - && !currenttipBody.isEmpty() - && !accessor.getPlayer().isSneaking()) { - currenttipBody.clear(); - currenttipBody.add(ITALIC + "Press shift for more data"); - } + currenttipHead = handler.handleBlockTextData( + targetStack, + world, + player, + target, + accessor, + currenttipHead, + Layout.HEADER); + currenttipBody = handler + .handleBlockTextData(targetStack, world, player, target, accessor, currenttipBody, Layout.BODY); + currenttipTail = handler.handleBlockTextData( + targetStack, + world, + player, + target, + accessor, + currenttipTail, + Layout.FOOTER); - currenttip.addAll(currenttipHead); - currenttip.addAll(currenttipBody); - currenttip.addAll(currenttipTail); - - this.tooltip = new Tooltip(currenttip, targetStack); + if (ConfigHandler.instance() + .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHIFTBLOCK, false) + && !currenttipBody.isEmpty() + && !accessor.getPlayer().isSneaking()) { + currenttipBody.clear(); + currenttipBody.add(ITALIC + "Press shift for more data"); } - } else if (target != null && target.typeOfHit == MovingObjectPosition.MovingObjectType.ENTITY) { - DataAccessorCommon accessor = DataAccessorCommon.instance; - accessor.set(world, player, target); - Entity targetEnt = RayTracing.instance().getTargetEntity(); // This need to be replaced by the override - // check. + currenttip.addAll(currenttipHead); + currenttip.addAll(currenttipBody); + currenttip.addAll(currenttipTail); - if (targetEnt != null) { - currenttip = new TipList(); - currenttipHead = new TipList(); - currenttipBody = new TipList(); - currenttipTail = new TipList(); + this.tooltip = new Tooltip(currenttip, targetStack); + } + } else if (target != null && target.typeOfHit == MovingObjectPosition.MovingObjectType.ENTITY) { + DataAccessorCommon accessor = DataAccessorCommon.instance; + accessor.set(world, player, target); - currenttipHead = handler.handleEntityTextData( - targetEnt, - world, - player, - target, - accessor, - currenttipHead, - Layout.HEADER); - currenttipBody = handler.handleEntityTextData( - targetEnt, - world, - player, - target, - accessor, - currenttipBody, - Layout.BODY); - currenttipTail = handler.handleEntityTextData( - targetEnt, - world, - player, - target, - accessor, - currenttipTail, - Layout.FOOTER); + Entity targetEnt = RayTracing.instance().getTargetEntity(); // This need to be replaced by the override + // check. - if (ConfigHandler.instance() - .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHIFTENTS, false) - && !currenttipBody.isEmpty() - && !accessor.getPlayer().isSneaking()) { - currenttipBody.clear(); - currenttipBody.add(ITALIC + "Press shift for more data"); - } + if (targetEnt != null) { + currenttip = new TipList(); + currenttipHead = new TipList(); + currenttipBody = new TipList(); + currenttipTail = new TipList(); - currenttip.addAll(currenttipHead); - currenttip.addAll(currenttipBody); - currenttip.addAll(currenttipTail); + currenttipHead = handler.handleEntityTextData( + targetEnt, + world, + player, + target, + accessor, + currenttipHead, + Layout.HEADER); + currenttipBody = handler + .handleEntityTextData(targetEnt, world, player, target, accessor, currenttipBody, Layout.BODY); + currenttipTail = handler.handleEntityTextData( + targetEnt, + world, + player, + target, + accessor, + currenttipTail, + Layout.FOOTER); - this.tooltip = new Tooltip(currenttip, false); + if (ConfigHandler.instance() + .getConfig(Configuration.CATEGORY_GENERAL, Constants.CFG_WAILA_SHIFTENTS, false) + && !currenttipBody.isEmpty() + && !accessor.getPlayer().isSneaking()) { + currenttipBody.clear(); + currenttipBody.add(ITALIC + "Press shift for more data"); } + + currenttip.addAll(currenttipHead); + currenttip.addAll(currenttipBody); + currenttip.addAll(currenttipTail); + + this.tooltip = new Tooltip(currenttip, false); } }