Fix inheritance logic to be able to use instanceof ContextVariable instead of NameExpression

fabpot · fabpot · commit b6d9dd62eeb5 · 2025-01-24T13:47:29.000+01:00
diff --git a/src/ExpressionParser.php b/src/ExpressionParser.php
@@ -655,7 +655,7 @@ public function parseArguments()
 
             $name = null;
             if ($namedArguments && (($token = $stream->nextIf(Token::OPERATOR_TYPE, '=')) || (!$definition && $token = $stream->nextIf(Token::PUNCTUATION_TYPE, ':')))) {
-                if (!$value instanceof NameExpression) {
+                if (!$value instanceof ContextVariable) {
                     throw new SyntaxError(\sprintf('A parameter name must be a string, "%s" given.', \get_class($value)), $token->getLine(), $stream->getSourceContext());
                 }
                 $name = $value->getAttribute('name');
@@ -743,7 +743,7 @@ private function parseTestExpression(Node $node): TestExpression
             $arguments = new Nodes([0 => $this->getPrimary()]);
         }
 
-        if ('defined' === $test->getName() && $node instanceof NameExpression && null !== $alias = $this->parser->getImportedSymbol('function', $node->getAttribute('name'))) {
+        if ('defined' === $test->getName() && $node instanceof ContextVariable && null !== $alias = $this->parser->getImportedSymbol('function', $node->getAttribute('name'))) {
             $node = new MacroReferenceExpression($alias['node']->getNode('var'), $alias['name'], new ArrayExpression([], $node->getTemplateLine()), $node->getTemplateLine());
         }
 
@@ -898,7 +898,7 @@ public function parseOnlyArguments()
 
             $name = null;
             if (($token = $stream->nextIf(Token::OPERATOR_TYPE, '=')) || ($token = $stream->nextIf(Token::PUNCTUATION_TYPE, ':'))) {
-                if (!$value instanceof NameExpression) {
+                if (!$value instanceof ContextVariable) {
                     throw new SyntaxError(\sprintf('A parameter name must be a string, "%s" given.', \get_class($value)), $token->getLine(), $stream->getSourceContext());
                 }
                 $name = $value->getAttribute('name');
@@ -946,7 +946,7 @@ private function parseSubscriptExpressionDot(Node $node): AbstractExpression
         }
 
         if (
-            $node instanceof NameExpression
+            $node instanceof ContextVariable
             && (
                 null !== $this->parser->getImportedSymbol('template', $node->getAttribute('name'))
                 || '_self' === $node->getAttribute('name') && $attribute instanceof ConstantExpression
diff --git a/src/Node/Expression/ArrayExpression.php b/src/Node/Expression/ArrayExpression.php
@@ -13,6 +13,7 @@
 
 use Twig\Compiler;
 use Twig\Node\Expression\Unary\StringCastUnary;
+use Twig\Node\Expression\Variable\ContextVariable;
 
 class ArrayExpression extends AbstractExpression
 {
@@ -99,7 +100,7 @@ public function compile(Compiler $compiler): void
                 ++$nextIndex;
             } else {
                 $key = null;
-                if ($pair['key'] instanceof NameExpression) {
+                if ($pair['key'] instanceof ContextVariable) {
                     $pair['key'] = new StringCastUnary($pair['key'], $pair['key']->getTemplateLine());
                 }
                 if ($pair['key'] instanceof TempNameExpression) {
diff --git a/src/Node/Expression/AssignNameExpression.php b/src/Node/Expression/AssignNameExpression.php
@@ -15,8 +15,9 @@
 use Twig\Compiler;
 use Twig\Error\SyntaxError;
 use Twig\Node\Expression\Variable\AssignContextVariable;
+use Twig\Node\Expression\Variable\ContextVariable;
 
-class AssignNameExpression extends NameExpression
+class AssignNameExpression extends ContextVariable
 {
     public function __construct(string $name, int $lineno)
     {
diff --git a/src/Node/Expression/Binary/NullCoalesceBinary.php b/src/Node/Expression/Binary/NullCoalesceBinary.php
@@ -15,11 +15,11 @@
 use Twig\Node\EmptyNode;
 use Twig\Node\Expression\AbstractExpression;
 use Twig\Node\Expression\BlockReferenceExpression;
-use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\OperatorEscapeInterface;
 use Twig\Node\Expression\Test\DefinedTest;
 use Twig\Node\Expression\Test\NullTest;
 use Twig\Node\Expression\Unary\NotUnary;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\TwigTest;
 
 final class NullCoalesceBinary extends AbstractBinary implements OperatorEscapeInterface
@@ -28,7 +28,7 @@ public function __construct(AbstractExpression $left, AbstractExpression $right,
     {
         parent::__construct($left, $right, $lineno);
 
-        if (!$left instanceof NameExpression) {
+        if (!$left instanceof ContextVariable) {
             $test = new DefinedTest(clone $left, new TwigTest('defined'), new EmptyNode(), $left->getTemplateLine());
             // for "block()", we don't need the null test as the return value is always a string
             if (!$left instanceof BlockReferenceExpression) {
diff --git a/src/Node/Expression/Filter/DefaultFilter.php b/src/Node/Expression/Filter/DefaultFilter.php
@@ -19,9 +19,9 @@
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\FilterExpression;
 use Twig\Node\Expression\GetAttrExpression;
-use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\Ternary\ConditionalTernary;
 use Twig\Node\Expression\Test\DefinedTest;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\Node;
 use Twig\TwigFilter;
 use Twig\TwigTest;
@@ -53,7 +53,7 @@ public function __construct(Node $node, TwigFilter|ConstantExpression $filter, N
             $default = new FilterExpression($node, new TwigFilter('default', [CoreExtension::class, 'default']), $arguments, $node->getTemplateLine());
         }
 
-        if ('default' === $name && ($node instanceof NameExpression || $node instanceof GetAttrExpression)) {
+        if ('default' === $name && ($node instanceof ContextVariable || $node instanceof GetAttrExpression)) {
             $test = new DefinedTest(clone $node, new TwigTest('defined'), new EmptyNode(), $node->getTemplateLine());
             $false = \count($arguments) ? $arguments->getNode('0') : new ConstantExpression('', $node->getTemplateLine());
 
diff --git a/src/Node/Expression/GetAttrExpression.php b/src/Node/Expression/GetAttrExpression.php
@@ -14,6 +14,7 @@
 
 use Twig\Compiler;
 use Twig\Extension\SandboxExtension;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Template;
 
 class GetAttrExpression extends AbstractExpression
@@ -28,7 +29,7 @@ public function __construct(AbstractExpression $node, AbstractExpression $attrib
             $nodes['arguments'] = $arguments;
         }
 
-        if ($arguments && !$arguments instanceof ArrayExpression && !$arguments instanceof NameExpression) {
+        if ($arguments && !$arguments instanceof ArrayExpression && !$arguments instanceof ContextVariable) {
             trigger_deprecation('twig/twig', '3.15', \sprintf('Not passing a "%s" instance as the "arguments" argument of the "%s" constructor is deprecated ("%s" given).', ArrayExpression::class, static::class, $arguments::class));
         }
 
diff --git a/src/Node/Expression/MethodCallExpression.php b/src/Node/Expression/MethodCallExpression.php
@@ -12,6 +12,7 @@
 namespace Twig\Node\Expression;
 
 use Twig\Compiler;
+use Twig\Node\Expression\Variable\ContextVariable;
 
 class MethodCallExpression extends AbstractExpression
 {
@@ -21,7 +22,7 @@ public function __construct(AbstractExpression $node, string $method, ArrayExpre
 
         parent::__construct(['node' => $node, 'arguments' => $arguments], ['method' => $method, 'safe' => false, 'is_defined_test' => false], $lineno);
 
-        if ($node instanceof NameExpression) {
+        if ($node instanceof ContextVariable) {
             $node->setAttribute('always_defined', true);
         }
     }
diff --git a/src/Node/Expression/NullCoalesceExpression.php b/src/Node/Expression/NullCoalesceExpression.php
@@ -18,6 +18,7 @@
 use Twig\Node\Expression\Test\DefinedTest;
 use Twig\Node\Expression\Test\NullTest;
 use Twig\Node\Expression\Unary\NotUnary;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\Node;
 use Twig\TwigTest;
 
@@ -60,7 +61,7 @@ public function compile(Compiler $compiler): void
          * cases might be implemented as an optimizer node visitor, but has not been done
          * as benefits are probably not worth the added complexity.
          */
-        if ($this->getNode('expr2') instanceof NameExpression) {
+        if ($this->getNode('expr2') instanceof ContextVariable) {
             $this->getNode('expr2')->setAttribute('always_defined', true);
             $compiler
                 ->raw('((')
diff --git a/src/Node/Expression/Test/DefinedTest.php b/src/Node/Expression/Test/DefinedTest.php
@@ -24,6 +24,7 @@
 use Twig\Node\Expression\MethodCallExpression;
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\TestExpression;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\Node;
 use Twig\TwigTest;
 
@@ -49,7 +50,7 @@ public function __construct(Node $node, TwigTest|string $name, ?Node $arguments,
             trigger_deprecation('twig/twig', '3.15', 'Not passing a "%s" instance to the "node" argument of "%s" is deprecated ("%s" given).', AbstractExpression::class, static::class, \get_class($node));
         }
 
-        if ($node instanceof NameExpression) {
+        if ($node instanceof ContextVariable) {
             $node->setAttribute('is_defined_test', true);
         } elseif ($node instanceof GetAttrExpression) {
             $node->setAttribute('is_defined_test', true);
diff --git a/src/Node/Expression/Variable/ContextVariable.php b/src/Node/Expression/Variable/ContextVariable.php
@@ -13,6 +13,6 @@
 
 use Twig\Node\Expression\NameExpression;
 
-final class ContextVariable extends NameExpression
+class ContextVariable extends NameExpression
 {
 }
diff --git a/src/Node/ImportNode.php b/src/Node/ImportNode.php
@@ -16,6 +16,7 @@
 use Twig\Node\Expression\AbstractExpression;
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\Variable\AssignTemplateVariable;
+use Twig\Node\Expression\Variable\ContextVariable;
 
 /**
  * Represents an import node.
@@ -44,7 +45,7 @@ public function compile(Compiler $compiler): void
     {
         $compiler->subcompile($this->getNode('var'));
 
-        if ($this->getNode('expr') instanceof NameExpression && '_self' === $this->getNode('expr')->getAttribute('name')) {
+        if ($this->getNode('expr') instanceof ContextVariable && '_self' === $this->getNode('expr')->getAttribute('name')) {
             $compiler->raw('$this');
         } else {
             $compiler
diff --git a/src/NodeVisitor/OptimizerNodeVisitor.php b/src/NodeVisitor/OptimizerNodeVisitor.php
@@ -19,6 +19,7 @@
 use Twig\Node\Expression\GetAttrExpression;
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\ParentExpression;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\ForNode;
 use Twig\Node\IncludeNode;
 use Twig\Node\Node;
@@ -137,13 +138,13 @@ private function enterOptimizeFor(Node $node): void
         // when do we need to add the loop variable back?
 
         // the loop variable is referenced for the current loop
-        elseif ($node instanceof NameExpression && 'loop' === $node->getAttribute('name')) {
+        elseif ($node instanceof ContextVariable && 'loop' === $node->getAttribute('name')) {
             $node->setAttribute('always_defined', true);
             $this->addLoopToCurrent();
         }
 
         // optimize access to loop targets
-        elseif ($node instanceof NameExpression && \in_array($node->getAttribute('name'), $this->loopsTargets)) {
+        elseif ($node instanceof ContextVariable && \in_array($node->getAttribute('name'), $this->loopsTargets)) {
             $node->setAttribute('always_defined', true);
         }
 
@@ -173,7 +174,7 @@ private function enterOptimizeFor(Node $node): void
                 || 'parent' === $node->getNode('attribute')->getAttribute('value')
             )
             && (true === $this->loops[0]->getAttribute('with_loop')
-             || ($node->getNode('node') instanceof NameExpression
+             || ($node->getNode('node') instanceof ContextVariable
                  && 'loop' === $node->getNode('node')->getAttribute('name')
              )
             )
diff --git a/src/NodeVisitor/SafeAnalysisNodeVisitor.php b/src/NodeVisitor/SafeAnalysisNodeVisitor.php
@@ -22,6 +22,7 @@
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\OperatorEscapeInterface;
 use Twig\Node\Expression\ParentExpression;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\Node;
 
 /**
@@ -146,7 +147,7 @@ public function leaveNode(Node $node, Environment $env): ?Node
         } elseif ($node instanceof MethodCallExpression || $node instanceof MacroReferenceExpression) {
             // all macro calls are safe
             $this->setSafe($node, ['all']);
-        } elseif ($node instanceof GetAttrExpression && $node->getNode('node') instanceof NameExpression) {
+        } elseif ($node instanceof GetAttrExpression && $node->getNode('node') instanceof ContextVariable) {
             $name = $node->getNode('node')->getAttribute('name');
             if (\in_array($name, $this->safeVars)) {
                 $this->setSafe($node, ['all']);
diff --git a/src/NodeVisitor/SandboxNodeVisitor.php b/src/NodeVisitor/SandboxNodeVisitor.php
@@ -23,6 +23,7 @@
 use Twig\Node\Expression\GetAttrExpression;
 use Twig\Node\Expression\NameExpression;
 use Twig\Node\Expression\Unary\SpreadUnary;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\ModuleNode;
 use Twig\Node\Node;
 use Twig\Node\Nodes;
@@ -122,7 +123,7 @@ public function leaveNode(Node $node, Environment $env): ?Node
     private function wrapNode(Node $node, string $name): void
     {
         $expr = $node->getNode($name);
-        if (($expr instanceof NameExpression || $expr instanceof GetAttrExpression) && !$expr->isGenerator()) {
+        if (($expr instanceof ContextVariable || $expr instanceof GetAttrExpression) && !$expr->isGenerator()) {
             // Simplify in 4.0 as the spread attribute has been removed there
             $new = new CheckToStringNode($expr);
             if ($expr->hasAttribute('spread')) {
diff --git a/src/TokenParser/EmbedTokenParser.php b/src/TokenParser/EmbedTokenParser.php
@@ -14,6 +14,7 @@
 use Twig\Node\EmbedNode;
 use Twig\Node\Expression\ConstantExpression;
 use Twig\Node\Expression\NameExpression;
+use Twig\Node\Expression\Variable\ContextVariable;
 use Twig\Node\Node;
 use Twig\Token;
 
@@ -35,7 +36,7 @@ public function parse(Token $token): Node
         $parentToken = $fakeParentToken = new Token(Token::STRING_TYPE, '__parent__', $token->getLine());
         if ($parent instanceof ConstantExpression) {
             $parentToken = new Token(Token::STRING_TYPE, $parent->getAttribute('value'), $token->getLine());
-        } elseif ($parent instanceof NameExpression) {
+        } elseif ($parent instanceof ContextVariable) {
             $parentToken = new Token(Token::NAME_TYPE, $parent->getAttribute('name'), $token->getLine());
         }
 

Original file line number	Diff line number	Diff line change
`@@ -655,7 +655,7 @@ public function parseArguments()`
`655`	`655`
`656`	`656`	`$name = null;`
`657`	`657`	`if ($namedArguments && (($token = $stream->nextIf(Token::OPERATOR_TYPE, '=')) \|\| (!$definition && $token = $stream->nextIf(Token::PUNCTUATION_TYPE, ':')))) {`
`658`		`- if (!$value instanceof NameExpression) {`
	`658`	`+ if (!$value instanceof ContextVariable) {`
`659`	`659`	`throw new SyntaxError(\sprintf('A parameter name must be a string, "%s" given.', \get_class($value)), $token->getLine(), $stream->getSourceContext());`
`660`	`660`	`}`
`661`	`661`	`$name = $value->getAttribute('name');`
`@@ -743,7 +743,7 @@ private function parseTestExpression(Node $node): TestExpression`
`743`	`743`	`$arguments = new Nodes([0 => $this->getPrimary()]);`
`744`	`744`	`}`
`745`	`745`
`746`		`- if ('defined' === $test->getName() && $node instanceof NameExpression && null !== $alias = $this->parser->getImportedSymbol('function', $node->getAttribute('name'))) {`
	`746`	`+ if ('defined' === $test->getName() && $node instanceof ContextVariable && null !== $alias = $this->parser->getImportedSymbol('function', $node->getAttribute('name'))) {`
`747`	`747`	`$node = new MacroReferenceExpression($alias['node']->getNode('var'), $alias['name'], new ArrayExpression([], $node->getTemplateLine()), $node->getTemplateLine());`
`748`	`748`	`}`
`749`	`749`
`@@ -898,7 +898,7 @@ public function parseOnlyArguments()`
`898`	`898`
`899`	`899`	`$name = null;`
`900`	`900`	`if (($token = $stream->nextIf(Token::OPERATOR_TYPE, '=')) \|\| ($token = $stream->nextIf(Token::PUNCTUATION_TYPE, ':'))) {`
`901`		`- if (!$value instanceof NameExpression) {`
	`901`	`+ if (!$value instanceof ContextVariable) {`
`902`	`902`	`throw new SyntaxError(\sprintf('A parameter name must be a string, "%s" given.', \get_class($value)), $token->getLine(), $stream->getSourceContext());`
`903`	`903`	`}`
`904`	`904`	`$name = $value->getAttribute('name');`
`@@ -946,7 +946,7 @@ private function parseSubscriptExpressionDot(Node $node): AbstractExpression`
`946`	`946`	`}`
`947`	`947`
`948`	`948`	`if (`
`949`		`- $node instanceof NameExpression`
	`949`	`+ $node instanceof ContextVariable`
`950`	`950`	`&& (`
`951`	`951`	`null !== $this->parser->getImportedSymbol('template', $node->getAttribute('name'))`
`952`	`952`	`\|\| '_self' === $node->getAttribute('name') && $attribute instanceof ConstantExpression`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Twig\Compiler;`
`15`	`15`	`use Twig\Node\Expression\Unary\StringCastUnary;`
	`16`	`+use Twig\Node\Expression\Variable\ContextVariable;`
`16`	`17`
`17`	`18`	`class ArrayExpression extends AbstractExpression`
`18`	`19`	`{`
`@@ -99,7 +100,7 @@ public function compile(Compiler $compiler): void`
`99`	`100`	`++$nextIndex;`
`100`	`101`	`} else {`
`101`	`102`	`$key = null;`
`102`		`- if ($pair['key'] instanceof NameExpression) {`
	`103`	`+ if ($pair['key'] instanceof ContextVariable) {`
`103`	`104`	`$pair['key'] = new StringCastUnary($pair['key'], $pair['key']->getTemplateLine());`
`104`	`105`	`}`
`105`	`106`	`if ($pair['key'] instanceof TempNameExpression) {`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,9 @@`
`15`	`15`	`use Twig\Compiler;`
`16`	`16`	`use Twig\Error\SyntaxError;`
`17`	`17`	`use Twig\Node\Expression\Variable\AssignContextVariable;`
	`18`	`+use Twig\Node\Expression\Variable\ContextVariable;`
`18`	`19`
`19`		`-class AssignNameExpression extends NameExpression`
	`20`	`+class AssignNameExpression extends ContextVariable`
`20`	`21`	`{`
`21`	`22`	`public function __construct(string $name, int $lineno)`
`22`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`use Twig\Compiler;`
`16`	`16`	`use Twig\Extension\SandboxExtension;`
	`17`	`+use Twig\Node\Expression\Variable\ContextVariable;`
`17`	`18`	`use Twig\Template;`
`18`	`19`
`19`	`20`	`class GetAttrExpression extends AbstractExpression`
`@@ -28,7 +29,7 @@ public function __construct(AbstractExpression $node, AbstractExpression $attrib`
`28`	`29`	`$nodes['arguments'] = $arguments;`
`29`	`30`	`}`
`30`	`31`
`31`		`- if ($arguments && !$arguments instanceof ArrayExpression && !$arguments instanceof NameExpression) {`
	`32`	`+ if ($arguments && !$arguments instanceof ArrayExpression && !$arguments instanceof ContextVariable) {`
`32`	`33`	`trigger_deprecation('twig/twig', '3.15', \sprintf('Not passing a "%s" instance as the "arguments" argument of the "%s" constructor is deprecated ("%s" given).', ArrayExpression::class, static::class, $arguments::class));`
`33`	`34`	`}`
`34`	`35`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Twig\Node\Expression;`
`13`	`13`
`14`	`14`	`use Twig\Compiler;`
	`15`	`+use Twig\Node\Expression\Variable\ContextVariable;`
`15`	`16`
`16`	`17`	`class MethodCallExpression extends AbstractExpression`
`17`	`18`	`{`
`@@ -21,7 +22,7 @@ public function __construct(AbstractExpression $node, string $method, ArrayExpre`
`21`	`22`
`22`	`23`	`parent::__construct(['node' => $node, 'arguments' => $arguments], ['method' => $method, 'safe' => false, 'is_defined_test' => false], $lineno);`
`23`	`24`
`24`		`- if ($node instanceof NameExpression) {`
	`25`	`+ if ($node instanceof ContextVariable) {`
`25`	`26`	`$node->setAttribute('always_defined', true);`
`26`	`27`	`}`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,6 @@`
`13`	`13`
`14`	`14`	`use Twig\Node\Expression\NameExpression;`
`15`	`15`
`16`		`-final class ContextVariable extends NameExpression`
	`16`	`+class ContextVariable extends NameExpression`
`17`	`17`	`{`
`18`	`18`	`}`