bug #4475 Fix having macro variables starting with an underscore (fab…

…pot)

This PR was merged into the 3.x branch.

Discussion
----------

Fix having macro variables starting with an underscore

Closes #4452

Commits
-------

bdb0f3c Fix having macro variables starting with an underscore

CHANGELOG

@@ -1,5 +1,6 @@
 # 3.16.0 (2024-XX-XX)
 
+ * Fix having macro variables starting with an underscore
  * Deprecate not passing a `Source` instance to `TokenStream`
  * Deprecate returning `null` from `TwigFilter::getSafe()` and `TwigFunction::getSafe()`, return `[]` instead
 

src/Node/Expression/TempNameExpression.php

@@ -32,7 +32,7 @@ public function __construct(string|int|null $name, int $lineno)
         if (null !== $name && (is_int($name) || ctype_digit($name))) {
             $name = (int) $name;
         } elseif (in_array($name, self::RESERVED_NAMES)) {
-            $name = '_'.$name.'_';
+            $name = "\u{035C}".$name;
         }
 
         parent::__construct([], ['name' => $name], $lineno);

src/Node/MacroNode.php

@@ -48,7 +48,7 @@ public function __construct(string $name, Node $body, Node $arguments, int $line
         }
 
         foreach ($arguments->getKeyValuePairs() as $pair) {
-            if ('_'.self::VARARGS_NAME.'_' === $pair['key']->getAttribute('name')) {
+            if ("\u{035C}".self::VARARGS_NAME === $pair['key']->getAttribute('name')) {
                 throw new SyntaxError(\sprintf('The argument "%s" in macro "%s" cannot be defined because the variable "%s" is reserved for arbitrary arguments.', self::VARARGS_NAME, $name, self::VARARGS_NAME), $pair['value']->getTemplateLine(), $pair['value']->getSourceContext());
             }
         }
@@ -88,9 +88,13 @@ public function compile(Compiler $compiler): void
 
         foreach ($arguments->getKeyValuePairs() as $pair) {
             $name = $pair['key'];
+            $var = $name->getAttribute('name');
+            if (str_starts_with($var, "\u{035C}")) {
+                $var = substr($var, \strlen("\u{035C}"));
+            }
             $compiler
                 ->write('')
-                ->string(trim($name->getAttribute('name'), '_'))
+                ->string($var)
                 ->raw(' => ')
                 ->subcompile($name)
                 ->raw(",\n")

tests/Node/MacroTest.php

@@ -42,19 +42,22 @@ public static function provideTests(): iterable
             new ConstantExpression(null, 1),
             new LocalVariable('bar', 1),
             new ConstantExpression('Foo', 1),
+            new LocalVariable('_underscore', 1),
+            new ConstantExpression(null, 1),
         ], 1);
 
         $body = new BodyNode([new TextNode('foo', 1)]);
         $node = new MacroNode('foo', $body, $arguments, 1);
 
         yield 'with use_yield = true' => [$node, <<<EOF
 // line 1
-public function macro_foo(\$foo = null, \$bar = "Foo", ...\$varargs): string|Markup
+public function macro_foo(\$foo = null, \$bar = "Foo", \$_underscore = null, ...\$varargs): string|Markup
 {
     \$macros = \$this->macros;
     \$context = [
         "foo" => \$foo,
         "bar" => \$bar,
+        "_underscore" => \$_underscore,
         "varargs" => \$varargs,
     ] + \$this->env->getGlobals();
 
@@ -71,12 +74,13 @@ public function macro_foo(\$foo = null, \$bar = "Foo", ...\$varargs): string|Mar
 
         yield 'with use_yield = false' => [$node, <<<EOF
 // line 1
-public function macro_foo(\$foo = null, \$bar = "Foo", ...\$varargs): string|Markup
+public function macro_foo(\$foo = null, \$bar = "Foo", \$_underscore = null, ...\$varargs): string|Markup
 {
     \$macros = \$this->macros;
     \$context = [
         "foo" => \$foo,
         "bar" => \$bar,
+        "_underscore" => \$_underscore,
         "varargs" => \$varargs,
     ] + \$this->env->getGlobals();