com.google.template.soy.passes

Class BuildAllDependeesMapVisitor

java.lang.Object

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

com.google.template.soy.soytree.AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

com.google.template.soy.passes.BuildAllDependeesMapVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,Map<SoyNode,List<SoyNode>>>

public final class BuildAllDependeesMapVisitor
extends AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

Visitor for building a map from each node to its list of dependees (ordered by nearest dependee first). The map built by this visitor is useful in optimization passes that move nodes within the tree. In the context of this pass, a dependee is a node that appears earlier in the depth-first traversal, and must remain in the same traversal relationship with the depender after any modifications to the tree, in order to preserve correctness.

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

exec(com.google.template.soy.soytree.SoyNode) must be called on a TemplateNode or an ancestor of a TemplateNode.

More specifically, a dependee may be an ancestor of the depender or an older sibling of either the depender or an ancestor of the depender. In the case of a dependee that is an ancestor of the depender, the depender must not be moved outside of the subtree of the dependee. In the case of a dependee that is an older sibling of either the depender or an ancestor of the depender, this same relationship must be maintained when the depender is moved within the tree.

Dependees are one of: (a) TemplateNode: Its nodes must remain in its subtree. (b) SplitLevelTopNode: Its immediate children (the bottom level) must remain under it. (c) ConditionalBlockNode other than LoopNode: It may never be executed, and we can't guarantee that any of the references made in a node's subtree will be defined in the case that the block is not executed, and furthermore, even if the node's subtree has no references, we don't want to needlessly process the node's subtree when the block is not executed. We make an exception for LoopNodes because we don't want to lose the ability to pull invariants out of loops. (d) LocalVarNode: Its subtree or younger siblings may reference its local variable. (e) MsgBlockNode: Any change to its immediate children would change the message to be translated, which would be incorrect.

Constructor Summary

Constructors

Constructor and Description
BuildAllDependeesMapVisitor()

Method Summary

Modifier and Type	Method and Description
Map<SoyNode,List<SoyNode>>	exec(SoyNode node) Executes the function defined by this visitor.
protected void	visitLetNode(LetNode node)
protected void	visitSoyFileNode(SoyFileNode node)
protected void	visitSoyFileSetNode(SoyFileSetNode node)
protected void	visitSoyNode(SoyNode node)
protected void	visitTemplateNode(TemplateNode node)

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

visit, visitCallBasicNode, visitCallDelegateNode, visitCallNode, visitCallParamContentNode, visitCallParamNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitDebuggerNode, visitForeachIfemptyNode, visitForeachNode, visitForeachNonemptyNode, visitHtmlAttributeNode, visitHtmlAttributeValueNode, visitHtmlCloseTagNode, visitHtmlCommentNode, visitHtmlOpenTagNode, visitIfCondNode, visitIfElseNode, visitIfNode, visitLetContentNode, visitLetValueNode, visitLogNode, visitLoopNode, visitMsgFallbackGroupNode, visitMsgHtmlTagNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitPrintNode, visitRawTextNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitSwitchNode, visitTemplateBasicNode, visitTemplateDelegateNode, visitVeLogNode

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

Constructor Detail

BuildAllDependeesMapVisitor

public BuildAllDependeesMapVisitor()

Method Detail

exec

public Map<SoyNode,List<SoyNode>> exec(SoyNode node)

Description copied from interface: NodeVisitor

Executes the function defined by this visitor.

Specified by:

exec in interface NodeVisitor<SoyNode,Map<SoyNode,List<SoyNode>>>

Overrides:

exec in class AbstractNodeVisitor<SoyNode,Map<SoyNode,List<SoyNode>>>

Parameters:

node - The node to execute the function on.

visitSoyFileSetNode

protected void visitSoyFileSetNode(SoyFileSetNode node)

Overrides:

visitSoyFileSetNode in class AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

visitSoyFileNode

protected void visitSoyFileNode(SoyFileNode node)

Overrides:

visitSoyFileNode in class AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

visitTemplateNode

protected void visitTemplateNode(TemplateNode node)

Overrides:

visitTemplateNode in class AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

visitLetNode

protected void visitLetNode(LetNode node)

Overrides:

visitLetNode in class AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<Map<SoyNode,List<SoyNode>>>

Parameters:

node - the visited node.