final class API extends Compat with GlobalHelpers with ClassName

Source
API.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. API
  2. ClassName
  3. GlobalHelpers
  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 API(global: CallbackGlobal)

Type Members

  1. class ApiPhase extends CallbackGlobal.GlobalPhase

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 API toany2stringadd[API] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (API, B)
    Implicit
    This member is added by an implicit conversion from API toArrowAssoc[API] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def className(s: CallbackGlobal.Symbol): CallbackGlobal.Name

    Create a (source) name for a class symbol s.

    Create a (source) name for a class symbol s.

    Attributes
    protected
    Definition Classes
    ClassName
  8. def classNameAsSeenIn(in: CallbackGlobal.Symbol, s: CallbackGlobal.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
  9. def classNameAsString(s: CallbackGlobal.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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def constructorName(cls: CallbackGlobal.Symbol): CallbackGlobal.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
  12. def constructorNameAsString(cls: CallbackGlobal.Symbol): String
    Attributes
    protected
    Definition Classes
    ClassName
  13. def enclOrModuleClass(s: CallbackGlobal.Symbol): CallbackGlobal.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
  14. def ensuring(cond: (API) => Boolean, msg: => Any): API
    Implicit
    This member is added by an implicit conversion from API toEnsuring[API] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (API) => Boolean): API
    Implicit
    This member is added by an implicit conversion from API toEnsuring[API] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): API
    Implicit
    This member is added by an implicit conversion from API toEnsuring[API] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): API
    Implicit
    This member is added by an implicit conversion from API toEnsuring[API] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. def flatclassName(s: CallbackGlobal.Symbol, sep: Char, dollarRequired: Boolean): String
    Attributes
    protected
    Definition Classes
    ClassName
  22. def flatname(s: CallbackGlobal.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
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. val global: CallbackGlobal
    Definition Classes
    APIClassNameGlobalHelpersCompat
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def ignoredSymbol(symbol: CallbackGlobal.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()
  27. def ignoredType(tpe: CallbackGlobal.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()
  28. def isEmptyName(name: CallbackGlobal.Name): Boolean

    Return true if name is empty, false otherwise.

    Return true if name is empty, false otherwise.

    Definition Classes
    GlobalHelpers
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. final def isSyntheticCoreClass(sym: CallbackGlobal.Symbol): Boolean
    Definition Classes
    GlobalHelpers
  31. def isTopLevelModule(sym: CallbackGlobal.Symbol): Boolean
    Attributes
    protected
    Definition Classes
    ClassName
  32. def mangledName(s: CallbackGlobal.Symbol): CallbackGlobal.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
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def newPhase(prev: Phase): ApiPhase
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def processMacroExpansion(in: CallbackGlobal.Tree)(func: (CallbackGlobal.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
  38. def processOriginalTreeAttachment(in: CallbackGlobal.Tree)(func: (CallbackGlobal.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
  39. def registerGeneratedClasses(classSymbols: Iterator[CallbackGlobal.Symbol]): Unit

    Registers only non-local generated classes in the callback by extracting information about its names and using the names to generate class file paths.

    Registers only non-local generated classes in the callback by extracting information about its names and using the names to generate class file paths.

    Mimics the previous logic that was present in Analyzer, despite the fact that now we construct the names that the compiler will give to every non-local class independently of genbcode.

    Why do we do this? The motivation is that we want to run the incremental algorithm independently of the compiler pipeline. This independence enables us to:

    1. Offload the incremental compiler logic out of the primary pipeline and run the incremental phases concurrently. 2. Know before the compilation is completed whether another compilation will or will not be required. This is important to make incremental compilation work with pipelining and enables further optimizations; for example, we can start subsequent incremental compilations before (!) the initial compilation is done. This can buy us ~30-40% faster incremental compiler iterations.

    This method only takes care of non-local classes because local classes have no relevance in the correctness of the algorithm and can be registered after genbcode. Local classes are only used to construct the relations of products and to produce the list of generated files + stamps, but names referring to local classes **never** show up in the name hashes of classes' APIs, hence never considered for name hashing.

    As local class files are owned by other classes that change whenever they change, we could most likely live without adding their class files to the products relation and registering their stamps. However, to be on the safe side, we will continue to register the local products in Analyzer.

  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. object Feedback

    Define common error messages for error reporting and assertions.

    Define common error messages for error reporting and assertions.

    Definition Classes
    GlobalHelpers
  46. object MacroExpansionOf
    Definition Classes
    GlobalHelpers

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from API toStringFormat[API] 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): (API, B)
    Implicit
    This member is added by an implicit conversion from API toArrowAssoc[API] 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 ClassName

Inherited from GlobalHelpers

Inherited from Compat

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAPI to any2stringadd[API]

Inherited by implicit conversion StringFormat fromAPI to StringFormat[API]

Inherited by implicit conversion Ensuring fromAPI to Ensuring[API]

Inherited by implicit conversion ArrowAssoc fromAPI to ArrowAssoc[API]

Ungrouped