Package org.pkl.core.ast.builder

Class ImportsAndReadsParser

java.lang.Object

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

org.pkl.core.parser.antlr.PklParserBaseVisitor<T>

org.pkl.core.ast.builder.AbstractAstBuilder<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

org.pkl.core.ast.builder.ImportsAndReadsParser

All Implemented Interfaces:

org.antlr.v4.runtime.tree.ParseTreeVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>, PklParserVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

public class ImportsAndReadsParser
extends AbstractAstBuilder<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Collects module uris and resource uris imported within a module.

Gathers the following:

• amends/extends URI's
• import declarations
• import expressions
• read expressions

Field Summary

Fields inherited from class org.pkl.core.ast.builder.AbstractAstBuilder

source

Constructor Summary

Constructors

Constructor	Description
ImportsAndReadsParser(com.oracle.truffle.api.source.Source source)

Method Summary

Modifier and Type	Method	Description
protected @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	aggregateResult(@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> aggregate, @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> nextResult)
protected VmExceptionBuilder	exceptionBuilder()
static @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	parse(ModuleKey moduleKey, ResolvedModuleKey resolvedModuleKey)	Parses a module, and collects all imports and reads.
java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	visitImportClause(PklParser.ImportClauseContext ctx)	Visit a parse tree produced by PklParser.importClause().
java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	visitImportExpr(PklParser.ImportExprContext ctx)	Visit a parse tree produced by the importExpr labeled alternative in PklParser.expr().
@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	visitModuleExtendsOrAmendsClause(PklParser.ModuleExtendsOrAmendsClauseContext ctx)	Visit a parse tree produced by PklParser.moduleExtendsOrAmendsClause().
java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>	visitReadExpr(PklParser.ReadExprContext ctx)	Visit a parse tree produced by the readExpr labeled alternative in PklParser.expr().

Methods inherited from class org.pkl.core.ast.builder.AbstractAstBuilder

createSourceSection, createSourceSection, createSourceSection, createSourceSection, createSourceSection, createSourceSection, createSourceSection, doVisitSingleLineConstantStringPart, parseCharacterEscapeSequence, parseUnicodeEscapeSequence

Methods inherited from class org.pkl.core.parser.antlr.PklParserBaseVisitor

visitAdditiveExpr, visitAmendExpr, visitAnnotation, visitArgumentList, visitClassBody, visitClassHeader, visitClassMethod, visitClassProperty, visitClazz, visitComparisonExpr, visitConstrainedType, visitDeclaredType, visitDefaultUnionType, visitEqualityExpr, visitExponentiationExpr, visitExpr, visitExprInput, visitFalseLiteral, visitFloatLiteral, visitForGenerator, visitFunctionLiteral, visitFunctionType, visitIfExpr, visitIntLiteral, visitLetExpr, visitLogicalAndExpr, visitLogicalNotExpr, visitLogicalOrExpr, visitMemberPredicate, visitMethodHeader, visitModifier, visitModule, visitModuleDecl, visitModuleExpr, visitModuleHeader, visitModuleType, visitMultiLineStringLiteral, visitMultiLineStringPart, visitMultiplicativeExpr, visitNewExpr, visitNonNullExpr, visitNothingType, visitNullableType, visitNullCoalesceExpr, visitNullLiteral, visitObjectBody, visitObjectElement, visitObjectEntry, visitObjectMember, visitObjectMethod, visitObjectProperty, visitObjectSpread, visitOuterExpr, visitParameter, visitParameterList, visitParenthesizedExpr, visitParenthesizedType, visitPipeExpr, visitQualifiedAccessExpr, visitQualifiedIdentifier, visitReplInput, visitReservedKeyword, visitSingleLineStringLiteral, visitSingleLineStringPart, visitStringConstant, visitStringLiteralType, visitSubscriptExpr, visitSuperAccessExpr, visitSuperSubscriptExpr, visitThisExpr, visitThrowExpr, visitTraceExpr, visitTrueLiteral, visitType, visitTypeAlias, visitTypeAliasHeader, visitTypeAnnotation, visitTypeArgumentList, visitTypedIdentifier, visitTypeParameter, visitTypeParameterList, visitTypeTestExpr, visitUnaryMinusExpr, visitUnionType, visitUnknownType, visitUnqualifiedAccessExpr, visitWhenGenerator

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

defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode, visitTerminal

Methods inherited from class java.lang.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 Detail

ImportsAndReadsParser

public ImportsAndReadsParser(com.oracle.truffle.api.source.Source source)

Method Detail

parse

public static @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> parse(ModuleKey moduleKey,
                                                                                                                       ResolvedModuleKey resolvedModuleKey)
                                                                                                                throws java.io.IOException

Parses a module, and collects all imports and reads.

Throws:

java.io.IOException

exceptionBuilder

protected VmExceptionBuilder exceptionBuilder()

Specified by:

exceptionBuilder in class AbstractAstBuilder<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

visitModuleExtendsOrAmendsClause

public @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> visitModuleExtendsOrAmendsClause(PklParser.ModuleExtendsOrAmendsClauseContext ctx)

Description copied from class: PklParserBaseVisitor

Visit a parse tree produced by PklParser.moduleExtendsOrAmendsClause().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitModuleExtendsOrAmendsClause in interface PklParserVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

visitModuleExtendsOrAmendsClause in class PklParserBaseVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitImportClause

public java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> visitImportClause(PklParser.ImportClauseContext ctx)

Description copied from class: PklParserBaseVisitor

Visit a parse tree produced by PklParser.importClause().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitImportClause in interface PklParserVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

visitImportClause in class PklParserBaseVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitImportExpr

public java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> visitImportExpr(PklParser.ImportExprContext ctx)

Description copied from class: PklParserBaseVisitor

Visit a parse tree produced by the importExpr labeled alternative in PklParser.expr().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitImportExpr in interface PklParserVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

visitImportExpr in class PklParserBaseVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitReadExpr

public java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> visitReadExpr(PklParser.ReadExprContext ctx)

Description copied from class: PklParserBaseVisitor

Visit a parse tree produced by the readExpr labeled alternative in PklParser.expr().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(org.antlr.v4.runtime.tree.RuleNode) on ctx.

Specified by:

visitReadExpr in interface PklParserVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

visitReadExpr in class PklParserBaseVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>

Parameters:

ctx - the parse tree

Returns:

the visitor result

aggregateResult

protected @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> aggregateResult(@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> aggregate,
                                                                                                                             @Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>> nextResult)

Overrides:

aggregateResult in class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<@Nullable java.util.List<Pair<java.lang.String,com.oracle.truffle.api.source.SourceSection>>>