Implement offset access type syntax

Author: rvanvelzen

src/Ast/Type/OffsetAccessTypeNode.php

@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\PhpDocParser\Ast\Type;
+
+use PHPStan\PhpDocParser\Ast\NodeAttributes;
+
+class OffsetAccessTypeNode implements TypeNode
+{
+
+	use NodeAttributes;
+
+	/** @var TypeNode */
+	public $type;
+
+	/** @var TypeNode */
+	public $offset;
+
+	public function __construct(TypeNode $type, TypeNode $offset)
+	{
+		$this->type = $type;
+		$this->offset = $offset;
+	}
+
+	public function __toString(): string
+	{
+		return $this->type . '[' . $this->offset . ']';
+	}
+
+}

src/Parser/TypeParser.php

@@ -80,7 +80,7 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
 			$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_PARENTHESES);
 
 			if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-				return $this->tryParseArray($tokens, $type);
+				return $this->tryParseArrayOrOffsetAccess($tokens, $type);
 			}
 
 			return $type;
@@ -90,7 +90,7 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
 			$type = new Ast\Type\ThisTypeNode();
 
 			if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-				return $this->tryParseArray($tokens, $type);
+				return $this->tryParseArrayOrOffsetAccess($tokens, $type);
 			}
 
 			return $type;
@@ -115,19 +115,19 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
 					$type = $this->parseGeneric($tokens, $type);
 
 					if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-						$type = $this->tryParseArray($tokens, $type);
+						$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 					}
 				} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
 					$type = $this->tryParseCallable($tokens, $type);
 
 				} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-					$type = $this->tryParseArray($tokens, $type);
+					$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 
 				} elseif ($type->name === 'array' && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
 					$type = $this->parseArrayShape($tokens, $type);
 
 					if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-						$type = $this->tryParseArray($tokens, $type);
+						$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 					}
 				}
 
@@ -293,7 +293,7 @@ private function parseNullable(TokenIterator $tokens): Ast\Type\TypeNode
 		}
 
 		if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-			$type = $this->tryParseArray($tokens, $type);
+			$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 		}
 
 		return new Ast\Type\NullableTypeNode($type);
@@ -427,7 +427,7 @@ private function parseCallableReturnType(TokenIterator $tokens): Ast\Type\TypeNo
 		}
 
 		if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
-			$type = $this->tryParseArray($tokens, $type);
+			$type = $this->tryParseArrayOrOffsetAccess($tokens, $type);
 		}
 
 		return $type;
@@ -452,15 +452,25 @@ private function tryParseCallable(TokenIterator $tokens, Ast\Type\IdentifierType
 
 
 	/** @phpstan-impure */
-	private function tryParseArray(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\TypeNode
+	private function tryParseArrayOrOffsetAccess(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\TypeNode
 	{
 		try {
 			while ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
 				$tokens->pushSavePoint();
+
+				$canBeOffsetAccessType = !$tokens->isPrecededByHorizontalWhitespace();
 				$tokens->consumeTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET);
-				$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_SQUARE_BRACKET);
-				$tokens->dropSavePoint();
-				$type = new Ast\Type\ArrayTypeNode($type);
+
+				if ($canBeOffsetAccessType && !$tokens->isCurrentTokenType(Lexer::TOKEN_CLOSE_SQUARE_BRACKET)) {
+					$offset = $this->parse($tokens);
+					$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_SQUARE_BRACKET);
+					$tokens->dropSavePoint();
+					$type = new Ast\Type\OffsetAccessTypeNode($type, $offset);
+				} else {
+					$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_SQUARE_BRACKET);
+					$tokens->dropSavePoint();
+					$type = new Ast\Type\ArrayTypeNode($type);
+				}
 			}
 
 		} catch (ParserException $e) {

tests/PHPStan/Parser/PhpDocParserTest.php

@@ -37,6 +37,7 @@
 use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPUnit\Framework\TestCase;
@@ -974,6 +975,23 @@ public function provideReturnTagsData(): Iterator
 			]),
 		];
 
+		yield [
+			'OK with offset access type',
+			'/** @return Foo[Bar] */',
+			new PhpDocNode([
+				new PhpDocTagNode(
+					'@return',
+					new ReturnTagValueNode(
+						new OffsetAccessTypeNode(
+							new IdentifierTypeNode('Foo'),
+							new IdentifierTypeNode('Bar')
+						),
+						''
+					)
+				),
+			]),
+		];
+
 		yield [
 			'invalid without type and description',
 			'/** @return */',

tests/PHPStan/Parser/TypeParserTest.php

@@ -19,6 +19,7 @@
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\TypeNode;
 use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
@@ -747,6 +748,13 @@ public function provideParseData(): array
 				new IdentifierTypeNode('array'),
 				Lexer::TOKEN_OPEN_SQUARE_BRACKET,
 			],
+			[
+				'array[ int ]',
+				new OffsetAccessTypeNode(
+					new IdentifierTypeNode('array'),
+					new IdentifierTypeNode('int')
+				),
+			],
 			[
 				"?\t\xA009", // edge-case with \h
 				new NullableTypeNode(