Code cleanup (#133)

* gradle updateBuildScript

* fix comments and commented-out code

Code deletion, converting comments into javadocs, and refactoring code to not
need comments.

* remove redundant suppressions

* replace C-style array declaration with Java-style

* make private field final

* remove unnecessary semicolon

* extract a common part from an if

* simplify boolean expression

* simplify ternary if

* remove unused imports

* convert escaped characters for clarity

* replace while with for

* replace explicit types with diamond operators

* replace anonymous type with lambda

* enable modern Java syntax

* migrate to enhanced switch

* migrate to pattern variables for instanceof

* remove empty javadoc

* add Nonnull annotation to overrides of Nonnull methods

* replace wailaStack with null

When wailaStack is not null, the flow breaks out of the loop,
so there's no need to confuse the reader with putting wailaStack
both as the result and the parameter of the call - there's no
recursion.

* int cannot be bigger than its max value

* suppress dataflow warning

* remove redundant initializer

The default value of int is 0.

* null check is covered by instanceof

* simplify some calls of addVertexWithUV

* fix typos and add TODOs

* make flipState more understandable

build.gradle

@@ -1,4 +1,4 @@
-//version: 1683563728
+//version: 1685785062
 /*
  DO NOT CHANGE THIS FILE!
  Also, you may replace this file at any time if there is an update available.
@@ -69,7 +69,7 @@ plugins {
     id 'com.diffplug.spotless' version '6.13.0' apply false // 6.13.0 is the last jvm8 supporting version
     id 'com.modrinth.minotaur' version '2.+' apply false
     id 'com.matthewprenger.cursegradle' version '1.4.0' apply false
-    id 'com.gtnewhorizons.retrofuturagradle' version '1.3.7'
+    id 'com.gtnewhorizons.retrofuturagradle' version '1.3.14'
 }
 
 print("You might want to check out './gradlew :faq' if your build fails.\n")
@@ -569,9 +569,10 @@ repositories {
 
 def mixinProviderGroup = "io.github.legacymoddingmc"
 def mixinProviderModule = "unimixins"
-def mixinProviderVersion = "0.1.6"
+def mixinProviderVersion = "0.1.7.1"
 def mixinProviderSpecNoClassifer = "${mixinProviderGroup}:${mixinProviderModule}:${mixinProviderVersion}"
 def mixinProviderSpec = "${mixinProviderSpecNoClassifer}:dev"
+ext.mixinProviderSpec = mixinProviderSpec
 
 dependencies {
     if (usesMixins.toBoolean()) {
@@ -729,7 +730,7 @@ dependencies {
         java17Dependencies("com.github.GTNewHorizons:lwjgl3ify:${lwjgl3ifyVersion}")
     }
     if (modId != 'hodgepodge') {
-        java17Dependencies('com.github.GTNewHorizons:Hodgepodge:2.2.8')
+        java17Dependencies('com.github.GTNewHorizons:Hodgepodge:2.2.13')
     }
 
     java17PatchDependencies('net.minecraft:launchwrapper:1.15') {transitive = false}
@@ -822,6 +823,18 @@ public abstract class RunHotswappableMinecraftTask extends RunMinecraftTask {
         }
         this.classpath(project.java17DependenciesCfg)
     }
+
+    public void setup(Project project) {
+        super.setup(project)
+        if (project.usesMixins.toBoolean()) {
+            this.extraJvmArgs.addAll(project.provider(() -> {
+                def mixinCfg = project.configurations.detachedConfiguration(project.dependencies.create(project.mixinProviderSpec))
+                mixinCfg.canBeConsumed = false
+                mixinCfg.transitive = false
+                enableHotswap ? ["-javaagent:" + mixinCfg.singleFile.absolutePath] : []
+            }))
+        }
+    }
 }
 
 def runClient17Task = tasks.register("runClient17", RunHotswappableMinecraftTask, Distribution.CLIENT, "runClient")
@@ -1263,12 +1276,14 @@ tasks.register('faq') {
     description = 'Prints frequently asked questions about building a project'
 
     doLast {
-        print("If your build fails to fetch dependencies, they might have been deleted and replaced by newer " +
-            "versions.\nCheck if the versions you try to fetch are still on the distributing sites.\n" +
-            "The links can be found in repositories.gradle and build.gradle:repositories, " +
-            "not build.gradle:buildscript.repositories - this one is for gradle plugin metadata.\n\n" +
+        print("If your build fails to fetch dependencies, run './gradlew updateDependencies'. " +
+            "Or you can manually check if the versions are still on the distributing sites - " +
+            "the links can be found in repositories.gradle and build.gradle:repositories, " +
+            "but not build.gradle:buildscript.repositories - those ones are for gradle plugin metadata.\n\n" +
             "If your build fails to recognize the syntax of new Java versions, enable Jabel in your " +
-            "gradle.properties. See how it's done in GTNH ExampleMod/gradle.properties.")
+            "gradle.properties. See how it's done in GTNH ExampleMod/gradle.properties. " +
+            "However, keep in mind that Jabel enables only syntax features, but not APIs that were introduced in " +
+            "Java 9 or later.")
     }
 }
 

gradle.properties

@@ -21,6 +21,10 @@ forgeVersion = 10.13.4.1614
 # Do you need to test how your custom blocks interacts with a player that is not the owner? -> leave name empty
 developmentEnvironmentUserName = Developer
 
+# Enables using modern java syntax (up to version 17) via Jabel, while still targetting JVM 8.
+# See https://github.com/bsideup/jabel for details on how this works.
+enableModernJavaSyntax = true
+
 # Define a source file of your project with:
 # public static final String VERSION = "GRADLETOKEN_VERSION";
 # The string's content will be replaced with your mods version when compiled. You should use this to specify your mod's

src/main/java/com/glodblock/github/client/gui/GuiDualInterface.java

@@ -128,15 +128,12 @@ public void drawFG(final int offsetX, final int offsetY, final int mouseX, final
     @Override
     protected String getBackground() {
         if (!ModAndClassUtil.isBigInterface) return "guis/interface.png";
-        switch (((ContainerInterface) this.cvb).getPatternCapacityCardsInstalled()) {
-            case 1:
-                return "guis/interface2.png";
-            case 2:
-                return "guis/interface3.png";
-            case 3:
-                return "guis/interface4.png";
-        }
-        return "guis/interface.png";
+        return switch (((ContainerInterface) this.cvb).getPatternCapacityCardsInstalled()) {
+            case 1 -> "guis/interface2.png";
+            case 2 -> "guis/interface3.png";
+            case 3 -> "guis/interface4.png";
+            default -> "guis/interface.png";
+        };
     }
 
     @Override

src/main/java/com/glodblock/github/client/gui/GuiFCImgButton.java

@@ -244,9 +244,7 @@ public void drawButton(final Minecraft par1Minecraft, final int par2, final int
                         Math.round(uv_y * 16F * 16F / 3F),
                         Math.round(16F * 16F / 3F),
                         Math.round(16F * 16F / 3F));
-                this.mouseDragged(par1Minecraft, par2, par3);
 
-                GL11.glPopMatrix();
             } else {
                 GL11.glPushMatrix();
                 GL11.glTranslatef(this.xPosition, this.yPosition, 0.0F);
@@ -280,9 +278,9 @@ public void drawButton(final Minecraft par1Minecraft, final int par2, final int
                         Math.round(uv_y * 16F * 16F / 3F),
                         Math.round(16F * 16F / 3F),
                         Math.round(16F * 16F / 3F));
-                this.mouseDragged(par1Minecraft, par2, par3);
-                GL11.glPopMatrix();
             }
+            this.mouseDragged(par1Minecraft, par2, par3);
+            GL11.glPopMatrix();
         }
         GL11.glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
     }

src/main/java/com/glodblock/github/client/gui/GuiFluidCraftConfirm.java

@@ -1,7 +1,5 @@
 package com.glodblock.github.client.gui;
 
-import java.util.*;
-
 import net.minecraft.entity.player.InventoryPlayer;
 
 import com.glodblock.github.FluidCraft;

src/main/java/com/glodblock/github/client/gui/GuiFluidLevelEmitter.java

@@ -164,7 +164,6 @@ private void addQty(final long i) {
 
             FluidCraft.proxy.netHandler.sendToServer(new CPacketValueConfig(result, 0));
         } catch (final NumberFormatException e) {
-            // nope..
             this.level.setText("0");
         }
     }

src/main/java/com/glodblock/github/client/gui/GuiInterfaceTerminalWireless.java

@@ -76,7 +76,6 @@ public class GuiInterfaceTerminalWireless extends FCBaseMEGui implements IDropTo
     protected static boolean onlyBrokenRecipes = false;
     protected GuiTabButton craftingStatusBtn;
 
-    // private final IConfigManager configSrc;
     private int rows = 3;
 
     private static final String MOLECULAR_ASSEMBLER = "tile.appliedenergistics2.BlockMolecularAssembler";
@@ -210,8 +209,7 @@ public void setSearchString() {
 
     protected void repositionSlots() {
         for (final Object obj : this.inventorySlots.inventorySlots) {
-            if (obj instanceof AppEngSlot) {
-                final AppEngSlot slot = (AppEngSlot) obj;
+            if (obj instanceof final AppEngSlot slot) {
                 slot.yDisplayPosition = this.ySize + slot.getY() - 78 - 7;
             }
         }
@@ -220,7 +218,9 @@ protected void repositionSlots() {
     protected int calculateRowsCount() {
         final int maxRows = this.getMaxRows();
         final boolean hasNEI = IntegrationRegistry.INSTANCE.isEnabled(IntegrationType.NEI);
-        final int NEIPadding = hasNEI ? 22 /* input */ + 18 /* top panel */ : 0;
+        final int input = 22;
+        final int topPanel = 18;
+        final int NEIPadding = hasNEI ? input + topPanel : 0;
         final int extraSpace = this.height - MAGIC_HEIGHT_NUMBER - NEIPadding;
 
         return Math.max(3, Math.min(maxRows, extraSpace / 18));
@@ -243,8 +243,7 @@ public void drawFG(final int offsetX, final int offsetY, final int mouseX, final
         final int ex = getScrollBar().getCurrentScroll();
         for (int x = 0; x < this.rows && ex + x < this.lines.size(); x++) {
             final Object lineObj = this.lines.get(ex + x);
-            if (lineObj instanceof ClientDCInternalInv) {
-                final ClientDCInternalInv inv = (ClientDCInternalInv) lineObj;
+            if (lineObj instanceof final ClientDCInternalInv inv) {
                 for (int z = 0; z < inv.getInventory().getSizeInventory(); z++) {
                     if (this.matchedStacks.contains(inv.getInventory().getStackInSlot(z))) drawRect(
                             z * 18 + 22,
@@ -253,8 +252,7 @@ public void drawFG(final int offsetX, final int offsetY, final int mouseX, final
                             1 + offset + 16,
                             GuiColors.InterfaceTerminalMatch.getColor());
                 }
-            } else if (lineObj instanceof String) {
-                String name = (String) lineObj;
+            } else if (lineObj instanceof String name) {
                 final int rows = this.byName.get(name).size();
                 String postfix = "";
 
@@ -309,8 +307,7 @@ public void drawScreen(final int mouseX, final int mouseY, final float btn) {
         final int ex = this.getScrollBar().getCurrentScroll();
         for (int x = 0; x < this.rows && ex + x < this.lines.size(); x++) {
             final Object lineObj = this.lines.get(ex + x);
-            if (lineObj instanceof ClientDCInternalInv) {
-                final ClientDCInternalInv inv = (ClientDCInternalInv) lineObj;
+            if (lineObj instanceof final ClientDCInternalInv inv) {
                 for (int z = 0; z < inv.getInventory().getSizeInventory(); z++) {
                     inventorySlots.inventorySlots.add(new SlotDisconnected(inv, z, z * 18 + 22, 1 + offset));
                 }
@@ -405,8 +402,7 @@ protected void actionPerformed(final GuiButton btn) {
 
         } else if (btn == craftingStatusBtn) {
             InventoryHandler.switchGui(GuiType.CRAFTING_STATUS);
-        } else if (btn instanceof GuiImgButton) {
-            final GuiImgButton iBtn = (GuiImgButton) btn;
+        } else if (btn instanceof final GuiImgButton iBtn) {
             if (iBtn.getSetting() != Settings.ACTIONS) {
                 final Enum cv = iBtn.getCurrentValue();
                 final boolean backwards = Mouse.isButtonDown(1);
@@ -444,8 +440,7 @@ public void drawBG(final int offsetX, final int offsetY, final int mouseX, final
         for (int x = 0; x < this.rows && ex + x < this.lines.size(); x++) {
 
             final Object lineObj = this.lines.get(ex + x);
-            if (lineObj instanceof ClientDCInternalInv) {
-                final ClientDCInternalInv inv = (ClientDCInternalInv) lineObj;
+            if (lineObj instanceof final ClientDCInternalInv inv) {
 
                 GL11.glColor4f(1, 1, 1, 1);
                 final int width = inv.getInventory().getSizeInventory() * 18;
@@ -539,7 +534,7 @@ public void postUpdate(final NBTTagCompound in) {
 
         if (this.refreshList) {
             this.refreshList = false;
-            // invalid caches on refresh
+            // invalidate caches on refresh
             this.cachedSearches.clear();
             this.refreshList();
         }

src/main/java/com/glodblock/github/client/gui/GuiLevelMaintainer.java

@@ -364,32 +364,33 @@ public FCGuiLineField getLine() {
         public void draw() {
             this.getQty().draw();
             this.getBatch().draw();
-            ArrayList<String> message = new ArrayList<String>();
+            ArrayList<String> message = new ArrayList<>();
             message.add(NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_TITLE) + "\n");
             switch (this.state) {
-                case Idling:
+                case Idling -> {
                     this.line.setColor(0xFF55FF55);
                     message.add(
                             NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_CURRENT)
                                     + NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_IDLE));
-                    break;
-                case Crafting:
+                }
+                case Crafting -> {
                     this.line.setColor(0xFFFFFF55);
                     message.add(
                             NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_CURRENT)
                                     + NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_LINK));
-                    break;
-                case Exporting:
+                }
+                case Exporting -> {
                     this.line.setColor(0xFFAA00AA);
                     message.add(
                             NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_CURRENT)
                                     + NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_EXPORT));
-                    break;
-                default:
+                }
+                default -> {
                     this.line.setColor(0);
                     message.add(
                             NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_CURRENT)
                                     + NameConst.i18n(NameConst.TT_LEVEL_MAINTAINER_NONE));
+                }
             }
             message.add("");
             if (isShiftKeyDown()) {
@@ -430,7 +431,7 @@ public Widget(FCGuiTextField textField, String tooltip, int idx, String action)
             this.textField = textField;
             this.textField.setEnableBackgroundDrawing(false);
             this.textField.setText("0");
-            this.textField.setMaxStringLength(10); // it's enough to useful
+            this.textField.setMaxStringLength(10); // this length is enough to useful
             this.idx = idx;
             this.action = action;
             this.tooltip = tooltip;

src/main/java/com/glodblock/github/client/gui/GuiRenamer.java

@@ -16,7 +16,7 @@
 
 public class GuiRenamer extends AEBaseGui implements IDropToFillTextField {
 
-    private MEGuiTextField textField;
+    private final MEGuiTextField textField;
 
     public GuiRenamer(InventoryPlayer ip, ITerminalHost monitorable) {
         super(new ContainerRenamer(ip, monitorable));

src/main/java/com/glodblock/github/client/gui/base/FCGuiMonitor.java

@@ -122,9 +122,8 @@ protected void actionPerformed(final GuiButton btn) {
         if (btn == this.craftingStatusBtn || btn == this.craftingStatusImgBtn) {
             InventoryHandler.switchGui(GuiType.CRAFTING_STATUS);
         }
-        if (btn instanceof GuiImgButton) {
+        if (btn instanceof final GuiImgButton iBtn) {
             final boolean backwards = Mouse.isButtonDown(1);
-            final GuiImgButton iBtn = (GuiImgButton) btn;
             if (iBtn.getSetting() != Settings.ACTIONS) {
                 final Enum<?> cv = iBtn.getCurrentValue();
                 final Enum<?> next = Platform.rotateEnum(cv, backwards, iBtn.getSetting().getPossibleValues());
@@ -273,6 +272,8 @@ public void initGui() {
                         AEConfig.instance.settings.getSetting(Settings.TERMINAL_STYLE)));
         this.offsetY += 20;
 
+        // Right now 80 > offsetX, but that can be changed later.
+        // noinspection DataFlowIssue
         this.searchField = new FCGuiTextField(
                 this.fontRendererObj,
                 this.guiLeft + Math.max(80, this.offsetX),
@@ -433,7 +434,7 @@ protected void handleMouseClick(final Slot slot, final int slotIdx, final int ct
 
         if (slot instanceof SlotPatternTerm) {
             if (mouseButton == 6) {
-                return; // prevent weird double clicks..
+                return; // prevents weird double clicks
             }
             try {
                 NetworkHandler.instance.sendToServer(((SlotPatternTerm) slot).getRequest(isShiftKeyDown()));
@@ -442,13 +443,13 @@ protected void handleMouseClick(final Slot slot, final int slotIdx, final int ct
             }
         } else if (slot instanceof SlotCraftingTerm) {
             if (mouseButton == 6) {
-                return; // prevent weird double clicks..
+                return; // prevents weird double clicks
             }
             InventoryAction action;
             if (isShiftKeyDown()) {
                 action = InventoryAction.CRAFT_SHIFT;
             } else {
-                // Craft stack on right-click, craft single on left-click
+                // Craft a stack on right-click, craft a single one on left-click
                 action = (mouseButton == 1) ? InventoryAction.CRAFT_STACK : InventoryAction.CRAFT_ITEM;
             }
             final PacketInventoryAction p = new PacketInventoryAction(action, slotIdx, 0);

src/main/java/com/glodblock/github/client/gui/container/ContainerFluidMonitor.java

@@ -222,7 +222,7 @@ public void postChange(Iterable<IAEFluidStack> change, ItemStack fluidContainer,
     }
 
     /**
-     * The insert operation. For input, we have an filled container stack. For outputs, we have the following: 1.
+     * The insert operation. For input, we have a filled container stack. For outputs, we have the following: 1.
      * Leftover filled container stack - primary output. 2. Empty containers 3. Partially filled container x1 In order
      * above, the itemstack at `slotIndex` is transformed into the output.
      */

src/main/java/com/glodblock/github/client/gui/container/ContainerFluidPatternEncoder.java

@@ -106,7 +106,10 @@ public void encodePattern() {
     }
 
     private static IAEItemStack[] collectAeInventory(AeStackInventory<IAEItemStack> inv) {
-        // see note at top of DensePatternDetails
+        /*
+         * AE2 API documentation says the input/output arrays can contain nulls, but their use of the API directly
+         * contradicts that, so we just go by behaviour and filter out nulls.
+         */
         List<IAEItemStack> acc = new ArrayList<>();
         for (IAEItemStack stack : inv) {
             if (stack != null) {
@@ -130,20 +133,20 @@ public void doAction(EntityPlayerMP player, InventoryAction action, int slotId,
         if (slot instanceof SlotFluidConvertingFake) {
             final ItemStack stack = player.inventory.getItemStack();
             switch (action) {
-                case PICKUP_OR_SET_DOWN:
+                case PICKUP_OR_SET_DOWN -> {
                     if (stack == null) {
                         slot.putStack(null);
                     } else {
                         ((SlotFluidConvertingFake) slot).putConvertedStack(stack.copy());
                     }
-                    break;
-                case PLACE_SINGLE:
+                }
+                case PLACE_SINGLE -> {
                     if (stack != null) {
                         ((SlotFluidConvertingFake) slot)
                                 .putConvertedStack(Objects.requireNonNull(Util.copyStackWithSize(stack, 1)));
                     }
-                    break;
-                case SPLIT_OR_PLACE_SINGLE:
+                }
+                case SPLIT_OR_PLACE_SINGLE -> {
                     ItemStack inSlot = slot.getStack();
                     if (inSlot != null) {
                         if (stack == null) {
@@ -161,7 +164,7 @@ public void doAction(EntityPlayerMP player, InventoryAction action, int slotId,
                         ((SlotFluidConvertingFake) slot)
                                 .putConvertedStack(Objects.requireNonNull(Util.copyStackWithSize(stack, 1)));
                     }
-                    break;
+                }
             }
         } else {
             super.doAction(player, action, slotId, id);