Sync refactor 2 (#56)

* start

* add center() method

* center panels by default

* synced panel fixes

* allow custom player slots

* r

* try fix close panel issue

* sync closePanelInternal() to server

* refactor client panel opening & remove deprecated methods

* add container customizer

* fix compile issue

* fix container customizer stackoverflow

* check contains for gui actions and jei ghost slots

* support for non phantom oversized slots

* remove default mode stuff

Author: brachy84

src/main/java/com/cleanroommc/modularui/CommonProxy.java

@@ -9,7 +9,8 @@
 import com.cleanroommc.modularui.screen.ModularContainer;
 import com.cleanroommc.modularui.test.ItemEditorGui;
 import com.cleanroommc.modularui.test.TestBlock;
-import com.cleanroommc.modularui.value.sync.GuiSyncManager;
+
+import com.cleanroommc.modularui.value.sync.ModularSyncManager;
 
 import net.minecraft.util.Timer;
 import net.minecraftforge.common.MinecraftForge;
@@ -72,7 +73,7 @@ public static void registerBlocks(RegistryEvent.Register<EntityEntry> event) {
     @SubscribeEvent
     public static void onCloseContainer(PlayerContainerEvent.Open event) {
         if (event.getContainer() instanceof ModularContainer container) {
-            GuiSyncManager syncManager = container.getSyncManager();
+            ModularSyncManager syncManager = container.getSyncManager();
             if (syncManager != null) {
                 syncManager.onOpen();
             }

src/main/java/com/cleanroommc/modularui/api/IGuiHolder.java

@@ -3,7 +3,8 @@
 import com.cleanroommc.modularui.factory.GuiData;
 import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.ModularScreen;
-import com.cleanroommc.modularui.value.sync.GuiSyncManager;
+
+import com.cleanroommc.modularui.value.sync.PanelSyncManager;
 
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
@@ -18,7 +19,7 @@ public interface IGuiHolder<T extends GuiData> {
      * Only called on client side.
      *
      * @param data      information about the creation context
-     * @param mainPanel the panel created in {@link #buildUI(GuiData, GuiSyncManager)}
+     * @param mainPanel the panel created in {@link #buildUI(GuiData, PanelSyncManager)}
      * @return a modular screen instance with the given panel
      */
     @SideOnly(Side.CLIENT)
@@ -29,10 +30,10 @@ default ModularScreen createScreen(T data, ModularPanel mainPanel) {
     /**
      * Called on server and client. Create only the main panel here. Only here you can add sync handlers to widgets directly.
      * If the widget to be synced is not in this panel yet (f.e. in another panel) the sync handler must be registered here
-     * with {@link GuiSyncManager}.
+     * with {@link PanelSyncManager}.
      *
      * @param data        information about the creation context
      * @param syncManager sync handler where widget sync handlers should be registered
      */
-    ModularPanel buildUI(T data, GuiSyncManager syncManager);
+    ModularPanel buildUI(T data, PanelSyncManager syncManager);
 }

src/main/java/com/cleanroommc/modularui/api/IPanelHandler.java

@@ -0,0 +1,70 @@
+package com.cleanroommc.modularui.api;
+
+import com.cleanroommc.modularui.screen.ModularPanel;
+import com.cleanroommc.modularui.screen.SecondaryPanel;
+import com.cleanroommc.modularui.value.sync.PanelSyncHandler;
+
+import org.jetbrains.annotations.ApiStatus;
+
+/**
+ * This class can handle opening and closing of a {@link ModularPanel}. It makes sure, that the same panel is not created multiple times and instead reused.
+ * Using {@link #openPanel()} is the only way to open multiple panels.
+ * Panels can be closed with {@link #closePanel()}, but also with {@link ModularPanel#closeIfOpen(boolean)} and {@link ModularPanel#animateClose()}.
+ * They are the same. Synced panels must be registered in the main {@link com.cleanroommc.modularui.value.sync.PanelSyncManager PanelSyncManager}.
+ * It is recommended to use {@link com.cleanroommc.modularui.value.sync.PanelSyncManager#panel(String, ModularPanel, PanelSyncHandler.IPanelBuilder) PanelSyncManager#panel(String, ModularPanel, PanelSyncHandler.IPanelBuilder)}.
+ */
+public interface IPanelHandler {
+
+    /**
+     * Creates a synced panel handler. It MUST be registered in a {@link com.cleanroommc.modularui.value.sync.PanelSyncManager PanelSyncManager} on
+     * both sides to work.
+     *
+     * @param mainPanel    the main panel of the GUI
+     * @param panelBuilder the panel builder, that will create the new panel. It must not return null or the main panel.
+     * @return a synced panel handler.
+     * @throws NullPointerException     if the build panel of the builder is null
+     * @throws IllegalArgumentException if the build panel of the builder is the main panel
+     */
+    static IPanelHandler synced(ModularPanel mainPanel, PanelSyncHandler.IPanelBuilder panelBuilder) {
+        return new PanelSyncHandler(mainPanel, panelBuilder);
+    }
+
+    /**
+     * Creates a non synced panel handler. Trying to use synced values anyway will result in a crash.
+     *
+     * @param mainPanel the main panel of the GUI
+     * @param provider  the panel builder, that will create the new panel. It must not return null or the main panel.
+     * @return a simple panel handler.
+     * @throws NullPointerException     if the build panel of the builder is null
+     * @throws IllegalArgumentException if the build panel of the builder is the main panel or there are synced values in the panel
+     */
+    static IPanelHandler simple(ModularPanel mainPanel, SecondaryPanel.IPanelBuilder provider) {
+        return new SecondaryPanel(mainPanel, provider);
+    }
+
+    /**
+     * Opens the panel. If there is no cached panel, one will be created.
+     * Can be called on both sides if this handler is synced.
+     */
+    void openPanel();
+
+    /**
+     * Initiates the closing animation if the panel is open.
+     * Can be called on both sides if this handler is synced.
+     */
+    void closePanel();
+
+    /**
+     * Called internally after the panel is closed.
+     */
+    @ApiStatus.OverrideOnly
+    void closePanelInternal();
+
+    /**
+     * Deletes the current cached panel. Should not be used frequently.
+     * This only works on non synced panels. Otherwise, it crashes.
+     *
+     * @throws UnsupportedOperationException if this handler is synced
+     */
+    void deleteCachedPanel();
+}

src/main/java/com/cleanroommc/modularui/api/IPanelSyncManager.java

@@ -0,0 +1,22 @@
+package com.cleanroommc.modularui.api;
+
+import com.cleanroommc.modularui.value.sync.SyncHandler;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+import org.jetbrains.annotations.ApiStatus;
+
+public interface IPanelSyncManager {
+
+    @ApiStatus.Internal
+    void detectAndSendChanges(boolean init);
+
+    void onClose();
+
+    void onOpen();
+
+    EntityPlayer getPlayer();
+
+    IPanelSyncManager syncValue(String key, int id, SyncHandler syncHandler);
+
+}

src/main/java/com/cleanroommc/modularui/api/UIFactory.java

@@ -3,7 +3,8 @@
 import com.cleanroommc.modularui.factory.GuiData;
 import com.cleanroommc.modularui.screen.ModularPanel;
 import com.cleanroommc.modularui.screen.ModularScreen;
-import com.cleanroommc.modularui.value.sync.GuiSyncManager;
+
+import com.cleanroommc.modularui.value.sync.PanelSyncManager;
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.network.PacketBuffer;
@@ -37,13 +38,13 @@ public interface UIFactory<D extends GuiData> {
      * @return new main panel
      */
     @ApiStatus.OverrideOnly
-    ModularPanel createPanel(D guiData, GuiSyncManager syncManager);
+    ModularPanel createPanel(D guiData, PanelSyncManager syncManager);
 
     /**
      * Creates the screen for the GUI. Is only called on client side.
      *
      * @param guiData   gui data
-     * @param mainPanel main panel created in {@link #createPanel(GuiData, GuiSyncManager)}
+     * @param mainPanel main panel created in {@link #createPanel(GuiData, PanelSyncManager)}
      * @return new main panel
      */
     @SideOnly(Side.CLIENT)

src/main/java/com/cleanroommc/modularui/api/drawable/IDrawable.java

@@ -1,19 +1,15 @@
 package com.cleanroommc.modularui.api.drawable;
 
-import com.cleanroommc.modularui.api.ITheme;
 import com.cleanroommc.modularui.drawable.Icon;
 import com.cleanroommc.modularui.screen.viewport.GuiContext;
-import com.cleanroommc.modularui.theme.ThemeAPI;
 import com.cleanroommc.modularui.theme.WidgetTheme;
-import com.cleanroommc.modularui.utils.Color;
 import com.cleanroommc.modularui.widget.Widget;
 import com.cleanroommc.modularui.widget.sizer.Area;
 
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
 
 import com.google.gson.JsonObject;
-import org.jetbrains.annotations.ApiStatus;
 
 /**
  * An object which can be drawn. This is mainly used for backgrounds and overlays in
@@ -104,18 +100,6 @@ default void drawAtZero(GuiContext context, Area area, WidgetTheme widgetTheme)
         draw(context, 0, 0, area.width, area.height, widgetTheme);
     }
 
-    /**
-     * Applies a theme color before drawing. Do not call, only override.
-     *
-     * @param theme       theme to apply color of
-     * @param widgetTheme widget theme to apply color of
-     */
-    @Deprecated
-    @ApiStatus.ScheduledForRemoval(inVersion = "2.6.0")
-    default void applyThemeColor(ITheme theme, WidgetTheme widgetTheme) {
-        Color.setGlColorOpaque(Color.WHITE.main);
-    }
-
     /**
      * @return if theme color can be applied on this drawable
      */
@@ -168,7 +152,7 @@ public DrawableWidget(IDrawable drawable) {
         @SideOnly(Side.CLIENT)
         @Override
         public void draw(GuiContext context, WidgetTheme widgetTheme) {
-            this.drawable.drawAtZero(context, getArea());
+            this.drawable.drawAtZero(context, getArea(), widgetTheme);
         }
     }
 }

src/main/java/com/cleanroommc/modularui/api/widget/IPositioned.java

@@ -376,6 +376,10 @@ default W align(Alignment alignment) {
                 alignY(alignment.y);
     }
 
+    default W center() {
+        return align(Alignment.Center);
+    }
+
     default W flex(Consumer<Flex> flexConsumer) {
         flexConsumer.accept(flex());
         return getThis();

src/main/java/com/cleanroommc/modularui/api/widget/ISynced.java

@@ -1,6 +1,6 @@
 package com.cleanroommc.modularui.api.widget;
 
-import com.cleanroommc.modularui.value.sync.GuiSyncManager;
+import com.cleanroommc.modularui.value.sync.ModularSyncManager;
 import com.cleanroommc.modularui.value.sync.SyncHandler;
 
 import org.jetbrains.annotations.NotNull;
@@ -25,7 +25,7 @@ default W getThis() {
      *
      * @param syncManager sync manager
      */
-    void initialiseSyncHandler(GuiSyncManager syncManager);
+    void initialiseSyncHandler(ModularSyncManager syncManager);
 
     /**
      * Checks if the received sync handler is valid for this widget.
@@ -38,6 +38,13 @@ default boolean isValidSyncHandler(SyncHandler syncHandler) {
         return false;
     }
 
+    default <T> T castIfTypeElseNull(SyncHandler syncHandler, Class<T> clazz) {
+        if (syncHandler != null && clazz.isAssignableFrom(syncHandler.getClass())) {
+            return (T) syncHandler;
+        }
+        return null;
+    }
+
     /**
      * @return true if this widget has a valid sync handler
      */

src/main/java/com/cleanroommc/modularui/core/mixin/ContainerAccessor.java

@@ -1,13 +1,26 @@
 package com.cleanroommc.modularui.core.mixin;
 
+import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.inventory.Container;
 
+import net.minecraft.inventory.IInventory;
+import net.minecraft.item.ItemStack;
+
+import net.minecraft.world.World;
+
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.gen.Accessor;
+import org.spongepowered.asm.mixin.gen.Invoker;
 
 @Mixin(Container.class)
 public interface ContainerAccessor {
 
     @Accessor
     int getDragEvent();
+
+    @Invoker
+    boolean invokeMergeItemStack(ItemStack stack, int startIndex, int endIndex, boolean reverseDirection);
+
+    @Invoker
+    void invokeClearContainer(EntityPlayer playerIn, World worldIn, IInventory inventoryIn);
 }

src/main/java/com/cleanroommc/modularui/drawable/IconRenderer.java

@@ -4,6 +4,7 @@
 import com.cleanroommc.modularui.api.drawable.IIcon;
 import com.cleanroommc.modularui.api.drawable.IKey;
 import com.cleanroommc.modularui.screen.viewport.GuiContext;
+import com.cleanroommc.modularui.theme.WidgetTheme;
 import com.cleanroommc.modularui.utils.Alignment;
 
 import net.minecraft.client.Minecraft;
@@ -101,7 +102,7 @@ public void drawMeasuredLines(GuiContext context, List<IIcon> lines) {
         for (IIcon icon : lines) {
             int x = icon.getWidth() > 0 ? getStartX(icon.getWidth()) : this.x;
             if (!this.simulate) {
-                icon.draw(context, x, y, maxWidth, icon.getHeight());
+                icon.draw(context, x, y, maxWidth, icon.getHeight(), WidgetTheme.getDefault());
             }
             y += (int) ((icon.getHeight() + this.linePadding) * this.scale);
         }