final class API extends Compat with GlobalHelpers with ClassName
- Alphabetic
- By Inheritance
- API
- ClassName
- GlobalHelpers
- Compat
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new API(global: CallbackGlobal)
Type Members
- class ApiPhase extends CallbackGlobal.GlobalPhase
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: 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
-
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 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: 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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
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
-
def
constructorNameAsString(cls: CallbackGlobal.Symbol): String
- Attributes
- protected
- Definition Classes
- ClassName
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
flatclassName(s: CallbackGlobal.Symbol, sep: Char, dollarRequired: Boolean): String
- Attributes
- protected
- Definition Classes
- ClassName
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
val
global: CallbackGlobal
- Definition Classes
- API → ClassName → GlobalHelpers
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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()
-
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()
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isTopLevelModule(sym: CallbackGlobal.Symbol): Boolean
- Attributes
- protected
- Definition Classes
- ClassName
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newPhase(prev: Phase): ApiPhase
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
-
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
. -
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
- @native() @throws( ... )
-
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