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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
|
/* ____ ____ ____ ____ ______ *\
** / __// __ \/ __// __ \/ ____/ SOcos COmpiles Scala **
** __\_ \/ /_/ / /__/ /_/ /\_ \ (c) 2002, LAMP/EPFL **
** /_____/\____/\___/\____/____/ **
\* */
// $Id$
package scalac.checkers;
import java.util.Iterator;
import java.util.HashSet;
import java.util.Set;
import java.util.Stack;
import scala.tools.util.Position;
import scalac.CompilationUnit;
import scalac.ast.Tree;
import scalac.ast.Tree.AbsTypeDef;
import scalac.ast.Tree.Ident;
import scalac.ast.Tree.Template;
import scalac.ast.Tree.ValDef;
import scalac.ast.TreeInfo;
import scalac.symtab.Definitions;
import scalac.symtab.Symbol;
import scalac.symtab.Type;
import scalac.util.Debug;
/**
* This checker checks that trees are well-formed. It checks both the
* shape and the attribution of the trees. WARNING: currently, the
* checks are valid only for trees generated by phase AddConstructors.
*/
public class TreeChecker {
//########################################################################
// Private Fields
/** The global definitions */
private final Definitions definitions;
/** The stack of current units */
private final Stack/*<CompilationUnit>*/ units = new Stack();
/** The stack of current classes */
private final Stack/*<Symbol>*/ classes = new Stack();
/** The stack of current members */
private final Stack/*<Symbol>*/ members = new Stack();
/** The stack of current owners */
private final Stack/*<Symbol>*/ owners = new Stack();
/** The currently visible type variables */
private final Set/*<Symbol>*/ tvars = new HashSet();
/** The currently visible value variables */
private final Set/*<Symbol>*/ vvars = new HashSet();
/** The currently visible labels */
private final Set/*<Symbol>*/ labels = new HashSet();
/** The currently defined symbols */
private final Set/*<Symbol>*/ symbols = new HashSet();
//########################################################################
// Public Constructors
/** Initializes this instance. */
public TreeChecker(Definitions definitions) {
this.definitions = definitions;
}
//########################################################################
// Public Methods - Checking units
/** Checks the unit. Returns true. */
public boolean check(CompilationUnit unit) {
pushUnit(unit);
template(unit.body);
popUnit();
return true;
}
//########################################################################
// Private Methods - Checking templates
/** Checks the templates. Returns true. */
private boolean template(Tree[] trees) {
for (int i = 0; i < trees.length; i++) template(trees[i]);
return true;
}
/** Checks the template. Returns true. */
private boolean template(Tree tree) {
switch (tree) {
case Empty:
return true;
case ClassDef(_, _, AbsTypeDef[] tparams, ValDef[][] vparams, _, Template(_, Tree[] body)):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isClass(): show(tree);
assert vparams.length == 1: show(tree);
containSymbols(tparams, symbol.typeParams());
containSymbols(vparams[0],symbol.valueParams());
registerSymbol(symbol);
scopeInsertParametersOf(symbol);
pushClass(symbol);
member(body);
popClass();
scopeRemoveParametersOf(symbol);
return true;
case PackageDef(Tree packaged, Template(Tree[] bases, Tree[] body)):
Symbol symbol = packaged.symbol();
assert symbol != null && symbol.isPackage(): show(packaged);
assert bases.length == 0: show(tree);
pushOwner(symbol);
template(body);
popOwner();
return true;
default:
throw Debug.abort("illegal case", tree);
}
}
//########################################################################
// Private Methods - Checking members
/** Checks the members. Returns true. */
private boolean member(Tree[] trees) {
for (int i = 0; i < trees.length; i++) member(trees[i]);
return true;
}
/** Checks the member. Returns true. */
private boolean member(Tree tree) {
switch (tree) {
case Empty:
return true;
case ClassDef(_, _, _, _, _, _):
return template(tree);
case ValDef(_, _, _, Tree rhs):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isTerm(): show(tree);
assert rhs == Tree.Empty: show(tree);
registerSymbol(symbol);
pushMember(symbol);
popMember();
return true;
case DefDef(_, _, AbsTypeDef[]tparams, ValDef[][]vparams, _, Tree rhs):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isMethod(): show(tree);
assert vparams.length == 1: show(tree);
containSymbols(tparams, symbol.typeParams());
containSymbols(vparams[0],symbol.valueParams());
assert symbol.isDeferred() == (rhs == Tree.Empty): show(tree);
registerSymbol(symbol);
scopeInsertParametersOf(symbol);
pushMember(symbol);
if (!symbol.isDeferred()) expression(rhs, symbol.resultType());
popMember();
scopeRemoveParametersOf(symbol);
return true;
default:
throw Debug.abort("illegal case", tree);
}
}
//########################################################################
// Private Methods - Checking statements
/** Checks the statement. Returns true. */
private boolean statement(Set locals, Tree tree) {
switch (tree) {
case Empty:
return true;
case ValDef(_, _, _, Tree rhs):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isTerm(): show(tree);
scopeInsertVVariable(symbol, false);
locals.add(symbol);
pushOwner(symbol);
expression(rhs, symbol.type());
popOwner();
return true;
default:
return expression(tree, tree.type());
}
}
//########################################################################
// Private Methods - Checking expressions
/** Checks the expression of given expected type. Returns true. */
private boolean expression(Tree tree, Type expected) {
// !!! conforms(tree, expected);
expected = tree.type();
switch (tree) {
case LabelDef(_, Ident[] idents, Tree rhs):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isLabel(): show(tree);
Symbol[] params = symbol.type().valueParams();
assert params.length == idents.length: show(tree)
+ format("params", Debug.show(params));
for (int i = 0; i < idents.length; i++) {
location(idents[i]);
conforms(idents[i], definitions.ANY_TYPE(), params[i].type());
Symbol local = idents[i].symbol();
assert local != null && !local.isModule(): show(idents[i]);
}
conforms(tree, symbol.resultType());
scopeInsertLabel(symbol);
expression(rhs, symbol.resultType());
scopeRemoveLabel(symbol);
return true;
case Block(Tree[] statements, Tree value):
Set locals = new HashSet();
for (int i = 0; i < statements.length; i++)
statement(locals, statements[i]);
expression(value, expected);
for (Iterator i = locals.iterator(); i.hasNext(); )
scopeRemoveVVariable((Symbol)i.next());
return true;
case Assign(Tree lhs, Tree rhs):
location(lhs);
expression(rhs, lhs.type().widen());
return true;
case If(Tree cond, Tree thenp, Tree elsep):
expression(cond, definitions.boolean_TYPE());
expression(thenp, expected);
expression(elsep, expected);
return true;
case Switch(Tree test, _, Tree[] bodies, Tree otherwise):
expression(test, definitions.int_TYPE());
for (int i = 0; i < bodies.length; i++)
expression(bodies[i], expected);
expression(otherwise, expected);
return true;
case Return(Tree value):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isMethod(): show(tree);
assert currentMember() == symbol: show(tree);
return expression(value, currentMember().resultType());
case Throw(Tree value):
return expression(value, definitions.THROWABLE_TYPE());
case New(Tree init):
switch (init) {
case Apply(Select(Create(_, Tree[] targs), _), Tree[] vargs):
return expression(init, definitions.void_TYPE());
default:
throw Debug.abort("illegal case", show(tree));
}
case Create(Tree qualifier, Tree[] targs):
assert qualifier == Tree.Empty: show(tree);
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isClass(): show(tree);
return true;
case Apply(Tree vfun, Tree[] vargs):
vapply(tree, vfun.type(), vargs);
switch (vfun) {
case TypeApply(Tree tfun, Tree[] targs):
Symbol symbol = tfun.symbol();
assert symbol != null && !symbol.isLabel(): show(tree);
tapply(tree, tfun.type(), targs);
return function(tfun);
default:
return function(vfun);
}
case Super(_, _):
case This(_):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isClass(): show(tree);
assert symbol == currentClass(): show(tree);
return true;
case Select(_, _):
case Ident(_):
return location(tree);
case Literal(_):
return true;
default:
throw Debug.abort("illegal case", show(tree));
}
}
/** Checks the type application. Returns true. */
private boolean tapply(Tree tree, Type function, Tree[] args) {
Symbol[] params = function.typeParams();
assert params.length == args.length: show(tree)
+ format("params", Debug.show(params));
Type.Map subst = Type.getSubst(params, Tree.typeOf(args));
for (int i = 0; i < args.length; i++) {
Type expected = subst.apply(params[i].info());
Type loBound = subst.apply(params[i].loBound());
conforms(args[i], expected, loBound);
}
conforms(tree, subst.apply(function.resultType()));
return true;
}
/** Checks the value application. Returns true. */
private boolean vapply(Tree tree, Type function, Tree[] args) {
Symbol[] params = function.valueParams();
assert params.length == args.length: show(tree)
+ format("params", Debug.show(params));
for (int i = 0; i < args.length; i++)
expression(args[i], params[i].type());
conforms(tree, function.resultType());
return true;
}
//########################################################################
// Private Methods - Checking functions
/** Checks the function. Returns true. */
private boolean function(Tree tree) {
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isTerm(): show(tree);
assert symbol.isMethod(): show(tree);
switch (tree) {
case Select(Tree qualifier, _):
if (qualifier instanceof Tree.Create)
assert symbol.isInitializer(): show(tree);
return selection(tree);
case Ident(_):
if (!symbol.isLabel() && symbol.isStatic()) return true;
assert labels.contains(symbol): show(tree);
assert symbol.owner() == currentMember(): show(tree);
return true;
default:
throw Debug.abort("illegal case", tree);
}
}
/** Checks the location. Returns true. */
private boolean location(Tree tree) {
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isTerm(): show(tree);
assert !symbol.isMethod(): show(tree);
switch (tree) {
case Select(_, _):
return selection(tree);
case Ident(_):
if (symbol.owner().isStaticOwner()) return true;
assert vvars.contains(symbol): show(tree);
assert symbol.owner() == currentMember(): show(tree);
return true;
default:
throw Debug.abort("illegal case", tree);
}
}
//########################################################################
// Private Methods - Checking selection
/** Checks the selection. Returns true. */
private boolean selection(Tree tree) {
switch (tree) {
case Select(Tree qualifier, _):
Symbol symbol = tree.symbol();
assert symbol != null && symbol.isTerm(): show(tree);
Symbol owner = symbol.owner();
assert owner.isClass() && !owner.isStaticOwner(): show(tree);
assert qualifier.type().baseType(owner) != Type.NoType:
show(tree) + "#" + qualifier.type() + "/" + owner;
return expression(qualifier, qualifier.type());
default:
throw Debug.abort("illegal case", tree);
}
}
//########################################################################
// Private Methods - Checking helpers
/** Do the trees contain the given symbols? */
private void containSymbols(Tree[] trees, Symbol[] symbols) {
boolean ok = trees.length == symbols.length;
for (int i = 0; ok && i < trees.length; i++)
ok &= trees[i].symbol() == symbols[i];
assert ok: show() + format("trees", trees) + format("symbols",symbols);
}
/** Does the type conform to the expected type and lower bound? */
private void conforms(Tree tree, Type expected, Type loBound) {
conforms(tree, expected);
if (false && !loBound.isSubType(tree.type())) { // !!! false &&
Type.explainSwitch = true;
assert loBound.isSubType(tree.type()): show(tree)
+ format("loBound", expected);
Type.explainSwitch = false;
}
}
/** Does the type conform to the expected type? */
private void conforms(Tree tree, Type expected) {
if (!tree.type().isSubType(expected)) {
Type.explainSwitch = true;
assert tree.type().isSubType(expected): show(tree)
+ format("expected", expected);
Type.explainSwitch = false;
}
}
//########################################################################
// Private Methods - Declaring symbols
/** Remove parameters of symbol from current scope. */
private void scopeInsertParametersOf(Symbol symbol) {
Symbol[] tparams = symbol.typeParams();
for (int i = 0; i < tparams.length; i++)
scopeInsertTVariable(tparams[i], true);
Symbol[] vparams = symbol.valueParams();
for (int i = 0; i < vparams.length; i++)
scopeInsertVVariable(vparams[i], true);
}
/** Adds the type variable to the current scope. */
private void scopeInsertTVariable(Symbol symbol, boolean isParameter) {
assert !symbol.owner().isClass(): show(symbol);
assert symbol.isParameter() == isParameter: show(symbol);
registerSymbol(symbol);
tvars.add(symbol);
}
/** Adds the value variable to the current scope. */
private void scopeInsertVVariable(Symbol symbol, boolean isParameter) {
assert !symbol.owner().isClass(): show(symbol);
assert symbol.isParameter() == isParameter: show(symbol);
registerSymbol(symbol);
vvars.add(symbol);
}
/** Adds the label to current scope. */
private void scopeInsertLabel(Symbol symbol) {
assert !symbol.owner().isClass(): show(symbol);
registerSymbol(symbol);
labels.add(symbol);
}
/** Remove parameters of symbol from current scope. */
private void scopeRemoveParametersOf(Symbol symbol) {
Symbol[] tparams = symbol.typeParams();
for (int i = 0; i < tparams.length; i++)
scopeRemoveTVariable(tparams[i]);
Symbol[] vparams = symbol.valueParams();
for (int i = 0; i < vparams.length; i++)
scopeRemoveVVariable(vparams[i]);
}
/** Removes the type variable from current scope. */
private void scopeRemoveTVariable(Symbol symbol) {
boolean removed = tvars.remove(symbol);
assert removed: show(symbol);
}
/** Removes the value variable from current scope. */
private void scopeRemoveVVariable(Symbol symbol) {
boolean removed = vvars.remove(symbol);
assert removed: show(symbol);
}
/** Removes the label symbol from current scope. */
private void scopeRemoveLabel(Symbol symbol) {
boolean removed = labels.remove(symbol);
assert removed: show(symbol);
}
/** Registers the symbol. */
private void registerSymbol(Symbol symbol) {
boolean added = symbols.add(symbol);
assert added: show(symbol);
}
//########################################################################
// Private Methods - Managing current context
/** Returns the current unit. */
private CompilationUnit currentUnit() {
return units.size() > 0 ? (CompilationUnit)units.peek() : null;
}
/** Returns the current class. */
private Symbol currentClass() {
return classes.size() > 0 ? (Symbol)classes.peek() : null;
}
/** Returns the current member. */
private Symbol currentMember() {
return members.size() > 0 ? (Symbol)members.peek() : null;
}
/** Returns the current owner. */
private Symbol currentOwner() {
return owners.size() > 0 ? (Symbol)owners.peek() : null;
}
/** Sets the current unit to the given one. */
private void pushUnit(CompilationUnit unit) {
assert units.size() == 0: showPush(unit);
assert classes.size() == 0: showPush(unit);
assert members.size() == 0: showPush(unit);
units.push(unit);
}
/** Sets the current class to the given one. */
private void pushClass(Symbol clasz) {
assert clasz.isClass(): showPush(clasz);
assert members.size() == 0: showPush(clasz);
classes.push(clasz);
pushOwner(clasz);
}
/** Sets the current member to the given one. */
private void pushMember(Symbol member) {
assert member.isTerm(): showPush(member);
assert members.size() == 0: showPush(member);
assert member.owner() == currentClass(): showPush(member);
members.push(member);
pushOwner(member);
}
/** Sets the current owner to the given one. */
private void pushOwner(Symbol owner) {
owners.push(owner);
}
/** Sets the current unit to the previous one. */
private void popUnit() {
assert units.size() > 0: show();
units.pop();
}
/** Sets the current class to the previous one. */
private void popClass() {
assert members.size() == 0: show();
assert classes.size() > 0: show();
popOwner();
classes.pop();
}
/** Sets the current member to the previous one. */
private void popMember() {
assert members.size() > 0: show();
popOwner();
members.pop();
}
/** Sets the current owner to the previous one. */
private void popOwner() {
assert owners.size() > 0: show();
owners.pop();
}
//########################################################################
// Private Methods - Showing errors
/** Returns the current position. */
private String show() {
return format("unit", currentUnit())
+ format("clasz", currentClass())
+ format("member", currentMember())
+ format("owner", currentOwner());
}
/** Returns the current position and given header and value. */
private String show(String header, Object value) {
return show() + format(header, value);
}
/** Returns the current position and given symbol. */
private String show(Symbol symbol) {
return show("symbol", symbol)
+ format("symbol.pos", Position.toString(symbol.pos))
+ format("symbol.info", symbol.info());
}
/** Returns the current position and given tree. */
private String show(Tree tree) {
return show("tree", tree)
+ format("tree.pos", Position.toString(tree.pos))
+ format("tree.symbol", tree.symbol())
+ format("tree.type", tree.type());
}
/** Returns the current position and given pushed value. */
private String showPush(Object value) {
return show("pushing", value);
}
/** Returns a string with the given header and value. */
private String format(String header, Object value) {
while (header.length() < 12) header = header + ' ';
return "\n" + header + ": " + toString(value);
}
/** Returns a string representation of the given value. */
private String toString(Object value) {
if (value instanceof Symbol) return Debug.show(value);
if (value instanceof Object[]) return Debug.show(value);
return String.valueOf(value);
}
//########################################################################
}
|