xsbt

ExtractAPI

class ExtractAPI[GlobalType <: Global] extends Compat with ClassName with GlobalHelpers

Extracts full (including private members) API representation out of Symbols and Types.

API for each class is extracted separately. Inner classes are represented as an empty (without members) member of the outer class and as a separate class with full API representation. For example:

class A { class B { def foo: Int = 123 } }

Is represented as:

// className = A class A { class B } // className = A.B class A.B { def foo: Int }

Each compilation unit should be processed by a fresh instance of this class.

NOTE: This class extract *full* API representation. In most of other places in the incremental compiler, only non-private (accessible from other compilation units) members are relevant. Other parts of the incremental compiler filter out private definitions before processing API structures. Check SameAPI for an example.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExtractAPI
  2. GlobalHelpers
  3. ClassName
  4. Compat
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExtractAPI(global: GlobalType, sourceFile: File)

Type Members

  1. implicit class MacroExpansionAttachmentCompat extends AnyRef

    Definition Classes
    Compat
  2. class SuppressSymbolRef extends GlobalType.TypeMap

    Replace all types that directly refer to the forbidden symbol by NoType.

  3. final class SymbolCompat extends AnyRef

    Attributes
    protected
    Definition Classes
    Compat

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val DummyValue: Int

    Definition Classes
    Compat
  7. object Feedback

    Define common error messages for error reporting and assertions.

  8. val LocalChild: scala.reflect.internal.StdNames.tpnme.NameType

    Definition Classes
    Compat
  9. object MacroExpansionOf

    Definition Classes
    GlobalHelpers
  10. object MirrorHelper

    Definition Classes
    Compat
  11. val Nullary: GlobalType.NullaryMethodType.type

    Definition Classes
    Compat
  12. object NullaryMethodTpe

    Definition Classes
    Compat
  13. val ScalaObjectClass: GlobalType.ClassSymbol

    Definition Classes
    Compat
  14. def allExtractedNonLocalClasses: Set[ClassLike]

  15. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  16. 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
  17. 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.

    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 use unexpandedName.

    Attributes
    protected
    Definition Classes
    ClassName
  18. 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
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. 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
  21. def constructorNameAsString(cls: GlobalType.Symbol): String

    Attributes
    protected
    Definition Classes
    ClassName
  22. final def devWarning(msg: ⇒ String): Unit

    Definition Classes
    Compat
    Annotations
    @inline()
  23. 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
  24. final def enteringPhase[T](ph: Phase)(op: ⇒ T): T

    Definition Classes
    Compat
    Annotations
    @inline()
  25. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  27. def extractAllClassesOf(in: GlobalType.Symbol, c: GlobalType.Symbol): Unit

  28. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def flatclassName(s: GlobalType.Symbol, sep: Char, dollarRequired: Boolean): String

    Attributes
    protected
    Definition Classes
    ClassName
  30. 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
  31. final def forceStructures(): Unit

    Force all lazy structures.

    Force all lazy structures. This is necessary so that we see the symbols/types at this phase and so that we don't hold on to compiler objects and classes

    Annotations
    @tailrec()
  32. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  33. val global: GlobalType

    Definition Classes
    ExtractAPIGlobalHelpersClassNameCompat
  34. def hasMacro(s: GlobalType.Symbol): Boolean

    Definition Classes
    Compat
  35. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  36. 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()
  37. 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()
  38. 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
  39. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  40. def isTopLevelModule(sym: GlobalType.Symbol): Boolean

    Attributes
    protected
    Definition Classes
    ClassName
  41. def linearizedAncestorTypes(info: GlobalType.Type): List[GlobalType.Type]

  42. def mainClasses: Set[String]

  43. 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
  44. def moduleSuffix(s: GlobalType.Symbol): String

    Definition Classes
    Compat
  45. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  46. final def notify(): Unit

    Definition Classes
    AnyRef
  47. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  48. 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
  49. implicit def symbolCompat(sym: GlobalType.Symbol): SymbolCompat

    Attributes
    protected
    Definition Classes
    Compat
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  51. def toString(): String

    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from GlobalHelpers

Inherited from ClassName

Inherited from Compat

Inherited from AnyRef

Inherited from Any

Ungrouped