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
|
/* ____ ____ ____ ____ ______ *\
** / __// __ \/ __// __ \/ ____/ SOcos COmpiles Scala **
** __\_ \/ /_/ / /__/ /_/ /\_ \ (c) 2002, LAMP/EPFL **
** /_____/\____/\___/\____/____/ **
\* */
// $Id$
package scalac.symtab;
import java.io.StringWriter;
import ch.epfl.lamp.util.CodePrinter;
import scalac.Global;
import scalac.atree.AConstant;
import scalac.symtab.Type.Constraint;
import scalac.symtab.Scope.SymbolIterator;
import scalac.util.Name;
import scalac.util.NameTransformer;
import scalac.util.Debug;
/** This class provides methods to print symbols and types. */
public class SymbolTablePrinter {
//########################################################################
// Private Fields
/** The global environment */
private final Global global;
/** The underlying code printer */
private final CodePrinter printer;
//########################################################################
// Public Constructors
/** Creates a new instance */
public SymbolTablePrinter() {
this((String)null);
}
/** Creates a new instance */
public SymbolTablePrinter(String step) {
this(Global.instance, new CodePrinter(step));
}
/** Creates a new instance */
public SymbolTablePrinter(CodePrinter printer) {
this(Global.instance, printer);
}
/** Creates a new instance */
public SymbolTablePrinter(Global global, CodePrinter printer) {
this.global = global;
this.printer = printer;
}
//########################################################################
// Public Methods - Getting & Setting
/** Returns the underlying code printer. */
public CodePrinter getCodePrinter() {
return printer;
}
//########################################################################
// Public Methods - Formatting
/** Increases the indentation level by one. */
public SymbolTablePrinter indent() {
printer.indent();
return this;
}
/** Decreases the indentation level by one. */
public SymbolTablePrinter undent() {
printer.undent();
return this;
}
/** Inserts a new line. */
public SymbolTablePrinter line() {
printer.line();
return this;
}
/** Inserts a white space. */
public SymbolTablePrinter space() {
printer.space();
return this;
}
//########################################################################
// Public Methods - Printing simple values
/** Prints a new line. */
public SymbolTablePrinter println() {
printer.println();
return this;
}
/** Prints the boolean value followed by a new line. */
public SymbolTablePrinter println(boolean value) {
printer.println(value);
return this;
}
/** Prints the byte value followed by a new line. */
public SymbolTablePrinter println(byte value) {
printer.println(value);
return this;
}
/** Prints the short value followed by a new line. */
public SymbolTablePrinter println(short value) {
printer.println(value);
return this;
}
/** Prints the char value followed by a new line. */
public SymbolTablePrinter println(char value) {
printer.println(value);
return this;
}
/** Prints the int value followed by a new line. */
public SymbolTablePrinter println(int value) {
printer.println(value);
return this;
}
/** Prints the long value followed by a new line. */
public SymbolTablePrinter println(long value) {
printer.println(value);
return this;
}
/** Prints the float value followed by a new line. */
public SymbolTablePrinter println(float value) {
printer.println(value);
return this;
}
/** Prints the double value followed by a new line. */
public SymbolTablePrinter println(double value) {
printer.println(value);
return this;
}
/** Prints the string followed by a new line. */
public SymbolTablePrinter println(String value) {
printer.println(value);
return this;
}
/** Prints the boolean value. */
public SymbolTablePrinter print(boolean value) {
printer.print(value);
return this;
}
/** Prints the byte value. */
public SymbolTablePrinter print(byte value) {
printer.print(value);
return this;
}
/** Prints the short value. */
public SymbolTablePrinter print(short value) {
printer.print(value);
return this;
}
/** Prints the char value. */
public SymbolTablePrinter print(char value) {
printer.print(value);
return this;
}
/** Prints the int value. */
public SymbolTablePrinter print(int value) {
printer.print(value);
return this;
}
/** Prints the long value. */
public SymbolTablePrinter print(long value) {
printer.print(value);
return this;
}
/** Prints the float value. */
public SymbolTablePrinter print(float value) {
printer.print(value);
return this;
}
/** Prints the long value. */
public SymbolTablePrinter print(double value) {
printer.print(value);
return this;
}
/** Prints the string. */
public SymbolTablePrinter print(String value) {
printer.print(value);
return this;
}
//########################################################################
// Public Methods - Printing scopes
/** Prints the members of the given scope. */
public SymbolTablePrinter printScope(Scope scope) {
return printScope(scope, false);
}
/** Prints the members of the given scope. */
public SymbolTablePrinter printScope(Scope scope, boolean lazy) {
boolean first = true;
for (SymbolIterator i = scope.iterator(); i.hasNext(); ) {
Symbol member = i.next();
if (!mustShowMember(member)) continue;
if (first) print("{").indent(); else print(", ");
first = false;
line().printSignature(member);
}
if (!first) line().undent().print("}"); else if (!lazy) print("{}");
return this;
}
/**
* Returns true iff the given member must be printed. The default
* implementation always returns true.
*/
public boolean mustShowMember(Symbol member) {
return true;
}
//########################################################################
// Public Methods - Printing symbols
/**
* Returns the string representation of the kind of the given
* symbol or null if there is no such representation.
*/
public String getSymbolKind(Symbol symbol) {
switch (symbol.kind) {
case Kinds.NONE:
return null;
case Kinds.CLASS:
if (symbol.isPackageClass()) return "package class";
if (symbol.isModuleClass()) return "object class";
if (symbol.isTrait()) return "trait";
return "class";
case Kinds.TYPE:
case Kinds.ALIAS:
return "type";
case Kinds.VAL:
if (symbol.isVariable()) return "variable";
if (symbol.isPackage()) return "package";
if (symbol.isModule()) return "object";
if (symbol.isConstructor()) return "constructor";
if (symbol.isInitializedMethod())
if (global.debug || (symbol.flags & Modifiers.STABLE) == 0)
return "method";
return "value";
default:
throw Debug.abort("unknown kind " + symbol.kind);
}
}
/**
* Returns the definition keyword associated to the given symbol
* or null if there is no such keyword.
*/
public String getSymbolKeyword(Symbol symbol) {
if (symbol.isParameter()) return null;
switch (symbol.kind) {
case Kinds.NONE:
return null;
case Kinds.CLASS:
if (symbol.isTrait()) return "trait";
return "class";
case Kinds.TYPE:
case Kinds.ALIAS:
return "type";
case Kinds.VAL:
if (symbol.isVariable()) return "var";
if (symbol.isPackage()) return "package";
if (symbol.isModule()) return "object";
if (symbol.isInitializedMethod()) return "def";
return "val";
default:
throw Debug.abort("unknown kind " + symbol.kind);
}
}
/** Returns the name of the given symbol. */
public String getSymbolName(Symbol symbol) {
String name = symbol.simpleName().toString();
if (!global.debug) name = NameTransformer.decode(name);
return name;
}
/** Returns the inner string of the given symbol. */
public String getSymbolInnerString(Symbol symbol) {
switch (symbol.kind) {
case Kinds.NONE : return ":";
case Kinds.ALIAS: return "=";
case Kinds.CLASS: return "extends";
case Kinds.TYPE : return "<:";
case Kinds.VAL : return symbol.isModule() ? "extends" :
symbol.isDefParameter() ? ": =>" : ":";
default : throw Debug.abort("unknown kind " + symbol.kind);
}
}
/** Prints the unique identifier of the given symbol */
public SymbolTablePrinter printSymbolUniqueId(Symbol symbol) {
if (global.uniqid) print('#').print(symbol.id);
return this;
}
/** Prints the name of the given symbol */
public SymbolTablePrinter printSymbolName(Symbol symbol) {
print(getSymbolName(symbol));
return printSymbolUniqueId(symbol);
}
/** Prints the kind and the name of the given symbol. */
public SymbolTablePrinter printSymbolKindAndName(Symbol symbol) {
if (symbol.isAnonymousClass()) {
print("<template>");
return printSymbolUniqueId(symbol);
} else {
String kind = getSymbolKind(symbol);
if (kind != null) print(kind).space();
return printSymbolName(symbol);
}
}
/** Prints the type of the given symbol with the given inner string. */
public SymbolTablePrinter printSymbolType(Symbol symbol, String inner) {
Type type = symbol.rawFirstInfo();
if (!(type instanceof Type.LazyType)) type = symbol.info();
boolean star = false;
if ((symbol.flags & Modifiers.REPEATED) != 0 &&
type.symbol() == global.definitions.SEQ_CLASS &&
type.typeArgs().length == 1)
{
type = type.typeArgs()[0];
star = true;
}
printType(type, inner);
if (star) print("*");
return this;
}
/** Prints the signature of the given symbol. */
public SymbolTablePrinter printSignature(Symbol symbol) {
String keyword = getSymbolKeyword(symbol);
if (keyword != null) print(keyword).space();
String inner = getSymbolInnerString(symbol);
return printSymbolName(symbol)
.printType(symbol.loBound(), ">:")
.printSymbolType(symbol, inner);
}
/** Prints the given type parameter section. */
public SymbolTablePrinter printTypeParams(Symbol[] tparams) {
print('[');
for (int i = 0; i < tparams.length; i++) {
if (i > 0) print(",");
printSignature(tparams[i]);
}
return print(']');
}
/** Prints the given value parameter section. */
public SymbolTablePrinter printValueParams(Symbol[] vparams) {
print('(');
for (int i = 0; i < vparams.length; i++) {
if (i > 0) print(",");
printSymbolType(vparams[i],
vparams[i].isDefParameter() ? "=>" : null);
}
return print(')');
}
//########################################################################
// Public Methods - Printing types
/** Returns the type to print for the given type (transitive). */
public Type getTypeToPrintForType(Type type) {
while (true) {
Type result = getTypeToPrintForType0(type);
if (result == type) return result;
type = result;
}
}
/** Returns the type to print for the given type (non-transitive). */
public Type getTypeToPrintForType0(Type type) {
switch (type) {
case ThisType(Symbol clasz):
if (global.debug || !clasz.isModuleClass()) return type;
Type prefix = getTypeToPrintForType(clasz.owner().thisType());
Symbol module = clasz.sourceModule();
if (module.owner() != clasz.owner()) return type;
if (!module.type().isObjectType()) return type;
return Type.singleType(prefix, module);
case SingleType(_, Symbol sym):
if (global.debug) return type;
if (sym.isSynthetic()) return type.widen();
return type;
case CompoundType(Type[] parts, Scope members):
if (global.debug) return type;
if (type.isFunctionType()) return parts[1];
return type;
case TypeVar(Type origin, Constraint constr):
if (constr.inst != Type.NoType) return constr.inst;
return type;
default:
return type;
}
}
/** Prints the given types separated by infix. */
public SymbolTablePrinter printTypes(Type[] types, String infix) {
for (int i = 0; i < types.length; i++) {
if (i > 0) print(infix);
printType(types[i]);
}
return this;
}
/** Prints the given type. */
public SymbolTablePrinter printType(Type type) {
return printType0(getTypeToPrintForType(type));
}
public SymbolTablePrinter printType0(Type type) {
printCommonPart(type);
switch (type) {
case ThisType(_):
case SingleType(_,_):
return print(".type");
default:
return this;
}
}
/** Prints the given type with the given inner string. */
public SymbolTablePrinter printType(Type type, String inner) {
if ("<:".equals(inner) && type.symbol() == global.definitions.ANY_CLASS ||
">:".equals(inner) && type.symbol() == global.definitions.ALL_CLASS)
return this;
else
return printType0(getTypeToPrintForType(type), inner);
}
public SymbolTablePrinter printType0(Type type, String inner) {
switch (type) {
case PolyType(Symbol[] tparams, Type result):
if (tparams.length != 0 || global.debug) printTypeParams(tparams);
return printType(result, inner);
case MethodType(Symbol[] vparams, Type result):
return printValueParams(vparams).printType(result, inner);
default:
if (inner != null) {
if (!inner.startsWith(":")) space();
print(inner).space();
}
return printType0(type);
}
}
/** Prints a function type with the given type arguments. */
public SymbolTablePrinter printFunctionType(Type[] types) {
Type[] args = new Type[types.length - 1];
for (int i = 0; i < args.length; i++) args[i] = types[i];
print('(').printTypes(args, ",").print(") => ");
printType(types[types.length - 1]);
return this;
}
/** Prints a template type with the given base types. */
public SymbolTablePrinter printTemplateType(Type[] types) {
print("<template: ").printTypes(types, " with ").print(" {...}>");
return this;
}
/** Prints the type and prefix common part of the given type. */
public SymbolTablePrinter printCommonPart(Type type) {
switch (type) {
case ErrorType:
return print("<error>");
case AnyType:
return print("<any type>");
case NoType:
return print("<notype>");
case NoPrefix:
return print("<noprefix>");
case ThisType(Symbol sym):
if ((sym.isAnonymousClass() || sym.isCompoundSym()) && !global.debug)
return print("this");
return printSymbolName(sym).print(".this");
case TypeRef(Type pre, Symbol sym, Type[] args):
if (!global.debug) {
if (type.isFunctionType())
return printFunctionType(args);
if (sym.isAnonymousClass() || sym.isCompoundSym())
return printTemplateType(pre.memberInfo(sym).parents());
}
printPrefix(pre).printSymbolName(sym);
//print("{" + sym.owner() + "}");//DEBUG
if (args.length != 0) print('[').printTypes(args, ",").print(']');
return this;
case SingleType(Type pre, Symbol sym):
return printPrefix(pre).printSymbolName(sym);
case ConstantType(Type base, AConstant value):
return printType(base).printConstantValue(value);
case CompoundType(Type[] parts, Scope members):
return printTypes(parts," with ").space()
.printScope(members,true)
.printSymbolUniqueId(type.symbol());
case MethodType(_, _):
return printType0(type, null);
case PolyType(_, _):
return printType0(type, null);
case OverloadedType(Symbol[] alts, Type[] alttypes):
return printTypes(alttypes, " <and> ");
case TypeVar(Type origin, Constraint constr):
return printType(origin).print("?");
case UnboxedType(int kind):
return print(type.unboxedName(kind).toString());
case UnboxedArrayType(Type elemtp):
return printType(elemtp).print("[]");
case LazyType():
if (!global.debug) return print("?");
String classname = type.getClass().getName();
return print("<lazy type ").print(classname).print(">");
default:
String classname = type.getClass().getName();
return print("<unknown type ").print(classname).print(">");
}
}
//########################################################################
// Public Methods - Printing prefixes
/** Returns the type to print for the given prefix (transitive). */
public Type getTypeToPrintForPrefix(Type prefix) {
while (true) {
Type result = getTypeToPrintForPrefix0(prefix);
if (result == prefix || result == null) return result;
prefix = result;
}
}
/** Returns the type to print for the given prefix (non-transitive). */
public Type getTypeToPrintForPrefix0(Type prefix) {
if (!global.debug) {
if (prefix.symbol().isNone()) return null;
if (prefix.symbol().isRoot()) return null;
}
return getTypeToPrintForType0(prefix);
}
/** Prints the given type as a prefix. */
public SymbolTablePrinter printPrefix(Type prefix) {
prefix = getTypeToPrintForPrefix(prefix);
return prefix == null ? this : printPrefix0(prefix);
}
public SymbolTablePrinter printPrefix0(Type prefix) {
printCommonPart(prefix);
switch (prefix) {
case NoPrefix:
case ThisType(_):
case SingleType(_,_):
return print(".");
default:
return print("#");
}
}
//########################################################################
// Public Methods - Printing constants
/** Prints the given constant value. */
public SymbolTablePrinter printConstantValue(AConstant value) {
return print("(").print(value.toString()).print(")");
}
//########################################################################
// Public Methods - Converting
/** Returns the string representation of this printer. */
public String toString() {
return printer.toString();
}
//########################################################################
}
|