-
Notifications
You must be signed in to change notification settings - Fork 1k
/
Interactive.scala
581 lines (512 loc) · 21.8 KB
/
Interactive.scala
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
package dotty.tools
package dotc
package interactive
import scala.annotation.tailrec
import scala.collection._
import ast.{NavigateAST, Trees, tpd, untpd}
import core._, core.Decorators.{sourcePos => _, _}
import Contexts._, Flags._, Names._, NameOps._, Symbols._, Trees._, Types._
import transform.SymUtils.decorateSymbol
import util.Positions._, util.SourceFile, util.SourcePosition
import core.Denotations.SingleDenotation
import NameKinds.SimpleNameKind
import config.Printers.interactiv
import StdNames.nme
/** High-level API to get information out of typed trees, designed to be used by IDEs.
*
* @see `InteractiveDriver` to get typed trees from code.
*/
object Interactive {
import ast.tpd._
object Include {
case class Set private (val bits: Int) extends AnyVal {
def | (that: Set): Set = Set(bits | that.bits)
def except(that: Set): Set = Set(bits & ~that.bits)
def isEmpty: Boolean = bits == 0
def isOverridden: Boolean = (bits & overridden.bits) != 0
def isOverriding: Boolean = (bits & overriding.bits) != 0
def isReferences: Boolean = (bits & references.bits) != 0
def isDefinitions: Boolean = (bits & definitions.bits) != 0
def isLinkedClass: Boolean = (bits & linkedClass.bits) != 0
def isImports: Boolean = (bits & imports.bits) != 0
def isLocal: Boolean = (bits & local.bits) != 0
}
/** The empty set */
val empty: Set = Set(0)
/** Include trees whose symbol is overridden by `sym` */
val overridden: Set = Set(1 << 0)
/**
* Include trees whose symbol overrides `sym` (but for performance only in same source
* file)
*/
val overriding: Set = Set(1 << 1)
/** Include references */
val references: Set = Set(1 << 2)
/** Include definitions */
val definitions: Set = Set(1 << 3)
/** Include `sym.linkedClass */
val linkedClass: Set = Set(1 << 4)
/** Include imports in the results */
val imports: Set = Set(1 << 5)
/** Include local symbols, inspect local trees */
val local: Set = Set(1 << 6)
/** All the flags */
val all: Set = Set(~0)
}
/** Does this tree define a symbol ? */
def isDefinition(tree: Tree): Boolean =
tree.isInstanceOf[DefTree with NameTree]
/** The type of the closest enclosing tree with a type containing position `pos`. */
def enclosingType(trees: List[SourceTree], pos: SourcePosition)(implicit ctx: Context): Type = {
val path = pathTo(trees, pos)
if (path.isEmpty) NoType
else path.head.tpe
}
/** The closest enclosing tree with a symbol containing position `pos`, or the `EmptyTree`.
*/
def enclosingTree(trees: List[SourceTree], pos: SourcePosition)(implicit ctx: Context): Tree =
enclosingTree(pathTo(trees, pos))
/** The closes enclosing tree with a symbol, or the `EmptyTree`.
*/
def enclosingTree(path: List[Tree])(implicit ctx: Context): Tree =
path.dropWhile(!_.symbol.exists).headOption.getOrElse(tpd.EmptyTree)
/**
* The source symbols that are the closest to `path`.
*
* If this path ends in an import, then this returns all the symbols that are imported by this
* import statement.
*
* @param path The path to the tree whose symbols to extract.
* @return The source symbols that are the closest to `path`.
*
* @see sourceSymbol
*/
def enclosingSourceSymbols(path: List[Tree], pos: SourcePosition)(implicit ctx: Context): List[Symbol] = {
val syms = path match {
// For a named arg, find the target `DefDef` and jump to the param
case NamedArg(name, _) :: Apply(fn, _) :: _ =>
val funSym = fn.symbol
if (funSym.name == StdNames.nme.copy
&& funSym.is(Synthetic)
&& funSym.owner.is(CaseClass)) {
List(funSym.owner.info.member(name).symbol)
} else {
val classTree = funSym.topLevelClass.asClass.rootTree
val paramSymbol =
for {
DefDef(_, _, paramss, _, _) <- tpd.defPath(funSym, classTree).lastOption
param <- paramss.flatten.find(_.name == name)
} yield param.symbol
List(paramSymbol.getOrElse(fn.symbol))
}
// For constructor calls, return the `<init>` that was selected
case _ :: (_: New) :: (select: Select) :: _ =>
List(select.symbol)
case (_: Thicket) :: (imp: Import) :: _ =>
importedSymbols(imp, _.pos.contains(pos.pos))
case (imp: Import) :: _ =>
importedSymbols(imp, _.pos.contains(pos.pos))
case _ =>
List(enclosingTree(path).symbol)
}
syms.map(_.sourceSymbol).filter(_.exists)
}
/** Check if `tree` matches `sym`.
* This is the case if the symbol defined by `tree` equals `sym`,
* or the source symbol of tree equals sym,
* or `include` is `overridden`, and `tree` is overridden by `sym`,
* or `include` is `overriding`, and `tree` overrides `sym`.
*/
def matchSymbol(tree: Tree, sym: Symbol, include: Include.Set)(implicit ctx: Context): Boolean = {
def overrides(sym1: Symbol, sym2: Symbol) =
sym1.owner.derivesFrom(sym2.owner) && sym1.overriddenSymbol(sym2.owner.asClass) == sym2
( sym == tree.symbol
|| sym.exists && sym == tree.symbol.sourceSymbol
|| !include.isEmpty && sym.name == tree.symbol.name && sym.maybeOwner != tree.symbol.maybeOwner
&& ( include.isOverridden && overrides(sym, tree.symbol)
|| include.isOverriding && overrides(tree.symbol, sym)
)
)
}
private def safely[T](op: => List[T]): List[T] =
try op catch { case ex: TypeError => Nil }
/** Get possible completions from tree at `pos`
*
* @return offset and list of symbols for possible completions
*/
def completions(pos: SourcePosition)(implicit ctx: Context): (Int, List[Symbol]) = {
val path = pathTo(ctx.compilationUnit.tpdTree, pos.pos)
computeCompletions(pos, path)(contextOfPath(path))
}
private def computeCompletions(pos: SourcePosition, path: List[Tree])(implicit ctx: Context): (Int, List[Symbol]) = {
val completions = Scopes.newScope.openForMutations
val (completionPos, prefix, termOnly, typeOnly) = path match {
case (ref: RefTree) :: _ =>
if (ref.name == nme.ERROR)
(ref.pos.point, "", false, false)
else
(ref.pos.point,
ref.name.toString.take(pos.pos.point - ref.pos.point),
ref.name.isTermName,
ref.name.isTypeName)
case _ =>
(0, "", false, false)
}
/** Include in completion sets only symbols that
* 1. start with given name prefix, and
* 2. do not contain '$' except in prefix where it is explicitly written by user, and
* 3. have same term/type kind as name prefix given so far
*
* The reason for (2) is that we do not want to present compiler-synthesized identifiers
* as completion results. However, if a user explicitly writes all '$' characters in an
* identifier, we should complete the rest.
*/
def include(sym: Symbol) =
sym.name.startsWith(prefix) &&
!sym.name.toString.drop(prefix.length).contains('$') &&
(!termOnly || sym.isTerm) &&
(!typeOnly || sym.isType)
def enter(sym: Symbol) =
if (include(sym)) completions.enter(sym)
def add(sym: Symbol) =
if (sym.exists && !completions.lookup(sym.name).exists) enter(sym)
def addMember(site: Type, name: Name) =
if (!completions.lookup(name).exists)
for (alt <- site.member(name).alternatives) enter(alt.symbol)
def accessibleMembers(site: Type, superAccess: Boolean = true): Seq[Symbol] = site match {
case site: NamedType if site.symbol.is(Package) =>
site.decls.toList.filter(include) // Don't look inside package members -- it's too expensive.
case _ =>
def appendMemberSyms(name: Name, buf: mutable.Buffer[SingleDenotation]): Unit =
try buf ++= site.member(name).alternatives
catch { case ex: TypeError => }
site.memberDenots(takeAllFilter, appendMemberSyms).collect {
case mbr if include(mbr.symbol) => mbr.accessibleFrom(site, superAccess).symbol
case _ => NoSymbol
}.filter(_.exists)
}
def addAccessibleMembers(site: Type, superAccess: Boolean = true): Unit =
for (mbr <- accessibleMembers(site)) addMember(site, mbr.name)
def getImportCompletions(ictx: Context): Unit = {
implicit val ctx = ictx
val imp = ctx.importInfo
if (imp != null) {
def addImport(name: TermName) = {
addMember(imp.site, name)
addMember(imp.site, name.toTypeName)
}
// FIXME: We need to also take renamed items into account for completions,
// That means we have to return list of a pairs (Name, Symbol) instead of a list
// of symbols from `completions`.!=
for (imported <- imp.originals if !imp.excluded.contains(imported)) addImport(imported)
if (imp.isWildcardImport)
for (mbr <- accessibleMembers(imp.site) if !imp.excluded.contains(mbr.name.toTermName))
addMember(imp.site, mbr.name)
}
}
def getScopeCompletions(ictx: Context): Unit = {
implicit val ctx = ictx
if (ctx.owner.isClass) {
addAccessibleMembers(ctx.owner.thisType)
ctx.owner.asClass.classInfo.selfInfo match {
case selfSym: Symbol => add(selfSym)
case _ =>
}
}
else if (ctx.scope != null) ctx.scope.foreach(add)
getImportCompletions(ctx)
var outer = ctx.outer
while ((outer.owner `eq` ctx.owner) && (outer.scope `eq` ctx.scope)) {
getImportCompletions(outer)
outer = outer.outer
}
if (outer `ne` NoContext) getScopeCompletions(outer)
}
def implicitConversionTargets(qual: Tree)(implicit ctx: Context): Set[Type] = {
val typer = ctx.typer
val conversions = new typer.ImplicitSearch(defn.AnyType, qual, pos.pos).allImplicits
val targets = conversions.map(_.widen.finalResultType)
interactiv.println(i"implicit conversion targets considered: ${targets.toList}%, %")
targets
}
def getMemberCompletions(qual: Tree): Unit = {
addAccessibleMembers(qual.tpe)
implicitConversionTargets(qual)(ctx.fresh.setExploreTyperState())
.foreach(addAccessibleMembers(_))
}
path match {
case (sel @ Select(qual, _)) :: _ => getMemberCompletions(qual)
case _ => getScopeCompletions(ctx)
}
val completionList = completions.toList
interactiv.println(i"completion with pos = $pos, prefix = $prefix, termOnly = $termOnly, typeOnly = $typeOnly = $completionList%, %")
(completionPos, completionList)
}
/** Possible completions of members of `prefix` which are accessible when called inside `boundary` */
def completions(prefix: Type, boundary: Symbol)(implicit ctx: Context): List[Symbol] =
safely {
if (boundary != NoSymbol) {
val boundaryCtx = ctx.withOwner(boundary)
def exclude(sym: Symbol) = sym.isAbsent || sym.is(Synthetic) || sym.is(Artifact)
def addMember(name: Name, buf: mutable.Buffer[SingleDenotation]): Unit =
buf ++= prefix.member(name).altsWith(sym =>
!exclude(sym) && sym.isAccessibleFrom(prefix)(boundaryCtx))
prefix.memberDenots(completionsFilter, addMember).map(_.symbol).toList
}
else Nil
}
/** Filter for names that should appear when looking for completions. */
private[this] object completionsFilter extends NameFilter {
def apply(pre: Type, name: Name)(implicit ctx: Context): Boolean =
!name.isConstructorName && name.toTermName.info.kind == SimpleNameKind
}
/** Find named trees with a non-empty position whose symbol match `sym` in `trees`.
*
* Note that nothing will be found for symbols not defined in source code,
* use `sourceSymbol` to get a symbol related to `sym` that is defined in
* source code.
*/
def namedTrees(trees: List[SourceTree], include: Include.Set, sym: Symbol)
(implicit ctx: Context): List[SourceTree] =
if (!sym.exists)
Nil
else
namedTrees(trees, include, matchSymbol(_, sym, include))
/** Find named trees with a non-empty position satisfying `treePredicate` in `trees`.
*
* @param includeReferences If true, include references and not just definitions
*/
def namedTrees(trees: List[SourceTree],
include: Include.Set,
treePredicate: NameTree => Boolean = util.common.alwaysTrue
)(implicit ctx: Context): List[SourceTree] = safely {
val buf = new mutable.ListBuffer[SourceTree]
def traverser(source: SourceFile) = {
new untpd.TreeTraverser {
private def handle(utree: untpd.NameTree): Unit = {
val tree = utree.asInstanceOf[tpd.NameTree]
if (tree.symbol.exists
&& !tree.symbol.is(Synthetic)
&& !tree.symbol.isPrimaryConstructor
&& tree.pos.exists
&& !tree.pos.isZeroExtent
&& (include.isReferences || isDefinition(tree))
&& treePredicate(tree))
buf += SourceTree(tree, source)
}
override def traverse(tree: untpd.Tree)(implicit ctx: Context) = {
tree match {
case imp: untpd.Import if include.isImports && tree.hasType =>
val tree = imp.asInstanceOf[tpd.Import]
val selections = tpd.importSelections(tree)
traverse(imp.expr)
selections.foreach(traverse)
case utree: untpd.ValOrDefDef if tree.hasType =>
handle(utree)
if (include.isLocal) traverseChildren(tree)
case utree: untpd.NameTree if tree.hasType =>
handle(utree)
traverseChildren(tree)
case tree: untpd.Inlined =>
traverse(tree.call)
case _ =>
traverseChildren(tree)
}
}
}
}
trees.foreach(t => traverser(t.source).traverse(t.tree))
buf.toList
}
/**
* Find trees that match `symbol` in `trees`.
*
* @param trees The trees to inspect.
* @param includes Whether to include references, definitions, etc.
* @param symbol The symbol for which we want to find references.
* @param predicate An additional predicate that the trees must match.
*/
def findTreesMatching(trees: List[SourceTree],
includes: Include.Set,
symbol: Symbol,
predicate: NameTree => Boolean = util.common.alwaysTrue
)(implicit ctx: Context): List[SourceTree] = {
val linkedSym = symbol.linkedClass
val fullPredicate: NameTree => Boolean = tree =>
( (includes.isDefinitions || !Interactive.isDefinition(tree))
&& ( Interactive.matchSymbol(tree, symbol, includes)
|| ( includes.isLinkedClass
&& linkedSym.exists
&& Interactive.matchSymbol(tree, linkedSym, includes)
)
)
&& predicate(tree)
)
namedTrees(trees, includes, fullPredicate)
}
/** The reverse path to the node that closest encloses position `pos`,
* or `Nil` if no such path exists. If a non-empty path is returned it starts with
* the tree closest enclosing `pos` and ends with an element of `trees`.
*/
def pathTo(trees: List[SourceTree], pos: SourcePosition)(implicit ctx: Context): List[Tree] =
trees.find(_.pos.contains(pos)) match {
case Some(tree) => pathTo(tree.tree, pos.pos)
case None => Nil
}
def pathTo(tree: Tree, pos: Position)(implicit ctx: Context): List[Tree] =
if (tree.pos.contains(pos))
NavigateAST.pathTo(pos, tree, skipZeroExtent = true)
.collect { case t: untpd.Tree => t }
.dropWhile(!_.hasType).asInstanceOf[List[tpd.Tree]]
else Nil
def contextOfStat(stats: List[Tree], stat: Tree, exprOwner: Symbol, ctx: Context): Context = stats match {
case Nil =>
ctx
case first :: _ if first eq stat =>
ctx.exprContext(stat, exprOwner)
case (imp: Import) :: rest =>
contextOfStat(rest, stat, exprOwner, ctx.importContext(imp, imp.symbol(ctx)))
case _ :: rest =>
contextOfStat(rest, stat, exprOwner, ctx)
}
def contextOfPath(path: List[Tree])(implicit ctx: Context): Context = path match {
case Nil | _ :: Nil =>
ctx.run.runContext.fresh.setCompilationUnit(ctx.compilationUnit)
case nested :: encl :: rest =>
val outer = contextOfPath(encl :: rest)
try encl match {
case tree @ PackageDef(pkg, stats) =>
assert(tree.symbol.exists)
if (nested `eq` pkg) outer
else contextOfStat(stats, nested, pkg.symbol.moduleClass, outer.packageContext(tree, tree.symbol))
case tree: DefDef =>
assert(tree.symbol.exists)
val localCtx = outer.localContext(tree, tree.symbol).setNewScope
for (tparam <- tree.tparams) localCtx.enter(tparam.symbol)
for (vparams <- tree.vparamss; vparam <- vparams) localCtx.enter(vparam.symbol)
// Note: this overapproximates visibility a bit, since value parameters are only visible
// in subsequent parameter sections
localCtx
case tree: MemberDef =>
assert(tree.symbol.exists)
outer.localContext(tree, tree.symbol)
case tree @ Block(stats, expr) =>
val localCtx = outer.fresh.setNewScope
stats.foreach {
case stat: MemberDef => localCtx.enter(stat.symbol)
case _ =>
}
contextOfStat(stats, nested, ctx.owner, localCtx)
case tree @ CaseDef(pat, guard, rhs) if nested `eq` rhs =>
val localCtx = outer.fresh.setNewScope
pat.foreachSubTree {
case bind: Bind => localCtx.enter(bind.symbol)
case _ =>
}
localCtx
case tree @ Template(constr, parents, self, _) =>
if ((constr :: self :: parents).contains(nested)) ctx
else contextOfStat(tree.body, nested, tree.symbol, outer.inClassContext(self.symbol))
case _ =>
outer
}
catch {
case ex: CyclicReference => outer
}
}
/** The first tree in the path that is a definition. */
def enclosingDefinitionInPath(path: List[Tree])(implicit ctx: Context): Tree =
path.find(_.isInstanceOf[DefTree]).getOrElse(EmptyTree)
/**
* Find the definitions of the symbol at the end of `path`.
*
* @param path The path to the symbol for which we want the definitions.
* @param driver The driver responsible for `path`.
* @return The definitions for the symbol at the end of `path`.
*/
def findDefinitions(path: List[Tree], pos: SourcePosition, driver: InteractiveDriver)(implicit ctx: Context): List[SourceTree] = {
enclosingSourceSymbols(path, pos).flatMap { sym =>
val enclTree = enclosingTree(path)
val includeLocal = if (sym.exists && sym.isLocal) Include.local else Include.empty
val (trees, include) =
if (enclTree.isInstanceOf[MemberDef])
(driver.allTreesContaining(sym.name.sourceModuleName.toString),
Include.definitions | Include.overriding | Include.overridden)
else sym.topLevelClass match {
case cls: ClassSymbol =>
val trees = Option(cls.sourceFile).flatMap(InteractiveDriver.toUriOption) match {
case Some(uri) if driver.openedTrees.contains(uri) =>
driver.openedTrees(uri)
case _ => // Symbol comes from the classpath
SourceTree.fromSymbol(cls).toList
}
(trees, Include.definitions | Include.overriding)
case _ =>
(Nil, Include.empty)
}
findTreesMatching(trees, include | includeLocal, sym)
}
}
/**
* Given `sym`, originating from `sourceDriver`, find its representation in
* `targetDriver`.
*
* @param symbol The symbol to expression in the new driver.
* @param sourceDriver The driver from which `symbol` originates.
* @param targetDriver The driver in which we want to get a representation of `symbol`.
* @return A representation of `symbol` in `targetDriver`.
*/
def localize(symbol: Symbol, sourceDriver: InteractiveDriver, targetDriver: InteractiveDriver): Symbol = {
def in[T](driver: InteractiveDriver)(fn: Context => T): T =
fn(driver.currentCtx)
if (sourceDriver == targetDriver) symbol
else {
val owners = in(sourceDriver) { implicit ctx =>
symbol.ownersIterator.toList.reverse.map(_.name)
}
in(targetDriver) { implicit ctx =>
val base: Symbol = ctx.definitions.RootClass
owners.tail.foldLeft(base) { (prefix, symbolName) =>
if (prefix.exists) prefix.info.member(symbolName).symbol
else NoSymbol
}
}
}
}
/**
* Return a predicate function that determines whether a given `NameTree` is an implementation of
* `sym`.
*
* @param sym The symbol whose implementations to find.
* @return A function that determines whether a `NameTree` is an implementation of `sym`.
*/
def implementationFilter(sym: Symbol)(implicit ctx: Context): NameTree => Boolean = {
if (sym.isClass) {
case td: TypeDef =>
val treeSym = td.symbol
(treeSym != sym || !treeSym.is(AbstractOrTrait)) && treeSym.derivesFrom(sym)
case _ =>
false
} else {
case md: MemberDef =>
matchSymbol(md, sym, Include.overriding) && !md.symbol.is(Deferred)
case _ =>
false
}
}
/**
* Is this tree using a renaming introduced by an import statement or an alias for `this`?
*
* @param tree The tree to inspect
* @return True, if this tree's name is different than its symbol's name, indicating that
* it uses a renaming introduced by an import statement or an alias for `this`.
*/
def isRenamed(tree: NameTree)(implicit ctx: Context): Boolean = {
val symbol = tree.symbol
symbol.exists && !sameName(tree.name, symbol.name)
}
/** Are the two names the same? */
def sameName(n0: Name, n1: Name): Boolean = {
n0.stripModuleClassSuffix.toTermName eq n1.stripModuleClassSuffix.toTermName
}
}