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
|
package dotty.tools.dotc
package printing
import core._
import Texts._, Types._, Flags._, Names._, Symbols._, NameOps._, Constants._
import Contexts.Context, Scopes.Scope, Denotations.Denotation, Annotations.Annotation
import StdNames.nme
import ast.Trees._, ast.untpd
import java.lang.Integer.toOctalString
import scala.annotation.switch
class PlainPrinter(_ctx: Context) extends Printer {
protected[this] implicit val ctx = _ctx
protected def maxToTextRecursions = 100
protected final def controlled(op: => Text): Text =
if (ctx.toTextRecursions < maxToTextRecursions)
try {
ctx.toTextRecursions += 1
op
} finally {
ctx.toTextRecursions -= 1
}
else {
recursionLimitExceeeded()
"..."
}
protected def recursionLimitExceeeded() = {
ctx.warning("Exceeded recursion depth attempting to print type.")
(new Throwable).printStackTrace
}
/** Render elements alternating with `sep` string */
protected def toText(elems: Traversable[Showable], sep: String) =
Text(elems map (_ toText this), sep)
/** Render element within highest precedence */
protected def toTextLocal(elem: Showable): Text =
atPrec(DotPrec) { elem.toText(this) }
/** Render element within lowest precedence */
protected def toTextGlobal(elem: Showable): Text =
atPrec(GlobalPrec) { elem.toText(this) }
protected def toTextLocal(elems: Traversable[Showable], sep: String) =
atPrec(DotPrec) { toText(elems, sep) }
protected def toTextGlobal(elems: Traversable[Showable], sep: String) =
atPrec(GlobalPrec) { toText(elems, sep) }
/** If the name of the symbol's owner should be used when you care about
* seeing an interesting name: in such cases this symbol is e.g. a method
* parameter with a synthetic name, a constructor named "this", an object
* "package", etc. The kind string, if non-empty, will be phrased relative
* to the name of the owner.
*/
protected def hasMeaninglessName(sym: Symbol) = (
(sym is Param) && sym.owner.isSetter // x$1
|| sym.isClassConstructor // this
|| (sym.name == nme.PACKAGE) // package
)
def nameString(name: Name): String = name.toString + {
if (ctx.settings.debugNames.value)
if (name.isTypeName) "/T" else "/V"
else ""
}
def toText(name: Name): Text = Str(nameString(name))
/** String representation of a name used in a refinement
* In refined printing this undoes type parameter expansion
*/
protected def refinementNameString(tp: RefinedType) = nameString(tp.refinedName)
/** String representation of a refinement */
protected def toTextRefinement(rt: RefinedType) =
(refinementNameString(rt) ~ toTextRHS(rt.refinedInfo)).close
/** The longest sequence of refinement types, starting at given type
* and following parents.
*/
private def refinementChain(tp: Type): List[Type] =
tp :: (tp match {
case RefinedType(parent, _) => refinementChain(parent)
case _ => Nil
})
def toText(tp: Type): Text = controlled {
tp match {
case tp: TypeType =>
toTextRHS(tp)
case tp: SingletonType =>
val pre = toTextPrefix(tp)
if (pre.lastLine.endsWith(".")) pre ~ "type"
else fullNameString(tp.typeSymbol.skipPackageObject) ~ ".type"
case tp @ TypeRef(pre, name) =>
toTextPrefix(pre) ~ selectionString(tp)
case tp: RefinedType =>
// return tp.toString // !!! DEBUG
val parent :: (refined: List[RefinedType]) =
refinementChain(tp).reverse
toTextLocal(parent) ~ "{" ~ Text(refined map toTextRefinement, "; ").close ~ "}"
case AndType(tp1, tp2) =>
changePrec(AndPrec) { toText(tp1) ~ " & " ~ toText(tp2) }
case OrType(tp1, tp2) =>
changePrec(OrPrec) { toText(tp1) ~ " | " ~ toText(tp2) }
case ErrorType =>
"<error>"
case tp: WildcardType =>
if (tp.optBounds.exists) "?" ~ toTextRHS(tp.bounds) else "?"
case NoType =>
"<notype>"
case NoPrefix =>
"<noprefix>"
case tp: MethodType =>
def paramText(name: TermName, tp: Type) = toText(name) ~ ": " ~ toText(tp)
changePrec(GlobalPrec) {
(if (tp.isImplicit) "(implicit " else "(") ~
Text((tp.paramNames, tp.paramTypes).zipped map paramText, ", ") ~
")" ~ toText(tp.resultType)
}
case tp: ExprType =>
changePrec(GlobalPrec) { "=> " ~ toText(tp.resultType) }
case tp: PolyType =>
def paramText(name: TypeName, bounds: TypeBounds) = toText(polyParamName(name)) ~ ": " ~ toText(bounds)
changePrec(GlobalPrec) {
"[" ~
Text((tp.paramNames, tp.paramBounds).zipped map paramText, ", ") ~
"]" ~ toText(tp.resultType)
}
case PolyParam(pt, n) =>
toText(polyParamName(pt.paramNames(n)))
case AnnotatedType(annot, tpe) =>
toTextLocal(tpe) ~ " " ~ toText(annot)
case tp: TypeVar =>
toTextLocal(tp.underlying)
case _ =>
tp.fallbackToText(this)
}
}.close
protected def polyParamName(name: TypeName): TypeName = name
/** The name of the symbol without a unique id. Under refined printing,
* the decoded original name.
*/
protected def simpleNameString(sym: Symbol): String = nameString(sym.name)
/** The unique id of symbol, after a # */
protected def idString(sym: Symbol): String =
if (ctx.settings.uniqid.value) "#" + sym.id else ""
def nameString(sym: Symbol): String = simpleNameString(sym) + idString(sym)
def fullNameString(sym: Symbol): String =
if (sym.isRoot || sym == NoSymbol || sym.owner.isEffectiveRoot)
nameString(sym)
else
fullNameString(sym.effectiveOwner.enclosingClass) + "." + nameString(sym)
protected def objectPrefix = "object "
protected def packagePrefix = "package "
protected def trimPrefix(text: Text) =
text.stripPrefix(objectPrefix).stripPrefix(packagePrefix)
protected def selectionString(tp: NamedType) =
if (tp.symbol.exists) nameString(tp.symbol)
else nameString(tp.name)
/** The string representation of this type used as a prefix */
protected def toTextPrefix(tp: Type): Text = controlled {
tp match {
case tp @ TermRef(pre, name) =>
toTextPrefix(pre) ~ selectionString(tp) ~ "."
case ThisType(cls) =>
nameString(cls) + ".this."
case SuperType(thistpe, _) =>
toTextPrefix(thistpe).map(_.replaceAll("""\bthis\.$""", "super."))
case tp @ ConstantType(value) =>
toTextLocal(tp.underlying) ~ "(" ~ toText(value) ~ ")."
case MethodParam(mt, idx) =>
nameString(mt.paramNames(idx)) + "."
case RefinedThis(_) =>
"this."
case NoPrefix =>
""
case _ =>
trimPrefix(toTextLocal(tp)) ~ "#"
}
}
protected def isOmittablePrefix(sym: Symbol) =
(defn.UnqualifiedOwners contains sym) || isEmptyPrefix(sym)
protected def isEmptyPrefix(sym: Symbol) =
sym.isEffectiveRoot || sym.isAnonymousClass || sym.name.isReplWrapperName
/** String representation of a definition's type following its name */
protected def toTextRHS(tp: Type): Text = controlled {
tp match {
case TypeBounds(lo, hi) =>
if (lo eq hi)
" = " ~ toText(lo)
else
(if (lo == defn.NothingType) Text() else " >: " ~ toText(lo)) ~
(if (hi == defn.AnyType) Text() else " <: " ~ toText(hi))
case tp @ ClassInfo(pre, cls, cparents, decls, selfInfo) =>
val preText = toTextLocal(pre)
val (tparams, otherDecls) = decls.toList partition treatAsTypeParam
val tparamsText =
if (tparams.isEmpty) Text() else ("[" ~ dclsText(tparams) ~ "]").close
val selfText: Text = selfInfo match {
case NoType => Text()
case sym: Symbol if !sym.isCompleted => "this: ? =>"
case _ => "this: " ~ atPrec(InfixPrec) { toText(tp.selfType) } ~ " =>"
}
val parentsText = Text(cparents.map(p =>
toTextLocal(reconstituteParent(cls, p))), " with ")
val trueDecls = otherDecls.filterNot(treatAsTypeArg)
val declsText =
if (trueDecls.isEmpty || !ctx.settings.debug.value) Text()
else dclsText(trueDecls)
tparamsText ~ " extends " ~ parentsText ~ "{" ~ selfText ~ declsText ~
"} at " ~ preText
case _ =>
": " ~ toTextGlobal(tp)
}
}
protected def treatAsTypeParam(sym: Symbol): Boolean = false
protected def treatAsTypeArg(sym: Symbol): Boolean = false
protected def reconstituteParent(cls: ClassSymbol, parent: Type): Type = parent
/** String representation of symbol's kind. */
def kindString(sym: Symbol): String = {
val flags = sym.flagsUNSAFE
if (flags is PackageClass) "package class"
else if (flags is PackageVal) "package"
else if (sym.isPackageObject)
if (sym.isClass) "package object class"
else "package object"
else if (sym.isAnonymousClass) "anonymous class"
else if (flags is ModuleClass) "module class"
else if (flags is ModuleVal) "module"
else if (flags is ImplClass) "implementation class"
else if (flags is Trait) "trait"
else if (sym.isClass) "class"
else if (sym.isType) "type"
else if (sym.isGetter) "getter"
else if (sym.isSetter) "setter"
else if (flags is Lazy) "lazy value"
else if (flags is Mutable) "variable"
else if (sym.isClassConstructor && sym.isPrimaryConstructor) "primary constructor"
else if (sym.isClassConstructor) "constructor"
else if (sym.isSourceMethod) "method"
else if (sym.isTerm) "value"
else ""
}
/** String representation of symbol's definition key word */
protected def keyString(sym: Symbol): String = {
val flags = sym.flagsUNSAFE
if (flags is JavaInterface) "interface"
else if ((flags is Trait) && !(flags is ImplClass)) "trait"
else if (sym.isClass) "class"
else if (sym.isType) "type"
else if (flags is Mutable) "var"
else if (flags is Package) "package"
else if (flags is Module) "object"
else if (sym.isSourceMethod) "def"
else if (sym.isTerm && (!(flags is Param))) "val"
else ""
}
/** String representation of symbol's flags */
protected def toTextFlags(sym: Symbol): Text =
Text(sym.flags.flagStrings map stringToText, " ")
/** String representation of symbol's variance or "" if not applicable */
protected def varianceString(sym: Symbol): String = sym.variance match {
case -1 => "-"
case 1 => "+"
case _ => ""
}
def dclText(sym: Symbol): Text =
(toTextFlags(sym) ~~ keyString(sym) ~~
(varianceString(sym) ~ nameString(sym)) ~ toTextRHS(sym.info)).close
def toText(sym: Symbol): Text =
(kindString(sym) ~~ {
if (hasMeaninglessName(sym)) simpleNameString(sym.owner) + idString(sym)
else nameString(sym)
}).close
def locationText(sym: Symbol): Text = {
val owns = sym.effectiveOwner
if (owns.isClass && !isEmptyPrefix(owns)) " in " ~ toText(owns) else Text()
}
def locatedText(sym: Symbol): Text =
(toText(sym) ~ locationText(sym)).close
def toText(denot: Denotation): Text = toText(denot.symbol) ~ "/D"
@switch private def escapedChar(ch: Char): String = ch match {
case '\b' => "\\b"
case '\t' => "\\t"
case '\n' => "\\n"
case '\f' => "\\f"
case '\r' => "\\r"
case '"' => "\\\""
case '\'' => "\\\'"
case '\\' => "\\\\"
case _ => if (ch.isControl) "\\0" + toOctalString(ch) else String.valueOf(ch)
}
def toText(const: Constant): Text = const.tag match {
case StringTag => "\"" + escapedString(const.value.toString) + "\""
case ClazzTag => "classOf[" ~ toText(const.tpe) ~ "]"
case CharTag => s"'${escapedChar(const.charValue)}'"
case LongTag => const.longValue.toString + "L"
case EnumTag => const.symbolValue.name.toString
case _ => String.valueOf(const.value)
}
def toText(annot: Annotation): Text = s"@${annot.symbol.name}" // for now
protected def escapedString(str: String): String = str flatMap escapedChar
def dclsText(syms: List[Symbol], sep: String): Text = Text(syms map dclText, sep)
def toText(sc: Scope): Text =
("Scope{" ~ dclsText(sc.toList) ~ "}").close
def toText[T >: Untyped](tree: Tree[T]): Text = {
tree match {
case node: Positioned =>
def toTextElem(elem: Any): Text = elem match {
case elem: Showable => elem.toText(this)
case elem: List[_] => "List(" ~ Text(elem map toTextElem, ",") ~ ")"
case elem => elem.toString
}
val nodeName = node.productPrefix
val elems =
Text(node.productIterator.map(toTextElem).toList, ", ")
val tpSuffix =
if (ctx.settings.printtypes.value && tree.hasType)
" | " ~ toText(tree.tpe.asInstanceOf[Type])
else
Text()
nodeName ~ "(" ~ elems ~ tpSuffix ~ ")" ~ node.pos.toString
case _ =>
tree.fallbackToText(this)
}
}.close // todo: override in refined printer
def plain = this
}
|