-
Notifications
You must be signed in to change notification settings - Fork 3k
/
elab_hint_haccess.rs
381 lines (331 loc) · 11.5 KB
/
elab_hint_haccess.rs
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// This source code is licensed under the MIT license found in the
// LICENSE file in the "hack" directory of this source tree.
use bitflags::bitflags;
use nast::Class_;
use nast::Contexts;
use nast::Hint;
use nast::Hint_;
use nast::Id;
use nast::WhereConstraintHint;
use crate::prelude::*;
#[derive(Clone, Default)]
pub struct ElabHintHaccessPass {
current_class: Option<Rc<Id>>,
flags: Flags,
}
bitflags! {
#[derive(Default, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)]
struct Flags: u8 {
const IN_CONTEXT = 1 << 0;
const IN_HACCESS = 1 << 1;
const IN_WHERE_CLAUSE = 1 << 2;
}
}
impl ElabHintHaccessPass {
fn set_in_class(&mut self, cls: &Class_) {
self.current_class = Some(Rc::new(cls.name.clone()))
}
fn in_context(&self) -> bool {
self.flags.contains(Flags::IN_CONTEXT)
}
fn set_in_context(&mut self, value: bool) {
self.flags.set(Flags::IN_CONTEXT, value)
}
fn in_haccess(&self) -> bool {
self.flags.contains(Flags::IN_HACCESS)
}
fn set_in_haccess(&mut self, value: bool) {
self.flags.set(Flags::IN_HACCESS, value)
}
fn in_where_clause(&self) -> bool {
self.flags.contains(Flags::IN_WHERE_CLAUSE)
}
fn set_in_where_clause(&mut self, value: bool) {
self.flags.set(Flags::IN_WHERE_CLAUSE, value)
}
}
impl Pass for ElabHintHaccessPass {
fn on_ty_hint_top_down(&mut self, env: &Env, elem: &mut Hint) -> ControlFlow<()> {
if !self.in_haccess() {
return Continue(());
}
match &mut *elem.1 {
Hint_::Happly(id, hints) if id.name() == sn::classes::SELF => {
if let Some(class_id) = self.current_class.as_deref() {
*id = class_id.clone();
// TODO[mjt] we appear to be discarding type arguments on `Happly` here?
hints.clear();
Continue(())
} else {
env.emit_error(NamingError::SelfOutsideClass(id.0.clone()));
Break(())
}
}
Hint_::Happly(id, _)
if id.name() == sn::classes::STATIC || id.name() == sn::classes::PARENT =>
{
env.emit_error(NamingError::InvalidTypeAccessRoot {
pos: id.pos().clone(),
id: Some(id.name().to_string()),
});
Break(())
}
Hint_::Hthis | Hint_::Happly(..) => Continue(()),
Hint_::Habstr(..) if self.in_where_clause() || self.in_context() => Continue(()),
// TODO[mjt] I don't understand what this case corresponds to
Hint_::Hvar(..) => Continue(()),
_ => {
env.emit_error(NamingError::InvalidTypeAccessRoot {
pos: elem.0.clone(),
id: None,
});
Break(())
}
}
}
fn on_ty_hint__top_down(&mut self, _: &Env, elem: &mut Hint_) -> ControlFlow<()> {
self.set_in_haccess(matches!(elem, Hint_::Haccess(..)));
Continue(())
}
fn on_ty_class__top_down(&mut self, _: &Env, elem: &mut Class_) -> ControlFlow<()> {
self.set_in_class(elem);
Continue(())
}
fn on_ty_where_constraint_hint_top_down(
&mut self,
_: &Env,
_: &mut WhereConstraintHint,
) -> ControlFlow<()> {
self.set_in_where_clause(true);
Continue(())
}
fn on_ty_contexts_top_down(&mut self, _: &Env, _: &mut Contexts) -> ControlFlow<()> {
self.set_in_context(true);
Continue(())
}
}
#[cfg(test)]
mod tests {
use nast::ConstraintKind;
use nast::Id;
use nast::Pos;
use super::*;
// -- type access through `self` -------------------------------------------
#[test]
// type access through `self` is valid inside a class
fn test_haccess_self_in_class_valid() {
let env = Env::default();
let class_name = "Classy";
let mut pass = ElabHintHaccessPass {
current_class: Some(Rc::new(Id(Default::default(), "Classy".to_string()))),
..Default::default()
};
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Happly(
Id(Pos::default(), sn::classes::SELF.to_string()),
vec![],
)),
),
vec![Id(Pos::default(), "T".to_string())],
)),
);
elem.transform(&env, &mut pass);
assert!(env.into_errors().is_empty());
assert!(match elem {
Hint(_, box Hint_::Haccess(Hint(_, box Hint_::Happly(id, hints)), _)) =>
id.name() == class_name && hints.is_empty(),
_ => false,
})
}
#[test]
// currently we erase any type params to which `self` is applied; adding
// test for tracking
fn test_haccess_self_in_class_erased_tparams_valid() {
let env = Env::default();
let class_name = "Classy";
let mut pass = ElabHintHaccessPass {
current_class: Some(Rc::new(Id(Default::default(), "Classy".to_string()))),
..Default::default()
};
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Happly(
Id(Pos::default(), sn::classes::SELF.to_string()),
vec![Hint(Pos::default(), Box::new(Hint_::Hmixed))],
)),
),
vec![Id(Pos::default(), "T".to_string())],
)),
);
elem.transform(&env, &mut pass);
assert!(env.into_errors().is_empty());
assert!(match elem {
Hint(_, box Hint_::Haccess(Hint(_, box Hint_::Happly(id, hints)), _)) =>
id.name() == class_name && hints.is_empty(),
_ => false,
})
}
#[test]
// type access through `self` is invalid outside a class
fn test_haccess_self_outside_class_invalid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass::default();
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Happly(
Id(Pos::default(), sn::classes::SELF.to_string()),
vec![],
)),
),
vec![Id(Pos::default(), "T".to_string())],
)),
);
elem.transform(&env, &mut pass);
let err_opt = env.into_errors().pop();
assert!(matches!(
err_opt,
Some(NamingPhaseError::Naming(NamingError::SelfOutsideClass(..)))
));
}
// -- type access through `this` -------------------------------------------
#[test]
// type access through `this` is always valid
fn test_haccess_this_valid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass::default();
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(Pos::default(), Box::new(Hint_::Hthis)),
vec![Id(Pos::default(), "T".to_string())],
)),
);
elem.transform(&env, &mut pass);
assert!(env.into_errors().is_empty());
assert!(matches!(
elem,
Hint(_, box Hint_::Haccess(Hint(_, box Hint_::Hthis), _))
))
}
// -- type access through `static` / `parent` ------------------------------
#[test]
// type access through `static` is invalid
fn test_haccess_static_in_class_invalid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass {
current_class: Some(Rc::new(Id(Default::default(), "Classy".to_string()))),
..Default::default()
};
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Happly(
Id(Pos::default(), sn::classes::STATIC.to_string()),
vec![],
)),
),
vec![Id(Pos::default(), "T".to_string())],
)),
);
elem.transform(&env, &mut pass);
let err_opt = env.into_errors().pop();
assert!(matches!(
err_opt,
Some(NamingPhaseError::Naming(
NamingError::InvalidTypeAccessRoot { .. }
))
));
}
// -- type access through type param ---------------------------------------
#[test]
// type access through type parameter is valid inside a context
fn test_haccess_tparam_in_context_valid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass::default();
let mut elem = Contexts(
Pos::default(),
vec![Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Habstr("T".to_string(), vec![])),
),
vec![Id(Pos::default(), "C".to_string())],
)),
)],
);
elem.transform(&env, &mut pass);
assert!(env.into_errors().is_empty());
let Contexts(_, mut hints) = elem;
assert!(matches!(
hints.pop(),
Some(Hint(_, box Hint_::Haccess(Hint(_, box Hint_::Habstr(..)), _)))
))
}
#[test]
// type access through type parameter is valid inside a where clause
fn test_haccess_tparam_in_where_clause_valid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass::default();
let mut elem = WhereConstraintHint(
Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Habstr("T".to_string(), vec![])),
),
vec![Id(Pos::default(), "C".to_string())],
)),
),
ConstraintKind::ConstraintSuper,
Hint(Pos::default(), Box::new(Hint_::Hmixed)),
);
elem.transform(&env, &mut pass);
assert!(env.into_errors().is_empty());
let WhereConstraintHint(hint, _, _) = elem;
assert!(matches!(
hint,
Hint(_, box Hint_::Haccess(Hint(_, box Hint_::Habstr(..)), _))
))
}
#[test]
// type access through type parameter in any other context is invalid
fn test_haccess_tparam_invalid() {
let env = Env::default();
let mut pass = ElabHintHaccessPass::default();
let mut elem = Hint(
Pos::default(),
Box::new(Hint_::Haccess(
Hint(
Pos::default(),
Box::new(Hint_::Habstr("T".to_string(), vec![])),
),
vec![Id(Pos::default(), "C".to_string())],
)),
);
elem.transform(&env, &mut pass);
let err_opt = env.into_errors().pop();
assert!(matches!(
err_opt,
Some(NamingPhaseError::Naming(
NamingError::InvalidTypeAccessRoot { .. }
))
));
}
}