Remove location from Token

Update phpstan-baseline.neon

Author: vojtech-dobes

phpstan-baseline.neon

@@ -28,4 +28,4 @@ parameters:
 			message: '#^Parameter \$column of class Vojtechdobes\\GrammarProcessing\\Location constructor expects int\<0, max\>, int given\.$#'
 			identifier: argument.type
 			count: 1
-			path: src/GrammarProcessing/LexicalGrammar.php
+			path: src/GrammarProcessing/LocationGetter.php

src/GrammarProcessing/LexicalGrammar.php

@@ -42,14 +42,7 @@ public function parseSource(string $source): TokenStream
 			throw new UnexpectedTokenException("Can't parse source: " . preg_last_error_msg(), null);
 		}
 
-		$getLocation = function (int $offset) use ($source): Location {
-			$precedingText = substr($source, 0, $offset);
-
-			return new Location(
-				line: substr_count($precedingText, "\n") + 1,
-				column: $offset - strrpos("\n" . $precedingText, "\n") + 1,
-			);
-		};
+		$locationGetter = new LocationGetter($source);
 
 		$expectedOffset = 0;
 		$endOffset = strlen($source);
@@ -58,7 +51,7 @@ public function parseSource(string $source): TokenStream
 			if ($expectedOffset !== $match[0][1]) {
 				$this->throwUnexpectedTokenException(
 					$match[0][0],
-					$getLocation($match[0][1]),
+					$locationGetter->getLocation($match[0][1]),
 				);
 			}
 
@@ -68,12 +61,12 @@ public function parseSource(string $source): TokenStream
 		if ($expectedOffset !== strlen($source)) {
 			$this->throwUnexpectedTokenException(
 				substr($source, $expectedOffset),
-				$getLocation($expectedOffset),
+				$locationGetter->getLocation($expectedOffset),
 			);
 		}
 
 		if ($matches === []) {
-			return new TokenStream([]);
+			return new TokenStream([], $locationGetter);
 		}
 
 		if ($this->ignoredTokenSymbols !== []) {
@@ -100,15 +93,15 @@ public function parseSource(string $source): TokenStream
 		}
 
 		if ($matches === []) {
-			return new TokenStream([]);
+			return new TokenStream([], $locationGetter);
 		}
 
 		$iMin = 1 + count($this->ignoredTokenSymbols);
 		$iMax = count($this->syntaxTokenSymbols) + $iMin;
 
 		return new TokenStream(
 			array_map(
-				function (array $match) use ($getLocation, $iMax, $iMin): Token {
+				function (array $match) use ($iMax, $iMin): Token {
 					$type = NULL;
 
 					for ($i = $iMin; $i < $iMax; $i++) {
@@ -121,11 +114,11 @@ function (array $match) use ($getLocation, $iMax, $iMin): Token {
 						$type,
 						$match[0][0],
 						$match[0][1],
-						$getLocation,
 					);
 				},
 				$matches,
 			),
+			$locationGetter,
 		);
 	}
 

src/GrammarProcessing/LocationGetter.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Vojtechdobes\GrammarProcessing;
+
+
+final class LocationGetter
+{
+
+	public function __construct(
+		private readonly string $source,
+	) {}
+
+
+
+	public function getLocation(int $offset): Location
+	{
+		$precedingText = substr($this->source, 0, $offset);
+
+		return new Location(
+			line: substr_count($precedingText, "\n") + 1,
+			column: $offset - strrpos("\n" . $precedingText, "\n") + 1,
+		);
+	}
+
+}

src/GrammarProcessing/Token.php

@@ -6,30 +6,10 @@
 final class Token
 {
 
-	/** @var callable(int): Location $getLocation */
-	private $getLocation;
-
-	public Location $location {
-
-		get {
-			return ($this->getLocation)($this->tokenOffset);
-		}
-
-	}
-
-
-
-	/**
-	 * @param callable(int): Location $getLocation
-	 */
 	public function __construct(
 		public readonly string $type,
 		public readonly string $value,
-		private readonly int $tokenOffset,
-		callable $getLocation,
-	)
-	{
-		$this->getLocation = $getLocation;
-	}
+		public readonly int $offset,
+	) {}
 
 }

src/GrammarProcessing/TokenStream.php

@@ -16,6 +16,7 @@ final class TokenStream
 	 */
 	public function __construct(
 		public readonly array $tokens,
+		private readonly LocationGetter $locationGetter,
 	) {}
 
 
@@ -65,7 +66,7 @@ public function consumeEndOfStream(): void
 		throw new CannotConsumeTokenException(
 			"Unexpected token '{$token->value}'",
 			$this->currentToken,
-			$token->location,
+			$this->locationGetter->getLocation($token->offset),
 		);
 	}
 
@@ -88,9 +89,9 @@ public function consumeTokenWithType(string $type): Token
 
 		if ($token->type !== $type) {
 			throw new CannotConsumeTokenException(
-				"Expected token with type '{$type}', got '{$token->type}' instead",
+				"Expected token with type '{$type}', got '{$token->type}' ({$token->value}) instead",
 				$this->currentToken,
-				$token->location,
+				$this->locationGetter->getLocation($token->offset),
 			);
 		}
 
@@ -117,7 +118,7 @@ public function consumeTokenWithValue(string $value): Token
 			throw new CannotConsumeTokenException(
 				"Expected token '{$value}', got '{$token->value}' instead",
 				$this->currentToken,
-				$token->location,
+				$this->locationGetter->getLocation($token->offset),
 			);
 		}
 

tests/cases/LexicalGrammar.Test.php

@@ -16,6 +16,13 @@
 	$expectedTokens,
 ] = $case;
 
+$locationGetter = new Vojtechdobes\GrammarProcessing\LocationGetter($source);
+
+function formatLocation(Vojtechdobes\GrammarProcessing\Location $location): string
+{
+	return "{$location->line},{$location->column}";
+}
+
 $lexicalGrammar = new Vojtechdobes\GrammarProcessing\LexicalGrammar(
 	ignoredTokenSymbols: $ignoredTokenSymbols,
 	syntaxTokenSymbols: $syntaxTokenSymbols,
@@ -31,7 +38,7 @@
 			static fn ($token) => [
 				$token->type,
 				$token->value,
-				"{$token->location->line},{$token->location->column}",
+				formatLocation($locationGetter->getLocation($token->offset)),
 			],
 			$tokenStream->tokens,
 		),