Add support for keybindings (#154)

* Added patchwork-key-bindings

* Added patchwork keybinding for Patcher


Cleaning up remaining absolute imports

* Fix missing import

* Fix archive base name

* Fix folders, paths and project names

* Fix KeyBinding names and add @unique

* Should probably respect keybind context

* Remove now incorrect comment

Co-authored-by: Glitch <[email protected]>

Co-authored-by: Glitch <[email protected]>

Author: Snakefangox

patchwork-key-bindings/build.gradle

@@ -0,0 +1,2 @@
+archivesBaseName = "patchwork-key-bindings"
+version = getSubprojectVersion(project, "0.1.0")

patchwork-key-bindings/src/main/java/net/minecraftforge/client/extensions/IForgeKeybinding.java

@@ -0,0 +1,69 @@
+/*
+ * 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.extensions;
+
+import javax.annotation.Nonnull;
+
+import net.minecraftforge.client.settings.IKeyConflictContext;
+import net.minecraftforge.client.settings.KeyModifier;
+
+import net.minecraft.client.options.KeyBinding;
+import net.minecraft.client.util.InputUtil;
+
+public interface IForgeKeybinding {
+	default KeyBinding getKeyBinding() {
+		return (KeyBinding) this;
+	}
+
+	@Nonnull
+	InputUtil.KeyCode getKey();
+
+	/**
+	 * Checks that the key conflict context and modifier are active, and that the keyCode matches this binding.
+	 */
+	default boolean isActiveAndMatches(InputUtil.KeyCode keyCode) {
+		return keyCode.getKeyCode() != 0 && keyCode.equals(getKey()) && getKeyConflictContext().isActive() && getKeyModifier().isActive(getKeyConflictContext());
+	}
+
+	default void setToDefault() {
+		setKeyModifierAndCode(getKeyModifierDefault(), getKeyBinding().getDefaultKeyCode());
+	}
+
+	IKeyConflictContext getKeyConflictContext();
+
+	void setKeyConflictContext(IKeyConflictContext keyConflictContext);
+
+	KeyModifier getKeyModifierDefault();
+
+	KeyModifier getKeyModifier();
+
+	void setKeyModifierAndCode(KeyModifier keyModifier, InputUtil.KeyCode keyCode);
+
+	/**
+	 * Returns true when one of the bindings' key codes conflicts with the other's modifier.
+	 */
+	default boolean hasKeyCodeModifierConflict(KeyBinding other) {
+		if (getKeyConflictContext().conflicts(((IForgeKeybinding) other).getKeyConflictContext()) || ((IForgeKeybinding) other).getKeyConflictContext().conflicts(getKeyConflictContext())) {
+			return getKeyModifier().matches(((IForgeKeybinding) other).getKey()) || ((IForgeKeybinding) other).getKeyModifier().matches(getKey());
+		}
+
+		return false;
+	}
+}

patchwork-key-bindings/src/main/java/net/minecraftforge/client/settings/IKeyConflictContext.java

@@ -0,0 +1,37 @@
+/*
+ * 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.settings;
+
+/**
+ * Defines the context that a {@link KeyBinding} is used.
+ * Key conflicts occur when a {@link KeyBinding} has the same {@link IKeyConflictContext} and has conflicting modifiers and keyCodes.
+ */
+public interface IKeyConflictContext {
+	/**
+	 * @return true if conditions are met to activate {@link KeyBinding}s with this context
+	 */
+	boolean isActive();
+
+	/**
+	 * @return true if the other context can have {@link KeyBinding} conflicts with this one.
+	 * This will be called on both contexts to check for conflicts.
+	 */
+	boolean conflicts(IKeyConflictContext other);
+}

patchwork-key-bindings/src/main/java/net/minecraftforge/client/settings/KeyConflictContext.java

@@ -0,0 +1,70 @@
+/*
+ * 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.settings;
+
+import net.minecraft.client.MinecraftClient;
+
+public enum KeyConflictContext implements IKeyConflictContext {
+	/**
+	 * Universal key bindings are used in every context and will conflict with any other context.
+	 * Key Bindings are universal by default.
+	 */
+	UNIVERSAL {
+		@Override
+		public boolean isActive() {
+			return true;
+		}
+
+		@Override
+		public boolean conflicts(IKeyConflictContext other) {
+			return true;
+		}
+	},
+
+	/**
+	 * Gui key bindings are only used when a {@link GuiScreen} is open.
+	 */
+	GUI {
+		@Override
+		public boolean isActive() {
+			return MinecraftClient.getInstance().currentScreen != null;
+		}
+
+		@Override
+		public boolean conflicts(IKeyConflictContext other) {
+			return this == other;
+		}
+	},
+
+	/**
+	 * In-game key bindings are only used when a {@link GuiScreen} is not open.
+	 */
+	IN_GAME {
+		@Override
+		public boolean isActive() {
+			return !GUI.isActive();
+		}
+
+		@Override
+		public boolean conflicts(IKeyConflictContext other) {
+			return this == other;
+		}
+	}
+}

patchwork-key-bindings/src/main/java/net/minecraftforge/client/settings/KeyModifier.java

@@ -0,0 +1,150 @@
+/*
+ * 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.settings;
+
+import java.util.function.Supplier;
+
+import javax.annotation.Nullable;
+
+import org.lwjgl.glfw.GLFW;
+
+import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.gui.screen.Screen;
+import net.minecraft.client.resource.language.I18n;
+import net.minecraft.client.util.InputUtil;
+
+public enum KeyModifier {
+	CONTROL {
+		@Override
+		public boolean matches(InputUtil.KeyCode key) {
+			int keyCode = key.getKeyCode();
+
+			if (MinecraftClient.IS_SYSTEM_MAC) {
+				return keyCode == GLFW.GLFW_KEY_LEFT_ALT || keyCode == GLFW.GLFW_KEY_RIGHT_ALT;
+			} else {
+				return keyCode == GLFW.GLFW_KEY_LEFT_CONTROL || keyCode == GLFW.GLFW_KEY_RIGHT_CONTROL;
+			}
+		}
+
+		@Override
+		public boolean isActive(@Nullable IKeyConflictContext conflictContext) {
+			return Screen.hasControlDown();
+		}
+
+		@Override
+		public String getLocalizedComboName(InputUtil.KeyCode key, Supplier<String> defaultLogic) {
+			String keyName = defaultLogic.get();
+			String localizationFormatKey = MinecraftClient.IS_SYSTEM_MAC ? "forge.controlsgui.control.mac" : "forge.controlsgui.control";
+			return I18n.translate(localizationFormatKey, keyName);
+		}
+	},
+	SHIFT {
+		@Override
+		public boolean matches(InputUtil.KeyCode key) {
+			return key.getKeyCode() == GLFW.GLFW_KEY_LEFT_SHIFT || key.getKeyCode() == GLFW.GLFW_KEY_RIGHT_SHIFT;
+		}
+
+		@Override
+		public boolean isActive(@Nullable IKeyConflictContext conflictContext) {
+			return Screen.hasShiftDown();
+		}
+
+		@Override
+		public String getLocalizedComboName(InputUtil.KeyCode key, Supplier<String> defaultLogic) {
+			return I18n.translate("forge.controlsgui.shift", defaultLogic.get());
+		}
+	},
+	ALT {
+		@Override
+		public boolean matches(InputUtil.KeyCode key) {
+			return key.getKeyCode() == GLFW.GLFW_KEY_LEFT_ALT || key.getKeyCode() == GLFW.GLFW_KEY_RIGHT_ALT;
+		}
+
+		@Override
+		public boolean isActive(@Nullable IKeyConflictContext conflictContext) {
+			return Screen.hasAltDown();
+		}
+
+		@Override
+		public String getLocalizedComboName(InputUtil.KeyCode keyCode, Supplier<String> defaultLogic) {
+			return I18n.translate("forge.controlsgui.alt", defaultLogic.get());
+		}
+	},
+	NONE {
+		@Override
+		public boolean matches(InputUtil.KeyCode key) {
+			return false;
+		}
+
+		@Override
+		public boolean isActive(@Nullable IKeyConflictContext conflictContext) {
+			if (conflictContext != null && !conflictContext.conflicts(KeyConflictContext.IN_GAME)) {
+				for (KeyModifier keyModifier : MODIFIER_VALUES) {
+					if (keyModifier.isActive(conflictContext)) {
+						return false;
+					}
+				}
+			}
+
+			return true;
+		}
+
+		@Override
+		public String getLocalizedComboName(InputUtil.KeyCode key, Supplier<String> defaultLogic) {
+			return defaultLogic.get();
+		}
+	};
+
+	public static final KeyModifier[] MODIFIER_VALUES = {SHIFT, CONTROL, ALT};
+
+	public static KeyModifier getActiveModifier() {
+		for (KeyModifier keyModifier : MODIFIER_VALUES) {
+			if (keyModifier.isActive(null)) {
+				return keyModifier;
+			}
+		}
+
+		return NONE;
+	}
+
+	public static boolean isKeyCodeModifier(InputUtil.KeyCode key) {
+		for (KeyModifier keyModifier : MODIFIER_VALUES) {
+			if (keyModifier.matches(key)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public static KeyModifier valueFromString(String stringValue) {
+		try {
+			return valueOf(stringValue);
+		} catch (NullPointerException | IllegalArgumentException ignored) {
+			return NONE;
+		}
+	}
+
+	public abstract boolean matches(InputUtil.KeyCode key);
+
+	public abstract boolean isActive(@Nullable IKeyConflictContext conflictContext);
+
+	public abstract String getLocalizedComboName(InputUtil.KeyCode key, Supplier<String> defaultLogic);
+}

patchwork-key-bindings/src/main/java/net/patchworkmc/impl/keybindings/ForgeKeyBindingConstruct.java

@@ -0,0 +1,27 @@
+/*
+ * 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.patchworkmc.impl.keybindings;
+
+import net.minecraftforge.client.settings.IKeyConflictContext;
+import net.minecraftforge.client.settings.KeyModifier;
+
+public interface ForgeKeyBindingConstruct {
+	void patchwork$constructForgeKeyBindingOptions(IKeyConflictContext keyConflictContext, KeyModifier keyModifier);
+}