From d0209dc76254aecbc5d079f100917c425cac894d Mon Sep 17 00:00:00 2001 From: jmp Date: Sat, 24 Oct 2020 18:40:05 -0700 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Expose=20the=20Brigadier=20manager?= =?UTF-8?q?=20from=20Brigadier-enabled=20command=20managers?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../brigadier/BrigadierManagerHolder.java | 47 +++++++++++++++++++ .../bukkit/BukkitCommandManager.java | 17 ++++++- .../bukkit/CloudCommodoreManager.java | 4 ++ .../paper/PaperBrigadierListener.java | 10 +++- .../paper/PaperCommandManager.java | 19 +++++++- 5 files changed, 92 insertions(+), 5 deletions(-) create mode 100644 cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierManagerHolder.java diff --git a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierManagerHolder.java b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierManagerHolder.java new file mode 100644 index 00000000..cac61844 --- /dev/null +++ b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierManagerHolder.java @@ -0,0 +1,47 @@ +// +// MIT License +// +// Copyright (c) 2020 Alexander Söderberg & Contributors +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// +package cloud.commandframework.brigadier; + +import org.checkerframework.checker.nullness.qual.Nullable; + +/** + * This interface is implemented by command managers capable of registering commands to Brigadier. + * + * @param Command sender type + */ +public interface BrigadierManagerHolder { + + /** + * Get the Brigadier manager instance used by this manager. This method being present + * in a command manager means the manager has the capability to register commands + * to Brigadier, but does not necessarily mean that this capability is being used. + *

+ * In the case that Brigadier isn't used, this method should always return {@code null}. + * + * @return The Brigadier manager instance, if commands are being registered to Brigadier. + * Else, {@code null} + */ + @Nullable CloudBrigadierManager brigadierManager(); + +} diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommandManager.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommandManager.java index f73961ff..a72552fa 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommandManager.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommandManager.java @@ -25,6 +25,8 @@ package cloud.commandframework.bukkit; import cloud.commandframework.CommandManager; import cloud.commandframework.CommandTree; +import cloud.commandframework.brigadier.BrigadierManagerHolder; +import cloud.commandframework.brigadier.CloudBrigadierManager; import cloud.commandframework.bukkit.arguments.selector.MultipleEntitySelector; import cloud.commandframework.bukkit.arguments.selector.MultiplePlayerSelector; import cloud.commandframework.bukkit.arguments.selector.SingleEntitySelector; @@ -53,6 +55,7 @@ import org.bukkit.enchantments.Enchantment; import org.bukkit.entity.Player; import org.bukkit.plugin.Plugin; import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; import java.util.EnumSet; import java.util.Set; @@ -65,7 +68,8 @@ import java.util.regex.Pattern; * * @param Command sender type */ -public class BukkitCommandManager extends CommandManager { +@SuppressWarnings("unchecked") +public class BukkitCommandManager extends CommandManager implements BrigadierManagerHolder { private static final int VERSION_RADIX = 10; private static final int BRIGADIER_MINIMUM_VERSION = 13; @@ -317,6 +321,17 @@ public class BukkitCommandManager extends CommandManager { } } + /** + * {@inheritDoc} + */ + @Override + public @Nullable CloudBrigadierManager brigadierManager() { + if (this.getCommandRegistrationHandler() instanceof CloudCommodoreManager) { + return ((CloudCommodoreManager) this.getCommandRegistrationHandler()).brigadierManager(); + } + return null; + } + /** * Strip the plugin namespace from a plugin namespaced command. This * will also strip the leading '/' if it's present diff --git a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/CloudCommodoreManager.java b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/CloudCommodoreManager.java index 6203e4c8..bae48d32 100644 --- a/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/CloudCommodoreManager.java +++ b/cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/CloudCommodoreManager.java @@ -71,6 +71,10 @@ class CloudCommodoreManager extends BukkitPluginRegistrationHandler { this.registerWithCommodore(String.format("%s:%s", bukkitCommand.getPlugin().getName(), label).toLowerCase(), command); } + protected @NonNull CloudBrigadierManager brigadierManager() { + return this.brigadierManager; + } + private void registerWithCommodore( final @NonNull String label, final @NonNull Command command diff --git a/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierListener.java b/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierListener.java index a4a8cd9f..734e86d6 100644 --- a/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierListener.java +++ b/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierListener.java @@ -57,10 +57,16 @@ class PaperBrigadierListener implements Listener { new BukkitBrigadierMapper<>(this.paperCommandManager, this.brigadierManager); } + protected @NonNull CloudBrigadierManager brigadierManager() { + return this.brigadierManager; + } + @EventHandler @SuppressWarnings("deprecation") - public void onCommandRegister(final com.destroystokyo.paper.event.brigadier - .@NonNull CommandRegisteredEvent event) { + public void onCommandRegister( + final com.destroystokyo.paper.event.brigadier. + @NonNull CommandRegisteredEvent event + ) { if (!(event.getCommand() instanceof PluginIdentifiableCommand)) { return; } else if (!((PluginIdentifiableCommand) event.getCommand()) diff --git a/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperCommandManager.java b/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperCommandManager.java index 5d5920e8..8218d9c0 100644 --- a/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperCommandManager.java +++ b/cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperCommandManager.java @@ -24,6 +24,7 @@ package cloud.commandframework.paper; import cloud.commandframework.CommandTree; +import cloud.commandframework.brigadier.CloudBrigadierManager; import cloud.commandframework.bukkit.BukkitCommandManager; import cloud.commandframework.bukkit.CloudBukkitCapabilities; import cloud.commandframework.execution.CommandExecutionCoordinator; @@ -31,6 +32,7 @@ import org.bukkit.Bukkit; import org.bukkit.command.CommandSender; import org.bukkit.plugin.Plugin; import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; import java.util.function.Function; @@ -41,6 +43,8 @@ import java.util.function.Function; */ public class PaperCommandManager extends BukkitCommandManager { + private PaperBrigadierListener paperBrigadierListener = null; + /** * Construct a new Paper command manager * @@ -96,9 +100,9 @@ public class PaperCommandManager extends BukkitCommandManager { super.registerBrigadier(); } else { try { - final PaperBrigadierListener brigadierListener = new PaperBrigadierListener<>(this); + this.paperBrigadierListener = new PaperBrigadierListener<>(this); Bukkit.getPluginManager().registerEvents( - brigadierListener, + this.paperBrigadierListener, this.getOwningPlugin() ); this.setSplitAliases(true); @@ -108,6 +112,17 @@ public class PaperCommandManager extends BukkitCommandManager { } } + /** + * {@inheritDoc} + */ + @Override + public @Nullable CloudBrigadierManager brigadierManager() { + if (this.paperBrigadierListener != null) { + return this.paperBrigadierListener.brigadierManager(); + } + return super.brigadierManager(); + } + /** * Register asynchronous completions. This requires all argument parsers to be thread safe, and it * is up to the caller to guarantee that such is the case