Supplement signal type hint support #189

Author: Scony

CHANGELOG.md

@@ -10,6 +10,8 @@
  - Added support for unique node names in parser & formatter
  - Added support for property etters in parser & formatter
  - Added support for inline-lambdas in parser & formatter
+ - Added support for func-level constants
+ - Added support for typed signal arguments
 
 ### Changed
  - Removed support for legacy (Godot `3.x`) GDScript from core testcases

gdtoolkit/formatter/expression_to_str.py

@@ -102,6 +102,10 @@ def expression_to_str(expression: Node) -> str:
         "enum_body": _enum_body_to_str,
         "enum_element": _enum_element_to_str,
         "signal_args": _args_to_str,
+        "signal_arg_typed": lambda e: "{}: {}".format(
+            e.children[0].value,
+            e.children[1].value,
+        ),
         "comma_separated_list": lambda e: _arguments_to_str(e.children),
         "contextless_comma_separated_list": lambda e: _arguments_to_str(e.children),
         "contextless_operator_chain_based_expression": (

gdtoolkit/formatter/expression_utils.py

@@ -23,6 +23,7 @@ def is_foldable(expression: Node) -> bool:
             "node_path",
             "string_name",
             "unique_node_path",
+            "signal_arg_typed",
         ]
         and not expression.data.endswith("_pattern")
     )

gdtoolkit/parser/gdscript.lark

@@ -27,7 +27,9 @@ enum_named: "enum" NAME enum_body
 enum_body: "{" [enum_element ("," enum_element)* [trailing_comma]] "}"
 enum_element: NAME ["=" test_expr]
 signal_stmt: "signal" NAME [signal_args]
-signal_args: "(" [NAME [":" TYPE_HINT] ("," NAME [":" TYPE_HINT])* [trailing_comma]] ")"
+signal_args: "(" [signal_arg ("," signal_arg)* [trailing_comma]] ")"
+?signal_arg: NAME
+           | NAME ":" TYPE_HINT -> signal_arg_typed
 extends_stmt: "extends" (NAME | string) ("." NAME)*
 classname_stmt: "class_name" NAME
 !classname_extends_stmt: "class_name" NAME "extends" (NAME | string) ("." NAME)*

tests/formatter/input-output-pairs/complex-signal-statements.in.gd

@@ -2,3 +2,7 @@ class X:
 	signal a(x, y)
 	signal b(aaaaaaaa, bbbbbbbbb, ccccccccc, dddddddd, eeeeeeee, ffffffff, ggggggggg, hhhhhhhh, iiiiiiii, jjjjjjjjjjj)
 	signal c(x, y,)
+	signal d(x:int,)
+	signal e(x,y:float)
+	signal f(x:int,aaaaaaaa, bbbbbbbbb, ccccccccc, dddddddd, eeeeeeee, ffffffff, ggggggggg, hhhhhhhh, iiiiiiii, jjjjjjjjjjj,y:float)
+	signal g(xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx: int)

tests/formatter/input-output-pairs/complex-signal-statements.out.gd

@@ -16,3 +16,24 @@ class X:
 		x,
 		y,
 	)
+	signal d(
+		x: int,
+	)
+	signal e(x, y: float)
+	signal f(
+		x: int,
+		aaaaaaaa,
+		bbbbbbbbb,
+		ccccccccc,
+		dddddddd,
+		eeeeeeee,
+		ffffffff,
+		ggggggggg,
+		hhhhhhhh,
+		iiiiiiii,
+		jjjjjjjjjjj,
+		y: float
+	)
+	signal g(
+		xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx: int
+	)

tests/valid-gd-scripts/signals.gd

@@ -3,3 +3,5 @@ signal bbb (ccc)
 signal ccc (ddd, eee    )
 signal empty()
 signal w_trailing_comma(a,b,)
+signal w_types(a:int,)
+signal w_types_2(a:float,b:int,c,d)