TASK: Pass token iterator by-reference in all Parser implementations

Author: grebaldi

src/Language/Parser/BooleanLiteral/BooleanLiteralParser.php

@@ -33,7 +33,7 @@ final class BooleanLiteralParser
      * @param \Iterator<mixed,Token> $tokens
      * @return BooleanLiteralNode
      */
-    public function parse(\Iterator $tokens): BooleanLiteralNode
+    public function parse(\Iterator &$tokens): BooleanLiteralNode
     {
         Scanner::assertType($tokens, TokenType::KEYWORD_TRUE, TokenType::KEYWORD_FALSE);
 

src/Language/Parser/EnumDeclaration/EnumDeclarationParser.php

@@ -52,7 +52,7 @@ public function __construct()
      * @param \Iterator<mixed,Token> $tokens
      * @return EnumDeclarationNode
      */
-    public function parse(\Iterator $tokens): EnumDeclarationNode
+    public function parse(\Iterator &$tokens): EnumDeclarationNode
     {
         $enumKeyWordToken = $this->extractEnumKeywordToken($tokens);
         $enumNameNode = $this->parseEnumName($tokens);
@@ -76,7 +76,7 @@ public function parse(\Iterator $tokens): EnumDeclarationNode
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    private function extractEnumKeywordToken(\Iterator $tokens): Token
+    private function extractEnumKeywordToken(\Iterator &$tokens): Token
     {
         Scanner::assertType($tokens, TokenType::KEYWORD_ENUM);
 
@@ -92,7 +92,7 @@ private function extractEnumKeywordToken(\Iterator $tokens): Token
      * @param \Iterator<mixed,Token> $tokens
      * @return EnumNameNode
      */
-    private function parseEnumName(\Iterator $tokens): EnumNameNode
+    private function parseEnumName(\Iterator &$tokens): EnumNameNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
 
@@ -112,7 +112,7 @@ private function parseEnumName(\Iterator $tokens): EnumNameNode
      * @param \Iterator<mixed,Token> $tokens
      * @return void
      */
-    private function skipOpeningBracketToken(\Iterator $tokens): void
+    private function skipOpeningBracketToken(\Iterator &$tokens): void
     {
         Scanner::assertType($tokens, TokenType::BRACKET_CURLY_OPEN);
         Scanner::skipOne($tokens);
@@ -122,7 +122,7 @@ private function skipOpeningBracketToken(\Iterator $tokens): void
      * @param \Iterator<mixed,Token> $tokens
      * @return EnumMemberDeclarationNodes
      */
-    private function parseEnumMemberDeclarations(\Iterator $tokens): EnumMemberDeclarationNodes
+    private function parseEnumMemberDeclarations(\Iterator &$tokens): EnumMemberDeclarationNodes
     {
         $items = [];
         while (true) {
@@ -146,7 +146,7 @@ private function parseEnumMemberDeclarations(\Iterator $tokens): EnumMemberDecla
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    private function extractClosingBracketToken(\Iterator $tokens): Token
+    private function extractClosingBracketToken(\Iterator &$tokens): Token
     {
         Scanner::skipSpace($tokens);
         Scanner::assertType($tokens, TokenType::BRACKET_CURLY_CLOSE);
@@ -162,7 +162,7 @@ private function extractClosingBracketToken(\Iterator $tokens): Token
      * @param \Iterator<mixed,Token> $tokens
      * @return EnumMemberDeclarationNode
      */
-    private function parseEnumMemberDeclaration(\Iterator $tokens): EnumMemberDeclarationNode
+    private function parseEnumMemberDeclaration(\Iterator &$tokens): EnumMemberDeclarationNode
     {
         $enumMemberName = $this->parseEnumMemberName($tokens);
         $value = $this->parseEnumMemberValue($tokens);
@@ -182,7 +182,7 @@ private function parseEnumMemberDeclaration(\Iterator $tokens): EnumMemberDeclar
      * @param \Iterator<mixed,Token> $tokens
      * @return EnumMemberNameNode
      */
-    private function parseEnumMemberName(\Iterator $tokens): EnumMemberNameNode
+    private function parseEnumMemberName(\Iterator &$tokens): EnumMemberNameNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
 
@@ -201,7 +201,7 @@ private function parseEnumMemberName(\Iterator $tokens): EnumMemberNameNode
      * @param \Iterator $tokens
      * @return null|EnumMemberValueNode
      */
-    private function parseEnumMemberValue(\Iterator $tokens): ?EnumMemberValueNode
+    private function parseEnumMemberValue(\Iterator &$tokens): ?EnumMemberValueNode
     {
         if (Scanner::type($tokens) !== TokenType::BRACKET_ROUND_OPEN) {
             return null;

src/Language/Parser/Expression/ExpressionParser.php

@@ -530,7 +530,7 @@ private function parseBinaryOperator(\Iterator &$tokens): BinaryOperator
      * @param ExpressionNode $condition
      * @return ExpressionNode
      */
-    private function parseTernaryOperation(\Iterator $tokens, ExpressionNode $condition): ExpressionNode
+    private function parseTernaryOperation(\Iterator &$tokens, ExpressionNode $condition): ExpressionNode
     {
         Scanner::assertType($tokens, TokenType::QUESTIONMARK);
         Scanner::skipOne($tokens);

src/Language/Parser/IntegerLiteral/IntegerLiteralParser.php

@@ -33,7 +33,7 @@ final class IntegerLiteralParser
      * @param \Iterator<mixed,Token> $tokens
      * @return IntegerLiteralNode
      */
-    public function parse(\Iterator $tokens): IntegerLiteralNode
+    public function parse(\Iterator &$tokens): IntegerLiteralNode
     {
         $token = $tokens->current();
 

src/Language/Parser/NullLiteral/NullLiteralParser.php

@@ -33,7 +33,7 @@ final class NullLiteralParser
      * @param \Iterator<mixed,Token> $tokens
      * @return NullLiteralNode
      */
-    public function parse(\Iterator $tokens): NullLiteralNode
+    public function parse(\Iterator &$tokens): NullLiteralNode
     {
         Scanner::assertType($tokens, TokenType::KEYWORD_NULL);
 

src/Language/Parser/PropertyDeclaration/PropertyDeclarationParser.php

@@ -44,7 +44,7 @@ public function __construct()
      * @param \Iterator<mixed,Token> $tokens
      * @return PropertyDeclarationNode
      */
-    public function parse(\Iterator $tokens): PropertyDeclarationNode
+    public function parse(\Iterator &$tokens): PropertyDeclarationNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
         $propertyNameToken = $tokens->current();

src/Language/Parser/StringLiteral/StringLiteralParser.php

@@ -33,7 +33,7 @@ final class StringLiteralParser
      * @param \Iterator<mixed,Token> $tokens
      * @return StringLiteralNode
      */
-    public function parse(\Iterator $tokens): StringLiteralNode
+    public function parse(\Iterator &$tokens): StringLiteralNode
     {
         Scanner::assertType($tokens, TokenType::STRING_QUOTED);
 

src/Language/Parser/StructDeclaration/StructDeclarationParser.php

@@ -45,7 +45,7 @@ public function __construct()
      * @param \Iterator<mixed,Token> $tokens
      * @return StructDeclarationNode
      */
-    public function parse(\Iterator $tokens): StructDeclarationNode
+    public function parse(\Iterator &$tokens): StructDeclarationNode
     {
         $structKeywordToken = $this->extractStructKeywordToken($tokens);
         $structNameNode = $this->parseStructName($tokens);
@@ -67,7 +67,7 @@ public function parse(\Iterator $tokens): StructDeclarationNode
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    public function extractStructKeywordToken(\Iterator $tokens): Token
+    public function extractStructKeywordToken(\Iterator &$tokens): Token
     {
         Scanner::assertType($tokens, TokenType::KEYWORD_STRUCT);
 
@@ -83,7 +83,7 @@ public function extractStructKeywordToken(\Iterator $tokens): Token
      * @param \Iterator<mixed,Token> $tokens
      * @return StructNameNode
      */
-    public function parseStructName(\Iterator $tokens): StructNameNode
+    public function parseStructName(\Iterator &$tokens): StructNameNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
 
@@ -102,7 +102,7 @@ public function parseStructName(\Iterator $tokens): StructNameNode
      * @param \Iterator<mixed,Token> $tokens
      * @return void
      */
-    public function skipOpeningBracketToken(\Iterator $tokens): void
+    public function skipOpeningBracketToken(\Iterator &$tokens): void
     {
         Scanner::assertType($tokens, TokenType::BRACKET_CURLY_OPEN);
         Scanner::skipOne($tokens);
@@ -113,7 +113,7 @@ public function skipOpeningBracketToken(\Iterator $tokens): void
      * @param \Iterator<mixed,Token> $tokens
      * @return PropertyDeclarationNodes
      */
-    public function parsePropertyDeclarations(\Iterator $tokens): PropertyDeclarationNodes
+    public function parsePropertyDeclarations(\Iterator &$tokens): PropertyDeclarationNodes
     {
         $items = [];
         while (Scanner::type($tokens) === TokenType::STRING) {
@@ -128,7 +128,7 @@ public function parsePropertyDeclarations(\Iterator $tokens): PropertyDeclaratio
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    public function extractClosingBracketToken(\Iterator $tokens): Token
+    public function extractClosingBracketToken(\Iterator &$tokens): Token
     {
         Scanner::assertType($tokens, TokenType::BRACKET_CURLY_CLOSE);
 

src/Language/Parser/Tag/TagParser.php

@@ -57,7 +57,7 @@ public function __construct()
      * @param \Iterator<mixed,Token> $tokens
      * @return TagNode
      */
-    public function parse(\Iterator $tokens): TagNode
+    public function parse(\Iterator &$tokens): TagNode
     {
         $tagStartOpeningToken = $this->extractTagStartOpeningToken($tokens);
         $tagNameNode = $this->parseTagName($tokens);
@@ -98,7 +98,7 @@ public function parse(\Iterator $tokens): TagNode
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    private function extractTagStartOpeningToken(\Iterator $tokens): Token
+    private function extractTagStartOpeningToken(\Iterator &$tokens): Token
     {
         Scanner::assertType($tokens, TokenType::TAG_START_OPENING);
         $tagStartOpeningToken = $tokens->current();
@@ -111,7 +111,7 @@ private function extractTagStartOpeningToken(\Iterator $tokens): Token
      * @param \Iterator<mixed,Token> $tokens
      * @return TagNameNode
      */
-    private function parseTagName(\Iterator $tokens): TagNameNode
+    private function parseTagName(\Iterator &$tokens): TagNameNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
         $tagNameToken = $tokens->current();
@@ -127,7 +127,7 @@ private function parseTagName(\Iterator $tokens): TagNameNode
      * @param \Iterator<mixed,Token> $tokens
      * @return AttributeNodes
      */
-    private function parseAttributes(\Iterator $tokens): AttributeNodes
+    private function parseAttributes(\Iterator &$tokens): AttributeNodes
     {
         $items = [];
         while (!$this->isTagEnd($tokens)) {
@@ -145,7 +145,7 @@ private function parseAttributes(\Iterator $tokens): AttributeNodes
      * @param \Iterator<mixed,Token> $tokens
      * @return boolean
      */
-    private function isTagEnd($tokens): bool
+    private function isTagEnd(\Iterator $tokens): bool
     {
         return (
             Scanner::type($tokens) === TokenType::TAG_END ||
@@ -157,7 +157,7 @@ private function isTagEnd($tokens): bool
      * @param \Iterator<mixed,Token> $tokens
      * @return AttributeNode
      */
-    private function parseAttribute(\Iterator $tokens): AttributeNode
+    private function parseAttribute(\Iterator &$tokens): AttributeNode
     {
         $attributeNameNode = $this->parseAttributeName($tokens);
         $attributeValueNode = $this->parseAttributeValue($tokens);
@@ -177,7 +177,7 @@ private function parseAttribute(\Iterator $tokens): AttributeNode
      * @param \Iterator<mixed,Token> $tokens
      * @return AttributeNameNode
      */
-    private function parseAttributeName(\Iterator $tokens): AttributeNameNode
+    private function parseAttributeName(\Iterator &$tokens): AttributeNameNode
     {
         Scanner::assertType($tokens, TokenType::STRING);
         $attributeNameToken = $tokens->current();
@@ -193,7 +193,7 @@ private function parseAttributeName(\Iterator $tokens): AttributeNameNode
      * @param \Iterator<mixed,Token> $tokens
      * @return null|StringLiteralNode|ExpressionNode
      */
-    private function parseAttributeValue(\Iterator $tokens): null|StringLiteralNode|ExpressionNode
+    private function parseAttributeValue(\Iterator &$tokens): null|StringLiteralNode|ExpressionNode
     {
         if (Scanner::type($tokens) === TokenType::EQUALS) {
             Scanner::skipOne($tokens);
@@ -241,7 +241,7 @@ private function parseExpression(\Iterator &$tokens): ExpressionNode
      * @param \Iterator<mixed,Token> $tokens
      * @return null|Token
      */
-    private function extractTagSelfCloseToken(\Iterator $tokens): ?Token
+    private function extractTagSelfCloseToken(\Iterator &$tokens): ?Token
     {
         if (Scanner::type($tokens) === TokenType::TAG_SELF_CLOSE) {
             $tagSelfCloseToken = $tokens->current();
@@ -257,7 +257,7 @@ private function extractTagSelfCloseToken(\Iterator $tokens): ?Token
      * @param \Iterator<mixed,Token> $tokens
      * @return void
      */
-    private function skipTagEndToken(\Iterator $tokens): void
+    private function skipTagEndToken(\Iterator &$tokens): void
     {
         Scanner::assertType($tokens, TokenType::TAG_END);
         Scanner::skipOne($tokens);
@@ -267,7 +267,7 @@ private function skipTagEndToken(\Iterator $tokens): void
      * @param \Iterator<mixed,Token> $tokens
      * @return ChildNodes
      */
-    private function parseChildren(\Iterator $tokens): ChildNodes
+    private function parseChildren(\Iterator &$tokens): ChildNodes
     {
         $items = [];
         $preserveLeadingSpace = false;
@@ -307,7 +307,7 @@ private function parseChildren(\Iterator $tokens): ChildNodes
      * @param \Iterator<mixed,Token> $tokens
      * @return void
      */
-    private function skipTagStartClosingToken(\Iterator $tokens): void
+    private function skipTagStartClosingToken(\Iterator &$tokens): void
     {
         Scanner::assertType($tokens, TokenType::TAG_START_CLOSING);
         Scanner::skipOne($tokens);
@@ -318,7 +318,7 @@ private function skipTagStartClosingToken(\Iterator $tokens): void
      * @param TagNameNode $openingTagNameNode
      * @return void
      */
-    private function assertAndSkipClosingTagName(\Iterator $tokens, TagNameNode $openingTagNameNode): void
+    private function assertAndSkipClosingTagName(\Iterator &$tokens, TagNameNode $openingTagNameNode): void
     {
         Scanner::assertType($tokens, TokenType::STRING);
         $tagNameToken = $tokens->current();
@@ -337,7 +337,7 @@ private function assertAndSkipClosingTagName(\Iterator $tokens, TagNameNode $ope
      * @param \Iterator<mixed,Token> $tokens
      * @return Token
      */
-    private function extractTagEndToken(\Iterator $tokens): Token
+    private function extractTagEndToken(\Iterator &$tokens): Token
     {
         Scanner::assertType($tokens, TokenType::TAG_END);
         $tagEndToken = $tokens->current();

src/Language/Parser/Text/TextParser.php

@@ -46,7 +46,7 @@ final class TextParser
      * @param boolean $preserveLeadingSpace
      * @return null|TextNode
      */
-    public function parse(\Iterator $tokens, bool $preserveLeadingSpace = false): ?TextNode
+    public function parse(\Iterator &$tokens, bool $preserveLeadingSpace = false): ?TextNode
     {
         $this->reset($preserveLeadingSpace);