avail/avail.compiler.problems

Package-level declarations

Types

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

This tracks the problems encountered while compiling a single module.

Problem

abstract class Problem(val moduleName: ModuleName?, val lineNumber: Int, val characterInFile: Long, val type: ProblemType, messagePattern: String, arguments: Any)

A Problem is produced when encountering an unexpected or less than ideal situation during compilation. Within an interactive system, the problem is presumably presented to the user in some manner, whereas in batch usage multiple problems may simply be collected and later presented in aggregate.

ProblemHandler

interface ProblemHandler

A Problem has a ProblemType, indicating its basic nature and severity. This helps a ProblemHandler decide how best to respond to the Problem, such as deciding whether to continue parsing to discover subsequent problems or to give up building the modules.

ProblemsAtPosition

class ProblemsAtPosition : Comparable<ProblemsAtPosition>

An aggregate of problems at a specific token. It also includes the String used to mark the location of the problem in the source text.

ProblemType

enum ProblemType : Enum<ProblemType>

A Problem has a ProblemType, indicating its basic nature and severity. This helps a ProblemHandler decide how best to respond to the Problem, such as deciding whether to proceed and look for subsequent problems or to give up building the modules.

SimpleProblemHandler

@FunctionalInterface

interface SimpleProblemHandler : ProblemHandler

A SimpleProblemHandler is a ProblemHandler that handles all Problems the same way, via its handleGeneric method.