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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>>

org.pkl.core.ast.builder.ImportsAndReadsParser

All Implemented Interfaces:

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

public final class ImportsAndReadsParser
extends AbstractAstBuilder<@Nullable List<Pair<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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>	aggregateResult(@Nullable List<Pair<String,com.oracle.truffle.api.source.SourceSection>> aggregate, @Nullable List<Pair<String,com.oracle.truffle.api.source.SourceSection>> nextResult)
protected VmExceptionBuilder	exceptionBuilder()
static @Nullable List<Pair<String,com.oracle.truffle.api.source.SourceSection>>	parse(ModuleKey moduleKey, ResolvedModuleKey resolvedModuleKey)	Parses a module, and collects all imports and reads.
List<Pair<String,com.oracle.truffle.api.source.SourceSection>>	visitImportClause(PklParser.ImportClauseContext ctx)	Visit a parse tree produced by PklParser.importClause().
List<Pair<String,com.oracle.truffle.api.source.SourceSection>>	visitImportExpr(PklParser.ImportExprContext ctx)	Visit a parse tree produced by the importExpr labeled alternative in PklParser.expr().
List<Pair<String,com.oracle.truffle.api.source.SourceSection>>	visitModuleExtendsOrAmendsClause(PklParser.ModuleExtendsOrAmendsClauseContext ctx)	Visit a parse tree produced by PklParser.moduleExtendsOrAmendsClause().
List<Pair<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 Details

ImportsAndReadsParser

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

Method Details

parse

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

Parses a module, and collects all imports and reads.

Throws:

IOException

exceptionBuilder

protected VmExceptionBuilder exceptionBuilder()

Specified by:

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

visitModuleExtendsOrAmendsClause

public List<Pair<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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

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

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitImportClause

public List<Pair<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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

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

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitImportExpr

public List<Pair<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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

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

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitReadExpr

public List<Pair<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 List<Pair<String,com.oracle.truffle.api.source.SourceSection>>>

Overrides:

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

Parameters:

ctx - the parse tree

Returns:

the visitor result

aggregateResult

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

Overrides:

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