xsbti

Interface AnalysisCallback

public interface AnalysisCallback

Method Summary

Modifier and Type	Method and Description
void	api(java.io.File sourceFile, ClassLike classApi) Deprecated. Use @link{#api(VirtualFileRef, xsbti.api.ClassLike)} instead.
void	api(VirtualFileRef sourceFile, ClassLike classApi) Register a public API entry coming from a given source file.
void	apiPhaseCompleted() Communicate to the callback that the API phase has finished.
void	binaryDependency(java.io.File onBinaryEntry, java.lang.String onBinaryClassName, java.lang.String fromClassName, java.io.File fromSourceFile, DependencyContext context) Deprecated. Use @link{#binaryDependency(Path, String, String, VirtualFileRef, DependencyContext)} instead.
void	binaryDependency(java.nio.file.Path onBinaryEntry, java.lang.String onBinaryClassName, java.lang.String fromClassName, VirtualFileRef fromSourceFile, DependencyContext context) Indicate that the class fromClassName depends on a class named onBinaryClassName coming from class file or jar onBinaryEntry.
void	classDependency(java.lang.String onClassName, java.lang.String sourceClassName, DependencyContext context) Indicate that the class sourceClassName depends on the class onClassName.
java.util.Set<java.lang.String>	classesInOutputJar() Return class files in output jar at a given point in time.
void	dependencyPhaseCompleted() Communicate to the callback that the dependency phase has finished.
boolean	enabled() Return whether incremental compilation is enabled or not.
void	generatedLocalClass(java.io.File source, java.io.File classFile) Deprecated. Use @link{#generatedLocalClass(VirtualFileRef, Path)} instead.
void	generatedLocalClass(VirtualFileRef source, java.nio.file.Path classFile) Map the product relation between classFile and source to indicate that classFile is the product of compilation from source.
void	generatedNonLocalClass(java.io.File source, java.io.File classFile, java.lang.String binaryClassName, java.lang.String srcClassName) Deprecated. Use @link{#generatedNonLocalClass(VirtualFileRef, Path, String, String)} instead.
void	generatedNonLocalClass(VirtualFileRef source, java.nio.file.Path classFile, java.lang.String binaryClassName, java.lang.String srcClassName) Map the source class name (srcClassName) of a top-level Scala class coming from a given source file to a binary class name (binaryClassName) coming from a given class file.
java.util.Optional<xsbti.T2<java.nio.file.Path,java.nio.file.Path>>	getPickleJarPair()
boolean	isPickleJava() Returns true if -Ypickle-java is on.
void	mainClass(java.io.File sourceFile, java.lang.String className) Deprecated. Use @link{#mainClass(VirtualFileRef, String)} instead.
void	mainClass(VirtualFileRef sourceFile, java.lang.String className) Register a class containing an entry point coming from a given source file.
void	problem(java.lang.String what, xsbti.Position pos, java.lang.String msg, xsbti.Severity severity, boolean reported) Register a compilation problem.
void	startSource(java.io.File source) Deprecated. Use @link{#startSource(VirtualFile)} instead.
void	startSource(VirtualFile source) Set the source file mapped to a concrete AnalysisCallback.
void	usedName(java.lang.String className, java.lang.String name, java.util.EnumSet<UseScope> useScopes) Register the use of a name from a given source class name.

Method Detail

startSource

@Deprecated
void startSource(java.io.File source)

Deprecated. Use @link{#startSource(VirtualFile)} instead.

This is kept around for sbt-dotty.

startSource

void startSource(VirtualFile source)

Set the source file mapped to a concrete AnalysisCallback.

Parameters:

source - Source file mapped to this instance of AnalysisCallback.

classDependency

void classDependency(java.lang.String onClassName,
                     java.lang.String sourceClassName,
                     DependencyContext context)

Indicate that the class sourceClassName depends on the class onClassName. Note that only classes defined in source files included in the current compilation will passed to this method. Dependencies on classes generated by sources not in the current compilation will be passed as binary dependencies to the `binaryDependency` method.

Parameters:

onClassName - Class name being depended on.

sourceClassName - Dependent class name.

context - The kind of dependency established between onClassName and sourceClassName.

See Also:

DependencyContext

binaryDependency

@Deprecated
void binaryDependency(java.io.File onBinaryEntry,
                                  java.lang.String onBinaryClassName,
                                  java.lang.String fromClassName,
                                  java.io.File fromSourceFile,
                                  DependencyContext context)

Deprecated. Use @link{#binaryDependency(Path, String, String, VirtualFileRef, DependencyContext)} instead.

This is kept around for sbt-dotty.

binaryDependency

void binaryDependency(java.nio.file.Path onBinaryEntry,
                      java.lang.String onBinaryClassName,
                      java.lang.String fromClassName,
                      VirtualFileRef fromSourceFile,
                      DependencyContext context)

Indicate that the class fromClassName depends on a class named onBinaryClassName coming from class file or jar onBinaryEntry.

Parameters:

onBinaryEntry - A binary entry represents either the jar or the concrete class file from which the Scala compiler knows that onBinaryClassName comes from.

onBinaryClassName - Dependent binary name. Binary name with JVM-like representation. Inner classes are represented with '$'. For more information on the binary name format, check section 13.1 of the Java Language Specification.

fromClassName - Represent the class file name where onBinaryClassName is defined. Binary name with JVM-like representation. Inner classes are represented with '$'. For more information on the binary name format, check section 13.1 of the Java Language Specification.

fromSourceFile - Source file where onBinaryClassName is defined.

context - The kind of dependency established between onClassName and sourceClassName.

See Also:

for more information on the context.

generatedNonLocalClass

@Deprecated
void generatedNonLocalClass(java.io.File source,
                                        java.io.File classFile,
                                        java.lang.String binaryClassName,
                                        java.lang.String srcClassName)

Deprecated. Use @link{#generatedNonLocalClass(VirtualFileRef, Path, String, String)} instead.

This is kept around for sbt-dotty.

generatedNonLocalClass

void generatedNonLocalClass(VirtualFileRef source,
                            java.nio.file.Path classFile,
                            java.lang.String binaryClassName,
                            java.lang.String srcClassName)

Map the source class name (srcClassName) of a top-level Scala class coming from a given source file to a binary class name (binaryClassName) coming from a given class file. This relation indicates that classFile is the product of compilation from source.

Parameters:

source - File where srcClassName is defined.

classFile - File where binaryClassName is defined. This class file is the product of source.

binaryClassName - Binary name with JVM-like representation. Inner classes are represented with '$'. For more information on the binary name format, check section 13.1 of the Java Language Specification.

srcClassName - Class name as defined in source.

generatedLocalClass

@Deprecated
void generatedLocalClass(java.io.File source,
                                     java.io.File classFile)

Deprecated. Use @link{#generatedLocalClass(VirtualFileRef, Path)} instead.

This is kept around for sbt-dotty.

generatedLocalClass

void generatedLocalClass(VirtualFileRef source,
                         java.nio.file.Path classFile)

Map the product relation between classFile and source to indicate that classFile is the product of compilation from source.

Parameters:

source - File that produced classFile.

classFile - File product of compilation of source.

api

@Deprecated
void api(java.io.File sourceFile,
                     ClassLike classApi)

Deprecated. Use @link{#api(VirtualFileRef, xsbti.api.ClassLike)} instead.

This is kept around for sbt-dotty.

api

void api(VirtualFileRef sourceFile,
         ClassLike classApi)

Register a public API entry coming from a given source file.

Parameters:

sourceFile - Source file where classApi comes from.

classApi - The extracted public class API.

mainClass

@Deprecated
void mainClass(java.io.File sourceFile,
                           java.lang.String className)

Deprecated. Use @link{#mainClass(VirtualFileRef, String)} instead.

This is kept around for sbt-dotty.

mainClass

void mainClass(VirtualFileRef sourceFile,
               java.lang.String className)

Register a class containing an entry point coming from a given source file. A class is an entry point if its bytecode contains a method with the following signature:

 public static void main(String[] args);
 

Parameters:

sourceFile - Source file where className is defined.

className - A class containing an entry point.

usedName

void usedName(java.lang.String className,
              java.lang.String name,
              java.util.EnumSet<UseScope> useScopes)

Register the use of a name from a given source class name.

Parameters:

className - The source class name that uses name.

name - The source name used in className.

useScopes - Scopes(e.g. patmat, implicit) where name is used className.

problem

void problem(java.lang.String what,
             xsbti.Position pos,
             java.lang.String msg,
             xsbti.Severity severity,
             boolean reported)

Register a compilation problem. This error may have already been logged or not. Unreported problems may happen because the reporting option was not enabled via command-line.

Parameters:

what - The headline of the error.

pos - At a given source position.

msg - The in-depth description of the error.

severity - The severity of the error reported.

reported - Flag that confirms whether this error was reported or not.

dependencyPhaseCompleted

void dependencyPhaseCompleted()

Communicate to the callback that the dependency phase has finished. For instance, you can use this method it to wait on asynchronous tasks.

apiPhaseCompleted

void apiPhaseCompleted()

Communicate to the callback that the API phase has finished. For instance, you can use this method it to wait on asynchronous tasks.

enabled

boolean enabled()

Return whether incremental compilation is enabled or not. This method is useful to know whether the incremental compilation phase defined by xsbt-analyzer should be added.

classesInOutputJar

java.util.Set<java.lang.String> classesInOutputJar()

Return class files in output jar at a given point in time. When straight-to-jar compilation is enabled, the following entrypoint in the analysis callback tells the compiler which classes can be found in the jar used as a compilation target (where all class files will be store). The entrypoint will return all the paths to class files in Zinc format, an example would be `xsbti/AnalysisCallback.class`. This entrypoint serves two main purposes: 1. Before the dependency phase is run, it returns the class files found in the jar previous to the current compilation. 2. After dependency has run, when called again, it returns the class files written by the compiler in genbcode. The second purpose is required because the compiler cannot communicate us via an internal programmatic API which files has written in genbcode and therefore we need to pay the price of opening the jar again to figure it out. If the compiler is to expose an entry point for this data, we can repurpose `classesInOutputJar` to only do 1).

isPickleJava

boolean isPickleJava()

Returns true if -Ypickle-java is on.

getPickleJarPair

java.util.Optional<xsbti.T2<java.nio.file.Path,java.nio.file.Path>> getPickleJarPair()