Add support for variadic functions, fixes #399

Author: Scony

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
  - Added support for @abstract functions
+ - Added support for variadic functions
 
 ### Changed
  - Fixed formatting of `@warning_ignore_start` and `@warning_ignore_restore`

gdtoolkit/common/ast.py

@@ -72,8 +72,13 @@ def __repr__(self):
 class Parameter:
     """Abstract representation of function parameter"""
 
-    def __init__(self, node: Tree):
-        self.name = node.children[0].value
+    def __init__(self, parameter_node: Tree):
+        if parameter_node.data == "func_arg_variadic":
+            self.name = parameter_node.children[0].children[0].value
+            self.variadic = True
+        else:
+            self.name = parameter_node.children[0].value
+            self.variadic = False
 
 
 # pylint: disable-next=too-few-public-methods

gdtoolkit/formatter/expression.py

@@ -155,6 +155,9 @@ def _format_foldable_to_multiple_lines(
         "lambda_header": _format_lambda_header_to_multiple_lines,
         # fake expressions:
         "func_args": _format_args_to_multiple_lines,
+        "func_arg_variadic": lambda e, ec, c: _append_to_expression_context_and_pass(
+            "...", e.children[0], ec, c
+        ),
         "func_arg_regular": _format_func_arg_to_multiple_lines,
         "func_arg_inf": _format_func_arg_to_multiple_lines,
         "func_arg_typed": _format_func_arg_to_multiple_lines,
@@ -332,12 +335,12 @@ def _format_func_arg_to_multiple_lines(
             expression.children[0], expression_context, context
         )
     if expression.data == "func_arg_typed" and len(expression.children) == 2:
-        return [
-            (
-                get_line(expression.children[1]),
-                f"{context.indent_string}{expression_to_str(expression)}",
-            )
-        ]
+        return _append_to_expression_context_and_pass(
+            f"{expression.children[0].value}: ",
+            expression.children[1],
+            expression_context,
+            context,
+        )
     template = {
         "func_arg_regular": "{} = ",
         "func_arg_inf": "{} := ",

gdtoolkit/formatter/expression_to_str.py

@@ -92,6 +92,7 @@ def expression_to_str(expression: Node) -> str:
         "lambda_header": _lambda_header_to_str,
         # fake expressions:
         "func_args": _args_to_str,
+        "func_arg_variadic": lambda e: f"...{expression_to_str(e.children[0])}",
         "func_arg_regular": lambda e: "{}{}".format(
             e.children[0].value,
             " = {}".format(standalone_expression_to_str(e.children[1]))

gdtoolkit/linter/basic_checks.py

@@ -129,7 +129,11 @@ def _unused_argument_check(parse_tree: Tree) -> List[Problem]:
             argument_tokens = {}
             func_args = func_header.children[1]
             for func_arg in [r for r in func_args.children if not is_trailing_comma(r)]:
-                arg_name_token = find_name_token_among_children(func_arg)
+                arg_name_token = find_name_token_among_children(
+                    func_arg
+                    if func_arg.data != "func_arg_variadic"
+                    else func_arg.children[0]
+                )
                 arg_name = arg_name_token.value  # type: ignore
                 argument_definitions[arg_name] = (
                     argument_definitions.get(arg_name, 0) + 1

gdtoolkit/parser/gdscript.lark

@@ -75,10 +75,13 @@ func_def: func_header _func_suite
 abstract_func_def: abstract_func_header
 func_header: "func" NAME func_args ["->" TYPE_HINT] ":"
 abstract_func_header: "func" NAME func_args ["->" TYPE_HINT]
+// TODO: Accept func_arg_variadic as last one only.
 func_args: "(" [func_arg ("," func_arg)* [trailing_comma]] ")"
-?func_arg: func_arg_regular
+?func_arg: func_arg_variadic
+         | func_arg_regular
          | func_arg_inf
          | func_arg_typed
+func_arg_variadic: "..." (func_arg_regular | func_arg_typed)
 func_arg_regular: NAME ["=" expr]
 func_arg_inf: NAME ":" "=" expr
 func_arg_typed: NAME ":" TYPE_HINT ["=" expr]

tests/common.py

@@ -1,7 +1,7 @@
 import os
 
 
-GODOT_SERVER = "godot4-latest"
+GODOT_SERVER = "godot4.5"
 
 
 def write_file(a_dir, file_name, code):

tests/formatter/input-output-pairs/variadic_functions.in.gd

@@ -0,0 +1,12 @@
+func foo(...args):
+	pass
+func bar(a,...args):
+	pass
+func baz(a,...args,):
+	pass
+func bat(a,...args:Array):
+	pass
+func ban(a,...args:Array,):
+	pass
+func bak(a,...aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:Array):
+	pass

tests/formatter/input-output-pairs/variadic_functions.out.gd

@@ -0,0 +1,31 @@
+func foo(...args):
+	pass
+
+
+func bar(a, ...args):
+	pass
+
+
+func baz(
+	a,
+	...args,
+):
+	pass
+
+
+func bat(a, ...args: Array):
+	pass
+
+
+func ban(
+	a,
+	...args: Array,
+):
+	pass
+
+
+func bak(
+	a,
+	...aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa: Array
+):
+	pass

tests/gd2py/input-output-pairs/class_level_statements.in.gd

@@ -35,3 +35,7 @@ func foo():
 
 static func bar():
 	pass
+
+
+func baz(a,b,...c):
+	pass