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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
use super::DefinitionCollector;
use crate::parser::{name_to_string_owned, type_from_hint_owned};
use mir_codebase::definitions::{
wrap_template_bound, ConstantDef, PropertyDef, TemplateParam, TraitDef,
};
use mir_types::Type;
use php_ast::owned::{ClassMemberKind, TraitDecl};
use std::ops::ControlFlow;
use std::sync::Arc;
impl<'a> DefinitionCollector<'a> {
pub(super) fn collect_trait(
&mut self,
decl: &TraitDecl,
stmt_span: php_ast::Span,
) -> ControlFlow<()> {
let trait_name = decl.name.as_deref().unwrap_or_default().to_string();
let fqcn = self.declared_fqn(&trait_name);
let trait_doc = decl
.doc_comment
.as_ref()
.map(|c| crate::parser::DocblockParser::parse(&c.text))
.unwrap_or_default();
let trait_doc_span = decl
.doc_comment
.as_ref()
.map(|c| c.span.start)
.unwrap_or(stmt_span.start);
self.emit_docblock_issues(&trait_doc, trait_doc_span);
if !self.version_allows(&trait_doc) {
return ControlFlow::Continue(());
}
// Hoisted above the `@template` bound/default resolution below so a
// same-file `@psalm-type` alias used in a bound/default (`@template T
// of Numeric`) is expanded before resolution — mirrors `class.rs`'s
// own template-param construction, which already does this.
let type_aliases = self.build_type_aliases(&trait_doc);
let trait_template_names: rustc_hash::FxHashSet<String> = trait_doc
.templates
.iter()
.map(|(n, _, _, _)| n.to_string())
.collect();
let trait_template_params: Vec<TemplateParam> = trait_doc
.templates
.iter()
.map(|(name, bound, variance, default)| TemplateParam {
name: name.as_str().into(),
bound: wrap_template_bound(bound.clone().map(|b| {
let b = super::expand_aliases_only(b, &type_aliases);
Self::fill_self_static_parent(
self.resolve_union_doc_with_templates(
b,
&trait_template_names,
fqcn.as_str(),
&[],
),
fqcn.as_str(),
)
})),
default: wrap_template_bound(default.clone().map(|d| {
let d = super::expand_aliases_only(d, &type_aliases);
Self::fill_self_static_parent(
self.resolve_union_doc_with_templates(
d,
&trait_template_names,
fqcn.as_str(),
&[],
),
fqcn.as_str(),
)
})),
defining_entity: fqcn.as_str().into(),
variance: *variance,
})
.collect();
let mut own_methods = mir_codebase::definitions::MemberMap::default();
let mut own_properties = mir_codebase::definitions::MemberMap::default();
let mut own_constants = mir_codebase::definitions::MemberMap::default();
let mut trait_uses: Vec<Arc<str>> = vec![];
let mut trait_use_locations: Vec<(Arc<str>, mir_types::Location)> = vec![];
// See `class.rs` for why this runs before the loop and only covers
// self/static references to this same trait's constants.
let self_int_constants: Arc<rustc_hash::FxHashMap<Arc<str>, i64>> = Arc::new(
decl.body
.members
.iter()
.filter_map(|m| match &m.kind {
ClassMemberKind::ClassConst(c) => {
let name = c.name.as_deref()?;
match super::infer_const_value(self, &c.value.kind) {
Some(t) if t.types.len() == 1 => match &t.types[0] {
mir_types::Atomic::TLiteralInt(n) => Some((Arc::from(name), *n)),
_ => None,
},
_ => None,
}
}
_ => None,
})
.collect(),
);
let _int_mask_guard =
crate::parser::docblock::SelfIntConstantsGuard::activate(&fqcn, &self_int_constants);
for member in decl.body.members.iter() {
match &member.kind {
ClassMemberKind::Method(m) => {
if m.name.as_deref() == Some("__construct") {
for p in m.params.iter() {
if p.visibility.is_some() {
let param_name = p.name.as_deref().unwrap_or_default();
let ty = self.resolve_union_opt(
p.type_hint
.as_ref()
.map(|h| type_from_hint_owned(h, Some(&fqcn))),
);
let prop = PropertyDef {
name: Arc::from(param_name),
ty: mir_codebase::definitions::wrap_property_type(ty.clone()),
inferred_ty: None,
native_ty: mir_codebase::definitions::wrap_property_type(ty),
visibility: Self::convert_visibility(p.visibility),
is_static: false,
is_readonly: p.is_readonly,
has_native_readonly: p.is_readonly,
default: mir_codebase::definitions::wrap_property_type(
p.default.as_ref().map(|_| Type::mixed()),
),
location: Some(
self.location(member.span.start, member.span.end),
),
deprecated: None,
has_native_type: p.type_hint.is_some(),
from_docblock: false,
};
own_properties.insert(Arc::from(param_name), prop);
}
}
}
if let Some(method) = self.build_method_storage(
m,
&fqcn,
Some(&member.span),
Some(&type_aliases),
&trait_template_params,
) {
own_methods.insert(
Arc::from(crate::util::php_ident_lowercase(&method.name).as_str()),
Arc::new(method),
);
}
if let Some(body) = &m.body {
self.scan_stmts_for_defines(&body.stmts);
}
}
ClassMemberKind::Property(p) => {
let prop_doc = self.parse_docblock_from_node(p.doc_comment.as_ref());
let prop_doc_span = p
.doc_comment
.as_ref()
.map(|c| c.span.start)
.unwrap_or(member.span.start);
self.emit_docblock_issues(&prop_doc, prop_doc_span);
if !self.version_allows(&prop_doc) {
continue;
}
let prop_name = p.name.as_deref().unwrap_or_default();
let hint_ty = self.resolve_union_opt(
p.type_hint
.as_ref()
.map(|h| type_from_hint_owned(h, Some(&fqcn))),
);
// phpstorm-stubs `#[LanguageLevelTypeAware]` wins, then an `@var`
// docblock (mirroring class.rs's precedence — a trait property's
// @var was previously ignored entirely, only the native hint was
// ever used), then the native hint.
let ty = self
.version_attr_type_string(&p.attributes)
.map(|s| crate::parser::docblock::parse_type_string(&s))
.or_else(|| {
prop_doc.var_type.clone().map(|t| {
self.resolve_union_doc_with_templates(
super::expand_aliases_only(t, &type_aliases),
&trait_template_names,
fqcn.as_str(),
&trait_template_params,
)
})
})
.or_else(|| hint_ty.clone());
own_properties.insert(
Arc::from(prop_name),
PropertyDef {
name: Arc::from(prop_name),
ty: mir_codebase::definitions::wrap_property_type(ty),
native_ty: mir_codebase::definitions::wrap_property_type(hint_ty),
inferred_ty: None,
visibility: Self::convert_visibility(p.visibility),
is_static: p.is_static,
is_readonly: p.is_readonly,
has_native_readonly: p.is_readonly,
default: None,
location: Some(self.location(member.span.start, member.span.end)),
deprecated: prop_doc.deprecated.as_deref().map(Arc::from).or_else(
|| {
if p.attributes.iter().any(|a| {
a.name
.parts
.last()
.map(|part| {
part.as_ref().eq_ignore_ascii_case("Deprecated")
})
.unwrap_or(false)
}) {
Some(Arc::from(""))
} else {
None
}
},
),
has_native_type: p.type_hint.is_some(),
from_docblock: false,
},
);
}
ClassMemberKind::ClassConst(c) => {
let const_doc = self.parse_docblock_from_node(c.doc_comment.as_ref());
let const_doc_span = c
.doc_comment
.as_ref()
.map(|c| c.span.start)
.unwrap_or(member.span.start);
self.emit_docblock_issues(&const_doc, const_doc_span);
if !self.version_allows(&const_doc) {
continue;
}
let const_name = c.name.as_deref().unwrap_or_default();
own_constants.insert(
Arc::from(const_name),
ConstantDef {
name: Arc::from(const_name),
ty: Type::mixed(),
visibility: None,
is_final: c.is_final,
location: Some(self.location(member.span.start, member.span.end)),
deprecated: const_doc.deprecated.as_deref().map(Arc::from).or_else(
|| {
if c.attributes.iter().any(|a| {
a.name
.parts
.last()
.map(|p| p.as_ref().eq_ignore_ascii_case("Deprecated"))
.unwrap_or(false)
}) {
Some(Arc::from(""))
} else {
None
}
},
),
},
);
}
ClassMemberKind::TraitUse(tu) => {
for t in tu.traits.iter() {
let fqcn: Arc<str> = self.resolve_name(&name_to_string_owned(t)).into();
let loc = self.location(t.span.start, t.span.end);
trait_use_locations.push((fqcn.clone(), loc));
trait_uses.push(fqcn);
}
}
}
}
self.add_docblock_members(
&trait_doc,
&type_aliases,
&fqcn,
&mut own_methods,
&mut own_properties,
Some(self.location(stmt_span.start, stmt_span.end)),
&trait_template_names,
&trait_template_params,
);
let require_extends: Vec<Arc<str>> = trait_doc
.require_extends
.iter()
.map(|s| self.resolve_type_name(s.as_str(), true).into())
.collect();
let require_implements: Vec<Arc<str>> = trait_doc
.require_implements
.iter()
.map(|s| self.resolve_type_name(s.as_str(), true).into())
.collect();
let trait_use_type_args: Vec<(Arc<str>, Vec<mir_types::Type>)> = trait_doc
.uses
.iter()
.filter_map(|ty| {
if let mir_types::Atomic::TNamedObject {
fqcn: used_trait,
type_params,
} = ty.types.first()?
{
Some((
self.resolve_type_name(used_trait.as_str(), true).into(),
type_params
.iter()
.map(|tp| {
self.resolve_union_doc_with_templates(
super::expand_aliases_only(tp.clone(), &type_aliases),
&trait_template_names,
&fqcn,
&trait_template_params,
)
})
.collect(),
))
} else {
None
}
})
.collect();
self.slice.traits.push(std::sync::Arc::new(TraitDef {
fqcn: fqcn.into(),
short_name: Arc::from(trait_name.as_str()),
own_methods,
own_properties,
own_constants,
template_params: trait_template_params,
traits: trait_uses,
location: Some(self.location(stmt_span.start, stmt_span.end)),
trait_use_locations,
trait_use_type_args,
require_extends,
require_implements,
deprecated: Self::deprecated_from_doc_or_attrs(
trait_doc.deprecated.as_deref(),
&decl.attributes,
),
type_aliases: type_aliases
.iter()
.map(|(k, v)| (Arc::from(k.as_str()), v.clone()))
.collect(),
}));
ControlFlow::Continue(())
}
}