Key Binds API

build-logic/src/main/groovy/qsl.common.gradle

@@ -48,6 +48,9 @@ dependencies {
 	modImplementation "org.quiltmc:quilt-loader:${Versions.LOADER_VERSION}"
 }
 
+sourceCompatibility = JavaVersion.VERSION_17
+targetCompatibility = JavaVersion.VERSION_17
+
 tasks.withType(JavaCompile).configureEach {
 	it.options.encoding = "UTF-8"
 	it.options.release.set(Versions.JAVA_VERSION)

library/gui/key_binds/build.gradle

@@ -0,0 +1,25 @@
+plugins {
+	id("qsl.module")
+}
+
+qslModule {
+	name = "Quilt Key Binds API"
+	moduleName = "key_binds"
+	id = "quilt_key_binds"
+	description = "Key binds registration and utilities."
+	moduleDependencies {
+		core {
+			api("resource_loader")
+			api("qsl_base")
+			testmodOnly("lifecycle_events")
+		}
+	}
+	clientOnly()
+	injectedInterface("net/minecraft/class_304") {
+		values = [
+			"org/quiltmc/qsl/key/binds/api/ChordedKeyBind",
+			"org/quiltmc/qsl/key/binds/api/QuiltKeyBind",
+			"org/quiltmc/qsl/key/binds/api/ToggleableKeyBind"
+		]
+	}
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/api/ChordedKeyBind.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.api;
+
+import com.mojang.blaze3d.platform.InputUtil;
+
+import net.minecraft.client.option.KeyBind;
+
+import org.quiltmc.loader.api.minecraft.ClientOnly;
+import org.quiltmc.qsl.base.api.util.InjectedInterface;
+import org.quiltmc.qsl.key.binds.impl.chords.KeyChord;
+
+// TODO - Explain what are key chords.
+/**
+ * An interface that adds key chord support to key binds.
+ */
+@ClientOnly
+@InjectedInterface(KeyBind.class)
+public interface ChordedKeyBind {
+	/**
+	 * Gets the bound key chord of the key bind.
+	 *
+	 * @return the key bind's bound key chord.
+	 */
+	default KeyChord getBoundChord() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Sets the bound key chord of the key bind.
+	 */
+	default void setBoundChord(KeyChord chord) {}
+
+	// TODO - This is a temporary measure until Chasm arrives. Replace it with a proper constructor or builder
+	/**
+	 * Specifies the default key chord for the key bind.
+	 * <p>
+	 * This method is to be used only on creating a key bind instance.
+	 *
+	 * @param keys the keys of the default key chord
+	 * @return the original key bind instance
+	 */
+	default KeyBind withChord(InputUtil.Key... keys) {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/api/KeyBindRegistry.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021-2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.api;
+
+import java.util.List;
+
+import net.fabricmc.api.EnvType;
+import net.fabricmc.api.Environment;
+
+import net.minecraft.client.option.KeyBind;
+
+import org.quiltmc.loader.api.minecraft.ClientOnly;
+import org.quiltmc.qsl.key.binds.impl.KeyBindRegistryImpl;
+
+// TODO - This isn't a registry anymore; What the heck should it be named?
+/**
+ * Handles the registration of modded key binds and allows for changing their properties,
+ * such as their state.
+ *
+ * <p>This class also allows for getting key binds registered by other mods.
+ */
+@ClientOnly
+public class KeyBindRegistry {
+	// TODO - Shouldn't we use Vanilla's Map for getAllKeyBinds instead? Two birds, one stone, zero thoughts, head empty
+	/**
+	 * Searches for a modded key bind with the specified translation key in the registry.
+	 *
+	 * @param translationKey the key bind's translation key
+	 * @return the key bind if found, {@code null} otherwise
+	 */
+	public static KeyBind getKeyBind(String translationKey) {
+		return KeyBindRegistryImpl.getKeyBind(translationKey);
+	}
+
+	/**
+	 * Returns a list containing all key binds.
+	 *
+	 * @return a list containing key binds
+	 */
+	public static List<KeyBind> getAllKeyBinds() {
+		return KeyBindRegistryImpl.getAllKeyBinds();
+	}
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/api/QuiltKeyBind.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.api;
+
+import com.mojang.blaze3d.platform.InputUtil;
+
+import net.minecraft.client.option.KeyBind;
+
+import org.quiltmc.loader.api.minecraft.ClientOnly;
+import org.quiltmc.qsl.base.api.util.InjectedInterface;
+
+/**
+ * An injected interface for KeyBind that adds few Quilt-relevant utility methods.
+ */
+@ClientOnly
+@InjectedInterface(KeyBind.class)
+public interface QuiltKeyBind {
+	/**
+	 * Gets whenever the key bind is from Vanilla or not.
+	 * This is automatically determined by using GameOptions' allKeys property.
+	 *
+	 * @return {@code true} if the key bind is from Vanilla, or {@code false} otherwise
+	 */
+	default boolean isVanilla() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Gets the bound key of the key bind.
+	 *
+	 * <p>The bound key is only directly used by the key bind system's internal logic.
+	 * If possible, use the methods provided by the KeyBind class instead.
+	 *
+	 * @return the key bind's bound key
+	 */
+	default InputUtil.Key getBoundKey() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/api/ToggleableKeyBind.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.api;
+
+import net.fabricmc.api.EnvType;
+import net.fabricmc.api.Environment;
+
+import net.minecraft.client.option.KeyBind;
+
+import org.quiltmc.loader.api.minecraft.ClientOnly;
+import org.quiltmc.qsl.base.api.util.InjectedInterface;
+
+// TODO - Add Javadocs; You can nab the ones from KeyBindRegistry
+/**
+ * An interface for adding toggling capabilities to key binds.
+ */
+@ClientOnly
+@InjectedInterface(KeyBind.class)
+public interface ToggleableKeyBind {
+	/**
+	 * Gets whenever the key bind is enabled or not.
+	 *
+	 * @return {@code true} if the key bind is enabled, {@code false} otherwise
+	 */
+	default boolean isEnabled() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Gets whenever the key bind is disabled or not.
+	 *
+	 * @return {@code true} if the key bind is disabled, {@code false} otherwise
+	 */
+	default boolean isDisabled() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Gets whenever the key bind can be disabled or not.
+	 *
+	 * @return {@code true} if the key bind can be disabled, {@code false} otherwise
+	 */
+	default boolean canDisable() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Enables the key bind.
+	 * <p>
+	 * If the key bind has been disabled more than once, this method will only
+	 * decrement its internal counter instead of enabling the key bind.
+	 */
+	default void enable() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+
+	/**
+	 * Disables the key bind.
+	 * <p>
+	 * When a key bind is disabled, it is effectively hidden from the game,
+	 * being non-existent to it. config/quilt/key_binds.json, however, will
+	 * still remember the key bind's bound keys, similar to non-existent key binds.
+	 * <p>
+	 * If the key bind is disabled while already disabled, it will be increment
+	 * an internal counter, making the next enable only decrement it instead of
+	 * enabling the key bind.
+	 */
+	default void disable() {
+		throw new IllegalStateException("Mixin injection failed.");
+	}
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/impl/InternalQuiltKeyBind.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.impl;
+
+import org.jetbrains.annotations.ApiStatus;
+
+@ApiStatus.Internal
+public interface InternalQuiltKeyBind {
+	void markAsVanilla();
+}

library/gui/key_binds/src/main/java/org/quiltmc/qsl/key/binds/impl/KeyBindManager.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2021-2022 QuiltMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.quiltmc.qsl.key.binds.impl;
+
+import org.jetbrains.annotations.ApiStatus;
+
+import net.minecraft.client.option.GameOptions;
+import net.minecraft.client.option.KeyBind;
+
+import org.quiltmc.loader.api.minecraft.ClientOnly;
+import org.quiltmc.qsl.key.binds.mixin.client.GameOptionsAccessor;
+
+@ClientOnly
+@ApiStatus.Internal
+public class KeyBindManager {
+	private final GameOptions options;
+	private final KeyBind[] allKeys;
+
+	public KeyBindManager(GameOptions options, KeyBind[] allKeys) {
+		this.options = options;
+		this.allKeys = allKeys;
+	}
+
+	public void addModdedKeyBinds() {
+		((GameOptionsAccessor) this.options).setAllKeys(KeyBindRegistryImpl.getKeyBinds());
+	}
+
+	public KeyBind[] getAllKeys() {
+		return this.allKeys;
+	}
+}