com.google.template.soy.sharedpasses.render

Class RenderVisitor

java.lang.Object

com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>

com.google.template.soy.soytree.AbstractSoyNodeVisitor<Void>

com.google.template.soy.sharedpasses.render.RenderVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,Void>

public class RenderVisitor
extends AbstractSoyNodeVisitor<Void>

Visitor for rendering the template subtree rooted at a given SoyNode.

Important: Do not use outside of Soy code (treat as superpackage-private).

The rendered output will be appended to the Appendable provided to the constructor.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Predicate<String>	activeDelPackageSelector The predicate for testing whether a given delpackage is active.
protected SoyCssRenamingMap	cssRenamingMap CSS renaming map.
protected SoyRecord	data The current template data.
protected boolean	debugSoyTemplateInfo Configures if we should render additional HTML comments for runtime insepction.
protected Environment	env The current environment.
protected EvalVisitor.EvalVisitorFactory	evalVisitorFactory Factory for creating an instance of EvalVisitor.
protected SoyRecord	ijData The current injected data.
protected SoyMsgBundle	msgBundle The bundle of translated messages, or null to use the messages from the Soy source.
protected Deque<Appendable>	outputBufStack The stack of output Appendables (current output buffer is top of stack).
protected TemplateRegistry	templateRegistry The bundle containing all the templates that may be rendered.
protected SoyIdRenamingMap	xidRenamingMap xid renaming map.

Constructor Summary

Constructors

Constructor and Description
RenderVisitor(EvalVisitor.EvalVisitorFactory evalVisitorFactory, Appendable outputBuf, TemplateRegistry templateRegistry, SoyRecord data, SoyRecord ijData, com.google.common.base.Predicate<String> activeDelPackageSelector, SoyMsgBundle msgBundle, SoyIdRenamingMap xidRenamingMap, SoyCssRenamingMap cssRenamingMap, boolean debugSoyTemplateInfo)

Method Summary

Modifier and Type	Method and Description
protected RenderVisitor	createHelperInstance(Appendable outputBuf, SoyRecord data) Creates a helper instance for rendering a subtemplate.
Void	exec(SoyNode node) Executes the function defined by this visitor.
protected void	visitCallBasicNode(CallBasicNode node)
protected void	visitCallDelegateNode(CallDelegateNode node)
protected void	visitCallParamNode(CallParamNode node)
protected void	visitDebuggerNode(DebuggerNode node)
protected void	visitForNode(ForNode node)
protected void	visitIfNode(IfNode node)
protected void	visitLetContentNode(LetContentNode node)
protected void	visitLetValueNode(LetValueNode node)
protected void	visitLogNode(LogNode node)
protected void	visitMsgFallbackGroupNode(MsgFallbackGroupNode node)
protected void	visitMsgHtmlTagNode(MsgHtmlTagNode node)
protected void	visitPrintNode(PrintNode node)
protected void	visitRawTextNode(RawTextNode node)
protected void	visitSoyNode(SoyNode node)
protected void	visitSwitchNode(SwitchNode node)
protected void	visitTemplateNode(TemplateNode node)
protected void	visitVeLogNode(VeLogNode node)

Methods inherited from class com.google.template.soy.soytree.AbstractSoyNodeVisitor

visit, visitCallNode, visitCallParamContentNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitForIfemptyNode, visitForNonemptyNode, visitHtmlAttributeNode, visitHtmlAttributeValueNode, visitHtmlCloseTagNode, visitHtmlCommentNode, visitHtmlOpenTagNode, visitIfCondNode, visitIfElseNode, visitLetNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitSoyFileNode, visitSoyFileSetNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitTemplateBasicNode, visitTemplateDelegateNode

Methods inherited from class com.google.template.soy.basetree.AbstractNodeVisitor

visitChildren, visitChildrenAllowingConcurrentModification

Methods inherited from class java.lang.Object

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

Field Detail

evalVisitorFactory

protected final EvalVisitor.EvalVisitorFactory evalVisitorFactory

Factory for creating an instance of EvalVisitor.

templateRegistry

protected final TemplateRegistry templateRegistry

The bundle containing all the templates that may be rendered.

data

protected final SoyRecord data

The current template data.

ijData

protected final SoyRecord ijData

The current injected data.

env

protected Environment env

The current environment.

activeDelPackageSelector

protected final com.google.common.base.Predicate<String> activeDelPackageSelector

The predicate for testing whether a given delpackage is active.

msgBundle

protected final SoyMsgBundle msgBundle

The bundle of translated messages, or null to use the messages from the Soy source.

xidRenamingMap

protected final SoyIdRenamingMap xidRenamingMap

xid renaming map.

cssRenamingMap

protected final SoyCssRenamingMap cssRenamingMap

CSS renaming map.

debugSoyTemplateInfo

protected boolean debugSoyTemplateInfo

Configures if we should render additional HTML comments for runtime insepction.

outputBufStack

protected Deque<Appendable> outputBufStack

The stack of output Appendables (current output buffer is top of stack).

Constructor Detail

RenderVisitor

public RenderVisitor(EvalVisitor.EvalVisitorFactory evalVisitorFactory,
                     Appendable outputBuf,
                     @Nullable
                     TemplateRegistry templateRegistry,
                     SoyRecord data,
                     @Nullable
                     SoyRecord ijData,
                     @Nullable
                     com.google.common.base.Predicate<String> activeDelPackageSelector,
                     @Nullable
                     SoyMsgBundle msgBundle,
                     @Nullable
                     SoyIdRenamingMap xidRenamingMap,
                     @Nullable
                     SoyCssRenamingMap cssRenamingMap,
                     boolean debugSoyTemplateInfo)

Parameters:

evalVisitorFactory - Factory for creating an instance of EvalVisitor.

outputBuf - The Appendable to append the output to.

templateRegistry - A registry of all templates. Should never be null (except in some unit tests).

data - The current template data.

ijData - The current injected data.

activeDelPackageSelector - The predicate for testing whether a given delpackage is active. Allowed to be null when known to be irrelevant.

msgBundle - The bundle of translated messages, or null to use the messages from the Soy source.

cssRenamingMap - The CSS renaming map, or null if not applicable.

xidRenamingMap - The 'xid' renaming map, or null if not applicable.

Method Detail

exec

public Void exec(SoyNode node)

Description copied from interface: NodeVisitor

Executes the function defined by this visitor.

Specified by:

exec in interface NodeVisitor<SoyNode,Void>

Overrides:

exec in class AbstractNodeVisitor<SoyNode,Void>

Parameters:

node - The node to execute the function on.

createHelperInstance

protected RenderVisitor createHelperInstance(Appendable outputBuf,
                                             SoyRecord data)

Creates a helper instance for rendering a subtemplate.

Parameters:

outputBuf - The Appendable to append the output to.

data - The template data.

Returns:

The newly created RenderVisitor instance.

visitTemplateNode

protected void visitTemplateNode(TemplateNode node)

Overrides:

visitTemplateNode in class AbstractSoyNodeVisitor<Void>

visitRawTextNode

protected void visitRawTextNode(RawTextNode node)

Overrides:

visitRawTextNode in class AbstractSoyNodeVisitor<Void>

visitMsgFallbackGroupNode

protected void visitMsgFallbackGroupNode(MsgFallbackGroupNode node)

Overrides:

visitMsgFallbackGroupNode in class AbstractSoyNodeVisitor<Void>

visitMsgHtmlTagNode

protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)

Overrides:

visitMsgHtmlTagNode in class AbstractSoyNodeVisitor<Void>

visitPrintNode

protected void visitPrintNode(PrintNode node)

Overrides:

visitPrintNode in class AbstractSoyNodeVisitor<Void>

visitLetValueNode

protected void visitLetValueNode(LetValueNode node)

Overrides:

visitLetValueNode in class AbstractSoyNodeVisitor<Void>

visitLetContentNode

protected void visitLetContentNode(LetContentNode node)

Overrides:

visitLetContentNode in class AbstractSoyNodeVisitor<Void>

visitIfNode

protected void visitIfNode(IfNode node)

Overrides:

visitIfNode in class AbstractSoyNodeVisitor<Void>

visitSwitchNode

protected void visitSwitchNode(SwitchNode node)

Overrides:

visitSwitchNode in class AbstractSoyNodeVisitor<Void>

visitForNode

protected void visitForNode(ForNode node)

Overrides:

visitForNode in class AbstractSoyNodeVisitor<Void>

visitCallBasicNode

protected void visitCallBasicNode(CallBasicNode node)

Overrides:

visitCallBasicNode in class AbstractSoyNodeVisitor<Void>

visitCallDelegateNode

protected void visitCallDelegateNode(CallDelegateNode node)

Overrides:

visitCallDelegateNode in class AbstractSoyNodeVisitor<Void>

visitCallParamNode

protected void visitCallParamNode(CallParamNode node)

Overrides:

visitCallParamNode in class AbstractSoyNodeVisitor<Void>

visitVeLogNode

protected void visitVeLogNode(VeLogNode node)

Overrides:

visitVeLogNode in class AbstractSoyNodeVisitor<Void>

visitLogNode

protected void visitLogNode(LogNode node)

Overrides:

visitLogNode in class AbstractSoyNodeVisitor<Void>

visitDebuggerNode

protected void visitDebuggerNode(DebuggerNode node)

Overrides:

visitDebuggerNode in class AbstractSoyNodeVisitor<Void>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<Void>

Parameters:

node - the visited node.