Simplify window updating

Author: NichtStudioCode

invui/src/main/java/xyz/xenondevs/invui/gui/AbstractGui.java

@@ -8,15 +8,17 @@
 import org.jetbrains.annotations.ApiStatus.Internal;
 import org.jspecify.annotations.Nullable;
 import xyz.xenondevs.invui.Click;
-import xyz.xenondevs.invui.internal.Viewer;
 import xyz.xenondevs.invui.internal.ViewerAtSlot;
 import xyz.xenondevs.invui.internal.util.*;
 import xyz.xenondevs.invui.inventory.Inventory;
 import xyz.xenondevs.invui.inventory.ObscuredInventory;
 import xyz.xenondevs.invui.inventory.event.ItemPreUpdateEvent;
 import xyz.xenondevs.invui.inventory.event.PlayerUpdateReason;
 import xyz.xenondevs.invui.inventory.event.UpdateReason;
-import xyz.xenondevs.invui.item.*;
+import xyz.xenondevs.invui.item.BoundItem;
+import xyz.xenondevs.invui.item.Item;
+import xyz.xenondevs.invui.item.ItemProvider;
+import xyz.xenondevs.invui.item.ItemWrapper;
 import xyz.xenondevs.invui.util.ItemUtils;
 import xyz.xenondevs.invui.window.AbstractWindow;
 import xyz.xenondevs.invui.window.Window;
@@ -32,15 +34,15 @@
  */
 @Internal
 public sealed abstract class AbstractGui
-    implements Gui, Viewer
+    implements Gui
     permits NormalGuiImpl, AbstractPagedGui, AbstractScrollGui, TabGuiImpl
 {
 
     private final int width;
     private final int height;
     private final int size;
     private final @Nullable SlotElement[] slotElements;
-    private final @Nullable Set<ViewerAtSlot<?>>[] viewers;
+    private final @Nullable Set<ViewerAtSlot>[] viewers;
 
     private boolean frozen;
     private boolean ignoreObscuredInventorySlots = true;
@@ -78,8 +80,8 @@ public void handleBundleSelect(Player player, int slot, int bundleSlot) {
             return;
 
         SlotElement slotElement = slotElements[slot];
-        switch(slotElement) {
-            case SlotElement.GuiLink le -> ((AbstractGui)le.gui()).handleBundleSelect(player, le.slot(), bundleSlot);
+        switch (slotElement) {
+            case SlotElement.GuiLink le -> ((AbstractGui) le.gui()).handleBundleSelect(player, le.slot(), bundleSlot);
             case SlotElement.Item ie -> ie.item().handleBundleSelect(player, bundleSlot);
             case SlotElement.InventoryLink ie -> handleInvBundleSelect(player, ie.inventory(), ie.slot(), bundleSlot);
             case null -> {}
@@ -240,10 +242,10 @@ private void handleInvNumberKey(Click click, Inventory inventory, int slot) {
         AbstractWindow<?> window = (AbstractWindow<?>) WindowManager.getInstance().getOpenWindow(player);
         assert window != null;
 
-        Pair<AbstractGui, Integer> pair = window.getGuiAtHotbar(click.hotbarButton());
-        if (pair == null)
+        SlotElement.GuiLink link = window.getGuiAtHotbar(click.hotbarButton());
+        if (link == null)
             return;
-        SlotElement hotbarElement = pair.first().getSlotElement(pair.second());
+        SlotElement hotbarElement = link.gui().getSlotElement(link.slot());
         if (hotbarElement == null)
             return;
         hotbarElement = hotbarElement.getHoldingElement();
@@ -413,18 +415,6 @@ public SequencedCollection<? extends Inventory> getInventories(Inventory... igno
     }
     //</editor-fold>
 
-    @Override
-    public void notifyUpdate(int slot) {
-        synchronized (viewers) {
-            var viewers = this.viewers[slot];
-            if (viewers != null) {
-                for (var viewer : viewers) {
-                    viewer.notifyUpdate();
-                }
-            }
-        }
-    }
-    
     @Override
     public void notifyWindows() {
         synchronized (viewers) {
@@ -455,72 +445,55 @@ public void notifyWindows(int index) {
         }
     }
 
-    public void addViewer(Viewer who, int what, int how) {
+    public void addViewer(AbstractWindow<?> who, int what, int how) {
         synchronized (viewers) {
             var viewerSet = this.viewers[what];
             if (viewerSet == null) {
                 viewerSet = new HashSet<>();
                 this.viewers[what] = viewerSet;
             }
-            viewerSet.add(new ViewerAtSlot<>(who, how));
+            viewerSet.add(new ViewerAtSlot(who, how));
         }
     }
 
-    public void removeViewer(Viewer who, int what, int how) {
+    public void removeViewer(AbstractWindow<?> who, int what, int how) {
         synchronized (viewers) {
             var viewerSet = this.viewers[what];
             if (viewerSet != null) {
-                viewerSet.remove(new ViewerAtSlot<>(who, how));
+                viewerSet.remove(new ViewerAtSlot(who, how));
                 if (viewerSet.isEmpty())
                     this.viewers[what] = null;
             }
         }
     }
 
     @Override
-    public List<Window> findAllWindows() {
-        // no need for synchronization on viewers because this method is called on-main and read-only
-        var windows = new ArrayList<Window>();
-        
-        var explored = new HashSet<Viewer>();
-        var queue = new LinkedList<Viewer>();
-        queue.add(this);
-        
-        while (!queue.isEmpty()) {
-            var current = queue.poll();
-            explored.add(current);
-            
-            if (current instanceof AbstractGui viewable) {
-                for (var viewers : viewable.viewers) {
-                    if (viewers == null)
-                        continue;
-                    
-                    for (var viewerAtSlot : viewers) {
-                        var viewer = viewerAtSlot.viewer();
-                        if (!explored.contains(viewer)) {
-                            queue.add(viewer);
-                        }
+    public Collection<Window> getWindows() {
+        synchronized (viewers) {
+            var windows = new HashSet<Window>();
+            for (var viewerSet : viewers) {
+                if (viewerSet != null) {
+                    for (var viewerAtSlot : viewerSet) {
+                        windows.add(viewerAtSlot.window());
                     }
                 }
-            } else if (current instanceof Window window) {
-                windows.add(window);
             }
+            
+            return Collections.unmodifiableSet(windows);
         }
-        
-        return windows;
     }
 
     @Override
-    public Set<Player> findAllCurrentViewers() {
-        return findAllWindows().stream()
+    public Collection<Player> getCurrentViewers() {
+        return getWindows().stream()
             .filter(Window::isOpen)
             .map(Window::getViewer)
-            .collect(Collectors.toSet());
+            .collect(Collectors.toUnmodifiableSet());
     }
 
     @Override
     public void closeForAllViewers() {
-        findAllCurrentViewers().forEach(Player::closeInventory);
+        getCurrentViewers().forEach(Player::closeInventory);
     }
 
     @Override
@@ -573,7 +546,6 @@ public void cancelAnimation() {
 
     @Override
     public void setSlotElement(int index, @Nullable SlotElement slotElement) {
-        SlotElement oldElement = slotElements[index];
         slotElements[index] = slotElement;
 
         // set the gui if it is a bound item
@@ -583,16 +555,6 @@ public void setSlotElement(int index, @Nullable SlotElement slotElement) {
             }
         }
 
-        // remove this gui as a viewer from the old slot element's gui
-        if (oldElement instanceof SlotElement.GuiLink(Gui gui, int slot)) {
-            ((AbstractGui) gui).removeViewer(this, slot, index);
-        }
-        
-        // add this gui as a viewer to the new slot element's viewable
-        if (slotElement instanceof SlotElement.GuiLink(Gui gui, int slot)) {
-            ((AbstractGui) gui).addViewer(this, slot, index);
-        }
-        
         // notify parents that a slot element has been changed
         var viewers = this.viewers[index];
         if (viewers != null) {

invui/src/main/java/xyz/xenondevs/invui/gui/Animation.java

@@ -203,7 +203,7 @@ default Builder filterTaggedSlots(char key, char... keys) {
          */
         default Builder addSoundEffect(Sound sound, float volume, float pitch) {
             return addShowHandler((animation, slot) ->
-                animation.getGui().findAllCurrentViewers().forEach(viewer ->
+                animation.getGui().getCurrentViewers().forEach(viewer ->
                     viewer.playSound(viewer, sound, volume, pitch)
                 )
             );

invui/src/main/java/xyz/xenondevs/invui/gui/Gui.java

@@ -8,6 +8,7 @@
 import xyz.xenondevs.invui.item.ItemProvider;
 import xyz.xenondevs.invui.window.Window;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.SequencedCollection;
 import java.util.Set;
@@ -493,22 +494,21 @@ static Gui single(Inventory inventory, int slot, ItemProvider background) {
     boolean isTagged(Slot slot, char key);
 
     /**
-     * Finds all {@link Window Windows} that show this {@link Gui}.
+     * Gets all {@link Window Windows} that show this {@link Gui}.
      *
-     * @return The list of {@link Window} that show this {@link Gui}
+     * @return The collection of {@link Window} that show this {@link Gui}
      */
-    List<Window> findAllWindows();
+    Collection<Window> getWindows();
 
     /**
-     * Finds all {@link Player Players} that are currently seeing this {@link Window}.
+     * Gets all {@link Player Players} that are currently seeing this {@link Window}.
      *
-     * @return The list of {@link Player Players} that are currently seeing this {@link Window}
+     * @return The collection of {@link Player Players} that are currently seeing this {@link Window}
      */
-    Set<Player> findAllCurrentViewers();
+    Collection<Player> getCurrentViewers();
 
     /**
-     * Closes the open {@link org.bukkit.inventory.Inventory} for all viewers of {@link Window Windows}
-     * where this {@link Gui} is displayed.
+     * Closes the all open {@link Window Windows} that display this {@link Gui}.
      */
     void closeForAllViewers();
 

invui/src/main/java/xyz/xenondevs/invui/gui/SlotElement.java

@@ -7,6 +7,10 @@
 import xyz.xenondevs.invui.inventory.Inventory;
 import xyz.xenondevs.invui.item.ItemProvider;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
 /**
  * Represents an element in a slot in a {@link Gui}.
  * You will rarely need to use this interface directly.
@@ -101,6 +105,26 @@ record GuiLink(Gui gui, int slot) implements SlotElement {
             return holdingElement != null ? holdingElement.getItemStack(player) : null;
         }
 
+        /**
+         * Creates a {@link List} of all {@link SlotElement SlotElements} that are linked together,
+         * starting with this {@link GuiLink}.
+         *
+         * @return A {@link List} of all linked {@link SlotElement SlotElements}
+         */
+        public List<SlotElement> traverse() {
+            var elements = new ArrayList<SlotElement>();
+            
+            SlotElement current = this;
+            while (current instanceof GuiLink(Gui g, int s)) {
+                elements.add(current);
+                current = g.getSlotElement(s);
+            }
+            if (current != null)
+                elements.add(current);
+            
+            return Collections.unmodifiableList(elements);
+        }
+        
     }
 
 }

invui/src/main/java/xyz/xenondevs/invui/internal/Viewer.java

@@ -1,9 +1,11 @@
 package xyz.xenondevs.invui.internal;
 
-public record ViewerAtSlot<V extends Viewer>(V viewer, int slot) {
+import xyz.xenondevs.invui.window.AbstractWindow;
+
+public record ViewerAtSlot(AbstractWindow<?> window, int slot) {
 
     public void notifyUpdate() {
-        viewer.notifyUpdate(slot);
+        window.notifyUpdate(slot);
     }
 
 }