Skip to content

Commit 5251b5b

Browse files
JanTvrdikJanTvrdik
committed
TypeParser: add support for callable types
1 parent 3ff33ac commit 5251b5b

File tree

6 files changed

+291
-4
lines changed

6 files changed

+291
-4
lines changed

‎doc/grammars/type.abnf‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,39 @@ Nullable
1616
= TokenNullable TokenIdentifier [Generic]
1717

1818
Atomic
19-
= TokenIdentifier [Generic / Array]
19+
= TokenIdentifier [Generic / Callable / Array]
2020
/ TokenThisVariable
2121
/ TokenParenthesesOpen Type TokenParenthesesClose [Array]
2222

2323
Generic
2424
= TokenAngleBracketOpen Type *(TokenComma Type) TokenAngleBracketClose
2525

26+
Callable
27+
= TokenParenthesesOpen [CallableParameters] TokenParenthesesClose TokenColon CallableReturnType
28+
29+
CallableParameters
30+
= CallableParameter *(TokenComma CallableParameter)
31+
32+
CallableParameter
33+
= Type [CallableParameterIsReference] [CallableParameterIsVariadic] [CallableParameterName] [CallableParameterIsOptional]
34+
35+
CallableParameterIsReference
36+
= TokenIntersection
37+
38+
CallableParameterIsVariadic
39+
= TokenVariadic
40+
41+
CallableParameterName
42+
= TokenVariable
43+
44+
CallableParameterIsOptional
45+
= TokenEqualSign
46+
47+
CallableReturnType
48+
= TokenIdentifier [Generic]
49+
/ Nullable
50+
/ TokenParenthesesOpen Type TokenParenthesesClose
51+
2652
Array
2753
= 1*(TokenSquareBracketOpen TokenSquareBracketClose)
2854

@@ -116,6 +142,18 @@ TokenSquareBracketClose
116142
TokenComma
117143
= "," *ByteHorizontalWs
118144

145+
TokenColon
146+
= ":" *ByteHorizontalWs
147+
148+
TokenVariadic
149+
= "..." *ByteHorizontalWs
150+
151+
TokenEqualSign
152+
= "=" *ByteHorizontalWs
153+
154+
TokenVariable
155+
= "$" ByteIdentifierFirst *ByteIdentifierSecond *ByteHorizontalWs
156+
119157
TokenDoubleArrow
120158
= "=>" *ByteHorizontalWs
121159

‎src/Ast/Type/CallableTypeNode.php‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\PhpDocParser\Ast\Type;
4+
5+
class CallableTypeNode implements TypeNode
6+
{
7+
8+
/** @var IdentifierTypeNode */
9+
public $identifier;
10+
11+
/** @var CallableTypeParameterNode[] */
12+
public $parameters;
13+
14+
/** @var TypeNode */
15+
public $returnType;
16+
17+
public function __construct(IdentifierTypeNode $identifier, array $parameters, TypeNode $returnType)
18+
{
19+
$this->identifier = $identifier;
20+
$this->parameters = $parameters;
21+
$this->returnType = $returnType;
22+
}
23+
24+
25+
public function __toString(): string
26+
{
27+
$parameters = implode(', ', $this->parameters);
28+
return "{$this->identifier}({$parameters}): {$this->returnType}";
29+
}
30+
31+
}

‎src/Ast/Type/CallableTypeParameterNode.php‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\PhpDocParser\Ast\Type;
4+
5+
use PHPStan\PhpDocParser\Ast\Node;
6+
7+
class CallableTypeParameterNode implements Node
8+
{
9+
10+
/** @var TypeNode */
11+
public $type;
12+
13+
/** @var bool */
14+
public $isReference;
15+
16+
/** @var bool */
17+
public $isVariadic;
18+
19+
/** @var string (may be empty) */
20+
public $parameterName;
21+
22+
/** @var bool */
23+
public $isOptional;
24+
25+
public function __construct(TypeNode $type, bool $isReference, bool $isVariadic, string $parameterName, bool $isOptional)
26+
{
27+
$this->type = $type;
28+
$this->isReference = $isReference;
29+
$this->isVariadic = $isVariadic;
30+
$this->parameterName = $parameterName;
31+
$this->isOptional = $isOptional;
32+
}
33+
34+
35+
public function __toString(): string
36+
{
37+
$type = "{$this->type} ";
38+
$isReference = $this->isReference ? '&' : '';
39+
$isVariadic = $this->isVariadic ? '...' : '';
40+
$default = $this->isOptional ? ' = default' : '';
41+
return "{$type}{$isReference}{$isVariadic}{$this->parameterName}{$default}";
42+
}
43+
44+
}

‎src/Lexer/Lexer.php‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ class Lexer
1919
const TOKEN_OPEN_SQUARE_BRACKET = 8;
2020
const TOKEN_CLOSE_SQUARE_BRACKET = 9;
2121
const TOKEN_COMMA = 10;
22+
const TOKEN_COLON = 29;
2223
const TOKEN_VARIADIC = 11;
2324
const TOKEN_DOUBLE_COLON = 12;
2425
const TOKEN_DOUBLE_ARROW = 13;
@@ -50,6 +51,7 @@ class Lexer
5051
self::TOKEN_OPEN_SQUARE_BRACKET => '\'[\'',
5152
self::TOKEN_CLOSE_SQUARE_BRACKET => '\']\'',
5253
self::TOKEN_COMMA => '\',\'',
54+
self::TOKEN_COLON => '\':\'',
5355
self::TOKEN_VARIADIC => '\'...\'',
5456
self::TOKEN_DOUBLE_COLON => '\'::\'',
5557
self::TOKEN_DOUBLE_ARROW => '\'=>\'',
@@ -107,8 +109,8 @@ public function tokenize(string $s): array
107109
private function initialize()
108110
{
109111
$patterns = [
110-
// '&' followed by TOKEN_VARIADIC or TOKEN_VARIABLE
111-
self::TOKEN_REFERENCE => '&(?=\\s*+(?:(?:\\.\\.\\.)|(?:\\$(?!this\\b))))',
112+
// '&' followed by TOKEN_VARIADIC, TOKEN_VARIABLE, TOKEN_EQUAL, TOKEN_EQUAL or TOKEN_CLOSE_PARENTHESES
113+
self::TOKEN_REFERENCE => '&(?=\\s*+(?:[.,=)]|(?:\\$(?!this(?![0-9a-z_\\x80-\\xFF])))))',
112114
self::TOKEN_UNION => '\\|',
113115
self::TOKEN_INTERSECTION => '&',
114116
self::TOKEN_NULLABLE => '\\?',
@@ -125,6 +127,7 @@ private function initialize()
125127
self::TOKEN_DOUBLE_COLON => '::',
126128
self::TOKEN_DOUBLE_ARROW => '=>',
127129
self::TOKEN_EQUAL => '=',
130+
self::TOKEN_COLON => ':',
128131

129132
self::TOKEN_OPEN_PHPDOC => '/\\*\\*(?=\\s)',
130133
self::TOKEN_CLOSE_PHPDOC => '\\*/',
@@ -137,7 +140,7 @@ private function initialize()
137140
self::TOKEN_DOUBLE_QUOTED_STRING => '"(?:\\\\[^\\r\\n]|[^"\\r\\n\\\\])*+"',
138141

139142
self::TOKEN_IDENTIFIER => '(?:[\\\\]?+[a-z_\\x80-\\xFF][0-9a-z_\\x80-\\xFF]*+)++',
140-
self::TOKEN_THIS_VARIABLE => '\\$this\\b',
143+
self::TOKEN_THIS_VARIABLE => '\\$this(?![0-9a-z_\\x80-\\xFF])',
141144
self::TOKEN_VARIABLE => '\\$[a-z_\\x80-\\xFF][0-9a-z_\\x80-\\xFF]*+',
142145

143146
self::TOKEN_HORIZONTAL_WS => '[\\x09\\x20]++',

‎src/Parser/TypeParser.php‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ private function parseAtomic(TokenIterator $tokens): Ast\Type\TypeNode
4848
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
4949
$type = $this->parseGeneric($tokens, $type);
5050

51+
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
52+
$type = $this->parseCallable($tokens, $type);
53+
5154
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
5255
$type = $this->tryParseArray($tokens, $type);
5356
}
@@ -110,6 +113,67 @@ private function parseGeneric(TokenIterator $tokens, Ast\Type\IdentifierTypeNode
110113
}
111114

112115

116+
private function parseCallable(TokenIterator $tokens, Ast\Type\IdentifierTypeNode $identifier): Ast\Type\TypeNode
117+
{
118+
$tokens->consumeTokenType(Lexer::TOKEN_OPEN_PARENTHESES);
119+
120+
$parameters = [];
121+
if (!$tokens->isCurrentTokenType(Lexer::TOKEN_CLOSE_PARENTHESES)) {
122+
$parameters[] = $this->parseCallableParameter($tokens);
123+
while ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA)) {
124+
$parameters[] = $this->parseCallableParameter($tokens);
125+
}
126+
}
127+
128+
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_PARENTHESES);
129+
$tokens->consumeTokenType(Lexer::TOKEN_COLON);
130+
$returnType = $this->parseCallableReturnType($tokens);
131+
132+
return new Ast\Type\CallableTypeNode($identifier, $parameters, $returnType);
133+
}
134+
135+
136+
private function parseCallableParameter(TokenIterator $tokens): Ast\Type\CallableTypeParameterNode
137+
{
138+
$type = $this->parse($tokens);
139+
$isReference = $tokens->tryConsumeTokenType(Lexer::TOKEN_REFERENCE);
140+
$isVariadic = $tokens->tryConsumeTokenType(Lexer::TOKEN_VARIADIC);
141+
142+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_VARIABLE)) {
143+
$parameterName = $tokens->currentTokenValue();
144+
$tokens->consumeTokenType(Lexer::TOKEN_VARIABLE);
145+
146+
} else {
147+
$parameterName = '';
148+
}
149+
150+
$isOptional = $tokens->tryConsumeTokenType(Lexer::TOKEN_EQUAL);
151+
return new Ast\Type\CallableTypeParameterNode($type, $isReference, $isVariadic, $parameterName, $isOptional);
152+
}
153+
154+
155+
private function parseCallableReturnType(TokenIterator $tokens): Ast\Type\TypeNode
156+
{
157+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_NULLABLE)) {
158+
$type = $this->parseNullable($tokens);
159+
160+
} elseif ($tokens->tryConsumeTokenType(Lexer::TOKEN_OPEN_PARENTHESES)) {
161+
$type = $this->parse($tokens);
162+
$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_PARENTHESES);
163+
164+
} else {
165+
$type = new Ast\Type\IdentifierTypeNode($tokens->currentTokenValue());
166+
$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
167+
168+
if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
169+
$type = $this->parseGeneric($tokens, $type);
170+
}
171+
}
172+
173+
return $type;
174+
}
175+
176+
113177
private function tryParseArray(TokenIterator $tokens, Ast\Type\TypeNode $type): Ast\Type\TypeNode
114178
{
115179
try {

‎tests/PHPStan/Parser/TypeParserTest.php‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
namespace PHPStan\PhpDocParser\Parser;
44

55
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
6+
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
7+
use PHPStan\PhpDocParser\Ast\Type\CallableTypeParameterNode;
68
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
79
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
810
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
@@ -262,6 +264,111 @@ public function provideParseData(): array
262264
]
263265
),
264266
],
267+
[
268+
'callable(): Foo',
269+
new CallableTypeNode(
270+
new IdentifierTypeNode('callable'),
271+
[],
272+
new IdentifierTypeNode('Foo')
273+
),
274+
],
275+
[
276+
'callable(): ?Foo',
277+
new CallableTypeNode(
278+
new IdentifierTypeNode('callable'),
279+
[],
280+
new NullableTypeNode(
281+
new IdentifierTypeNode('Foo')
282+
)
283+
),
284+
],
285+
[
286+
'callable(): Foo<Bar>',
287+
new CallableTypeNode(
288+
new IdentifierTypeNode('callable'),
289+
[],
290+
new GenericTypeNode(
291+
new IdentifierTypeNode('Foo'),
292+
[
293+
new IdentifierTypeNode('Bar'),
294+
]
295+
)
296+
),
297+
],
298+
[
299+
'callable(): Foo|Bar',
300+
new UnionTypeNode([
301+
new CallableTypeNode(
302+
new IdentifierTypeNode('callable'),
303+
[],
304+
new IdentifierTypeNode('Foo')
305+
),
306+
new IdentifierTypeNode('Bar'),
307+
]),
308+
],
309+
[
310+
'callable(): Foo&Bar',
311+
new IntersectionTypeNode([
312+
new CallableTypeNode(
313+
new IdentifierTypeNode('callable'),
314+
[],
315+
new IdentifierTypeNode('Foo')
316+
),
317+
new IdentifierTypeNode('Bar'),
318+
]),
319+
],
320+
[
321+
'callable(): (Foo|Bar)',
322+
new CallableTypeNode(
323+
new IdentifierTypeNode('callable'),
324+
[],
325+
new UnionTypeNode([
326+
new IdentifierTypeNode('Foo'),
327+
new IdentifierTypeNode('Bar'),
328+
])
329+
),
330+
],
331+
[
332+
'callable(): (Foo&Bar)',
333+
new CallableTypeNode(
334+
new IdentifierTypeNode('callable'),
335+
[],
336+
new IntersectionTypeNode([
337+
new IdentifierTypeNode('Foo'),
338+
new IdentifierTypeNode('Bar'),
339+
])
340+
),
341+
],
342+
[
343+
'callable(A&...$a=, B&...=, C): Foo',
344+
new CallableTypeNode(
345+
new IdentifierTypeNode('callable'),
346+
[
347+
new CallableTypeParameterNode(
348+
new IdentifierTypeNode('A'),
349+
true,
350+
true,
351+
'$a',
352+
true
353+
),
354+
new CallableTypeParameterNode(
355+
new IdentifierTypeNode('B'),
356+
true,
357+
true,
358+
'',
359+
true
360+
),
361+
new CallableTypeParameterNode(
362+
new IdentifierTypeNode('C'),
363+
false,
364+
false,
365+
'',
366+
false
367+
),
368+
],
369+
new IdentifierTypeNode('Foo')
370+
),
371+
],
265372
[
266373
'(Foo\\Bar<array<mixed, string>, (int | (string<foo> & bar)[])> | Lorem)',
267374
new UnionTypeNode([

0 commit comments

Comments
 (0)