Add support for r-strings, closes #257

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
  - Added support for multiline patterns within `match` statement branches
+ - Added support for r-strings
 
 ## [4.2.0] 2023-11-30
 

gdtoolkit/formatter/expression_to_str.py

@@ -77,6 +77,7 @@ def expression_to_str(expression: Node) -> str:
         "c_dict_element": _dict_element_to_str,
         "eq_dict_element": _dict_element_to_str,
         "string": lambda e: expression_to_str(e.children[0]),
+        "rstring": lambda e: f"r{expression_to_str(e.children[0])}",
         "get_node": lambda e: f"${expression_to_str(e.children[0])}",
         "path": lambda e: "".join([name_token.value for name_token in e.children]),
         "node_path": lambda e: f"^{expression_to_str(e.children[0])}",

gdtoolkit/formatter/expression_utils.py

@@ -17,6 +17,7 @@ def is_foldable(expression: Node) -> bool:
         return True
     return not isinstance(expression, Token) and expression.data not in [
         "string",
+        "rstring",
         "get_node",
         "node_path",
         "string_name",

gdtoolkit/formatter/safety_checks.py

@@ -69,6 +69,10 @@ def string(self, args):
         string_token = args[0]
         return expression_to_str(string_token)
 
+    def rstring(self, args):
+        string_token = args[0]
+        return expression_to_str(string_token)
+
     def par_pattern(self, args):
         return args[0] if len(args) > 0 else args
 

gdtoolkit/parser/gdscript.lark

@@ -253,6 +253,7 @@ _simple_lambda_stmt: single_lambda_stmt (";" single_lambda_stmt)* [";"]
                    | expr_stmt
 ?literal: NUMBER
         | string
+        | rstring
         | get_node
         | "^" string -> node_path
         | "&" string -> string_name
@@ -281,7 +282,9 @@ DECIMAL: INT "." INT? | "." INT
 INT: DIGIT (DIGIT | "_")*
 DIGIT: "0".."9"
 
-string: LONG_STRING | REGULAR_STRING
+rstring: "r" _string
+string: _string
+_string: LONG_STRING | REGULAR_STRING
 REGULAR_STRING: /("(?!"").*?(?<!\\)(\\\\)*?"|'(?!'').*?(?<!\\)(\\\\)*?')/i
 LONG_STRING: /""".*?(?<!\\)(\\\\)*?"""/is | /'''.*?(?<!\\)(\\\\)*?'''/is
 

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

@@ -0,0 +1,17 @@
+var x = r'x'
+
+var x2 = r'x "'
+var x3 = r'x " " \''
+var x4 = r"x '"
+var x5 = r"x ' ' \""
+
+var x6 = r'x \''
+var x7 = r"x \""
+var x8 = r'x \' "'
+
+var x9 = r'''x'''
+var x10 = r'''x "'''
+
+var x11 = r"""abc " def ' ghi"""
+
+var x12 = r'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

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

@@ -0,0 +1,17 @@
+var x = r"x"
+
+var x2 = r'x "'
+var x3 = r'x " " \''
+var x4 = r"x '"
+var x5 = r"x ' ' \""
+
+var x6 = r"x '"
+var x7 = r'x "'
+var x8 = r"x ' \""
+
+var x9 = r"x"
+var x10 = r'x "'
+
+var x11 = r"""abc " def ' ghi"""
+
+var x12 = r"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

tests/valid-gd-scripts/rstrings.gd

@@ -0,0 +1,5 @@
+func foo():
+	print(r'" \' \ \\')
+	print(r"\" ' \ \\")
+	print(r"""aaa""")
+	print(r'''bbb''')