Package org.pkl.core.stdlib

Class AbstractRenderer

java.lang.Object

org.pkl.core.stdlib.AbstractRenderer

All Implemented Interfaces:

VmValueVisitor

Direct Known Subclasses:

PcfRenderer, RendererNodes.Renderer

public abstract class AbstractRenderer
extends java.lang.Object
implements VmValueVisitor

Base class for renderers that are part of the standard library.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.StringBuilder	builder
protected PklConverter	converter
protected java.lang.StringBuilder	currIndent	The current indent.
protected java.util.Deque<java.lang.Object>	currPath
protected @Nullable com.oracle.truffle.api.source.SourceSection	currSourceSection	The (closest) SourceSection of the value being visited, for better error messages.
protected @Nullable VmValue	enclosingValue	The value directly enclosing the currently visited value, if any.
protected java.lang.String	indent	The indent to be used.
protected static char	LINE_BREAK
protected java.lang.String	name	The name of this renderer.

Constructor Summary

Constructors

Constructor	Description
AbstractRenderer(java.lang.String name, java.lang.StringBuilder builder, java.lang.String indent, PklConverter converter, boolean skipNullProperties, boolean skipNullEntries)

Method Summary

Modifier and Type	Method	Description
protected void	cannotRenderNonStringKey(java.lang.Object key)
protected void	cannotRenderTypeAddConverter(VmValue value)
protected boolean	canRenderPropertyOrEntryOf(VmDynamic object)
protected void	decreaseIndent()
protected abstract void	endDynamic(VmDynamic value, boolean isEmpty)
protected abstract void	endList(VmList value)
protected abstract void	endListing(VmListing value, boolean isEmpty)
protected abstract void	endMap(VmMap value)
protected abstract void	endMapping(VmMapping value, boolean isEmpty)
protected abstract void	endSet(VmSet value)
protected abstract void	endTyped(VmTyped value, boolean isEmpty)
protected void	increaseIndent()
void	renderDocument(java.lang.Object value)
void	renderValue(java.lang.Object value)
protected abstract void	startDynamic(VmDynamic value)
protected abstract void	startList(VmList value)
protected abstract void	startListing(VmListing value)
protected abstract void	startMap(VmMap value)
protected abstract void	startMapping(VmMapping value)
protected abstract void	startSet(VmSet value)
protected abstract void	startTyped(VmTyped value)
void	visit(java.lang.Object value)
void	visitClass(VmClass value)
protected abstract void	visitDocument(java.lang.Object value)
void	visitDynamic(VmDynamic value)
protected abstract void	visitElement(long index, java.lang.Object value, boolean isFirst)	Visits an element of a VmDynamic, VmListing, VmList, or VmSet.
protected abstract void	visitEntryKey(java.lang.Object key, boolean isFirst)	Visits an entry key of a VmDynamic, VmMapping, or VmMap.
protected abstract void	visitEntryValue(java.lang.Object value)	Visits an entry value of a VmDynamic, VmMapping, or VmMap.
void	visitFunction(VmFunction value)
void	visitList(VmList value)
void	visitListing(VmListing value)
void	visitMap(VmMap value)
void	visitMapping(VmMapping value)
protected abstract void	visitProperty(Identifier name, java.lang.Object value, boolean isFirst)	Visits a property of a VmDynamic or VmTyped.
protected abstract void	visitRenderDirective(VmTyped value)	Perform logic for rendering a render directive.
void	visitSet(VmSet value)
protected abstract void	visitTopLevelValue(java.lang.Object value)
void	visitTypeAlias(VmTypeAlias value)
void	visitTyped(VmTyped value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pkl.core.runtime.VmValueVisitor

visitBoolean, visitDataSize, visitDuration, visitFloat, visitInt, visitIntSeq, visitNull, visitPair, visitRegex, visitString

Field Detail

LINE_BREAK

protected static final char LINE_BREAK

See Also:

Constant Field Values

name

protected final java.lang.String name

The name of this renderer.

builder

protected final java.lang.StringBuilder builder

indent

protected final java.lang.String indent

The indent to be used.

converter

protected final PklConverter converter

currPath

protected java.util.Deque<java.lang.Object> currPath

enclosingValue

protected @Nullable VmValue enclosingValue

The value directly enclosing the currently visited value, if any.

currIndent

protected java.lang.StringBuilder currIndent

The current indent. Modified by increaseIndent() and decreaseIndent().

currSourceSection

protected @Nullable com.oracle.truffle.api.source.SourceSection currSourceSection

The (closest) SourceSection of the value being visited, for better error messages.

Constructor Detail

AbstractRenderer

public AbstractRenderer(java.lang.String name,
                        java.lang.StringBuilder builder,
                        java.lang.String indent,
                        PklConverter converter,
                        boolean skipNullProperties,
                        boolean skipNullEntries)

Method Detail

renderDocument

public final void renderDocument(java.lang.Object value)

renderValue

public final void renderValue(java.lang.Object value)

visit

public void visit(java.lang.Object value)

Specified by:

visit in interface VmValueVisitor

visitDocument

protected abstract void visitDocument(java.lang.Object value)

visitTopLevelValue

protected abstract void visitTopLevelValue(java.lang.Object value)

visitRenderDirective

protected abstract void visitRenderDirective(VmTyped value)

Perform logic for rendering a render directive. Render directives should be rendered verbatim.

startDynamic

protected abstract void startDynamic(VmDynamic value)

startTyped

protected abstract void startTyped(VmTyped value)

startListing

protected abstract void startListing(VmListing value)

startMapping

protected abstract void startMapping(VmMapping value)

startList

protected abstract void startList(VmList value)

startSet

protected abstract void startSet(VmSet value)

startMap

protected abstract void startMap(VmMap value)

visitElement

protected abstract void visitElement(long index,
                                     java.lang.Object value,
                                     boolean isFirst)

Visits an element of a VmDynamic, VmListing, VmList, or VmSet.

visitEntryKey

protected abstract void visitEntryKey(java.lang.Object key,
                                      boolean isFirst)

Visits an entry key of a VmDynamic, VmMapping, or VmMap.

visitEntryValue

protected abstract void visitEntryValue(java.lang.Object value)

Visits an entry value of a VmDynamic, VmMapping, or VmMap.

visitProperty

protected abstract void visitProperty(Identifier name,
                                      java.lang.Object value,
                                      boolean isFirst)

Visits a property of a VmDynamic or VmTyped.

endDynamic

protected abstract void endDynamic(VmDynamic value,
                                   boolean isEmpty)

endTyped

protected abstract void endTyped(VmTyped value,
                                 boolean isEmpty)

endListing

protected abstract void endListing(VmListing value,
                                   boolean isEmpty)

endMapping

protected abstract void endMapping(VmMapping value,
                                   boolean isEmpty)

endList

protected abstract void endList(VmList value)

endSet

protected abstract void endSet(VmSet value)

endMap

protected abstract void endMap(VmMap value)

visitTyped

public void visitTyped(VmTyped value)

Specified by:

visitTyped in interface VmValueVisitor

visitDynamic

public final void visitDynamic(VmDynamic value)

Specified by:

visitDynamic in interface VmValueVisitor

canRenderPropertyOrEntryOf

protected boolean canRenderPropertyOrEntryOf(VmDynamic object)

visitListing

public final void visitListing(VmListing value)

Specified by:

visitListing in interface VmValueVisitor

visitMapping

public final void visitMapping(VmMapping value)

Specified by:

visitMapping in interface VmValueVisitor

visitList

public final void visitList(VmList value)

Specified by:

visitList in interface VmValueVisitor

visitSet

public final void visitSet(VmSet value)

Specified by:

visitSet in interface VmValueVisitor

visitMap

public final void visitMap(VmMap value)

Specified by:

visitMap in interface VmValueVisitor

visitTypeAlias

public final void visitTypeAlias(VmTypeAlias value)

Specified by:

visitTypeAlias in interface VmValueVisitor

visitClass

public final void visitClass(VmClass value)

Specified by:

visitClass in interface VmValueVisitor

visitFunction

public final void visitFunction(VmFunction value)

Specified by:

visitFunction in interface VmValueVisitor

cannotRenderTypeAddConverter

protected void cannotRenderTypeAddConverter(VmValue value)

cannotRenderNonStringKey

protected void cannotRenderNonStringKey(java.lang.Object key)

increaseIndent

protected void increaseIndent()

decreaseIndent

protected void decreaseIndent()