Printer - preserve and add parentheses as needed

Author: ondrejmirtes

src/Ast/Type/ArrayTypeNode.php

@@ -20,6 +20,14 @@ public function __construct(TypeNode $type)
 
 	public function __toString(): string
 	{
+		if (
+			$this->type instanceof CallableTypeNode
+			|| $this->type instanceof ConstTypeNode
+			|| $this->type instanceof NullableTypeNode
+		) {
+			return '(' . $this->type . ')[]';
+		}
+
 		return $this->type . '[]';
 	}
 

src/Ast/Type/IntersectionTypeNode.php

@@ -3,6 +3,7 @@
 namespace PHPStan\PhpDocParser\Ast\Type;
 
 use PHPStan\PhpDocParser\Ast\NodeAttributes;
+use function array_map;
 use function implode;
 
 class IntersectionTypeNode implements TypeNode
@@ -24,7 +25,13 @@ public function __construct(array $types)
 
 	public function __toString(): string
 	{
-		return '(' . implode(' & ', $this->types) . ')';
+		return '(' . implode(' & ', array_map(static function (TypeNode $type): string {
+			if ($type instanceof NullableTypeNode) {
+				return '(' . $type . ')';
+			}
+
+			return (string) $type;
+		}, $this->types)) . ')';
 	}
 
 }

src/Ast/Type/OffsetAccessTypeNode.php

@@ -23,6 +23,14 @@ public function __construct(TypeNode $type, TypeNode $offset)
 
 	public function __toString(): string
 	{
+		if (
+			$this->type instanceof CallableTypeNode
+			|| $this->type instanceof ConstTypeNode
+			|| $this->type instanceof NullableTypeNode
+		) {
+			return '(' . $this->type . ')[' . $this->offset . ']';
+		}
+
 		return $this->type . '[' . $this->offset . ']';
 	}
 

src/Ast/Type/UnionTypeNode.php

@@ -3,6 +3,7 @@
 namespace PHPStan\PhpDocParser\Ast\Type;
 
 use PHPStan\PhpDocParser\Ast\NodeAttributes;
+use function array_map;
 use function implode;
 
 class UnionTypeNode implements TypeNode
@@ -24,7 +25,13 @@ public function __construct(array $types)
 
 	public function __toString(): string
 	{
-		return '(' . implode(' | ', $this->types) . ')';
+		return '(' . implode(' | ', array_map(static function (TypeNode $type): string {
+			if ($type instanceof NullableTypeNode) {
+				return '(' . $type . ')';
+			}
+
+				return (string) $type;
+		}, $this->types)) . ')';
 	}
 
 }

src/Parser/TokenIterator.php

@@ -268,4 +268,64 @@ private function throwError(int $expectedTokenType, ?string $expectedTokenValue
 		);
 	}
 
+	/**
+	 * Check whether the position is directly preceded by a certain token type.
+	 *
+	 * During this check TOKEN_HORIZONTAL_WS and TOKEN_PHPDOC_EOL are skipped
+	 */
+	public function hasTokenImmediatelyBefore(int $pos, int $expectedTokenType): bool
+	{
+		$tokens = $this->tokens;
+		$pos--;
+		for (; $pos >= 0; $pos--) {
+			$token = $tokens[$pos];
+			$type = $token[Lexer::TYPE_OFFSET];
+			if ($type === $expectedTokenType) {
+				return true;
+			}
+			if (!in_array($type, [
+				Lexer::TOKEN_HORIZONTAL_WS,
+				Lexer::TOKEN_PHPDOC_EOL,
+			], true)) {
+				break;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Check whether the position is directly followed by a certain token type.
+	 *
+	 * During this check TOKEN_HORIZONTAL_WS and TOKEN_PHPDOC_EOL are skipped
+	 */
+	public function hasTokenImmediatelyAfter(int $pos, int $expectedTokenType): bool
+	{
+		$tokens = $this->tokens;
+		$pos++;
+		for ($c = count($tokens); $pos < $c; $pos++) {
+			$token = $tokens[$pos];
+			$type = $token[Lexer::TYPE_OFFSET];
+			if ($type === $expectedTokenType) {
+				return true;
+			}
+			if (!in_array($type, [
+				Lexer::TOKEN_HORIZONTAL_WS,
+				Lexer::TOKEN_PHPDOC_EOL,
+			], true)) {
+				break;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Whether the given position is immediately surrounded by parenthesis.
+	 */
+	public function hasParentheses(int $startPos, int $endPos): bool
+	{
+		return $this->hasTokenImmediatelyBefore($startPos, Lexer::TOKEN_OPEN_PARENTHESES)
+			&& $this->hasTokenImmediatelyAfter($endPos, Lexer::TOKEN_CLOSE_PARENTHESES);
+	}
+
 }