class ExtractUsedNames[GlobalType <: CallbackGlobal] extends Compat with ClassName with GlobalHelpers
Extracts simple names used in given compilation unit.
Extracts simple (unqualified) names mentioned in given in non-definition position by collecting all symbols associated with non-definition trees and extracting names from all collected symbols. Also extract the names of the types of non-definition trees (see source-dependencies/types-in-used-names-* and source-dependencies/as-seen-from-* for examples where this is required).
If given symbol is mentioned both in definition and in non-definition position (e.g. in member selection) then that symbol is collected. It means that names of symbols defined and used in the same compilation unit are extracted. We've considered not extracting names of those symbols as an optimization strategy. It turned out that this is not correct. Check https://github.com/gkossakowski/sbt/issues/3 for an example of scenario where it matters.
All extracted names are returned in _decoded_ form. This way we stay consistent with the rest of incremental compiler which works with names in decoded form.
Names mentioned in Import nodes are handled properly but require some special logic for two reasons:
- The
termSymbol
of Import nodes point to the symbol of the prefix it imports from (not the actual members that we import, that are represented as names). 2. ImportSelector is not subtype of Tree therefore is not processed byTree.foreach
.
Another type of tree nodes that requires special handling is TypeTree. TypeTree nodes has a little bit odd representation:
- TypeTree.hasSymbol always returns false even when TypeTree.symbol returns a symbol 2. The original tree from which given TypeTree was derived is stored in TypeTree.original but Tree.forech doesn't walk into original tree so we missed it
The tree walking algorithm walks into TypeTree.original explicitly.
- Alphabetic
- By Inheritance
- ExtractUsedNames
- GlobalHelpers
- ClassName
- Compat
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ExtractUsedNames(global: GlobalType)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def className(s: GlobalType.Symbol): GlobalType.Name
Create a (source) name for a class symbol
s
.Create a (source) name for a class symbol
s
.- Attributes
- protected
- Definition Classes
- ClassName
- def classNameAsSeenIn(in: GlobalType.Symbol, s: GlobalType.Symbol): String
Create a (source) name for the class symbol
s
with a prefix determined by the class symbolin
.Create a (source) name for the class symbol
s
with a prefix determined by the class symbolin
.If
s
represents a package objectpkg3
, then the returned name will bepkg1.pkg2.pkg3.package
. Ifs
represents a classFoo
nested in package objectpkg3
then the returned name ispkg1.pkg2.pk3.Foo
.Note that some objects with special access rights are encoded in names (like qualified privates
private[qualifier]
). In order to get the right original names, we need to useunexpandedName
.- Attributes
- protected
- Definition Classes
- ClassName
- def classNameAsString(s: GlobalType.Symbol): String
Create a String (source) name for a class symbol
s
.Create a String (source) name for a class symbol
s
.- Attributes
- protected
- Definition Classes
- ClassName
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def constructorName(cls: GlobalType.Symbol): GlobalType.Name
Given a class symbol
cls
, construct a name representing this constructor.Given a class symbol
cls
, construct a name representing this constructor. For a class:a.b.Foo
this is:
a;b;Foo;init;
The prefix is important to avoid name hashing all constructors together (see #97), the weird format is necessary to avoid scalac or zinc trying to interpret this name (in particular we should not use '.' and we should not use '<init>'), we use ';' because it is one of the few characters that cannot appear in a valid JVM name.
- Attributes
- protected
- Definition Classes
- ClassName
- def constructorNameAsString(cls: GlobalType.Symbol): String
- Attributes
- protected
- Definition Classes
- ClassName
- def enclOrModuleClass(s: GlobalType.Symbol): GlobalType.Symbol
Return the enclosing class or the module class if it's a module.
Return the enclosing class or the module class if it's a module.
- Definition Classes
- GlobalHelpers
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extractAndReport(unit: GlobalType.CompilationUnit): Unit
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def flatclassName(s: GlobalType.Symbol, sep: Char, dollarRequired: Boolean): String
- Attributes
- protected
- Definition Classes
- ClassName
- def flatname(s: GlobalType.Symbol, separator: Char): String
Creates a flat (binary) name for a class symbol
s
.Creates a flat (binary) name for a class symbol
s
.- Attributes
- protected
- Definition Classes
- ClassName
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val global: GlobalType
- Definition Classes
- ExtractUsedNames → GlobalHelpers → ClassName
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def ignoredSymbol(symbol: GlobalType.Symbol): Boolean
Return true if symbol shall be ignored, false otherwise.
Return true if symbol shall be ignored, false otherwise.
- Definition Classes
- GlobalHelpers
- Annotations
- @inline()
- def ignoredType(tpe: GlobalType.Type): Boolean
Return true if type shall be ignored, false otherwise.
Return true if type shall be ignored, false otherwise.
- Definition Classes
- GlobalHelpers
- Annotations
- @inline()
- def isEmptyName(name: GlobalType.Name): Boolean
Return true if name is empty, false otherwise.
Return true if name is empty, false otherwise.
- Definition Classes
- GlobalHelpers
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isSyntheticCoreClass(sym: GlobalType.Symbol): Boolean
- Definition Classes
- GlobalHelpers
- def isTopLevelModule(sym: GlobalType.Symbol): Boolean
- Attributes
- protected
- Definition Classes
- ClassName
- def mangledName(s: GlobalType.Symbol): GlobalType.Name
Mangle a JVM symbol name in a format better suited for internal uses by sbt.
Mangle a JVM symbol name in a format better suited for internal uses by sbt.
- Attributes
- protected
- Definition Classes
- ClassName
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def processMacroExpansion(in: GlobalType.Tree)(func: (GlobalType.Tree) => Unit): Boolean
Returns true if given tree contains macro attchment.
Returns true if given tree contains macro attchment. In such case calls func on tree from attachment.
- Definition Classes
- GlobalHelpers
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object Feedback
Define common error messages for error reporting and assertions.
Define common error messages for error reporting and assertions.
- Definition Classes
- GlobalHelpers
- object MacroExpansionOf
- Definition Classes
- GlobalHelpers