All Downloads are FREE. Search and download functionalities are using the official Maven repository.

cloud.commandframework.bukkit.parsers.BlockPredicateArgument Maven / Gradle / Ivy

Go to download

Command framework and dispatcher for the JVM

There is a newer version: 1.8.4
Show newest version
//
// MIT License
//
// Copyright (c) 2022 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.bukkit.parsers;

import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.brigadier.argument.WrappedBrigadierParser;
import cloud.commandframework.bukkit.BukkitCommandManager;
import cloud.commandframework.bukkit.data.BlockPredicate;
import cloud.commandframework.bukkit.internal.CommandBuildContextSupplier;
import cloud.commandframework.bukkit.internal.CraftBukkitReflection;
import cloud.commandframework.bukkit.internal.MinecraftArgumentTypes;
import cloud.commandframework.bukkit.internal.RegistryReflection;
import cloud.commandframework.context.CommandContext;
import com.mojang.brigadier.arguments.ArgumentType;
import io.leangen.geantyref.TypeToken;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Objects;
import java.util.Queue;
import java.util.function.BiFunction;
import java.util.function.Predicate;
import org.bukkit.NamespacedKey;
import org.bukkit.block.Block;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Argument type for parsing a {@link BlockPredicate}.
 *
 * 
This argument type is only usable on Minecraft 1.13+, as it depends on Minecraft internals added in that version.

 *
 * 
This argument type only provides basic suggestions by default. Enabling Brigadier compatibility through
 * {@link BukkitCommandManager#registerBrigadier()} will allow client side validation and suggestions to be utilized.

 *
 * @param  Command sender type
 * @since 1.5.0
 */
public final class BlockPredicateArgument extends CommandArgument {

    private BlockPredicateArgument(
            final boolean required,
            final @NonNull String name,
            final @NonNull String defaultValue,
            final @Nullable BiFunction<@NonNull CommandContext, @NonNull String,
                    @NonNull List<@NonNull String>> suggestionsProvider,
            final @NonNull ArgumentDescription defaultDescription
    ) {
        super(required, name, new Parser<>(), defaultValue, BlockPredicate.class, suggestionsProvider, defaultDescription);
    }

    /**
     * Create a new {@link Builder}.
     *
     * @param name Name of the argument
     * @param   Command sender type
     * @return Created builder
     * @since 1.5.0
     */
    public static  BlockPredicateArgument.@NonNull Builder builder(final @NonNull String name) {
        return new BlockPredicateArgument.Builder<>(name);
    }

    /**
     * Create a new required {@link BlockPredicateArgument}.
     *
     * @param name Argument name
     * @param   Command sender type
     * @return Created argument
     * @since 1.5.0
     */
    public static  @NonNull BlockPredicateArgument of(final @NonNull String name) {
        return BlockPredicateArgument.builder(name).build();
    }

    /**
     * Create a new optional {@link BlockPredicateArgument}.
     *
     * @param name Argument name
     * @param   Command sender type
     * @return Created argument
     * @since 1.5.0
     */
    public static  @NonNull BlockPredicateArgument optional(final @NonNull String name) {
        return BlockPredicateArgument.builder(name).asOptional().build();
    }


    /**
     * Builder for {@link BlockPredicateArgument}.
     *
     * @param  sender type
     * @since 1.5.0
     */
    public static final class Builder extends TypedBuilder> {

        private Builder(final @NonNull String name) {
            super(BlockPredicate.class, name);
        }

        @Override
        public @NonNull BlockPredicateArgument build() {
            return new BlockPredicateArgument<>(
                    this.isRequired(),
                    this.getName(),
                    this.getDefaultValue(),
                    this.getSuggestionsProvider(),
                    this.getDefaultDescription()
            );
        }
    }

    /**
     * Parser for {@link BlockPredicateArgument}. Only supported on Minecraft 1.13 and newer CraftBukkit based servers.
     *
     * @param  sender type
     * @since 1.5.0
     */
    public static final class Parser implements ArgumentParser {

        private static final Class TAG_CONTAINER_CLASS;

        static {
            Class tagContainerClass;
            if (CraftBukkitReflection.MAJOR_REVISION > 12 && CraftBukkitReflection.MAJOR_REVISION < 16) {
                tagContainerClass = CraftBukkitReflection.needNMSClass("TagRegistry");
            } else {
                tagContainerClass = CraftBukkitReflection.firstNonNullOrThrow(
                        () -> "tagContainerClass",
                        CraftBukkitReflection.findNMSClass("ITagRegistry"),
                        CraftBukkitReflection.findMCClass("tags.ITagRegistry"),
                        CraftBukkitReflection.findMCClass("tags.TagContainer"),
                        CraftBukkitReflection.findMCClass("core.IRegistry"),
                        CraftBukkitReflection.findMCClass("core.Registry")
                );
            }
            TAG_CONTAINER_CLASS = tagContainerClass;
        }

        private static final Class CRAFT_WORLD_CLASS = CraftBukkitReflection.needOBCClass("CraftWorld");
        private static final Class MINECRAFT_SERVER_CLASS = CraftBukkitReflection.needNMSClassOrElse(
                "MinecraftServer",
                "net.minecraft.server.MinecraftServer"
        );
        private static final Class COMMAND_LISTENER_WRAPPER_CLASS = CraftBukkitReflection.firstNonNullOrThrow(
                () -> "Couldn't find CommandSourceStack class",
                CraftBukkitReflection.findNMSClass("CommandListenerWrapper"),
                CraftBukkitReflection.findMCClass("commands.CommandListenerWrapper"),
                CraftBukkitReflection.findMCClass("commands.CommandSourceStack")
        );
        private static final Class ARGUMENT_BLOCK_PREDICATE_CLASS =
                MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("block_predicate"));
        private static final Class ARGUMENT_BLOCK_PREDICATE_RESULT_CLASS = CraftBukkitReflection.firstNonNullOrThrow(
                () -> "Couldn't find BlockPredicateArgument$Result class",
                CraftBukkitReflection.findNMSClass("ArgumentBlockPredicate$b"),
                CraftBukkitReflection.findMCClass("commands.arguments.blocks.ArgumentBlockPredicate$b"),
                CraftBukkitReflection.findMCClass("commands.arguments.blocks.BlockPredicateArgument$Result")
        );
        private static final Class SHAPE_DETECTOR_BLOCK_CLASS = CraftBukkitReflection.firstNonNullOrThrow(
                () -> "Couldn't find BlockInWorld class",
                CraftBukkitReflection.findNMSClass("ShapeDetectorBlock"),
                CraftBukkitReflection.findMCClass("world.level.block.state.pattern.ShapeDetectorBlock"),
                CraftBukkitReflection.findMCClass("world.level.block.state.pattern.BlockInWorld")
        );
        private static final Class LEVEL_READER_CLASS = CraftBukkitReflection.firstNonNullOrThrow(
                () -> "Couldn't find LevelReader class",
                CraftBukkitReflection.findNMSClass("IWorldReader"),
                CraftBukkitReflection.findMCClass("world.level.IWorldReader"),
                CraftBukkitReflection.findMCClass("world.level.LevelReader")
        );
        private static final Class BLOCK_POSITION_CLASS = CraftBukkitReflection.firstNonNullOrThrow(
                () -> "Couldn't find BlockPos class",
                CraftBukkitReflection.findNMSClass("BlockPosition"),
                CraftBukkitReflection.findMCClass("core.BlockPosition"),
                CraftBukkitReflection.findMCClass("core.BlockPos")
        );
        private static final Constructor BLOCK_POSITION_CTR =
                CraftBukkitReflection.needConstructor(BLOCK_POSITION_CLASS, int.class, int.class, int.class);
        private static final Constructor SHAPE_DETECTOR_BLOCK_CTR = CraftBukkitReflection
                .needConstructor(SHAPE_DETECTOR_BLOCK_CLASS, LEVEL_READER_CLASS, BLOCK_POSITION_CLASS, boolean.class);
        private static final Method GET_HANDLE_METHOD = CraftBukkitReflection.needMethod(CRAFT_WORLD_CLASS, "getHandle");
        private static final @Nullable Method CREATE_PREDICATE_METHOD = CraftBukkitReflection.firstNonNullOrNull(
                CraftBukkitReflection.findMethod(ARGUMENT_BLOCK_PREDICATE_RESULT_CLASS, "create", TAG_CONTAINER_CLASS),
                CraftBukkitReflection.findMethod(ARGUMENT_BLOCK_PREDICATE_RESULT_CLASS, "a", TAG_CONTAINER_CLASS)
        );
        private static final Method GET_SERVER_METHOD = CraftBukkitReflection.streamMethods(COMMAND_LISTENER_WRAPPER_CLASS)
                .filter(it -> it.getReturnType().equals(MINECRAFT_SERVER_CLASS) && it.getParameterCount() == 0)
                .findFirst()
                .orElseThrow(() -> new IllegalStateException("Could not find CommandSourceStack#getServer."));
        private static final @Nullable Method GET_TAG_REGISTRY_METHOD = CraftBukkitReflection.firstNonNullOrNull(
                CraftBukkitReflection.findMethod(MINECRAFT_SERVER_CLASS, "getTagRegistry"),
                CraftBukkitReflection.findMethod(MINECRAFT_SERVER_CLASS, "getTags"),
                CraftBukkitReflection.streamMethods(MINECRAFT_SERVER_CLASS)
                        .filter(it -> it.getReturnType().equals(TAG_CONTAINER_CLASS) && it.getParameterCount() == 0)
                        .findFirst()
                        .orElse(null)
        );

        private final ArgumentParser parser;

        /**
         * Create a new {@link Parser}.
         *
         * @since 1.5.0
         */
        public Parser() {
            try {
                this.parser = this.createParser();
            } catch (final ReflectiveOperationException ex) {
                throw new RuntimeException("Failed to initialize BlockPredicate parser.", ex);
            }
        }

        @SuppressWarnings("unchecked")
        private ArgumentParser createParser() throws ReflectiveOperationException {
            final Constructor ctr = ARGUMENT_BLOCK_PREDICATE_CLASS.getDeclaredConstructors()[0];
            final ArgumentType inst;
            if (ctr.getParameterCount() == 0) {
                inst = (ArgumentType) ctr.newInstance();
            } else {
                // 1.19+
                inst = (ArgumentType) ctr.newInstance(CommandBuildContextSupplier.commandBuildContext());
            }
            return new WrappedBrigadierParser(inst).map((ctx, result) -> {
                if (result instanceof Predicate) {
                    // 1.19+
                    return ArgumentParseResult.success(new BlockPredicateImpl((Predicate) result));
                }
                final Object commandSourceStack = ctx.get(WrappedBrigadierParser.COMMAND_CONTEXT_BRIGADIER_NATIVE_SENDER);
                try {
                    final Object server = GET_SERVER_METHOD.invoke(commandSourceStack);
                    final Object obj;
                    if (GET_TAG_REGISTRY_METHOD != null) {
                        obj = GET_TAG_REGISTRY_METHOD.invoke(server);
                    } else {
                        obj = RegistryReflection.registryByName("block");
                    }
                    Objects.requireNonNull(CREATE_PREDICATE_METHOD, "create on BlockPredicateArgument$Result");
                    final Predicate predicate = (Predicate) CREATE_PREDICATE_METHOD.invoke(result, obj);
                    return ArgumentParseResult.success(new BlockPredicateImpl(predicate));
                } catch (final ReflectiveOperationException ex) {
                    throw new RuntimeException(ex);
                }
            });
        }

        @Override
        public @NonNull ArgumentParseResult<@NonNull BlockPredicate> parse(
                @NonNull final CommandContext<@NonNull C> commandContext,
                @NonNull final Queue<@NonNull String> inputQueue
        ) {
            return this.parser.parse(commandContext, inputQueue);
        }

        @Override
        public @NonNull List<@NonNull String> suggestions(
                final @NonNull CommandContext commandContext,
                final @NonNull String input
        ) {
            return this.parser.suggestions(commandContext, input);
        }

        private static final class BlockPredicateImpl implements BlockPredicate {

            private final Predicate predicate;

            BlockPredicateImpl(final @NonNull Predicate predicate) {
                this.predicate = predicate;
            }

            private boolean testImpl(final @NonNull Block block, final boolean loadChunks) {
                try {
                    final Object blockInWorld = SHAPE_DETECTOR_BLOCK_CTR.newInstance(
                            GET_HANDLE_METHOD.invoke(block.getWorld()),
                            BLOCK_POSITION_CTR.newInstance(block.getX(), block.getY(), block.getZ()),
                            loadChunks
                    );
                    return this.predicate.test(blockInWorld);
                } catch (final ReflectiveOperationException ex) {
                    throw new RuntimeException(ex);
                }
            }

            @Override
            public boolean test(final @NonNull Block block) {
                return this.testImpl(block, false);
            }

            @Override
            public @NonNull BlockPredicate loadChunks() {
                return new BlockPredicate() {
                    @Override
                    public @NonNull BlockPredicate loadChunks() {
                        return this;
                    }

                    @Override
                    public boolean test(final Block block) {
                        return BlockPredicateImpl.this.testImpl(block, true);
                    }
                };
            }
        }
    }

    /**
     * Called reflectively by {@link BukkitCommandManager}.
     *
     * @param commandManager command manager
     * @param             sender type
     */
    @SuppressWarnings("unused")
    private static  void registerParserSupplier(final @NonNull BukkitCommandManager commandManager) {
        commandManager.parserRegistry()
                .registerParserSupplier(TypeToken.get(BlockPredicate.class), params -> new BlockPredicateArgument.Parser<>());
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy