/
SimpleNameResolver.php
252 lines (222 loc) · 7.98 KB
/
SimpleNameResolver.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?php
// based on PhpParser's builtin one
namespace Psalm\Internal\PhpVisitor;
use PhpParser;
use PhpParser\ErrorHandler;
use PhpParser\NameContext;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Name;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt;
use PhpParser\NodeVisitorAbstract;
/**
* @internal
*/
class SimpleNameResolver extends NodeVisitorAbstract
{
/** @var NameContext Naming context */
private $nameContext;
/** @var int|null */
private $start_change;
/** @var int|null */
private $end_change;
/**
* @param ErrorHandler $errorHandler Error handler
* @param null|array<int, array{int, int, int, int, int, string}> $offset_map
*/
public function __construct(ErrorHandler $errorHandler, ?array $offset_map = null)
{
if ($offset_map) {
foreach ($offset_map as [, , $b_s, $b_e]) {
if ($this->start_change === null) {
$this->start_change = $b_s;
}
$this->end_change = $b_e;
}
}
$this->nameContext = new NameContext($errorHandler);
}
public function beforeTraverse(array $nodes): ?array
{
$this->nameContext->startNamespace();
return null;
}
public function enterNode(Node $node): ?int
{
if ($node instanceof Stmt\Namespace_) {
$this->nameContext->startNamespace($node->name);
} elseif ($node instanceof Stmt\Use_) {
foreach ($node->uses as $use) {
$this->addAlias($use, $node->type);
}
} elseif ($node instanceof Stmt\GroupUse) {
foreach ($node->uses as $use) {
$this->addAlias($use, $node->type, $node->prefix);
}
} elseif ($node instanceof Stmt\Class_) {
if (null !== $node->extends) {
$node->extends = $this->resolveClassName($node->extends);
}
foreach ($node->implements as &$interface) {
$interface = $this->resolveClassName($interface);
}
$this->resolveAttrGroups($node);
if (null !== $node->name) {
$this->addNamespacedName($node);
}
}
if ($node instanceof Stmt\ClassMethod
&& $this->start_change
&& $this->end_change
) {
/** @var array{startFilePos: int, endFilePos: int} */
$attrs = $node->getAttributes();
if ($cs = $node->getComments()) {
$attrs['startFilePos'] = $cs[0]->getStartFilePos();
}
if ($attrs['endFilePos'] < $this->start_change
|| $attrs['startFilePos'] > $this->end_change
) {
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
}
}
if ($node instanceof Stmt\ClassMethod
|| $node instanceof Expr\Closure
) {
$this->resolveSignature($node);
} elseif ($node instanceof Expr\StaticCall
|| $node instanceof Expr\StaticPropertyFetch
|| $node instanceof Expr\ClassConstFetch
|| $node instanceof Expr\New_
|| $node instanceof Expr\Instanceof_
) {
if ($node->class instanceof Name) {
$node->class = $this->resolveClassName($node->class);
}
} elseif ($node instanceof Stmt\Catch_) {
foreach ($node->types as &$type) {
$type = $this->resolveClassName($type);
}
} elseif ($node instanceof Expr\FuncCall) {
if ($node->name instanceof Name) {
$node->name = $this->resolveName($node->name, Stmt\Use_::TYPE_FUNCTION);
}
} elseif ($node instanceof Expr\ConstFetch) {
$node->name = $this->resolveName($node->name, Stmt\Use_::TYPE_CONSTANT);
} elseif ($node instanceof Stmt\Trait_) {
$this->resolveTrait($node);
} elseif ($node instanceof Stmt\TraitUse) {
foreach ($node->traits as &$trait) {
$trait = $this->resolveClassName($trait);
}
foreach ($node->adaptations as $adaptation) {
if (null !== $adaptation->trait) {
$adaptation->trait = $this->resolveClassName($adaptation->trait);
}
if ($adaptation instanceof Stmt\TraitUseAdaptation\Precedence) {
foreach ($adaptation->insteadof as &$insteadof) {
$insteadof = $this->resolveClassName($insteadof);
}
}
}
}
return null;
}
private function addAlias(Stmt\UseUse $use, int $type, ?Name $prefix = null): void
{
// Add prefix for group uses
/** @var Name $name */
$name = $prefix ? Name::concat($prefix, $use->name) : $use->name;
// Type is determined either by individual element or whole use declaration
$type |= $use->type;
$this->nameContext->addAlias(
$name,
(string) $use->getAlias(),
$type,
$use->getAttributes()
);
}
/**
* @param Stmt\Function_|Stmt\ClassMethod|Expr\Closure $node
*/
private function resolveSignature(PhpParser\NodeAbstract $node): void
{
foreach ($node->params as $param) {
$param->type = $this->resolveType($param->type);
}
$node->returnType = $this->resolveType($node->returnType);
}
/**
* @template T of Node|null
* @param T $node
* @return ($node is NullableType ? NullableType : ($node is Name ? Name : T))
* @psalm-suppress LessSpecificReturnType
*/
private function resolveType(?Node $node): ?Node
{
if ($node instanceof NullableType) {
$node->type = $this->resolveType($node->type);
return $node;
}
if ($node instanceof Name) {
return $this->resolveClassName($node);
}
return $node;
}
/**
* Resolve name, according to name resolver options.
*
* CAVE: Attribute values are of type `string`, this is
* different to PhpParser's `NameResolver` using objects.
*
* @param Name $name Function or constant name to resolve
* @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_*
*
* @return Name Resolved name, or original name with attribute
*/
protected function resolveName(Name $name, int $type): Name
{
$resolvedName = $this->nameContext->getResolvedName($name, $type);
if (null !== $resolvedName) {
$name->setAttribute('resolvedName', $resolvedName->toString());
} else {
$namespaceName = Name\FullyQualified::concat(
$this->nameContext->getNamespace(),
$name,
$name->getAttributes()
);
if ($namespaceName instanceof Name) {
$name->setAttribute('namespacedName', $namespaceName->toString());
}
}
return $name;
}
protected function resolveClassName(Name $name): Name
{
return $this->resolveName($name, Stmt\Use_::TYPE_NORMAL);
}
protected function addNamespacedName(Stmt\Class_ $node): void
{
/** @psalm-suppress UndefinedPropertyAssignment */
$node->namespacedName = Name::concat(
$this->nameContext->getNamespace(),
(string)$node->name
);
}
protected function resolveAttrGroups(Stmt\Class_ $node): void
{
foreach ($node->attrGroups as $attrGroup) {
foreach ($attrGroup->attrs as $attr) {
$attr->name = $this->resolveClassName($attr->name);
}
}
}
protected function resolveTrait(Stmt\Trait_ $node): void
{
$resolvedName = Name::concat($this->nameContext->getNamespace(), (string) $node->name);
if (null !== $resolvedName) {
$node->setAttribute('resolvedName', $resolvedName->toString());
}
}
}