Class Ek9SourceVisitor

java.lang.Object

org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<Void>

org.ek9lang.antlr.EK9BaseVisitor<Void>

org.ek9lang.compiler.common.Ek9SourceVisitor

All Implemented Interfaces:

org.antlr.v4.runtime.tree.ParseTreeVisitor<Void>, EK9Visitor<Void>

public class Ek9SourceVisitor
extends EK9BaseVisitor<Void>

A cut down visitor that just deals with packages at a basic level. Now refactored the results of the visit out to an immutable record, so the private properties in this visitor are now transient.

Constructor Summary

Constructors

Constructor	Description
Ek9SourceVisitor()

Method Summary

Modifier and Type	Method	Description
String	declarationOf(String dependencyModuleName)	Where a deps or devDeps entry for dependencyModuleName is declared, as file:line (the file as this visitor's source was named), or just the file when the line is not known.
Optional<PackageDetails>	getPackageDetails()
void	visit(EK9Parser.CompilationUnitContext context, ErrorListener errorListener)	This is the key to lexing and parsing the source file mainly just for package information.
Void	visitModuleDeclaration(EK9Parser.ModuleDeclarationContext ctx)	Only the module's package and program blocks matter here, and both are module-level.
Void	visitPackageBlock(EK9Parser.PackageBlockContext ctx)	Visit a parse tree produced by EK9Parser.packageBlock().
Void	visitProgramBlock(EK9Parser.ProgramBlockContext ctx)	The program NAMES only - their bodies are never visited.

Methods inherited from class EK9BaseVisitor

visitAccessModifier, visitAggregateParts, visitAggregateProperty, visitAllowingOnly, visitApplicationBlock, visitApplicationDeclaration, visitArgumentParam, visitAspectDeclaration, visitAssertDoesNotThrowExpression, visitAssertPanicExpression, visitAssertStatement, visitAssertThrowsExpression, visitAssignmentExpression, visitAssignmentStatement, visitBinaryLit, visitBinaryLiteral, visitBlock, visitBlockStatement, visitBooleanLit, visitBooleanLiteral, visitBytesLit, visitBytesLiteral, visitCall, visitCaseExpression, visitCaseStatement, visitCatchStatementExpression, visitCharacterLit, visitCharacterLiteral, visitClassBlock, visitClassDeclaration, visitColourLit, visitColourLiteral, visitCompilationUnit, visitComponentBlock, visitComponentDeclaration, visitConstantBlock, visitConstantDeclaration, visitConstantInitialiser, visitConstrainDeclaration, visitConstrainType, visitDateLit, visitDateLiteral, visitDateTimeLit, visitDateTimeLiteral, visitDeclareArgumentParam, visitDecorationDimensionLiteral, visitDecorationResolutionLiteral, visitDefaultOperator, visitDict, visitDimensionLit, visitDirective, visitDirectivePart, visitDottedName, visitDurationLit, visitDurationLiteral, visitDynamicClassDeclaration, visitDynamicFunctionBody, visitDynamicFunctionDeclaration, visitDynamicVariableCapture, visitElseOnlyBlock, visitEmptyBlock, visitEnumerationDeclaration, visitExcludedControlFlowStatement, visitExcludedInstantiation, visitExcludedListComprehension, visitExcludedLiteral, visitExpression, visitExpressionParam, visitExtendDeclaration, visitExtendPreamble, visitFinallyStatementExpression, visitFloatingPointLit, visitFloatingPointLiteral, visitForLoop, visitForRange, visitForStatementExpression, visitFunctionBlock, visitFunctionDeclaration, visitHttpAccess, visitHttpVerb, visitIdentifier, visitIdentifierReference, visitIfControlBlock, visitIfStatement, visitInitValuePair, visitInstructionBlock, visitIntegerLit, visitIntegerLiteral, visitList, visitMethodDeclaration, visitMillisecondLit, visitMillisecondLiteral, visitModuleBlock, visitModuleSegment, visitMoneyLit, visitMoneyLiteral, visitNonIdentifierOperator, visitObjectAccess, visitObjectAccessExpression, visitObjectAccessStart, visitObjectAccessType, visitOperationCall, visitOperationDetails, visitOperator, visitOperatorDeclaration, visitParameterisedArgs, visitParameterisedDetail, visitParameterisedParams, visitParameterisedType, visitParamExpression, visitPathLit, visitPathLiteral, visitPipelinePart, visitPreFlowAndControl, visitPreFlowStatement, visitPrimary, visitPrimaryReference, visitRange, visitRecordBlock, visitRecordDeclaration, visitReferencesBlock, visitRegExLit, visitRegisterStatement, visitRegularExpressionLiteral, visitRequireStatement, visitReservedWord, visitResolutionLit, visitReturningParam, visitSecurityConstraint, visitServiceBlock, visitServiceDeclaration, visitServiceOperationDeclaration, visitSheBang, visitSingleStatementBlock, visitStatement, visitStreamCat, visitStreamExpression, visitStreamExpressionTermination, visitStreamFor, visitStreamPart, visitStreamSource, visitStreamStatement, visitStreamStatementTermination, visitStringLit, visitStringLiteral, visitStringPart, visitSwitchStatementExpression, visitTernaryPart, visitTextBlock, visitTextBodyDeclaration, visitTextDeclaration, visitThrowStatement, visitTimeLit, visitTimeLiteral, visitTraitBlock, visitTraitDeclaration, visitTraitPreamble, visitTraitReference, visitTraitsList, visitTryStatementExpression, visitTypeBlock, visitTypeDeclaration, visitTypeDef, visitVariableDeclaration, visitVariableOnlyDeclaration, visitVersionNumberLit, visitVersionNumberLiteral, visitWebVariableCorrelation, visitWhileStatementExpression

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor

aggregateResult, defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode, visitTerminal

Methods inherited from class Object

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

Methods inherited from interface org.antlr.v4.runtime.tree.ParseTreeVisitor

visit, visitChildren, visitErrorNode, visitTerminal

Constructor Details

Ek9SourceVisitor

public Ek9SourceVisitor()

Method Details

visit

public void visit(EK9Parser.CompilationUnitContext context,
 ErrorListener errorListener)

This is the key to lexing and parsing the source file mainly just for package information.

getPackageDetails

public Optional<PackageDetails> getPackageDetails()

declarationOf

public String declarationOf(String dependencyModuleName)

Where a deps or devDeps entry for dependencyModuleName is declared, as file:line (the file as this visitor's source was named), or just the file when the line is not known. Used to report a dependency that cannot be resolved at the line that asked for it.

visitModuleDeclaration

public Void visitModuleDeclaration(EK9Parser.ModuleDeclarationContext ctx)

Only the module's package and program blocks matter here, and both are module-level. Visiting every child (visitChildren) recursed through every construct's body for nothing - and on a deeply nested source overflowed the stack before the compiler had even started (front-end audit FE53).

Specified by:

visitModuleDeclaration in interface EK9Visitor<Void>

Overrides:

visitModuleDeclaration in class EK9BaseVisitor<Void>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitProgramBlock

public Void visitProgramBlock(EK9Parser.ProgramBlockContext ctx)

The program NAMES only - their bodies are never visited.

Specified by:

visitProgramBlock in interface EK9Visitor<Void>

Overrides:

visitProgramBlock in class EK9BaseVisitor<Void>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitPackageBlock

public Void visitPackageBlock(EK9Parser.PackageBlockContext ctx)

Description copied from class: EK9BaseVisitor

Visit a parse tree produced by EK9Parser.packageBlock().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitPackageBlock in interface EK9Visitor<Void>

Overrides:

visitPackageBlock in class EK9BaseVisitor<Void>

Parameters:

ctx - the parse tree

Returns:

the visitor result