avail/avail.compiler.problems/CompilerDiagnostics

CompilerDiagnostics

class CompilerDiagnostics( source: A_String, moduleName: ModuleName, val pollForAbort: () -> Boolean, problemHandler: ProblemHandler)

This tracks the problems encountered while compiling a single module.

Author

Mark van Gulik

Parameters

source

The source code of the module.

moduleName

The ModuleName of the module being compiled.

pollForAbort

A BooleanSupplier to indicate whether to abort.

problemHandler

A ProblemHandler for, well, handling problems during compilation.

Constructors

CompilerDiagnostics

fun CompilerDiagnostics( source: A_String, moduleName: ModuleName, pollForAbort: () -> Boolean, problemHandler: ProblemHandler)

Create a CompilerDiagnostics suitable for tracking the potential problems encountered during compilation of a single module.

Types

Companion

object Companion

ParseNotificationLevel

enum ParseNotificationLevel : Enum<CompilerDiagnostics.ParseNotificationLevel>

These enumeration values form a priority scheme for reporting parsing problems.

Functions

expectedAt

fun expectedAt( level: CompilerDiagnostics.ParseNotificationLevel, describer: Describer, lexingState: LexingState)

Record an expectation at the given token.

handleProblem

fun handleProblem(problem: Problem)

Handle a problem via the problem handler.

recordToken

fun recordToken(token: A_Token)

Record the fact that this token was encountered while parsing the current top-level statement.

reportError

fun reportError()

Report the rightmost accumulated errors, then invoke the failureReporter.

fun reportError( lexingState: LexingState, headerMessagePattern: String, message: String)

Report one specific terminal problem and call the failure continuation to abort compilation.

setSuccessAndFailureReporters

fun setSuccessAndFailureReporters(theSuccessReporter: () -> Unit, theFailureReporter: () -> Unit)

Set the success reporter and failure reporter.

startParsingAt

fun startParsingAt(initialPositionInSource: LexingState)

Record the fact that we're starting to parse a top-level statement at the indicated one-based position in the source. Clear any already recorded expectations.

Properties

compilationIsInvalid

@Volatile

var compilationIsInvalid: Boolean = false

This boolean is set when the problemHandler decides that an encountered Problem is serious enough that code generation should be suppressed. In Avail, that means the serialized module should not be written to its repository.

pollForAbort

val pollForAbort: () -> Boolean

A way to quickly test if the client wishes to shut down prematurely.

positionsToTrack

var positionsToTrack: Int

Allow the positionsToTrack to be adjusted. Only do this when there is no compilation active for the receiver.

silentPositionsToTrack

var silentPositionsToTrack: Int

Allow the positionsToTrack for ParseNotificationLevel.SILENT entries to be adjusted. Only do this when there is no compilation active for the receiver.

successReporter

@Volatile

var successReporter: () -> Unit? = null

The continuation that reports success of compilation.

surrogateIndexConverter

val surrogateIndexConverter: A_String.SurrogateIndexConverter

A tool for converting character positions between Avail's Unicode strings and Java/Kotlin's UTF-16 representation.