Class CompilerPhase

java.lang.Object

org.ek9lang.compiler.CompilerPhase

All Implemented Interfaces:

BiFunction<Workspace, CompilerFlags, CompilationPhaseResult>

Direct Known Subclasses:

CodeGenerationAggregates, CodeGenerationApplications, CodeGenerationConstants, CodeGenerationPreparation, CodeOptimisation, IRAnalysis, IRGenerator, IROptimisation, ModuleDuplicateSymbolChecks, NonInferredTypeDefinition, Packaging, PackagingPostProcessing, PluginLinkage, PluginResolution, PostSymbolResolutionChecks, PreIntermediateRepresentationChecks, ReferenceChecks, SymbolDefinition, SymbolicAnalysis, SymbolResolution, TypeHierarchyChecks

public abstract class CompilerPhase
extends Object
implements BiFunction<Workspace, CompilerFlags, CompilationPhaseResult>

Marks the specific activity of a compiler phase. Provides mechanism to pass both phase and the compiler flags into the compilable program. This then enables them to be accessed within other components during compilation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final SharedThreadContext<CompilableProgram>	compilableProgramAccess
protected final Consumer<CompilationEvent>	listener
protected final boolean	modelFrozen	Is the symbol model already complete and read-only by the time this phase runs?
protected final CompilerReporter	reporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompilerPhase(CompilationPhase phase, SharedThreadContext<CompilableProgram> compilableProgramAccess, Consumer<CompilationEvent> listener, CompilerReporter reporter)

Method Summary

Modifier and Type	Method	Description
CompilationPhaseResult	apply(Workspace workspace, CompilerFlags compilerFlags)
protected abstract boolean	doApply(Workspace workspace, CompilerFlags compilerFlags)	Do the compilation phase.
protected ParsedModule	getParsedModuleForSource(CompilableSource source)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BiFunction

andThen

Field Details

listener

protected final Consumer<CompilationEvent> listener

reporter

protected final CompilerReporter reporter

compilableProgramAccess

protected final SharedThreadContext<CompilableProgram> compilableProgramAccess

modelFrozen

protected final boolean modelFrozen

Is the symbol model already complete and read-only by the time this phase runs?

A plain final field, fixed when the phase is constructed, because the answer is a static property of where the phase sits in the pipeline - see CompilationPhase.isModelFrozen(). There is deliberately no setter and no flag to maintain: nothing can set it late, clear it early, or forget to. A post-freeze phase reads a model nobody writes to, so it needs neither the lock nor any other synchronisation, and all of its threads may read concurrently.

Constructor Details

CompilerPhase

protected CompilerPhase(CompilationPhase phase,
 SharedThreadContext<CompilableProgram> compilableProgramAccess,
 Consumer<CompilationEvent> listener,
 CompilerReporter reporter)

Method Details

doApply

protected abstract boolean doApply(Workspace workspace,
 CompilerFlags compilerFlags)

Do the compilation phase.

apply

public CompilationPhaseResult apply(Workspace workspace,
 CompilerFlags compilerFlags)

Specified by:

apply in interface BiFunction<Workspace, CompilerFlags, CompilationPhaseResult>

getParsedModuleForSource

protected ParsedModule getParsedModuleForSource(CompilableSource source)