t

bloop.reporter

ZincReporter

trait ZincReporter extends xsbti.Reporter with ConfigurableReporter

Linear Supertypes
ConfigurableReporter, xsbti.Reporter, AnyRef, Any
Known Subclasses
ObservedReporter, Reporter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZincReporter
  2. ConfigurableReporter
  3. Reporter
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def allProblems: Seq[Problem]

    All the Problems seen by this reporter.

    All the Problems seen by this reporter.

    Definition Classes
    ConfigurableReporter
  2. abstract def allProblemsPerPhase: Seq[ProblemPerPhase]
  3. abstract def comment(arg0: Position, arg1: String): Unit
    Definition Classes
    Reporter
  4. abstract def config: ReporterConfig

    The configuration for this reporter.

    The configuration for this reporter.

    Definition Classes
    ConfigurableReporter
  5. abstract def cwd: AbsolutePath

    The current working directory of the user who started compilation.

    The current working directory of the user who started compilation.

    Definition Classes
    ConfigurableReporter
  6. abstract def enableFatalWarnings(): Unit

    Enables internal bloop implementation of fatal warnings.

    Enables internal bloop implementation of fatal warnings.

    Having fatal warnings implemented inside the compiler has several drawbacks:

    1. Bloop receives a failed compilation when there is a warning. A failed compilation doesn't allow us to cache the work done during an incremental compiler cycle and the compilation products generated are thrown away. This means next time we compile we need to redo the work of compiling all changed source files when we would only want to recompile the files that produced a fatal warning.

    2. When warnings are produced, Metals doesn't have access to the class files generated by the failed compilation. This affects negatively the editing experience in the editor.

    To work around these limitations, we remove -Xfatal-warnings from the scalac options passed to the compiler and we implement fatal warnings ourselves in our reporter implementation.

    Our implementation promotes warnings to errors just before we're going to report them but still represents warnings as warnings in the analysis file. At the same time, it also treats successful compilations with fatal warnings as errors at the very end of the compilation pipeline, after all the compilation passes have been done in a build graph, and guarantees that it works for clients that have their compilations deduplicated.

    All in all, implementing fatal warnings reproduces the previous behavior in the compiler but without the inconveniences of handling compilation results as failures when only fatal warnings are solely responsible for the failed result.

  7. abstract def getSourceFilesWithFatalWarnings: Set[File]

    Tells the caller which source files have fatal warnings so that Bloop can mark them as changed and get recompiled in the next incremental cycle.

  8. abstract def hasErrors(): Boolean

    true if this reporter has received errors, false otherwise.

    true if this reporter has received errors, false otherwise.

    Definition Classes
    ConfigurableReporter
  9. abstract def hasWarnings(): Boolean

    true if this reporter has received warnings, false otherwise.

    true if this reporter has received warnings, false otherwise.

    Definition Classes
    ConfigurableReporter
  10. abstract def log(arg0: xsbti.Problem): Unit
    Definition Classes
    Reporter
  11. abstract def printSummary(): Unit
    Definition Classes
    Reporter
  12. abstract def problems(): Array[xsbti.Problem]
    Definition Classes
    Reporter
  13. abstract def processEndCompilation(previousSuccessfulProblems: List[ProblemPerPhase], code: StatusCode, clientClassesDir: Option[AbsolutePath], analysisOut: Option[AbsolutePath]): Unit

    A function called at the very end of compilation that processes the state of the reporter.

    A function called at the very end of compilation that processes the state of the reporter. The execution of this endpoint can clean or report more diagnostics with the client but it does not announce the end of compilation, which is instead done with announceEndCompilation.

    previousSuccessfulProblems

    The problems reported in the previous compiler analysis that were successful.

    code

    The status code for a given compilation. The status code can be used whenever there is a noop compile and it's successful or cancelled.

    clientClassesDir

    The analysis file of the client in case it has been rewritten. compilation has been finished. When the request is deduplicated, this directory matches the classes directory of the deduplicated client.

  14. abstract def reportCancelledCompilation(): Unit

    Report the compile cancellation of this project.

  15. abstract def reportCompilationProgress(progress: Long, total: Long): Unit

    Report the progress from the compiler.

  16. abstract def reportEndCompilation(): Unit

    A function called at the very end of compilation that processes the end of compilation from the reporter point of view as well as announce the end to the client.

    A function called at the very end of compilation that processes the end of compilation from the reporter point of view as well as announce the end to the client.

    This method is called when the caller knows for sure that announcing the end of compilation to the client is safe. For example, when a compilation fails and there are no background tasks to run. Compare this to the sister reportEndCompilation method which is used for the opposite.

  17. abstract def reportEndIncrementalCycle(durationMs: Long, result: Try[Unit]): Unit

    A function called after every incremental cycle, even if any compilation errors happen.

    A function called after every incremental cycle, even if any compilation errors happen. This method is not called if the compilation is a no-op (e.g. same analysis as before).

    durationMs

    The time it took to complete the incremental compiler cycle.

    result

    The result of the incremental cycle. We don't use bsp.StatusCode because the bloop backend, where this method is used, should not depend on bsp4j.

  18. abstract def reportNextPhase(phase: String, sourceFile: File): Unit

    Report when the compiler enters in a phase.

  19. abstract def reportStartCompilation(previousProblems: List[ProblemPerPhase]): Unit

    A function called *always* at the very beginning of compilation.

  20. abstract def reportStartIncrementalCycle(sources: Seq[VirtualFile], outputDirs: Seq[File]): Unit

    A function called before every incremental cycle with the compilation inputs.

    A function called before every incremental cycle with the compilation inputs. This method is not called if the compilation is a no-op (e.g. same analysis as before).

  21. abstract def reset(): Unit
    Definition Classes
    Reporter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from ConfigurableReporter

Inherited from xsbti.Reporter

Inherited from AnyRef

Inherited from Any

Ungrouped