Skip to content

Commit d60ff77

Browse files
ondrejmirtesondrejmirtes
committed
Support ConstExprNode as type
1 parent c3aaad7 commit d60ff77

File tree

6 files changed

+169
-26
lines changed

6 files changed

+169
-26
lines changed

‎src/Ast/Type/ConstTypeNode.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\PhpDocParser\Ast\Type;
4+
5+
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprNode;
6+
7+
class ConstTypeNode implements TypeNode
8+
{
9+
10+
/** @var ConstExprNode */
11+
public $constExpr;
12+
13+
public function __construct(ConstExprNode $constExpr)
14+
{
15+
$this->constExpr = $constExpr;
16+
}
17+
18+
public function __toString(): string
19+
{
20+
return $this->constExpr->__toString();
21+
}
22+
23+
}

‎src/Parser/ConstExprParser.php‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
class ConstExprParser
99
{
1010

11-
public function parse(TokenIterator $tokens): Ast\ConstExpr\ConstExprNode
11+
public function parse(TokenIterator $tokens, bool $trimStrings = false): Ast\ConstExpr\ConstExprNode
1212
{
1313
if ($tokens->isCurrentTokenType(Lexer::TOKEN_FLOAT)) {
1414
$value = $tokens->currentTokenValue();
@@ -22,11 +22,17 @@ public function parse(TokenIterator $tokens): Ast\ConstExpr\ConstExprNode
2222

2323
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING)) {
2424
$value = $tokens->currentTokenValue();
25+
if ($trimStrings) {
26+
$value = trim($tokens->currentTokenValue(), "'");
27+
}
2528
$tokens->next();
2629
return new Ast\ConstExpr\ConstExprStringNode($value);
2730

2831
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_QUOTED_STRING)) {
2932
$value = $tokens->currentTokenValue();
33+
if ($trimStrings) {
34+
$value = trim($tokens->currentTokenValue(), '"');
35+
}
3036
$tokens->next();
3137
return new Ast\ConstExpr\ConstExprStringNode($value);
3238

‎src/Parser/TypeParser.php‎

Lines changed: 64 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@
88
class TypeParser
99
{
1010

11+
/** @var ConstExprParser|null */
12+
private $constExprParser;
13+
14+
/**
15+
* @param ConstExprParser|null $constExprParser
16+
*/
17+
public function __construct(?ConstExprParser $constExprParser = null)
18+
{
19+
$this->constExprParser = $constExprParser;
20+
}
21+
1122
public function parse(TokenIterator $tokens): Ast\Type\TypeNode
1223
{
1324
if ($tokens->isCurrentTokenType(Lexer::TOKEN_NULLABLE)) {
@@ -35,40 +46,75 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
3546
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_PARENTHESES);
3647

3748
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
38-
$type = $this->tryParseArray($tokens, $type);
49+
return $this->tryParseArray($tokens, $type);
3950
}
51+
52+
return $type;
4053
} elseif ($tokens->tryConsumeTokenType(Lexer::TOKEN_THIS_VARIABLE)) {
4154
$type = new Ast\Type\ThisTypeNode();
4255

4356
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
44-
$type = $this->tryParseArray($tokens, $type);
57+
return $this->tryParseArray($tokens, $type);
4558
}
46-
} else {
47-
$type = new Ast\Type\IdentifierTypeNode($tokens->currentTokenValue());
48-
$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
4959

50-
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
51-
$type = $this->parseGeneric($tokens, $type);
60+
return $type;
61+
}
5262

53-
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
54-
$type = $this->tryParseArray($tokens, $type);
55-
}
56-
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
57-
$type = $this->tryParseCallable($tokens, $type);
63+
$currentTokenValue = $tokens->currentTokenValue();
64+
$tokens->pushSavePoint(); // because of ConstFetchNode
65+
if ($tokens->tryConsumeTokenType(Lexer::TOKEN_IDENTIFIER)) {
66+
$type = new Ast\Type\IdentifierTypeNode($currentTokenValue);
5867

59-
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
60-
$type = $this->tryParseArray($tokens, $type);
68+
if (!$tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_COLON)) {
69+
$tokens->dropSavePoint(); // because of ConstFetchNode
70+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
71+
$type = $this->parseGeneric($tokens, $type);
6172

62-
} elseif ($type->name === 'array' && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
63-
$type = $this->parseArrayShape($tokens, $type);
73+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
74+
$type = $this->tryParseArray($tokens, $type);
75+
}
76+
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
77+
$type = $this->tryParseCallable($tokens, $type);
6478

65-
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
79+
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
6680
$type = $this->tryParseArray($tokens, $type);
81+
82+
} elseif ($type->name === 'array' && $tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_CURLY_BRACKET) && !$tokens->isPrecededByHorizontalWhitespace()) {
83+
$type = $this->parseArrayShape($tokens, $type);
84+
85+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
86+
$type = $this->tryParseArray($tokens, $type);
87+
}
6788
}
89+
90+
return $type;
91+
} else {
92+
$tokens->rollback(); // because of ConstFetchNode
6893
}
94+
} else {
95+
$tokens->dropSavePoint(); // because of ConstFetchNode
6996
}
7097

71-
return $type;
98+
$exception = new \PHPStan\PhpDocParser\Parser\ParserException(
99+
$tokens->currentTokenValue(),
100+
$tokens->currentTokenType(),
101+
$tokens->currentTokenOffset(),
102+
Lexer::TOKEN_IDENTIFIER
103+
);
104+
105+
if ($this->constExprParser === null) {
106+
throw $exception;
107+
}
108+
109+
try {
110+
$constExpr = $this->constExprParser->parse($tokens, true);
111+
if ($constExpr instanceof Ast\ConstExpr\ConstExprArrayNode) {
112+
throw $exception;
113+
}
114+
return new Ast\Type\ConstTypeNode($constExpr);
115+
} catch (\LogicException $e) {
116+
throw $exception;
117+
}
72118
}
73119

74120

‎tests/PHPStan/Parser/FuzzyTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ protected function setUp(): void
2222
{
2323
parent::setUp();
2424
$this->lexer = new Lexer();
25-
$this->typeParser = new TypeParser();
25+
$this->typeParser = new TypeParser(new ConstExprParser());
2626
$this->constExprParser = new ConstExprParser();
2727
}
2828

‎tests/PHPStan/Parser/PhpDocParserTest.php‎

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprArrayNode;
66
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
7+
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
78
use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
89
use PHPStan\PhpDocParser\Ast\PhpDoc\ExtendsTagValueNode;
910
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
@@ -24,6 +25,7 @@
2425
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
2526
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
2627
use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
28+
use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
2729
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
2830
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
2931
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
@@ -42,7 +44,8 @@ protected function setUp(): void
4244
{
4345
parent::setUp();
4446
$this->lexer = new Lexer();
45-
$this->phpDocParser = new PhpDocParser(new TypeParser(), new ConstExprParser());
47+
$constExprParser = new ConstExprParser();
48+
$this->phpDocParser = new PhpDocParser(new TypeParser($constExprParser), $constExprParser);
4649
}
4750

4851

@@ -944,15 +947,37 @@ public function provideReturnTagsData(): \Iterator
944947
new InvalidTagValueNode(
945948
'A | B < 123',
946949
new \PHPStan\PhpDocParser\Parser\ParserException(
947-
'123',
948-
Lexer::TOKEN_INTEGER,
949-
20,
950-
Lexer::TOKEN_IDENTIFIER
950+
'*/',
951+
Lexer::TOKEN_CLOSE_PHPDOC,
952+
24,
953+
Lexer::TOKEN_CLOSE_ANGLE_BRACKET
951954
)
952955
)
953956
),
954957
]),
955958
];
959+
960+
yield [
961+
'OK with type and const expr as generic type variable',
962+
'/** @return A | B < 123 > */',
963+
new PhpDocNode([
964+
new PhpDocTagNode(
965+
'@return',
966+
new ReturnTagValueNode(
967+
new UnionTypeNode([
968+
new IdentifierTypeNode('A'),
969+
new GenericTypeNode(
970+
new IdentifierTypeNode('B'),
971+
[
972+
new ConstTypeNode(new ConstExprIntegerNode('123')),
973+
]
974+
),
975+
]),
976+
''
977+
)
978+
),
979+
]),
980+
];
956981
}
957982

958983

@@ -2901,6 +2926,23 @@ public function provideRealWorldExampleData(): \Iterator
29012926
),
29022927
]),
29032928
];
2929+
2930+
yield [
2931+
'string literals in @return',
2932+
"/** @return 'foo'|'bar' */",
2933+
new PhpDocNode([
2934+
new PhpDocTagNode(
2935+
'@return',
2936+
new ReturnTagValueNode(
2937+
new UnionTypeNode([
2938+
new ConstTypeNode(new ConstExprStringNode('foo')),
2939+
new ConstTypeNode(new ConstExprStringNode('bar')),
2940+
]),
2941+
''
2942+
)
2943+
),
2944+
]),
2945+
];
29042946
}
29052947

29062948
}

‎tests/PHPStan/Parser/TypeParserTest.php‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
namespace PHPStan\PhpDocParser\Parser;
44

5+
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprFloatNode;
56
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
67
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
8+
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
79
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeItemNode;
810
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
911
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
1012
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
1113
use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
14+
use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
1215
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
1316
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
1417
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
@@ -31,7 +34,7 @@ protected function setUp(): void
3134
{
3235
parent::setUp();
3336
$this->lexer = new Lexer();
34-
$this->typeParser = new TypeParser();
37+
$this->typeParser = new TypeParser(new ConstExprParser());
3538
}
3639

3740

@@ -828,6 +831,29 @@ public function provideParseData(): array
828831
new CallableTypeParameterNode(new IdentifierTypeNode('mixed'), false, true, '', false),
829832
], new IdentifierTypeNode('TReturn')),
830833
],
834+
[
835+
"'foo'|'bar'",
836+
new UnionTypeNode([
837+
new ConstTypeNode(new ConstExprStringNode('foo')),
838+
new ConstTypeNode(new ConstExprStringNode('bar')),
839+
]),
840+
],
841+
[
842+
'Foo::FOO_CONSTANT',
843+
new ConstTypeNode(new ConstFetchNode('Foo', 'FOO_CONSTANT')),
844+
],
845+
[
846+
'123',
847+
new ConstTypeNode(new ConstExprIntegerNode('123')),
848+
],
849+
[
850+
'123.2',
851+
new ConstTypeNode(new ConstExprFloatNode('123.2')),
852+
],
853+
[
854+
'"bar"',
855+
new ConstTypeNode(new ConstExprStringNode('bar')),
856+
],
831857
];
832858
}
833859

0 commit comments

Comments
 (0)