abstract class Reporter extends xsbti.Reporter with ConfigurableReporter
A flexible reporter whose configuration is provided by a ReporterConfig
.
This configuration indicated whether to use colors, how to format messages,
etc.
A reporter has internal state and must be instantiated per compilation.
- Alphabetic
- By Inheritance
- Reporter
- ConfigurableReporter
- Reporter
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Reporter(logger: Logger, cwd: AbsolutePath, sourcePositionMapper: (Position) ⇒ Position, config: ReporterConfig, _problems: Buffer[ProblemPerPhase] = mutable.ArrayBuffer.empty)
- logger
The logger that will receive the output of the reporter.
- cwd
The current working directory of the user who started compilation.
- sourcePositionMapper
A function that transforms positions.
- config
The configuration for this reporter.
Type Members
- case class PositionId(sourcePath: String, pointer: Int) extends Product with Serializable
Abstract Value Members
-
abstract
def
logFull(problem: Problem): Unit
- Attributes
- protected
-
abstract
def
printSummary(): Unit
- Definition Classes
- Reporter
-
abstract
def
reportCancelledCompilation(): Unit
Report the compile cancellation of this project.
-
abstract
def
reportCompilationProgress(progress: Long, total: Long): Unit
Report the progress from the compiler.
-
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.
-
abstract
def
reportStartCompilation(previousProblems: List[ProblemPerPhase]): Unit
A function called *always* at the very beginning of compilation.
-
abstract
def
reportStartIncrementalCycle(sources: Seq[File], 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).
Concrete 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
- val _problems: Buffer[ProblemPerPhase]
-
def
allProblems: Seq[Problem]
All the
Problems
seen by this reporter.All the
Problems
seen by this reporter.- Definition Classes
- Reporter → ConfigurableReporter
- def allProblemsPerPhase: Seq[ProblemPerPhase]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
comment(pos: Position, msg: String): Unit
- Definition Classes
- Reporter → Reporter
-
def
compilationMsgFor(projectName: String, sources: Seq[File]): String
Create a compilation message summarizing the compilation of
sources
inprojectName
. -
val
config: ReporterConfig
The configuration for this reporter.
The configuration for this reporter.
- Definition Classes
- Reporter → ConfigurableReporter
-
val
cwd: AbsolutePath
The current working directory of the user who started compilation.
The current working directory of the user who started compilation.
- Definition Classes
- Reporter → ConfigurableReporter
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
filesToPhaseStack: TrieMap[File, List[String]]
- Attributes
- protected
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hasErrors(): Boolean
true
if this reporter has received errors,false
otherwise.true
if this reporter has received errors,false
otherwise.- Definition Classes
- Reporter → ConfigurableReporter → Reporter
-
def
hasWarnings(): Boolean
true
if this reporter has received warnings,false
otherwise.true
if this reporter has received warnings,false
otherwise.- Definition Classes
- Reporter → ConfigurableReporter → Reporter
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
liftProblem(p: xsbti.Problem): Problem
- Attributes
- protected
-
def
log(xproblem: xsbti.Problem): Unit
- Definition Classes
- Reporter → Reporter
-
val
logger: Logger
Where to log the message
Where to log the message
- Definition Classes
- Reporter → ConfigurableReporter
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
phasesAtFile: TrieMap[File, String]
- Attributes
- protected
-
def
problems(): Array[xsbti.Problem]
- Definition Classes
- Reporter → Reporter
-
def
reportEndCompilation(previousAnalysis: Option[CompileAnalysis], analysis: Option[CompileAnalysis], code: StatusCode): Unit
A function called at the very end of compilation, before returning from Zinc to bloop.
A function called at the very end of compilation, before returning from Zinc to bloop.
This method **is** called if the compilation is a no-op.
- previousAnalysis
An instance of a previous compiler analysis, if any.
- analysis
An instance of a new compiler analysis, if no error happened.
- 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.
-
def
reportNextPhase(phase: String, sourceFile: File): Unit
Report when the compiler enters in a phase.
-
def
reset(): Unit
- Definition Classes
- Reporter → Reporter
-
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( ... )