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.

Source
ExtractAPI.scala
Linear Supertypes
GlobalHelpers, ClassName, Compat, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtractAPI
  2. GlobalHelpers
  3. ClassName
  4. Compat
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. class SuppressSymbolRef extends GlobalType.TypeMap

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

    Replace all types that directly refer to the forbidden symbol by NoType. (a specialized version of substThisAndSym)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toany2stringadd[ExtractAPI[GlobalType]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ExtractAPI[GlobalType], B)
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toArrowAssoc[ExtractAPI[GlobalType]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def allExtractedNonLocalClasses: Set[ClassLike]
  7. def allExtractedNonLocalSymbols: Set[GlobalType.Symbol]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. 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
  10. 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
  11. 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
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. 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
  14. def constructorNameAsString(cls: GlobalType.Symbol): String
    Attributes
    protected
    Definition Classes
    ClassName
  15. 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
  16. def ensuring(cond: (ExtractAPI[GlobalType]) => Boolean, msg: => Any): ExtractAPI[GlobalType]
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toEnsuring[ExtractAPI[GlobalType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: (ExtractAPI[GlobalType]) => Boolean): ExtractAPI[GlobalType]
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toEnsuring[ExtractAPI[GlobalType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean, msg: => Any): ExtractAPI[GlobalType]
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toEnsuring[ExtractAPI[GlobalType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean): ExtractAPI[GlobalType]
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toEnsuring[ExtractAPI[GlobalType]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def extractAllClassesOf(in: GlobalType.Symbol, c: GlobalType.Symbol): Unit
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. def flatclassName(s: GlobalType.Symbol, sep: Char, dollarRequired: Boolean): String
    Attributes
    protected
    Definition Classes
    ClassName
  25. 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
  26. 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()
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. val global: GlobalType
    Definition Classes
    ExtractAPI → GlobalHelpers → ClassName → Compat
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. 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()
  31. 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()
  32. 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
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. final def isSyntheticCoreClass(sym: GlobalType.Symbol): Boolean
    Definition Classes
    GlobalHelpers
  35. def isTopLevelModule(sym: GlobalType.Symbol): Boolean
    Attributes
    protected
    Definition Classes
    ClassName
  36. def linearizedAncestorTypes(info: GlobalType.Type): List[GlobalType.Type]
  37. def mainClasses: Set[String]
  38. 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
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. 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
  43. def processOriginalTreeAttachment(in: GlobalType.Tree)(func: (GlobalType.Tree) => Unit): Unit

    If given tree contains object tree attachment calls func on tree from attachment.

    If given tree contains object tree attachment calls func on tree from attachment.

    Attributes
    protected
    Definition Classes
    Compat
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. object Feedback

    Define common error messages for error reporting and assertions.

    Define common error messages for error reporting and assertions.

    Definition Classes
    GlobalHelpers
  50. object MacroExpansionOf
    Definition Classes
    GlobalHelpers

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toStringFormat[ExtractAPI[GlobalType]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ExtractAPI[GlobalType], B)
    Implicit
    This member is added by an implicit conversion from ExtractAPI[GlobalType] toArrowAssoc[ExtractAPI[GlobalType]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from GlobalHelpers

Inherited from ClassName

Inherited from Compat

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromExtractAPI[GlobalType] to any2stringadd[ExtractAPI[GlobalType]]

Inherited by implicit conversion StringFormat fromExtractAPI[GlobalType] to StringFormat[ExtractAPI[GlobalType]]

Inherited by implicit conversion Ensuring fromExtractAPI[GlobalType] to Ensuring[ExtractAPI[GlobalType]]

Inherited by implicit conversion ArrowAssoc fromExtractAPI[GlobalType] to ArrowAssoc[ExtractAPI[GlobalType]]

Ungrouped