ExtractUsedNames

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 by Tree.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.

Linear Supertypes

GlobalHelpers, ClassName, AnyRef, Any

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
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
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 symbol in.
Create a (source) name for the class symbol s with a prefix determined by the class symbol in.
If s represents a package object pkg3, then the returned name will be pkg1.pkg2.pkg3.package. If s represents a class Foo nested in package object pkg3 then the returned name is pkg1.pkg2.pk3.Foo.

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def extract(unit: GlobalType.CompilationUnit): Iterable[(String, Iterable[String])]
def finalize(): Unit

Attributes
protected[java.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
def foreachNotPackageSymbolInType(tpe: GlobalType.Type)(op: (GlobalType.Symbol) ⇒ Unit): Unit

Apply op on every type symbol which doesn't represent a package.
Apply op on every type symbol which doesn't represent a package.

Definition Classes
GlobalHelpers
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val global: GlobalType

Definition Classes
ExtractUsedNames → GlobalHelpers → ClassName
def hashCode(): Int

Definition Classes
AnyRef → Any
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
def isTopLevelModule(sym: GlobalType.Symbol): Boolean

Attributes
protected
Definition Classes
ClassName
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package xsbt

class ExtractUsedNames[GlobalType <: CallbackGlobal] extends ClassName with GlobalHelpers

Instance Constructors

new ExtractUsedNames(global: GlobalType)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Feedback

object MacroExpansionOf

final def asInstanceOf[T0]: T0

def className(s: GlobalType.Symbol): GlobalType.Name

def classNameAsSeenIn(in: GlobalType.Symbol, s: GlobalType.Symbol): String

def classNameAsString(s: GlobalType.Symbol): String

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def extract(unit: GlobalType.CompilationUnit): Iterable[(String, Iterable[String])]

def finalize(): Unit

def flatclassName(s: GlobalType.Symbol, sep: Char, dollarRequired: Boolean): String

def flatname(s: GlobalType.Symbol, separator: Char): String

def foreachNotPackageSymbolInType(tpe: GlobalType.Type)(op: (GlobalType.Symbol) ⇒ Unit): Unit

final def getClass(): Class[_]

val global: GlobalType

def hashCode(): Int

def ignoredSymbol(symbol: GlobalType.Symbol): Boolean

def ignoredType(tpe: GlobalType.Type): Boolean

def isEmptyName(name: GlobalType.Name): Boolean

final def isInstanceOf[T0]: Boolean

def isTopLevelModule(sym: GlobalType.Symbol): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def processMacroExpansion(in: GlobalType.Tree)(func: (GlobalType.Tree) ⇒ Unit): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from GlobalHelpers

Inherited from ClassName

Inherited from AnyRef

Inherited from Any

Ungrouped