Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
net.minestom.server.command.CommandParserImpl Maven / Gradle / Ivy
package net.minestom.server.command;
import net.minestom.server.command.Graph.Node;
import net.minestom.server.command.builder.*;
import net.minestom.server.command.builder.arguments.Argument;
import net.minestom.server.command.builder.condition.CommandCondition;
import net.minestom.server.command.builder.exception.ArgumentSyntaxException;
import net.minestom.server.command.builder.suggestion.Suggestion;
import net.minestom.server.command.builder.suggestion.SuggestionCallback;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
final class CommandParserImpl implements CommandParser {
private static final Logger LOGGER = LoggerFactory.getLogger(CommandParserImpl.class);
static final CommandParserImpl PARSER = new CommandParserImpl();
static final class Chain {
CommandExecutor defaultExecutor = null;
SuggestionCallback suggestionCallback = null;
final ArrayDeque nodeResults = new ArrayDeque<>();
final List conditions = new ArrayList<>();
final List globalListeners = new ArrayList<>();
void append(NodeResult result) {
this.nodeResults.add(result);
final Graph.Execution execution = result.node.execution();
if (execution != null) {
// Create condition chain
final CommandCondition condition = execution.condition();
if (condition != null) conditions.add(condition);
// Track default executor
final CommandExecutor defExec = execution.defaultExecutor();
if (defExec != null) defaultExecutor = defExec;
// Merge global listeners
final CommandExecutor globalListener = execution.globalListener();
if (globalListener != null) globalListeners.add(globalListener);
}
}
CommandCondition mergedConditions() {
return (sender, commandString) -> {
for (CommandCondition condition : conditions) {
if (!condition.canUse(sender, commandString)) return false;
}
return true;
};
}
CommandExecutor mergedGlobalExecutors() {
return (sender, context) -> globalListeners.forEach(x -> x.apply(sender, context));
}
Map> collectArguments() {
return nodeResults.stream()
.skip(2) // skip root node and command
.collect(Collectors.toUnmodifiableMap(NodeResult::name, NodeResult::argumentResult));
}
List> getArgs() {
return nodeResults.stream().map(x -> x.node.argument()).collect(Collectors.toList());
}
int size() {
return nodeResults.size();
}
Chain() {}
Chain(CommandExecutor defaultExecutor,
SuggestionCallback suggestionCallback,
ArrayDeque nodeResults,
List conditions,
List globalListeners) {
this.defaultExecutor = defaultExecutor;
this.suggestionCallback = suggestionCallback;
this.nodeResults.addAll(nodeResults);
this.conditions.addAll(conditions);
this.globalListeners.addAll(globalListeners);
}
Chain fork() {
return new Chain(defaultExecutor, suggestionCallback, nodeResults, conditions, globalListeners);
}
}
@Override
public @NotNull CommandParser.Result parse(@NotNull CommandSender sender, @NotNull Graph graph, @NotNull String input) {
final CommandStringReader reader = new CommandStringReader(input);
Chain chain = new Chain();
Node parent = graph.root();
NodeResult result = parseNode(sender, parent, chain, reader);
chain = result.chain;
NodeResult lastNodeResult = chain.nodeResults.peekLast();
if (lastNodeResult == null) return UnknownCommandResult.INSTANCE;
Node lastNode = lastNodeResult.node;
if (result.argumentResult instanceof ArgumentResult.Success) {
CommandExecutor executor = nullSafeGetter(lastNode.execution(), Graph.Execution::executor);
if (executor != null) return ValidCommand.executor(input, chain, executor);
}
// If here, then the command failed or didn't have an executor
// Look for a default executor, or give up if we got nowhere
if (lastNode.equals(parent)) return UnknownCommandResult.INSTANCE;
if (chain.defaultExecutor != null) {
return ValidCommand.defaultExecutor(input, chain);
}
return InvalidCommand.invalid(input, chain);
}
@Contract("null, _ -> null; !null, null -> fail; !null, !null -> _")
private static @Nullable R nullSafeGetter(@Nullable T obj, Function getter) {
return obj == null ? null : getter.apply(obj);
}
private static NodeResult parseNode(@NotNull CommandSender sender, Node node, Chain chain, CommandStringReader reader) {
chain = chain.fork();
Argument argument = node.argument();
int start = reader.cursor();
if (reader.hasRemaining()) {
ArgumentResult result = parseArgument(sender, argument, reader);
SuggestionCallback suggestionCallback = argument.getSuggestionCallback();
NodeResult nodeResult = new NodeResult(node, chain, (ArgumentResult) result, suggestionCallback);
chain.append(nodeResult);
if (suggestionCallback != null) chain.suggestionCallback = suggestionCallback;
if (chain.size() == 1) { // If this is the root node (usually "Literal<>")
reader.cursor(start);
} else {
if (!(result instanceof ArgumentResult.Success)) {
reader.cursor(start);
return nodeResult;
}
}
} else {
// Nothing left, yet we're still being asked to parse? There must be defaults then
Function defaultSupplier = node.argument().getDefaultValue();
if (defaultSupplier != null) {
Object value = defaultSupplier.apply(sender);
ArgumentResult argumentResult = new ArgumentResult.Success<>(value, "");
chain.append(new NodeResult(node, chain, argumentResult, argument.getSuggestionCallback()));
// Add the default to the chain, and then carry on dealing with this node
} else {
// Still being asked to parse yet there's nothing left, syntax error.
return new NodeResult(
node,
chain,
new ArgumentResult.SyntaxError<>("Not enough arguments","",-1),
argument.getSuggestionCallback()
);
}
}
// Successfully matched this node's argument
start = reader.cursor();
if (!reader.hasRemaining()) start--; // This is needed otherwise the reader throws an AssertionError
NodeResult error = null;
for (Node child : node.next()) {
NodeResult childResult = parseNode(sender, child, chain, reader);
if (childResult.argumentResult instanceof ArgumentResult.Success) {
// Assume that there is only one successful node for a given chain of arguments
return childResult;
} else {
if (error == null || error.chain.size() < childResult.chain.size()) {
// If this is the base argument (e.g. "teleport" in /teleport) then
// do not report an argument to be incompatible, since the more
// correct thing would be to say that the command is unknown.
if (!(childResult.chain.size() == 2 && childResult.argumentResult instanceof ArgumentResult.IncompatibleType)) {
error = childResult;
}
}
reader.cursor(start);
}
}
// None were successful. Either incompatible types, or syntax error. It doesn't matter to us, though
// Try to execute this node
CommandExecutor executor = nullSafeGetter(node.execution(), Graph.Execution::executor);
if (executor == null) {
// Stuck here with no executor
if (error != null) {
return error;
} else {
return chain.nodeResults.peekLast();
}
}
if (reader.hasRemaining()) {
// Trailing data is a syntax error
return new NodeResult(
node,
chain,
new ArgumentResult.SyntaxError<>("Command has trailing data", "", -1),
argument.getSuggestionCallback()
);
}
// Command was successful!
return chain.nodeResults.peekLast();
}
record UnknownCommandResult() implements Result.UnknownCommand {
private static final Result INSTANCE = new UnknownCommandResult();
@Override
public @NotNull ExecutableCommand executable() {
return UnknownExecutableCmd.INSTANCE;
}
@Override
public @Nullable Suggestion suggestion(CommandSender sender) {
return null;
}
@Override
public List> args() {
return null;
}
}
sealed interface InternalKnownCommand extends Result.KnownCommand {
String input();
@Nullable CommandCondition condition();
@NotNull Map> arguments();
CommandExecutor globalListener();
@Nullable SuggestionCallback suggestionCallback();
@Override
default @Nullable Suggestion suggestion(CommandSender sender) {
final SuggestionCallback callback = suggestionCallback();
if (callback == null) return null;
final int lastSpace = input().lastIndexOf(" ");
final Suggestion suggestion = new Suggestion(input(), lastSpace + 2, input().length() - lastSpace - 1);
final CommandContext context = createCommandContext(input(), arguments());
callback.apply(sender, context, suggestion);
return suggestion;
}
}
record InvalidCommand(String input, CommandCondition condition, ArgumentCallback callback,
ArgumentResult.SyntaxError error,
@NotNull Map> arguments, CommandExecutor globalListener,
@Nullable SuggestionCallback suggestionCallback, List> args)
implements InternalKnownCommand, Result.KnownCommand.Invalid {
static InvalidCommand invalid(String input, Chain chain) {
return new InvalidCommand(input, chain.mergedConditions(),
null/*todo command syntax callback*/,
new ArgumentResult.SyntaxError<>("Command has trailing data.", null, -1),
chain.collectArguments(), chain.mergedGlobalExecutors(), chain.suggestionCallback, chain.getArgs());
}
@Override
public @NotNull ExecutableCommand executable() {
return new InvalidExecutableCmd(condition, globalListener, callback, error, input, arguments);
}
}
record ValidCommand(String input, CommandCondition condition, CommandExecutor executor,
@NotNull Map> arguments,
CommandExecutor globalListener, @Nullable SuggestionCallback suggestionCallback, List> args)
implements InternalKnownCommand, Result.KnownCommand.Valid {
static ValidCommand defaultExecutor(String input, Chain chain) {
return new ValidCommand(input, chain.mergedConditions(), chain.defaultExecutor, chain.collectArguments(),
chain.mergedGlobalExecutors(), chain.suggestionCallback, chain.getArgs());
}
static ValidCommand executor(String input, Chain chain, CommandExecutor executor) {
return new ValidCommand(input, chain.mergedConditions(), executor, chain.collectArguments(), chain.mergedGlobalExecutors(),
chain.suggestionCallback, chain.getArgs());
}
@Override
public @NotNull ExecutableCommand executable() {
return new ValidExecutableCmd(condition, globalListener, executor, input, arguments);
}
}
record UnknownExecutableCmd() implements ExecutableCommand {
static final ExecutableCommand INSTANCE = new UnknownExecutableCmd();
@Override
public @NotNull Result execute(@NotNull CommandSender sender) {
return ExecutionResultImpl.UNKNOWN;
}
}
record ValidExecutableCmd(CommandCondition condition, CommandExecutor globalListener, CommandExecutor executor,
String input,
Map> arguments) implements ExecutableCommand {
@Override
public @NotNull Result execute(@NotNull CommandSender sender) {
final CommandContext context = createCommandContext(input, arguments);
globalListener().apply(sender, context);
if (condition != null && !condition.canUse(sender, input())) {
return ExecutionResultImpl.PRECONDITION_FAILED;
}
try {
executor().apply(sender, context);
return new ExecutionResultImpl(ExecutableCommand.Result.Type.SUCCESS, context.getReturnData());
} catch (Exception e) {
LOGGER.error("An exception was encountered while executing command: " + input(), e);
return ExecutionResultImpl.EXECUTOR_EXCEPTION;
}
}
}
record InvalidExecutableCmd(CommandCondition condition, CommandExecutor globalListener, ArgumentCallback callback,
ArgumentResult.SyntaxError error, String input,
Map> arguments) implements ExecutableCommand {
@Override
public @NotNull Result execute(@NotNull CommandSender sender) {
globalListener().apply(sender, createCommandContext(input, arguments));
if (condition != null && !condition.canUse(sender, input())) {
return ExecutionResultImpl.PRECONDITION_FAILED;
}
if (callback != null)
callback.apply(sender, new ArgumentSyntaxException(error.message(), error.input(), error.code()));
return ExecutionResultImpl.INVALID_SYNTAX;
}
}
private static CommandContext createCommandContext(String input, Map> arguments) {
final CommandContext context = new CommandContext(input);
for (var entry : arguments.entrySet()) {
final String identifier = entry.getKey();
final ArgumentResult value = entry.getValue();
final Object argOutput = value instanceof ArgumentResult.Success success ? success.value() : null;
final String argInput = value instanceof ArgumentResult.Success success ? success.input() : "";
context.setArg(identifier, argOutput, argInput);
}
return context;
}
record ExecutionResultImpl(Type type, CommandData commandData) implements ExecutableCommand.Result {
static final ExecutableCommand.Result CANCELLED = new ExecutionResultImpl(Type.CANCELLED, null);
static final ExecutableCommand.Result UNKNOWN = new ExecutionResultImpl(Type.UNKNOWN, null);
static final ExecutableCommand.Result EXECUTOR_EXCEPTION = new ExecutionResultImpl(Type.EXECUTOR_EXCEPTION, null);
static final ExecutableCommand.Result PRECONDITION_FAILED = new ExecutionResultImpl(Type.PRECONDITION_FAILED, null);
static final ExecutableCommand.Result INVALID_SYNTAX = new ExecutionResultImpl(Type.INVALID_SYNTAX, null);
}
private record NodeResult(Node node, Chain chain, ArgumentResult argumentResult, SuggestionCallback callback) {
public String name() {
return node.argument().getId();
}
}
static final class CommandStringReader {
private final String input;
private int cursor = 0;
CommandStringReader(String input) {
this.input = input;
}
boolean hasRemaining() {
return cursor < input.length();
}
String readWord() {
final String input = this.input;
final int cursor = this.cursor;
final int i = input.indexOf(' ', cursor);
if (i == -1) {
this.cursor = input.length() + 1;
return input.substring(cursor);
}
final String read = input.substring(cursor, i);
this.cursor += read.length() + 1;
return read;
}
String readRemaining() {
final String input = this.input;
final String result = input.substring(cursor);
this.cursor = input.length();
return result;
}
int cursor() {
return cursor;
}
void cursor(int cursor) {
assert cursor >= 0 && cursor <= input.length();
this.cursor = cursor;
}
}
// ARGUMENT
private static ArgumentResult parseArgument(@NotNull CommandSender sender, Argument argument, CommandStringReader reader) {
// Handle specific type without loop
try {
// Single word argument
if (!argument.allowSpace()) {
final String word = reader.readWord();
return new ArgumentResult.Success<>(argument.parse(sender, word), word);
}
// Complete input argument
if (argument.useRemaining()) {
final String remaining = reader.readRemaining();
return new ArgumentResult.Success<>(argument.parse(sender, remaining), remaining);
}
} catch (ArgumentSyntaxException ignored) {
return new ArgumentResult.IncompatibleType<>();
}
// Bruteforce
assert argument.allowSpace() && !argument.useRemaining();
StringBuilder current = new StringBuilder(reader.readWord());
while (true) {
try {
final String input = current.toString();
return new ArgumentResult.Success<>(argument.parse(sender, input), input);
} catch (ArgumentSyntaxException ignored) {
if (!reader.hasRemaining()) break;
current.append(" ");
current.append(reader.readWord());
}
}
return new ArgumentResult.IncompatibleType<>();
}
private sealed interface ArgumentResult {
record Success(T value, String input)
implements ArgumentResult {
}
record IncompatibleType()
implements ArgumentResult {
}
record SyntaxError(String message, String input, int code)
implements ArgumentResult {
}
}
}
