Skip to content

Multiline function calling #8117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: dev/feature
Choose a base branch
from
Draft

Multiline function calling #8117

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
125d115
init commit
Efnilite Aug 6, 2025
18ba815
use FunctionRegistry
Efnilite Aug 6, 2025
e1dcf5d
init commit
Efnilite Aug 6, 2025
d82ac87
requested changes
Efnilite Aug 7, 2025
29dd1a1
fix variables
Efnilite Aug 7, 2025
17e0431
Merge branch 'dev/feature' into feature/multiline-function-args
Efnilite Sep 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
333 changes: 167 additions & 166 deletions src/main/java/ch/njol/skript/sections/ExprSecFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@

@Name("Function Section")
@Description("""
Runs a function with the specified arguments.
""")
Runs a function with the specified arguments.
""")
@Example("""
local function multiply(x: number, y: number) returns number:
return {_x} * {_y}
Expand All @@ -47,204 +47,205 @@ local function multiply(x: number, y: number) returns number:
@Since("INSERT VERSION")
public class ExprSecFunction extends SectionExpression<Object> {

/**
* The pattern for a valid function name.
* Functions must start with a letter or underscore and can only contain letters, numbers, and underscores.
*/
private final static Pattern FUNCTION_NAME_PATTERN = Pattern.compile("[A-z_][A-z_0-9]*");
/**
* The pattern for a valid function name.
* Functions must start with a letter or underscore and can only contain letters, numbers, and underscores.
*/
private final static Pattern FUNCTION_NAME_PATTERN = Pattern.compile("[A-z_][A-z_0-9]*");

/**
* The pattern for an argument that can be passed in the children of this section.
*/
private static final Pattern ARGUMENT_PATTERN = Pattern.compile("(?:(?:the )?argument )?(?<name>%s) set to (?<value>.+)".formatted(FUNCTION_NAME_PATTERN.toString()));
/**
* The pattern for an argument that can be passed in the children of this section.
*/
private static final Pattern ARGUMENT_PATTERN = Pattern.compile("(?:(?:the )?argument )?(?<name>%s) set to (?<value>.+)".formatted(FUNCTION_NAME_PATTERN.toString()));

static {
Skript.registerExpression(ExprSecFunction.class, Object.class, ExpressionType.SIMPLE, "[the] function <.+> with [the] arg[ument][s]");
}
static {
Skript.registerExpression(ExprSecFunction.class, Object.class, ExpressionType.SIMPLE, "[the] function <.+> with [the] arg[ument][s]");
}

private Function<?> function;
private LinkedHashMap<String, Expression<?>> arguments = null;
private Function<?> function;
private LinkedHashMap<String, Expression<?>> arguments = null;

@Override
public boolean init(Expression<?>[] expressions, int pattern, Kleenean delayed, ParseResult result,
@Nullable SectionNode node, @Nullable List<TriggerItem> triggerItems) {
@Override
public boolean init(Expression<?>[] expressions, int pattern, Kleenean delayed, ParseResult result,
@Nullable SectionNode node, @Nullable List<TriggerItem> triggerItems) {
assert node != null;

if (node.isEmpty()) {
Skript.error("A function section must contain arguments.");
return false;
}
if (node.isEmpty()) {
Skript.error("A function section must contain arguments.");
return false;
}

LinkedHashMap<String, String> args = new LinkedHashMap<>();
for (Node n : node) {
if (!(n instanceof SimpleNode) || n.getKey() == null) {
Skript.error("Invalid argument declaration for a function section: ", n.getKey());
return false;
}
LinkedHashMap<String, String> args = new LinkedHashMap<>();
for (Node n : node) {
if (!(n instanceof SimpleNode) || n.getKey() == null) {
Skript.error("Invalid argument declaration for a function section: ", n.getKey());
return false;
}

Matcher matcher = ARGUMENT_PATTERN.matcher(n.getKey());
if (!matcher.matches()) {
Skript.error("Invalid argument declaration for a function section: ", n.getKey());
return false;
}
Matcher matcher = ARGUMENT_PATTERN.matcher(n.getKey());
if (!matcher.matches()) {
Skript.error("Invalid argument declaration for a function section: ", n.getKey());
return false;
}

args.put(matcher.group("name"), matcher.group("value"));
}
args.put(matcher.group("name"), matcher.group("value"));
}

String namespace = ParserInstance.get().getCurrentScript().getConfig().getFileName();
String name = result.regexes.get(0).group();
String namespace = ParserInstance.get().getCurrentScript().getConfig().getFileName();
String name = result.regexes.get(0).group();

if (!FUNCTION_NAME_PATTERN.matcher(name).matches()) {
Skript.error("The function %s does not exist.", name);
return false;
}
if (!FUNCTION_NAME_PATTERN.matcher(name).matches()) {
Skript.error("The function %s does not exist.", name);
return false;
}

// todo use FunctionParser
function = findFunction(namespace, name, args);
// todo use FunctionParser
function = findFunction(namespace, name, args);

if (function == null || arguments == null || arguments.isEmpty()) {
doesNotExist(name, args);
return false;
}
if (function == null || arguments == null || arguments.isEmpty()) {
doesNotExist(name, args);
return false;
}

if (function.getReturnType() == null) {
Skript.error("The function %s does not return anything.", name);
return false;
}

return true;
}

/**
* Attempts to find the function to execute given the arguments.
*
* @param namespace The current script.
* @param name The name of the function.
* @param args The passed arguments.
* @return The function given the arguments, or null if no function is found.
*/
private Function<?> findFunction(String namespace, String name, LinkedHashMap<String, String> args) {
signatures:
for (Signature<?> signature : FunctionRegistry.getRegistry().getSignatures(namespace, name)) {
LinkedHashMap<String, Expression<?>> arguments = new LinkedHashMap<>();

LinkedHashMap<String, Parameter<?>> parameters = Arrays.stream(signature.getParameters())
.collect(Collectors.toMap(Parameter::getName, p -> p, (a, b) -> b, LinkedHashMap::new));
for (Entry<String, String> entry : args.entrySet()) {
Parameter<?> parameter = parameters.get(entry.getKey());

if (parameter == null) {
continue signatures;
}

//noinspection unchecked
Expression<?> expression = new SkriptParser(entry.getValue(), SkriptParser.ALL_FLAGS, ParseContext.DEFAULT)
.parseExpression(parameter.getType().getC());

if (expression == null || LiteralUtils.hasUnparsedLiteral(expression)) {
continue signatures;
}

arguments.put(entry.getKey(), expression);
}

Class<?>[] signatureArgs = Arrays.stream(signature.getParameters())
.map(it -> {
if (it.isSingleValue()) {
return it.getType().getC();
} else {
return it.getType().getC().arrayType();
}
})
.toArray(Class<?>[]::new);

Retrieval<Function<?>> retrieval = FunctionRegistry.getRegistry().getFunction(namespace, name, signatureArgs);
if (retrieval.result() == RetrievalResult.EXACT) {
this.arguments = arguments;
return retrieval.retrieved();
}
}

return null;
}

/**
* Prints the error for when a function does not exist.
*
* @param name The function name.
* @param arguments The passed arguments to the function call.
*/
private void doesNotExist(String name, LinkedHashMap<String, String> arguments) {
StringJoiner joiner = new StringJoiner(", ");

for (Map.Entry<String, String> entry : arguments.entrySet()) {
SkriptParser parser = new SkriptParser(entry.getValue(), SkriptParser.ALL_FLAGS, ParseContext.DEFAULT);

Expression<?> expression = LiteralUtils.defendExpression(parser.parseExpression(Object.class));

if (expression == null || LiteralUtils.hasUnparsedLiteral(expression)) {
joiner.add(entry.getKey() + ": ?");
continue;
}

if (expression.isSingle()) {
joiner.add(entry.getKey() + ": " + Classes.getSuperClassInfo(expression.getReturnType()).getName().getSingular());
} else {
joiner.add(entry.getKey() + ": " + Classes.getSuperClassInfo(expression.getReturnType()).getName().getPlural());
}
}

Skript.error("The function %s(%s) does not exist.", name, joiner);
}

@Override
protected Object @Nullable [] get(Event event) {
return true;
}

/**
* Attempts to find the function to execute given the arguments.
*
* @param namespace The current script.
* @param name The name of the function.
* @param args The passed arguments.
* @return The function given the arguments, or null if no function is found.
*/
private Function<?> findFunction(String namespace, String name, LinkedHashMap<String, String> args) {
signatures:
for (Signature<?> signature : FunctionRegistry.getRegistry().getSignatures(namespace, name)) {
LinkedHashMap<String, Expression<?>> arguments = new LinkedHashMap<>();

LinkedHashMap<String, Parameter<?>> parameters = Arrays.stream(signature.getParameters())
.collect(Collectors.toMap(Parameter::getName, p -> p, (a, b) -> b, LinkedHashMap::new));
for (Entry<String, String> entry : args.entrySet()) {
Parameter<?> parameter = parameters.get(entry.getKey());

if (parameter == null) {
continue signatures;
}

//noinspection unchecked
Expression<?> expression = LiteralUtils.defendExpression(
new SkriptParser(entry.getValue(), SkriptParser.ALL_FLAGS, ParseContext.DEFAULT)
.parseExpression(parameter.getType().getC()));

if (expression == null || LiteralUtils.hasUnparsedLiteral(expression)) {
continue signatures;
}

arguments.put(entry.getKey(), expression);
}

Class<?>[] signatureArgs = Arrays.stream(signature.getParameters())
.map(it -> {
if (it.isSingleValue()) {
return it.getType().getC();
} else {
return it.getType().getC().arrayType();
}
})
.toArray(Class<?>[]::new);

Retrieval<Function<?>> retrieval = FunctionRegistry.getRegistry().getFunction(namespace, name, signatureArgs);
if (retrieval.result() == RetrievalResult.EXACT) {
this.arguments = arguments;
return retrieval.retrieved();
}
}

return null;
}

/**
* Prints the error for when a function does not exist.
*
* @param name The function name.
* @param arguments The passed arguments to the function call.
*/
private void doesNotExist(String name, LinkedHashMap<String, String> arguments) {
StringJoiner joiner = new StringJoiner(", ");

for (Map.Entry<String, String> entry : arguments.entrySet()) {
SkriptParser parser = new SkriptParser(entry.getValue(), SkriptParser.ALL_FLAGS, ParseContext.DEFAULT);

Expression<?> expression = LiteralUtils.defendExpression(parser.parseExpression(Object.class));

if (expression == null || LiteralUtils.hasUnparsedLiteral(expression)) {
joiner.add(entry.getKey() + ": ?");
continue;
}

if (expression.isSingle()) {
joiner.add(entry.getKey() + ": " + Classes.getSuperClassInfo(expression.getReturnType()).getName().getSingular());
} else {
joiner.add(entry.getKey() + ": " + Classes.getSuperClassInfo(expression.getReturnType()).getName().getPlural());
}
}

Skript.error("The function %s(%s) does not exist.", name, joiner);
}

@Override
protected Object @Nullable [] get(Event event) {
if (function == null) {
return null;
}

Object[][] args = new Object[function.getParameters().length][];
int i = 0;
for (Parameter<?> value : function.getParameters()) {
Object[][] args = new Object[function.getParameters().length][];
int i = 0;
for (Parameter<?> value : function.getParameters()) {
Expression<?> expression = arguments.get(value.getName());

if (expression == null) {
return null;
}

args[i] = expression.getArray(event);
i++;
}
i++;
}

try {
try {
return function.execute(args);
} finally {
function.resetReturnValue();
}
}

@Override
public boolean isSingle() {
return function.isSingle();
}

@Override
public boolean isSectionOnly() {
return true;
}

@Override
public Class<?> getReturnType() {
return function.getReturnType() != null ? function.getReturnType().getC() : null;
}

@Override
public String toString(@Nullable Event event, boolean debug) {
return new SyntaxStringBuilder(event, debug)
.append("run function")
.append(function.getName())
.append("with arguments")
.toString();
}
}

@Override
public boolean isSingle() {
return function.isSingle();
}

@Override
public boolean isSectionOnly() {
return true;
}

@Override
public Class<?> getReturnType() {
return function.getReturnType() != null ? function.getReturnType().getC() : null;
}

@Override
public String toString(@Nullable Event event, boolean debug) {
return new SyntaxStringBuilder(event, debug)
.append("run function")
.append(function.getName())
.append("with arguments")
.toString();
}

}
Loading