Don't require BukkitCommandManager to use BukkitCommandSender

This commit is contained in:
Alexander Söderberg 2020-09-15 14:07:00 +02:00
parent d144c3ea8c
commit d78d64329b
No known key found for this signature in database
GPG key ID: C0207FF7EA146678
6 changed files with 84 additions and 37 deletions

View file

@ -53,7 +53,9 @@ public final class BukkitTest extends JavaPlugin {
public void onEnable() { public void onEnable() {
try { try {
final PaperCommandManager<BukkitCommandSender> mgr = new PaperCommandManager<>(this, final PaperCommandManager<BukkitCommandSender> mgr = new PaperCommandManager<>(this,
CommandExecutionCoordinator.simpleCoordinator()); CommandExecutionCoordinator
.simpleCoordinator(),
BukkitCommandSender::of);
mgr.registerBrigadier(); mgr.registerBrigadier();
mgr.command(mgr.commandBuilder("gamemode", mgr.command(mgr.commandBuilder("gamemode",
Collections.singleton("gajmöde"), Collections.singleton("gajmöde"),

View file

@ -32,7 +32,8 @@ import org.bukkit.plugin.Plugin;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
import java.util.List; import java.util.List;
final class BukkitCommand<C extends BukkitCommandSender> extends org.bukkit.command.Command implements PluginIdentifiableCommand { final class BukkitCommand<C extends com.intellectualsites.commands.sender.CommandSender>
extends org.bukkit.command.Command implements PluginIdentifiableCommand {
private final CommandComponent<C, ?> command; private final CommandComponent<C, ?> command;
private final BukkitCommandManager<C> bukkitCommandManager; private final BukkitCommandManager<C> bukkitCommandManager;
@ -54,7 +55,8 @@ final class BukkitCommand<C extends BukkitCommandSender> extends org.bukkit.comm
for (final String string : strings) { for (final String string : strings) {
builder.append(" ").append(string); builder.append(" ").append(string);
} }
this.bukkitCommandManager.executeCommand((C) BukkitCommandSender.of(commandSender), builder.toString()) this.bukkitCommandManager.executeCommand(this.bukkitCommandManager.getCommandSenderMapper().apply(commandSender),
builder.toString())
.whenComplete(((commandResult, throwable) -> { .whenComplete(((commandResult, throwable) -> {
if (throwable != null) { if (throwable != null) {
commandSender.sendMessage(ChatColor.RED + throwable.getCause().getMessage()); commandSender.sendMessage(ChatColor.RED + throwable.getCause().getMessage());
@ -79,7 +81,8 @@ final class BukkitCommand<C extends BukkitCommandSender> extends org.bukkit.comm
for (final String string : args) { for (final String string : args) {
builder.append(" ").append(string); builder.append(" ").append(string);
} }
return this.bukkitCommandManager.suggest((C) BukkitCommandSender.of(sender), builder.toString()); return this.bukkitCommandManager.suggest(this.bukkitCommandManager.getCommandSenderMapper().apply(sender),
builder.toString());
} }
@Override @Override

View file

@ -27,6 +27,7 @@ import com.google.common.reflect.TypeToken;
import com.intellectualsites.commands.execution.CommandExecutionCoordinator; import com.intellectualsites.commands.execution.CommandExecutionCoordinator;
import com.intellectualsites.commands.parsers.WorldComponent; import com.intellectualsites.commands.parsers.WorldComponent;
import org.bukkit.World; import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
@ -35,25 +36,32 @@ import java.util.function.Function;
/** /**
* Command manager for the Bukkit platform, using {@link BukkitCommandSender} as the * Command manager for the Bukkit platform, using {@link BukkitCommandSender} as the
* command sender type * command sender type
*
* @param <C> Command sender type
*/ */
public class BukkitCommandManager<C extends BukkitCommandSender> extends CommandManager<C, BukkitCommandMeta> { public class BukkitCommandManager<C extends com.intellectualsites.commands.sender.CommandSender>
extends CommandManager<C, BukkitCommandMeta> {
private final Plugin owningPlugin; private final Plugin owningPlugin;
private final Function<CommandSender, C> commandSenderMapper;
/** /**
* Construct a new Bukkit command manager * Construct a new Bukkit command manager
* *
* @param owningPlugin Plugin that is constructing the manager * @param owningPlugin Plugin that is constructing the manager
* @param commandExecutionCoordinator Coordinator provider * @param commandExecutionCoordinator Coordinator provider
* @param commandSenderMapper Function that maps {@link CommandSender} to the command sender type
* @throws Exception If the construction of the manager fails * @throws Exception If the construction of the manager fails
*/ */
public BukkitCommandManager(@Nonnull final Plugin owningPlugin, public BukkitCommandManager(@Nonnull final Plugin owningPlugin,
@Nonnull final Function<CommandTree<C, BukkitCommandMeta>, @Nonnull final Function<CommandTree<C, BukkitCommandMeta>,
CommandExecutionCoordinator<C, BukkitCommandMeta>> commandExecutionCoordinator) CommandExecutionCoordinator<C, BukkitCommandMeta>> commandExecutionCoordinator,
@Nonnull final Function<CommandSender, C> commandSenderMapper)
throws Exception { throws Exception {
super(commandExecutionCoordinator, new BukkitPluginRegistrationHandler()); super(commandExecutionCoordinator, new BukkitPluginRegistrationHandler());
((BukkitPluginRegistrationHandler) this.getCommandRegistrationHandler()).initialize(this); ((BukkitPluginRegistrationHandler) this.getCommandRegistrationHandler()).initialize(this);
this.owningPlugin = owningPlugin; this.owningPlugin = owningPlugin;
this.commandSenderMapper = commandSenderMapper;
/* Register Bukkit parsers */ /* Register Bukkit parsers */
this.getParserRegistry().registerParserSupplier(TypeToken.of(World.class), params -> new WorldComponent.WorldParser<>()); this.getParserRegistry().registerParserSupplier(TypeToken.of(World.class), params -> new WorldComponent.WorldParser<>());
@ -80,4 +88,9 @@ public class BukkitCommandManager<C extends BukkitCommandSender> extends Command
return BukkitCommandMetaBuilder.builder().withDescription("").build(); return BukkitCommandMetaBuilder.builder().withDescription("").build();
} }
@Nonnull
final Function<CommandSender, C> getCommandSenderMapper() {
return this.commandSenderMapper;
}
} }

View file

@ -23,11 +23,11 @@
// //
package com.intellectualsites.commands.parsers; package com.intellectualsites.commands.parsers;
import com.intellectualsites.commands.BukkitCommandSender;
import com.intellectualsites.commands.components.CommandComponent; import com.intellectualsites.commands.components.CommandComponent;
import com.intellectualsites.commands.components.parser.ComponentParseResult; import com.intellectualsites.commands.components.parser.ComponentParseResult;
import com.intellectualsites.commands.components.parser.ComponentParser; import com.intellectualsites.commands.components.parser.ComponentParser;
import com.intellectualsites.commands.context.CommandContext; import com.intellectualsites.commands.context.CommandContext;
import com.intellectualsites.commands.sender.CommandSender;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.World; import org.bukkit.World;
@ -41,7 +41,7 @@ import java.util.stream.Collectors;
* *
* @param <C> Command sender type * @param <C> Command sender type
*/ */
public class WorldComponent<C extends BukkitCommandSender> extends CommandComponent<C, World> { public class WorldComponent<C extends CommandSender> extends CommandComponent<C, World> {
protected WorldComponent(final boolean required, protected WorldComponent(final boolean required,
@Nonnull final String name, @Nonnull final String name,
@ -57,7 +57,7 @@ public class WorldComponent<C extends BukkitCommandSender> extends CommandCompon
* @return Created builder * @return Created builder
*/ */
@Nonnull @Nonnull
public static <C extends BukkitCommandSender> CommandComponent.Builder<C, World> newBuilder(@Nonnull final String name) { public static <C extends CommandSender> CommandComponent.Builder<C, World> newBuilder(@Nonnull final String name) {
return new WorldComponent.Builder<>(name); return new WorldComponent.Builder<>(name);
} }
@ -69,7 +69,7 @@ public class WorldComponent<C extends BukkitCommandSender> extends CommandCompon
* @return Created component * @return Created component
*/ */
@Nonnull @Nonnull
public static <C extends BukkitCommandSender> CommandComponent<C, World> required(@Nonnull final String name) { public static <C extends CommandSender> CommandComponent<C, World> required(@Nonnull final String name) {
return WorldComponent.<C>newBuilder(name).asRequired().build(); return WorldComponent.<C>newBuilder(name).asRequired().build();
} }
@ -81,7 +81,7 @@ public class WorldComponent<C extends BukkitCommandSender> extends CommandCompon
* @return Created component * @return Created component
*/ */
@Nonnull @Nonnull
public static <C extends BukkitCommandSender> CommandComponent<C, World> optional(@Nonnull final String name) { public static <C extends CommandSender> CommandComponent<C, World> optional(@Nonnull final String name) {
return WorldComponent.<C>newBuilder(name).asOptional().build(); return WorldComponent.<C>newBuilder(name).asOptional().build();
} }
@ -94,13 +94,13 @@ public class WorldComponent<C extends BukkitCommandSender> extends CommandCompon
* @return Created component * @return Created component
*/ */
@Nonnull @Nonnull
public static <C extends BukkitCommandSender> CommandComponent<C, World> optional(@Nonnull final String name, public static <C extends CommandSender> CommandComponent<C, World> optional(@Nonnull final String name,
@Nonnull final String defaultValue) { @Nonnull final String defaultValue) {
return WorldComponent.<C>newBuilder(name).asOptionalWithDefault(defaultValue).build(); return WorldComponent.<C>newBuilder(name).asOptionalWithDefault(defaultValue).build();
} }
public static final class Builder<C extends BukkitCommandSender> extends CommandComponent.Builder<C, World> { public static final class Builder<C extends CommandSender> extends CommandComponent.Builder<C, World> {
protected Builder(@Nonnull final String name) { protected Builder(@Nonnull final String name) {
super(World.class, name); super(World.class, name);
@ -114,7 +114,7 @@ public class WorldComponent<C extends BukkitCommandSender> extends CommandCompon
} }
public static final class WorldParser<C extends BukkitCommandSender> implements ComponentParser<C, World> { public static final class WorldParser<C extends CommandSender> implements ComponentParser<C, World> {
@Nonnull @Nonnull
@Override @Override

View file

@ -27,6 +27,7 @@ import com.destroystokyo.paper.brigadier.BukkitBrigadierCommandSource;
import com.destroystokyo.paper.event.brigadier.CommandRegisteredEvent; import com.destroystokyo.paper.event.brigadier.CommandRegisteredEvent;
import com.intellectualsites.commands.brigadier.CloudBrigadierManager; import com.intellectualsites.commands.brigadier.CloudBrigadierManager;
import com.intellectualsites.commands.components.CommandComponent; import com.intellectualsites.commands.components.CommandComponent;
import com.intellectualsites.commands.sender.CommandSender;
import com.mojang.brigadier.arguments.ArgumentType; import com.mojang.brigadier.arguments.ArgumentType;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.Material; import org.bukkit.Material;
@ -41,28 +42,29 @@ import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import java.util.UUID; import java.util.UUID;
class PaperBrigadierListener implements Listener { class PaperBrigadierListener<C extends CommandSender> implements Listener {
private final CloudBrigadierManager<BukkitCommandSender, BukkitBrigadierCommandSource> brigadierManager; private final CloudBrigadierManager<C, BukkitBrigadierCommandSource> brigadierManager;
private final PaperCommandManager paperCommandManager; private final PaperCommandManager<C> paperCommandManager;
private final String nmsVersion;
PaperBrigadierListener(@Nonnull final PaperCommandManager paperCommandManager) throws Exception { PaperBrigadierListener(@Nonnull final PaperCommandManager<C> paperCommandManager) throws Exception {
this.paperCommandManager = paperCommandManager; this.paperCommandManager = paperCommandManager;
this.brigadierManager = new CloudBrigadierManager<>(); this.brigadierManager = new CloudBrigadierManager<>();
/* Register default mappings */ /* Register default mappings */
final String version = Bukkit.getServer().getClass().getPackage().getName(); final String version = Bukkit.getServer().getClass().getPackage().getName();
final String nms = version.substring(version.lastIndexOf(".") + 1); this.nmsVersion = version.substring(version.lastIndexOf(".") + 1);
try { try {
/* Map UUID */ /* Map UUID */
this.mapSimpleNMS(UUID.class, this.getNMSArgument("UUID", nms).getConstructor()); this.mapSimpleNMS(UUID.class, this.getNMSArgument("UUID").getConstructor());
/* Map World */ /* Map World */
this.mapSimpleNMS(World.class, this.getNMSArgument("Dimension", nms).getConstructor()); this.mapSimpleNMS(World.class, this.getNMSArgument("Dimension").getConstructor());
/* Map Enchantment */ /* Map Enchantment */
this.mapSimpleNMS(Enchantment.class, this.getNMSArgument("Enchantment", nms).getConstructor()); this.mapSimpleNMS(Enchantment.class, this.getNMSArgument("Enchantment").getConstructor());
/* Map EntityType */ /* Map EntityType */
this.mapSimpleNMS(EntityType.class, this.getNMSArgument("EntitySummon", nms).getConstructor()); this.mapSimpleNMS(EntityType.class, this.getNMSArgument("EntitySummon").getConstructor());
/* Map Material */ /* Map Material */
this.mapSimpleNMS(Material.class, this.getNMSArgument("ItemStack", nms).getConstructor()); this.mapSimpleNMS(Material.class, this.getNMSArgument("ItemStack").getConstructor());
} catch (final Exception e) { } catch (final Exception e) {
this.paperCommandManager.getOwningPlugin() this.paperCommandManager.getOwningPlugin()
.getLogger() .getLogger()
@ -70,13 +72,26 @@ class PaperBrigadierListener implements Listener {
} }
} }
/**
* Attempt to retrieve an NMS argument type
*
* @param argument Argument type name
* @return Argument class
* @throws Exception If the type cannot be retrieved
*/
@Nonnull @Nonnull
private Class<?> getNMSArgument(@Nonnull final String argument, @Nonnull final String nms) throws Exception { private Class<?> getNMSArgument(@Nonnull final String argument) throws Exception {
return Class.forName(String.format("net.minecraft.server.%s.Argument%s", nms, argument)); return Class.forName(String.format("net.minecraft.server.%s.Argument%s", this.nmsVersion, argument));
} }
private void mapSimpleNMS(@Nonnull final Class<?> type, /**
@Nonnull final Constructor<?> constructor) { * Attempt to register a mapping between a type and a NMS argument type
*
* @param type Type to map
* @param constructor Constructor that construct the NMS argument type
*/
public void mapSimpleNMS(@Nonnull final Class<?> type,
@Nonnull final Constructor<?> constructor) {
try { try {
this.brigadierManager.registerDefaultArgumentTypeSupplier(type, () -> { this.brigadierManager.registerDefaultArgumentTypeSupplier(type, () -> {
try { try {
@ -96,8 +111,8 @@ class PaperBrigadierListener implements Listener {
@EventHandler @EventHandler
public void onCommandRegister(@Nonnull final CommandRegisteredEvent<BukkitBrigadierCommandSource> event) { public void onCommandRegister(@Nonnull final CommandRegisteredEvent<BukkitBrigadierCommandSource> event) {
final CommandTree<BukkitCommandSender, BukkitCommandMeta> commandTree = this.paperCommandManager.getCommandTree(); final CommandTree<C, BukkitCommandMeta> commandTree = this.paperCommandManager.getCommandTree();
final CommandTree.Node<CommandComponent<BukkitCommandSender, ?>> node = commandTree.getNamedNode(event.getCommandLabel()); final CommandTree.Node<CommandComponent<C, ?>> node = commandTree.getNamedNode(event.getCommandLabel());
if (node == null) { if (node == null) {
return; return;
} }

View file

@ -25,41 +25,55 @@ package com.intellectualsites.commands;
import com.intellectualsites.commands.execution.CommandExecutionCoordinator; import com.intellectualsites.commands.execution.CommandExecutionCoordinator;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
import javax.annotation.Nonnull; import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.function.Function; import java.util.function.Function;
/** /**
* Paper command manager that extends {@link BukkitCommandManager} * Paper command manager that extends {@link BukkitCommandManager}
*
* @param <C> Command sender type
*/ */
public class PaperCommandManager<C extends BukkitCommandSender> extends BukkitCommandManager<C> { public class PaperCommandManager<C extends com.intellectualsites.commands.sender.CommandSender>
extends BukkitCommandManager<C> {
/** /**
* Construct a new Paper command manager * Construct a new Paper command manager
* *
* @param owningPlugin Plugin that is constructing the manager * @param owningPlugin Plugin that is constructing the manager
* @param commandExecutionCoordinator Coordinator provider * @param commandExecutionCoordinator Coordinator provider
* @param commandSenderMapper Function that maps {@link CommandSender} to the command sender type
* @throws Exception If the construction of the manager fails * @throws Exception If the construction of the manager fails
*/ */
public PaperCommandManager(@Nonnull final Plugin owningPlugin, public PaperCommandManager(@Nonnull final Plugin owningPlugin,
@Nonnull final Function<CommandTree<C, BukkitCommandMeta>, @Nonnull final Function<CommandTree<C, BukkitCommandMeta>,
CommandExecutionCoordinator<C, BukkitCommandMeta>> commandExecutionCoordinator) throws CommandExecutionCoordinator<C, BukkitCommandMeta>> commandExecutionCoordinator,
@Nonnull final Function<CommandSender, C> commandSenderMapper) throws
Exception { Exception {
super(owningPlugin, commandExecutionCoordinator); super(owningPlugin, commandExecutionCoordinator, commandSenderMapper);
} }
/** /**
* Register the brigadier listener * Attempt to register the Brigadier mapper, and return it.
*
* @return {@link PaperBrigadierListener} instance, if it could be created. If it cannot
* be created {@code null} is returned
*/ */
public void registerBrigadier() { @Nullable
public PaperBrigadierListener<C> registerBrigadier() {
try { try {
Bukkit.getPluginManager().registerEvents(new PaperBrigadierListener(this), final PaperBrigadierListener<C> brigadierListener = new PaperBrigadierListener<>(this);
Bukkit.getPluginManager().registerEvents(brigadierListener,
this.getOwningPlugin()); this.getOwningPlugin());
return brigadierListener;
} catch (final Exception e) { } catch (final Exception e) {
this.getOwningPlugin().getLogger().severe("Failed to register Brigadier listener"); this.getOwningPlugin().getLogger().severe("Failed to register Brigadier listener");
e.printStackTrace(); e.printStackTrace();
} }
return null;
} }
} }