Finish & fix abstract controller manager + optimize hashmaps in codebase + no SDL screen

Author: isXander

build.gradle.kts

@@ -11,7 +11,7 @@ plugins {
 }
 
 group = "dev.isxander"
-version = "1.7.0-beta.2+1.20"
+version = "1.7.0-beta.3+1.20.2"
 val isAlpha = "alpha" in version.toString()
 val isBeta = "beta" in version.toString()
 if (isAlpha) println("Controlify alpha version detected.")

changelogs/1.7.0-beta.3+1.20.2.md

@@ -0,0 +1,29 @@
+# Controlify 1.7.0 (Beta 3) for 1.20.2
+
+## New Features
+
+- Added D-Pad snapping in container screens
+- Keyboard-like movement whitelist and warning toast when joining new servers
+- Added bind to open F3 debug screen
+- More snap points on recipe book
+- Allow users to define a custom SDL natives path (so you can put them in a common dir if you want)
+- Add a reset all binds button to controls tab
+
+## Changes
+
+- Internal changes to the way controllers are discovered, loaded and managed. (this could introduce new bugs)
+- `delegate_setup` config option has been renamed to `quiet_mode`.
+- Pause screen's disconnect shortcut now focuses the button instead of clicking it.
+- Add a donate button to the controller carousel screen.
+- Modify how analogue inputs are processed whilst ingame or using the virtual mouse to make it feel more "circular"
+- Marginally improve performance of Controlify by using optimized hashmaps.
+
+## Bug Fixes
+
+- Fix hotplugging when using natives.
+- Fix SDL download screen progress bar being a missing texture.
+- Fix people being unable to write newlines and spaces in signs when using mixed input mode.
+- Fix some modded GUIs crashing when attempting to open when Controlify is loaded.
+- Fix tridents not causing a vibration.
+- Fix rumble not working on joysticks.
+- Fix fabric mod json requirement allowing any 1.20 version not 1.20.2 and above.

src/main/java/dev/isxander/controlify/Controlify.java

@@ -3,6 +3,7 @@
 import com.mojang.blaze3d.Blaze3D;
 import dev.isxander.controlify.api.ControlifyApi;
 import dev.isxander.controlify.api.entrypoint.ControlifyEntrypoint;
+import dev.isxander.controlify.bindings.ControllerBindings;
 import dev.isxander.controlify.compatibility.ControlifyCompat;
 import dev.isxander.controlify.controller.joystick.JoystickController;
 import dev.isxander.controlify.controller.joystick.mapping.UnmappedJoystickMapping;
@@ -63,10 +64,12 @@ public class Controlify implements ControlifyApi {
     private boolean probeMode = false;
 
     private Controller<?, ?> currentController = null;
+    private InputMode currentInputMode = InputMode.KEYBOARD_MOUSE;
+
     private InGameInputHandler inGameInputHandler;
     public InGameButtonGuide inGameButtonGuide;
     private VirtualMouseHandler virtualMouseHandler;
-    private InputMode currentInputMode = InputMode.KEYBOARD_MOUSE;
+
     private ControllerHIDService controllerHIDService;
 
     private CompletableFuture<Boolean> nativeOnboardingFuture = null;
@@ -81,10 +84,6 @@ public class Controlify implements ControlifyApi {
 
     private int showMouseTicks = 0;
 
-    private @Nullable Controller<?, ?> switchableController = null;
-    private double askSwitchTime = 0;
-    private ToastUtils.ControlifyToast askSwitchToast = null;
-
     /**
      * Called at usual fabric client entrypoint.
      * Always runs, even with no controllers detected.
@@ -178,10 +177,6 @@ public void initializeControlify() {
             ClientTickEvents.END_CLIENT_TICK.register(client -> this.probeTick());
         }
 
-        // initialise and compatability modules that controlify implements itself
-        // this does NOT invoke any entrypoints. this is done in the pre-initialisation phase
-        ControlifyCompat.init();
-
         // register events
         ClientLifecycleEvents.CLIENT_STOPPING.register(minecraft -> {
             controllerHIDService().stop();
@@ -211,19 +206,28 @@ public void discoverControllers() {
             Log.LOGGER.info("No controllers found.");
         }
 
-        // if no controller is currently selected, select the first one
+        // if no controller is currently selected, pick one
         if (getCurrentController().isEmpty()) {
-            Controller<?, ?> controller = controllerManager.getConnectedControllers().stream().findFirst().orElse(null);
-            if (controller != null && (controller.config().delayedCalibration || !controller.config().deadzonesCalibrated)) {
-                controller = null;
-            }
+            Optional<Controller<?, ?>> lastUsedController = controllerManager.getConnectedControllers()
+                    .stream()
+                    .filter(c -> c.uid().equals(config().currentControllerUid()))
+                    .findAny();
 
-            this.setCurrentController(controller, false);
-        } else {
-            // setCurrentController saves config so there is no need to set dirty to save
-            config().saveIfDirty();
+            if (lastUsedController.isPresent()) {
+                this.setCurrentController(lastUsedController.get(), false);
+            } else {
+                Controller<?, ?> anyController = controllerManager.getConnectedControllers()
+                        .stream()
+                        .filter(c -> !c.config().delayedCalibration && c.config().deadzonesCalibrated)
+                        .findFirst()
+                        .orElse(null);
+
+                this.setCurrentController(anyController, false);
+            }
         }
 
+        config().saveIfDirty();
+
         FabricLoader.getInstance().getEntrypoints("controlify", ControlifyEntrypoint.class).forEach(entrypoint -> {
             try {
                 entrypoint.onControllersDiscovered(this);
@@ -233,10 +237,16 @@ public void discoverControllers() {
         });
     }
 
+    /**
+     * Completely finishes controlify initialization.
+     * This can be run at any point during the game's lifecycle.
+     * @return the future that completes when controlify has finished initializing
+     */
     public CompletableFuture<Void> finishControlifyInit() {
         if (finishedInit) {
             return CompletableFuture.completedFuture(null);
         }
+        probeMode = false;
         finishedInit = true;
 
         askNatives().whenComplete((loaded, th) -> {
@@ -248,12 +258,33 @@ public CompletableFuture<Void> finishControlifyInit() {
             ConnectServerEvent.EVENT.register((minecraft, address, data) -> {
                 notifyNewServer(data);
             });
+
+            // initialise and compatability modules that controlify implements itself
+            // this does NOT invoke any entrypoints. this is done in the pre-initialisation phase
+            ControlifyCompat.init();
+
+            // make sure people don't someone add binds after controllers could have been created
+            ControllerBindings.lockRegistry();
+
+            if (config().globalSettings().quietMode) {
+                config().globalSettings().quietMode = false;
+                config().setDirty();
+            }
+
             discoverControllers();
         });
 
         return askNatives().thenApply(loaded -> null);
     }
 
+    /**
+     * Called when a controller is connected. Either from controller
+     * discovery or hotplugging.
+     *
+     * @param controller the new controller
+     * @param hotplugged if this was a result of hotplugging
+     * @param newController if this controller has never been seen before
+     */
     private void onControllerAdded(Controller<?, ?> controller, boolean hotplugged, boolean newController) {
         if (SubmitUnknownControllerScreen.canSubmit(controller)) {
             minecraft.setScreen(new SubmitUnknownControllerScreen(controller, minecraft.screen));
@@ -264,12 +295,10 @@ private void onControllerAdded(Controller<?, ?> controller, boolean hotplugged,
             config().setDirty();
         }
 
-        if (hotplugged) {
-            if (controller.config().deadzonesCalibrated) {
-                setCurrentController(controller, hotplugged);
-            } else {
-                calibrationQueue.add(controller);
-            }
+        if (!controller.config().deadzonesCalibrated) {
+            calibrationQueue.add(controller);
+        } else if (hotplugged) {
+            setCurrentController(controller, true);
         }
 
         if (controller instanceof JoystickController<?> joystick && joystick.mapping() instanceof UnmappedJoystickMapping) {
@@ -278,7 +307,7 @@ private void onControllerAdded(Controller<?, ?> controller, boolean hotplugged,
                     Component.translatable("controlify.toast.unmapped_joystick.description", controller.name()),
                     true
             );
-        } else {
+        } else if (hotplugged) {
             ToastUtils.sendToast(
                     Component.translatable("controlify.toast.controller_connected.title"),
                     Component.translatable("controlify.toast.controller_connected.description", controller.name()),
@@ -289,8 +318,17 @@ private void onControllerAdded(Controller<?, ?> controller, boolean hotplugged,
         if (minecraft.screen instanceof ControllerCarouselScreen controllerListScreen) {
             controllerListScreen.refreshControllers();
         }
+
+        // saved after discovery
+        if (hotplugged) {
+            config().saveIfDirty();
+        }
     }
 
+    /**
+     * Called when a controller is disconnected.
+     * @param controller controller that has been disconnected
+     */
     private void onControllerRemoved(Controller<?, ?> controller) {
         this.setCurrentController(
                 controllerManager.getConnectedControllers()
@@ -325,6 +363,14 @@ public CompletableFuture<Boolean> askNatives() {
         if (nativeOnboardingFuture != null)
             return nativeOnboardingFuture;
 
+        // just say no if the platform doesn't support it
+        if (!SDL2NativesManager.isSupportedOnThisPlatform()) {
+            Log.LOGGER.warn("SDL is not supported on this platform. Platform: {}", SDL2NativesManager.Target.CURRENT);
+            nativeOnboardingFuture = new CompletableFuture<>();
+            minecraft.setScreen(new NoSDLScreen(() -> nativeOnboardingFuture.complete(false), minecraft.screen));
+            return nativeOnboardingFuture;
+        }
+
         // the user has already been asked, initialise SDL if necessary
         // and return a completed future
         if (config().globalSettings().vibrationOnboarded) {
@@ -373,19 +419,10 @@ public void tick(Minecraft client) {
 
         boolean outOfFocus = !config().globalSettings().outOfFocusInput && !client.isWindowActive();
 
+        // handles updating state of all controllers
         controllerManager.tick(outOfFocus);
 
-        if (switchableController != null && Blaze3D.getTime() - askSwitchTime <= 10000) {
-            if (switchableController.state().hasAnyInput()) {
-                switchableController.clearState();
-                this.setCurrentController(switchableController, true); // setCurrentController sets switchableController to null
-                if (askSwitchToast != null) {
-                    askSwitchToast.remove();
-                    askSwitchToast = null;
-                }
-            }
-        }
-
+        // handle showing/hiding mouse whilst in mixed input mode
         if (minecraft.mouseHandler.isMouseGrabbed())
             showMouseTicks = 0;
         if (currentInputMode() == InputMode.MIXED && showMouseTicks > 0) {
@@ -400,6 +437,7 @@ public void tick(Minecraft client) {
 
         LowBatteryNotifier.tick();
 
+        // if splitscreen ever happens this can tick over every controller
         getCurrentController().ifPresent(currentController -> {
             wrapControllerError(
                     () -> tickController(currentController, outOfFocus),
@@ -409,6 +447,12 @@ public void tick(Minecraft client) {
         });
     }
 
+    /**
+     * Ticks a specific controller.
+     *
+     * @param controller controller to tick
+     * @param outOfFocus if the window is out of focus
+     */
     private void tickController(Controller<?, ?> controller, boolean outOfFocus) {
         ControllerState state = controller.state();
 
@@ -479,10 +523,6 @@ public void setCurrentController(@Nullable Controller<?, ?> controller, boolean
 
         this.currentController = controller;
 
-        if (switchableController == controller) {
-            switchableController = null;
-        }
-
         if (controller == null) {
             this.setInputMode(InputMode.KEYBOARD_MOUSE);
             this.inGameInputHandler = null;
@@ -495,7 +535,7 @@ public void setCurrentController(@Nullable Controller<?, ?> controller, boolean
         DebugLog.log("Updated current controller to {}({})", controller.name(), controller.uid());
 
         if (!controller.uid().equals(config().currentControllerUid())) {
-            config().save();
+            config().setDirty();
         }
 
         this.inGameInputHandler = new InGameInputHandler(controller);
@@ -504,6 +544,8 @@ public void setCurrentController(@Nullable Controller<?, ?> controller, boolean
             setInputMode(InputMode.MIXED);
         else if (changeInputMode)
             setInputMode(InputMode.CONTROLLER);
+
+        config().saveIfDirty();
     }
 
     public Optional<ControllerManager> getControllerManager() {

src/main/java/dev/isxander/controlify/api/bind/ControllerBinding.java

@@ -3,7 +3,6 @@
 import com.google.gson.JsonObject;
 import dev.isxander.controlify.bindings.BindContext;
 import dev.isxander.controlify.bindings.IBind;
-import dev.isxander.controlify.bindings.RadialIcons;
 import dev.isxander.yacl3.api.Option;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.network.chat.Component;

src/main/java/dev/isxander/controlify/bindings/ControllerBindingImpl.java

@@ -17,6 +17,8 @@
 import dev.isxander.controlify.gui.DrawSize;
 import dev.isxander.yacl3.api.Option;
 import dev.isxander.yacl3.api.OptionDescription;
+import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap;
+import it.unimi.dsi.fastutil.objects.ObjectOpenHashSet;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.locale.Language;
@@ -39,9 +41,9 @@ public class ControllerBindingImpl<T extends ControllerState> implements Control
     private final ResourceLocation radialIcon;
     private final KeyMappingOverride override;
 
-    private static final Map<Controller<?, ?>, Set<IBind<?>>> pressedBinds = new HashMap<>();
+    private static final Map<Controller<?, ?>, Set<IBind<?>>> pressedBinds = new Object2ObjectOpenHashMap<>();
 
-    private int fakePressState = 0;
+    private byte fakePressState = 0;
 
     private ControllerBindingImpl(Controller<T, ?> controller, IBind<T> defaultBind, ResourceLocation id, KeyMappingOverride vanillaOverride, Component name, Component description, Component category, Set<BindContext> contexts, ResourceLocation icon) {
         this.controller = controller;
@@ -219,7 +221,7 @@ private static boolean hasBindPressed(ControllerBindingImpl<?> binding) {
     }
 
     private static void addPressedBind(ControllerBindingImpl<?> binding) {
-        pressedBinds.computeIfAbsent(binding.controller, c -> new HashSet<>()).addAll(getBinds(binding.bind));
+        pressedBinds.computeIfAbsent(binding.controller, c -> new ObjectOpenHashSet<>()).addAll(getBinds(binding.bind));
     }
 
     private static Set<IBind<?>> getBinds(IBind<?> bind) {