Supplement support for locally scoped constants #190

Author: Scony

gdtoolkit/formatter/class_statement.py

@@ -10,16 +10,14 @@
 from .statement_utils import format_simple_statement
 from .var_statement import format_var_statement
 from .expression_to_str import expression_to_str
-from .expression import (
-    format_expression,
-    format_concrete_expression,
-)
+from .expression import format_concrete_expression
 from .annotation import format_standalone_annotation
 from .property import (
     has_inline_property_body,
     append_property_body_to_formatted_line,
     format_property_body,
 )
+from .const_statement import format_const_statement
 
 
 def format_class_statement(statement: Tree, context: Context) -> Outcome:
@@ -31,7 +29,7 @@ def format_class_statement(statement: Tree, context: Context) -> Outcome:
         "classname_stmt": _format_classname_statement,
         "classname_extends_stmt": _format_classname_extends_statement,
         "class_var_stmt": _format_var_statement,
-        "const_stmt": _format_const_statement,
+        "const_stmt": format_const_statement,
         "class_def": _format_class_statement,
         "func_def": _format_func_statement,
         "static_func_def": partial(
@@ -55,21 +53,6 @@ def _format_child_and_prepend_to_outcome(
     )
 
 
-def _format_const_statement(statement: Tree, context: Context) -> Outcome:
-    if len(statement.children) == 4:
-        prefix = f"const {statement.children[1].value} = "
-    elif len(statement.children) == 5:
-        prefix = f"const {statement.children[1].value} := "
-    elif len(statement.children) == 6:
-        prefix = (
-            f"const {statement.children[1].value}: {statement.children[3].value} = "
-        )
-    expression_context = ExpressionContext(
-        prefix, statement.line, "", statement.end_line
-    )
-    return format_expression(statement.children[-1], expression_context, context)
-
-
 def _format_signal_statement(statement: Tree, context: Context) -> Outcome:
     if len(statement.children) == 1 or len(statement.children[1].children) == 0:
         return format_simple_statement(

gdtoolkit/formatter/const_statement.py

@@ -0,0 +1,20 @@
+from lark import Tree
+
+from .types import Outcome
+from .context import Context, ExpressionContext
+from .expression import format_expression
+
+
+def format_const_statement(statement: Tree, context: Context) -> Outcome:
+    if len(statement.children) == 4:
+        prefix = f"const {statement.children[1].value} = "
+    elif len(statement.children) == 5:
+        prefix = f"const {statement.children[1].value} := "
+    elif len(statement.children) == 6:
+        prefix = (
+            f"const {statement.children[1].value}: {statement.children[3].value} = "
+        )
+    expression_context = ExpressionContext(
+        prefix, statement.line, "", statement.end_line
+    )
+    return format_expression(statement.children[-1], expression_context, context)

gdtoolkit/formatter/function_statement.py

@@ -9,13 +9,14 @@
 from .block import format_block, reconstruct_blank_lines_in_range
 from .statement_utils import format_simple_statement
 from .var_statement import format_var_statement
+from .const_statement import format_const_statement
 
 
 def format_func_statement(statement: Tree, context: Context) -> Outcome:
     handlers = {
         "pass_stmt": partial(format_simple_statement, "pass"),
         "func_var_stmt": format_var_statement,
-        "const_stmt": _format_const_statement,
+        "const_stmt": format_const_statement,
         "expr_stmt": _format_expr_statement,
         "return_stmt": _format_return_statement,
         "break_stmt": partial(format_simple_statement, "break"),
@@ -30,21 +31,6 @@ def format_func_statement(statement: Tree, context: Context) -> Outcome:
     return handlers[statement.data](statement, context)
 
 
-def _format_const_statement(statement: Tree, context: Context) -> Outcome:
-    if len(statement.children) == 4:
-        prefix = f"const {statement.children[1].value} = "
-    elif len(statement.children) == 5:
-        prefix = f"const {statement.children[1].value} := "
-    elif len(statement.children) == 6:
-        prefix = (
-            f"const {statement.children[1].value}: {statement.children[3].value} = "
-        )
-    expression_context = ExpressionContext(
-        prefix, statement.line, "", statement.end_line
-    )
-    return format_expression(statement.children[-1], expression_context, context)
-
-
 def _format_expr_statement(statement: Tree, context: Context) -> Outcome:
     expr = statement.children[0]
     expression_context = ExpressionContext("", statement.line, "", statement.end_line)

tests/formatter/input-output-pairs/const-statements.in.gd

@@ -2,3 +2,10 @@ const a = 1
 const b = 1 + 1
 const c : = 1
 const d : int = 1
+
+
+func foo():
+	const q = 1
+	const w = 1 + 1
+	const e : = 1
+	const r : int = 1

tests/formatter/input-output-pairs/const-statements.out.gd

@@ -2,3 +2,10 @@ const a = 1
 const b = 1 + 1
 const c := 1
 const d: int = 1
+
+
+func foo():
+	const q = 1
+	const w = 1 + 1
+	const e := 1
+	const r: int = 1

tests/valid-gd-scripts/constants.gd

@@ -2,3 +2,8 @@ const X = 1
 const Y := 1
 const Z : int = 1
 # const Q : int := 1				# illegal
+
+func foo():
+	const Q = 1
+	const W := 1
+	const E : int = 1