Implement InputEvent through patchwork-events-input

patchwork-events-input/build.gradle

@@ -0,0 +1,6 @@
+archivesBaseName = "patchwork-events-input"
+version = getSubprojectVersion(project, "0.1.0")
+
+dependencies {
+	compile project(path: ':patchwork-fml', configuration: 'dev')
+}

patchwork-events-input/src/main/java/com/patchworkmc/mixin/event/input/MixinKeyboard.java

@@ -0,0 +1,44 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.mixin.event.input;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+import net.minecraftforge.client.event.InputEvent;
+import net.minecraftforge.common.MinecraftForge;
+
+import net.minecraft.client.Keyboard;
+import net.minecraft.client.MinecraftClient;
+
+@Mixin(Keyboard.class)
+public abstract class MixinKeyboard {
+	@Shadow
+	MinecraftClient client;
+
+	@Inject(method = "onKey", at = @At("RETURN"))
+	private void fireKeyInput(long window, int key, int scancode, int i, int j, CallbackInfo info) {
+		if (window == this.client.window.getHandle()) {
+			MinecraftForge.EVENT_BUS.post(new InputEvent.KeyInputEvent(key, scancode, i, j));
+		}
+	}
+}

patchwork-events-input/src/main/java/com/patchworkmc/mixin/event/input/MixinMouse.java

@@ -0,0 +1,68 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package com.patchworkmc.mixin.event.input;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Shadow;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.At.Shift;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+import org.spongepowered.asm.mixin.injection.callback.LocalCapture;
+import net.minecraftforge.client.event.InputEvent;
+import net.minecraftforge.common.MinecraftForge;
+import net.minecraftforge.eventbus.api.Event;
+
+import net.minecraft.client.Mouse;
+
+@Mixin(Mouse.class)
+public abstract class MixinMouse {
+	@Shadow
+	boolean middleButtonClicked;
+	@Shadow
+	abstract boolean wasLeftButtonClicked();
+	@Shadow
+	abstract boolean wasRightButtonClicked();
+	@Shadow
+	abstract double getX();
+	@Shadow
+	abstract double getY();
+
+	@Inject(method = "onMouseButton", at = @At("RETURN"), cancellable = true)
+	private void fireMouseInput(long window, int button, int action, int mods, CallbackInfo info) {
+		MinecraftForge.EVENT_BUS.post(new InputEvent.MouseInputEvent(button, action, mods));
+	}
+
+	@Inject(method = "onMouseButton", at = @At(value = "FIELD", ordinal = 3, target = "Lnet/minecraft/client/Mouse;client:Lnet/minecraft/client/MinecraftClient;", shift = Shift.BEFORE), cancellable = true)
+	private void onRawMouseClicked(long window, int button, int action, int mods, CallbackInfo info) {
+		if (MinecraftForge.EVENT_BUS.post(new InputEvent.RawMouseEvent(button, action, mods))) {
+			info.cancel();
+		}
+	}
+
+	@Inject(method = "onMouseScroll", locals = LocalCapture.CAPTURE_FAILHARD, at = @At(value = "INVOKE", target = "Lnet/minecraft/client/network/ClientPlayerEntity;isSpectator()Z", shift = Shift.BEFORE), cancellable = true)
+	private void onMouseScroll(long window, double d, double e, CallbackInfo info, double f, float i) {
+		final Event event = new InputEvent.MouseScrollEvent(f, wasLeftButtonClicked(), middleButtonClicked, wasRightButtonClicked(), getX(), getY());
+
+		if (MinecraftForge.EVENT_BUS.post(event)) {
+			info.cancel();
+		}
+	}
+}

patchwork-events-input/src/main/java/net/minecraftforge/client/event/InputEvent.java

@@ -0,0 +1,259 @@
+/*
+ * Minecraft Forge, Patchwork Project
+ * Copyright (c) 2016-2020, 2019-2020
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation version 2.1
+ * of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.minecraftforge.client.event;
+
+import net.minecraftforge.eventbus.api.Event;
+import org.lwjgl.glfw.GLFW;
+
+public class InputEvent extends Event {
+	/**
+	 * A cancellable mouse event fired before key bindings are updated.
+	 */
+	public static class RawMouseEvent extends InputEvent {
+		private final int action;
+		private final int button;
+		private final int mods;
+
+		// For EventBus
+		public RawMouseEvent() {
+			this(-1, -1, -1);
+		}
+
+		public RawMouseEvent(int button, int action, int mods) {
+			this.button = button;
+			this.action = action;
+			this.mods = mods;
+		}
+
+		/**
+		 * The mouse button that triggered this event.
+		 * https://www.glfw.org/docs/latest/group__buttons.html
+		 *
+		 * @see GLFW mouse constants starting with "GLFW_MOUSE_BUTTON_"
+		 */
+		public int getButton() {
+			return this.button;
+		}
+
+		/**
+		 * Integer representing the mouse button's action.
+		 *
+		 * @see GLFW#GLFW_PRESS
+		 * @see GLFW#GLFW_RELEASE
+		 */
+		public int getAction() {
+			return this.action;
+		}
+
+		/**
+		 * Bit field representing the modifier keys pressed.
+		 * https://www.glfw.org/docs/latest/group__mods.html
+		 *
+		 * @see GLFW#GLFW_MOD_SHIFT
+		 * @see GLFW#GLFW_MOD_CONTROL
+		 * @see GLFW#GLFW_MOD_ALT
+		 * @see GLFW#GLFW_MOD_SUPER
+		 */
+		public int getMods() {
+			return this.mods;
+		}
+
+		@Override
+		public boolean isCancelable() {
+			return true;
+		}
+	}
+
+	/**
+	 * This event fires when a mouse input is detected.
+	 */
+	public static class MouseInputEvent extends InputEvent {
+		private final int button;
+		private final int action;
+		private final int mods;
+
+		// For EventBus
+		public MouseInputEvent() {
+			this(-1, -1, -1);
+		}
+
+		public MouseInputEvent(int button, int action, int mods) {
+			this.button = button;
+			this.action = action;
+			this.mods = mods;
+		}
+
+		/**
+		 * The mouse button that triggered this event.
+		 * https://www.glfw.org/docs/latest/group__buttons.html
+		 *
+		 * @see GLFW mouse constants starting with "GLFW_MOUSE_BUTTON_"
+		 */
+		public int getButton() {
+			return this.button;
+		}
+
+		/**
+		 * Integer representing the mouse button's action.
+		 *
+		 * @see GLFW#GLFW_PRESS
+		 * @see GLFW#GLFW_RELEASE
+		 */
+		public int getAction() {
+			return this.action;
+		}
+
+		/**
+		 * Bit field representing the modifier keys pressed.
+		 * https://www.glfw.org/docs/latest/group__mods.html
+		 *
+		 * @see GLFW#GLFW_MOD_SHIFT
+		 * @see GLFW#GLFW_MOD_CONTROL
+		 * @see GLFW#GLFW_MOD_ALT
+		 * @see GLFW#GLFW_MOD_SUPER
+		 */
+		public int getMods() {
+			return this.mods;
+		}
+	}
+
+	/**
+	 * This event fires when the mouse scroll wheel is used outside of a gui.
+	 */
+	public static class MouseScrollEvent extends InputEvent {
+		private final double scrollDelta;
+		private final double mouseX;
+		private final double mouseY;
+		private final boolean leftDown;
+		private final boolean middleDown;
+		private final boolean rightDown;
+
+		// For EventBus
+		public MouseScrollEvent() {
+			this(-1, false, false, false, -1, -1);
+		}
+
+		public MouseScrollEvent(double scrollDelta, boolean leftDown, boolean middleDown, boolean rightDown, double mouseX, double mouseY) {
+			this.scrollDelta = scrollDelta;
+			this.leftDown = leftDown;
+			this.middleDown = middleDown;
+			this.rightDown = rightDown;
+			this.mouseX = mouseX;
+			this.mouseY = mouseY;
+		}
+
+		public double getScrollDelta() {
+			return this.scrollDelta;
+		}
+
+		public boolean isLeftDown() {
+			return this.leftDown;
+		}
+
+		public boolean isRightDown() {
+			return this.rightDown;
+		}
+
+		public boolean isMiddleDown() {
+			return this.middleDown;
+		}
+
+		public double getMouseX() {
+			return this.mouseX;
+		}
+
+		public double getMouseY() {
+			return this.mouseY;
+		}
+
+		@Override
+		public boolean isCancelable() {
+			return true;
+		}
+	}
+
+	/**
+	 * This event fires when a keyboard input is detected.
+	 */
+	public static class KeyInputEvent extends InputEvent {
+		private final int key;
+		private final int scanCode;
+		private final int action;
+		private final int modifiers;
+
+		// For EventBus
+		public KeyInputEvent() {
+			this(-1, -1, -1, -1);
+		}
+
+		public KeyInputEvent(int key, int scanCode, int action, int modifiers) {
+			this.key = key;
+			this.scanCode = scanCode;
+			this.action = action;
+			this.modifiers = modifiers;
+		}
+
+		/**
+		 * The keyboard key that triggered this event.
+		 * https://www.glfw.org/docs/latest/group__keys.html
+		 *
+		 * @see GLFW key constants starting with "GLFW_KEY_"
+		 */
+		public int getKey() {
+			return this.key;
+		}
+
+		/**
+		 * Platform-specific scan code.
+		 * Used for {@link InputMappings#getInputByCode(int, int)}
+		 *
+		 * <p>The scan code is unique for every key, regardless of whether it has a key code.
+		 * Scan codes are platform-specific but consistent over time, so keys will have different scan codes depending
+		 * on the platform but they are safe to save to disk as custom key bindings.
+		 */
+		public int getScanCode() {
+			return this.scanCode;
+		}
+
+		/**
+		 * Integer representing the key's action.
+		 *
+		 * @see GLFW#GLFW_PRESS
+		 * @see GLFW#GLFW_RELEASE
+		 * @see GLFW#GLFW_REPEAT
+		 */
+		public int getAction() {
+			return this.action;
+		}
+
+		/**
+		 * Bit field representing the modifier keys pressed.
+		 * https://www.glfw.org/docs/latest/group__mods.html
+		 *
+		 * @see GLFW#GLFW_MOD_SHIFT
+		 * @see GLFW#GLFW_MOD_CONTROL
+		 * @see GLFW#GLFW_MOD_ALT
+		 * @see GLFW#GLFW_MOD_SUPER
+		 */
+		public int getModifiers() {
+			return this.modifiers;
+		}
+	}
+}