Tidy the inventory summary merge and drop unused params

.github/workflows/build-and-test.yml

@@ -3,9 +3,9 @@ name: Build and test
 
 on:
   pull_request:
-    branches: [ master, main, release/** ]
+    branches: [ master, main ]
   push:
-    branches: [ master, main, release/** ]
+    branches: [ master, main ]
 
 jobs:
   build-and-test:

src/main/java/mcp/mobius/waila/api/impl/DataAccessorCommon.java

@@ -17,6 +17,7 @@ import cpw.mods.fml.common.registry.GameData;
 import mcp.mobius.waila.api.IWailaCommonAccessor;
 import mcp.mobius.waila.api.IWailaDataAccessor;
 import mcp.mobius.waila.api.IWailaEntityAccessor;
+import mcp.mobius.waila.handlers.HUDHandlerInventory;
 import mcp.mobius.waila.utils.NBTUtil;
 
 public class DataAccessorCommon implements IWailaCommonAccessor, IWailaDataAccessor, IWailaEntityAccessor {
@@ -123,9 +124,23 @@ public class DataAccessorCommon implements IWailaCommonAccessor, IWailaDataAcces
 
     @Override
     public NBTTagCompound getNBTData() {
-        if ((this.tileEntity != null) && this.isTagCorrectTileEntity(this.remoteNbt)) return remoteNbt;
+        if ((this.tileEntity != null) && this.isTagCorrectTileEntity(this.remoteNbt)) {
+            if (!remoteNbt.getBoolean(HUDHandlerInventory.TAG_SUMMARY_ONLY)) return remoteNbt;
+            NBTTagCompound tag = new NBTTagCompound();
+            try {
+                this.tileEntity.writeToNBT(tag);
+            } catch (Exception ignored) {}
+            return HUDHandlerInventory.mergeSummary(remoteNbt, tag);
+        }
 
-        if ((this.entity != null) && this.isTagCorrectEntity(this.remoteNbt)) return remoteNbt;
+        if ((this.entity != null) && this.isTagCorrectEntity(this.remoteNbt)) {
+            if (!remoteNbt.getBoolean(HUDHandlerInventory.TAG_SUMMARY_ONLY)) return remoteNbt;
+            NBTTagCompound tag = new NBTTagCompound();
+            try {
+                this.entity.writeToNBT(tag);
+            } catch (Exception ignored) {}
+            return HUDHandlerInventory.mergeSummary(remoteNbt, tag);
+        }
 
         if (this.tileEntity != null) {
             NBTTagCompound tag = new NBTTagCompound();

src/main/java/mcp/mobius/waila/api/impl/MetaDataProvider.java

@@ -21,6 +21,7 @@ import mcp.mobius.waila.api.IWailaEntityProvider;
 import mcp.mobius.waila.cbcore.LangUtil;
 import mcp.mobius.waila.cbcore.Layout;
 import mcp.mobius.waila.client.KeyEvent;
+import mcp.mobius.waila.handlers.HUDHandlerInventory;
 import mcp.mobius.waila.network.Message0x01TERequest;
 import mcp.mobius.waila.network.Message0x03EntRequest;
 import mcp.mobius.waila.network.WailaPacketHandler;
@@ -80,7 +81,8 @@ public class MetaDataProvider {
                 keys.addAll(ModuleRegistrar.instance().getSyncedNBTKeys(accessor.getTileEntity()));
 
             if (!keys.isEmpty() || ModuleRegistrar.instance().hasNBTProviders(block)
-                    || ModuleRegistrar.instance().hasNBTProviders(accessor.getTileEntity()))
+                    || ModuleRegistrar.instance().hasNBTProviders(accessor.getTileEntity())
+                    || HUDHandlerInventory.shouldRequest(accessor.getTileEntity()))
                 WailaPacketHandler.INSTANCE.sendToServer(new Message0x01TERequest(accessor.getTileEntity(), keys));
 
         } else if (accessor.getTileEntity() != null && !Waila.instance.serverPresent
@@ -193,7 +195,8 @@ public class MetaDataProvider {
             if (ModuleRegistrar.instance().hasSyncedNBTKeys(accessor.getEntity()))
                 keys.addAll(ModuleRegistrar.instance().getSyncedNBTKeys(accessor.getEntity()));
 
-            if (!keys.isEmpty() || ModuleRegistrar.instance().hasNBTEntityProviders(accessor.getEntity()))
+            if (!keys.isEmpty() || ModuleRegistrar.instance().hasNBTEntityProviders(accessor.getEntity())
+                    || HUDHandlerInventory.shouldRequest(accessor.getEntity()))
                 WailaPacketHandler.INSTANCE.sendToServer(new Message0x03EntRequest(accessor.getEntity(), keys));
 
         } else if (accessor.getEntity() != null && !Waila.instance.serverPresent && accessor.isTimeElapsed(250)) {

src/main/java/mcp/mobius/waila/handlers/HUDHandlerInventory.java

@@ -0,0 +1,175 @@
+package mcp.mobius.waila.handlers;
+
+import java.util.List;
+
+import net.minecraft.entity.Entity;
+import net.minecraft.entity.player.EntityPlayerMP;
+import net.minecraft.inventory.IInventory;
+import net.minecraft.inventory.InventoryLargeChest;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTBase;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.tileentity.TileEntity;
+import net.minecraft.tileentity.TileEntityChest;
+import net.minecraft.world.World;
+
+import mcp.mobius.waila.api.IWailaConfigHandler;
+import mcp.mobius.waila.api.IWailaDataAccessor;
+import mcp.mobius.waila.api.IWailaDataProvider;
+import mcp.mobius.waila.api.IWailaEntityAccessor;
+import mcp.mobius.waila.api.IWailaEntityProvider;
+import mcp.mobius.waila.api.impl.ConfigHandler;
+import mcp.mobius.waila.api.impl.ModuleRegistrar;
+import mcp.mobius.waila.cbcore.LangUtil;
+import mcp.mobius.waila.utils.WailaExceptionHandler;
+
+/**
+ * Shows "X items in Y of Z slots" for every block and entity that is an {@link IInventory}.
+ * <p>
+ * The server always adds the summary to the NBT answer of a {@link IInventory} target (see
+ * {@link #writeSummary(Object, World, int, int, int, NBTTagCompound)}). This is not done with an NBT provider, because
+ * an NBT provider would stop the synced NBT keys of other mods for all inventories.
+ * <p>
+ * If the client only asked because of the summary, the answer has only the summary and {@link #TAG_SUMMARY_ONLY}. The
+ * client then adds the summary to its own NBT of the target, so that other mods still get the same NBT as before.
+ */
+public class HUDHandlerInventory implements IWailaDataProvider, IWailaEntityProvider {
+
+    public static final String CFG_SHOW = "general.showinventory";
+
+    private static final String TAG_ITEMS = "WailaInvItems";
+    private static final String TAG_USED = "WailaInvUsed";
+    private static final String TAG_SLOTS = "WailaInvSlots";
+    public static final String TAG_SUMMARY_ONLY = "WailaInvOnly";
+
+    /**
+     * @return true if the client must ask the server for the summary of this target.
+     */
+    public static boolean shouldRequest(Object target) {
+        // Players implement IInventory, so this also summarises player inventories. Test instanceof EntityPlayer to
+        // skip.
+        return target instanceof IInventory && ConfigHandler.instance().getConfig(CFG_SHOW, true);
+    }
+
+    /**
+     * Server side: adds the item count, the used slots and the total slots of the target to the tag.
+     */
+    public static void writeSummary(Object target, NBTTagCompound tag) {
+        if (!(target instanceof IInventory)) return;
+        try {
+            IInventory inv = (IInventory) target;
+
+            // Count both halves of a double chest. The chest updates its neighbours every tick.
+            if (target instanceof TileEntityChest chest) {
+                TileEntityChest other = chest.adjacentChestXNeg != null ? chest.adjacentChestXNeg
+                        : chest.adjacentChestXPos != null ? chest.adjacentChestXPos
+                                : chest.adjacentChestZNeg != null ? chest.adjacentChestZNeg : chest.adjacentChestZPos;
+                if (other != null) inv = new InventoryLargeChest("", chest, other);
+            }
+
+            long items = 0;
+            int used = 0;
+            int slots = inv.getSizeInventory();
+            for (int i = 0; i < slots; i++) {
+                ItemStack stack = inv.getStackInSlot(i);
+                if (stack == null || stack.getItem() == null || stack.stackSize <= 0) continue;
+                items += stack.stackSize;
+                used++;
+            }
+
+            tag.setLong(TAG_ITEMS, items);
+            tag.setInteger(TAG_USED, used);
+            tag.setInteger(TAG_SLOTS, slots);
+        } catch (Exception | LinkageError e) {
+            // Do not lose the data of the other providers because of one bad inventory
+            WailaExceptionHandler.handleErr(e, "HUDHandlerInventory | " + target.getClass().getName(), null);
+        }
+    }
+
+    /**
+     * Client side: adds the values of a summary only answer to the local NBT of the target.
+     */
+    public static NBTTagCompound mergeSummary(NBTTagCompound remote, NBTTagCompound local) {
+        for (String key : new String[] { TAG_ITEMS, TAG_USED, TAG_SLOTS }) {
+            NBTBase tag = remote.getTag(key);
+            if (tag != null) local.setTag(key, tag.copy());
+        }
+        return local;
+    }
+
+    private static void addLine(NBTTagCompound tag, List<String> currenttip, IWailaConfigHandler config) {
+        if (tag == null || !config.getConfig(CFG_SHOW, true) || !tag.hasKey(TAG_SLOTS)) return;
+        int slots = tag.getInteger(TAG_SLOTS);
+        if (slots <= 0) return;
+        long items = tag.getLong(TAG_ITEMS);
+        int used = tag.getInteger(TAG_USED);
+        String key = items == 1 ? "hud.msg.inventory.single" : "hud.msg.inventory";
+        currenttip.add(String.format(LangUtil.translateG(key), items, used, slots));
+    }
+
+    @Override
+    public ItemStack getWailaStack(IWailaDataAccessor accessor, IWailaConfigHandler config) {
+        return null;
+    }
+
+    @Override
+    public List<String> getWailaHead(ItemStack itemStack, List<String> currenttip, IWailaDataAccessor accessor,
+            IWailaConfigHandler config) {
+        return currenttip;
+    }
+
+    @Override
+    public List<String> getWailaBody(ItemStack itemStack, List<String> currenttip, IWailaDataAccessor accessor,
+            IWailaConfigHandler config) {
+        addLine(accessor.getNBTData(), currenttip, config);
+        return currenttip;
+    }
+
+    @Override
+    public List<String> getWailaTail(ItemStack itemStack, List<String> currenttip, IWailaDataAccessor accessor,
+            IWailaConfigHandler config) {
+        return currenttip;
+    }
+
+    @Override
+    public NBTTagCompound getNBTData(EntityPlayerMP player, TileEntity te, NBTTagCompound tag, World world, int x,
+            int y, int z) {
+        return tag;
+    }
+
+    @Override
+    public Entity getWailaOverride(IWailaEntityAccessor accessor, IWailaConfigHandler config) {
+        return null;
+    }
+
+    @Override
+    public List<String> getWailaHead(Entity entity, List<String> currenttip, IWailaEntityAccessor accessor,
+            IWailaConfigHandler config) {
+        return currenttip;
+    }
+
+    @Override
+    public List<String> getWailaBody(Entity entity, List<String> currenttip, IWailaEntityAccessor accessor,
+            IWailaConfigHandler config) {
+        addLine(accessor.getNBTData(), currenttip, config);
+        return currenttip;
+    }
+
+    @Override
+    public List<String> getWailaTail(Entity entity, List<String> currenttip, IWailaEntityAccessor accessor,
+            IWailaConfigHandler config) {
+        return currenttip;
+    }
+
+    @Override
+    public NBTTagCompound getNBTData(EntityPlayerMP player, Entity ent, NBTTagCompound tag, World world) {
+        return tag;
+    }
+
+    public static void register() {
+        HUDHandlerInventory provider = new HUDHandlerInventory();
+        ModuleRegistrar.instance().addConfig("General", CFG_SHOW, true);
+        ModuleRegistrar.instance().registerBodyProvider((IWailaDataProvider) provider, IInventory.class);
+        ModuleRegistrar.instance().registerBodyProvider((IWailaEntityProvider) provider, IInventory.class);
+    }
+}

src/main/java/mcp/mobius/waila/network/Message0x01TERequest.java

@@ -20,6 +20,7 @@ import io.netty.channel.ChannelHandlerContext;
 import io.netty.channel.SimpleChannelInboundHandler;
 import mcp.mobius.waila.api.IWailaDataProvider;
 import mcp.mobius.waila.api.impl.ModuleRegistrar;
+import mcp.mobius.waila.handlers.HUDHandlerInventory;
 import mcp.mobius.waila.utils.AccessHelper;
 import mcp.mobius.waila.utils.NBTUtil;
 import mcp.mobius.waila.utils.WailaExceptionHandler;
@@ -125,11 +126,16 @@ public class Message0x01TERequest extends SimpleChannelInboundHandler<Message0x0
                     }
                 }
 
+            } else if (msg.keys.isEmpty()) {
+                // The client asked only for the inventory summary
+                tag.setBoolean(HUDHandlerInventory.TAG_SUMMARY_ONLY, true);
             } else {
                 entity.writeToNBT(tag);
                 tag = NBTUtil.createTag(tag, msg.keys);
             }
 
+            HUDHandlerInventory.writeSummary(entity, tag);
+
             tag.setInteger("WailaX", msg.posX);
             tag.setInteger("WailaY", msg.posY);
             tag.setInteger("WailaZ", msg.posZ);

src/main/java/mcp/mobius/waila/network/Message0x03EntRequest.java

@@ -16,6 +16,7 @@ import io.netty.channel.ChannelHandlerContext;
 import io.netty.channel.SimpleChannelInboundHandler;
 import mcp.mobius.waila.api.IWailaEntityProvider;
 import mcp.mobius.waila.api.impl.ModuleRegistrar;
+import mcp.mobius.waila.handlers.HUDHandlerInventory;
 import mcp.mobius.waila.utils.AccessHelper;
 import mcp.mobius.waila.utils.NBTUtil;
 import mcp.mobius.waila.utils.WailaExceptionHandler;
@@ -83,11 +84,16 @@ public class Message0x03EntRequest extends SimpleChannelInboundHandler<Message0x
                     }
                 }
 
+            } else if (msg.keys.isEmpty()) {
+                // The client asked only for the inventory summary
+                tag.setBoolean(HUDHandlerInventory.TAG_SUMMARY_ONLY, true);
             } else {
                 entity.writeToNBT(tag);
                 tag = NBTUtil.createTag(tag, msg.keys);
             }
 
+            HUDHandlerInventory.writeSummary(entity, tag);
+
             tag.setInteger("WailaEntityID", entity.getEntityId());
 
             WailaPacketHandler.INSTANCE.sendTo(new Message0x04EntNBTData(tag), WailaPacketHandler.getPlayer(ctx));

src/main/java/mcp/mobius/waila/server/ProxyServer.java

@@ -29,6 +29,7 @@ import mcp.mobius.waila.api.IWailaRegistrar;
 import mcp.mobius.waila.api.impl.ModuleRegistrar;
 import mcp.mobius.waila.handlers.DecoratorFMP;
 import mcp.mobius.waila.handlers.HUDHandlerFMP;
+import mcp.mobius.waila.handlers.HUDHandlerInventory;
 import mcp.mobius.waila.utils.LoadedMods;
 
 public class ProxyServer {
@@ -41,6 +42,7 @@ public class ProxyServer {
 
         HUDHandlerVanilla.register();
         HUDHandlerFurnace.register();
+        HUDHandlerInventory.register();
 
         /* BUILDCRAFT */
         BCModule.register();

src/main/resources/assets/waila/lang/en_US.lang

@@ -43,6 +43,8 @@ client.msg.nousage=No usage found.
 hud.msg.holdkeymoreinfo=Hold %s for more info
 
 hud.msg.empty=Empty
+hud.msg.inventory=%d items in %d of %d slots
+hud.msg.inventory.single=%d item in %d of %d slots
 hud.msg.output=Output
 hud.msg.input=Input
 hud.msg.out=Out
@@ -153,6 +155,7 @@ option.stevescarts.shifttoggle=Shift toggle
 option.general.showents=Show entities
 option.general.showhp=Show entities health
 option.general.showcrop=Show crop growth
+option.general.showinventory=Show inventory summary
 option.thaumcraft.aspects=Show aspects
 
 nei.options.keys.showenchant=Show enchanting values