com.google.template.soy.soytree

Class LetContentNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.LetNode

com.google.template.soy.soytree.LetContentNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>, SoyNode.RenderUnitNode, SoyNode.StandaloneNode, SoyNode.StatementNode

public final class LetContentNode
extends LetNode
implements SoyNode.RenderUnitNode

Node representing a 'let' statement with content.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.soytree.SoyNode

SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ConditionalBlockNode, SoyNode.ExprHolderNode, SoyNode.Kind, SoyNode.LocalVarBlockNode, SoyNode.LocalVarInlineNode, SoyNode.LocalVarNode, SoyNode.MsgBlockNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.MsgSubstUnitNode, SoyNode.ParentSoyNode<N extends SoyNode>, SoyNode.RenderUnitNode, SoyNode.SplitLevelTopNode<N extends SoyNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Field Summary

Fields inherited from class com.google.template.soy.soytree.LetNode

var

Constructor Summary

Constructors

Constructor and Description
LetContentNode(int id, SourceLocation location, String varName, CommandTagAttribute kindAttr, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
void	addChild(int index, SoyNode.StandaloneNode child) Adds the given child at the given index (shifting existing children if necessary).
void	addChild(SoyNode.StandaloneNode child) Adds the given child.
void	addChildren(int index, List<? extends SoyNode.StandaloneNode> children) Adds the given children at the given index (shifting existing children if necessary).
void	addChildren(List<? extends SoyNode.StandaloneNode> children) Adds the given children.
void	appendSourceStringForChildren(StringBuilder sb) Appends the source strings for all the children to the given StringBuilder.
void	clearChildren() Clears the list of children.
LetContentNode	copy(CopyState copyState) Copies this node.
static LetContentNode	forVariable(int id, SourceLocation sourceLocation, String varName, SanitizedContentKind contentKind) Creates a LetContentNode for a compiler-generated variable.
SoyNode.StandaloneNode	getChild(int index) Gets the child at the given index.
int	getChildIndex(Node child) Finds the index of the given child.
List<SoyNode.StandaloneNode>	getChildren() Gets the list of children.
String	getCommandName() Returns the Soy command name.
String	getCommandText() Returns the command text (may be the empty string).
SanitizedContentKind	getContentKind() Returns the content kind for strict autoescape, or null if not specified or not applicable.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
protected String	getTagString()
protected String	getTagString(boolean selfEnding)
int	numChildren() Gets the number of children.
void	removeChild(int index) Removes the child at the given index.
void	removeChild(SoyNode.StandaloneNode child) Removes the given child.
void	replaceChild(int index, SoyNode.StandaloneNode newChild) Replaces the child at the given index with the given new child.
void	replaceChild(SoyNode.StandaloneNode currChild, SoyNode.StandaloneNode newChild) Replaces the given current child with the given new child.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

getParent, getUniqueVarName, getVar, getVarName

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

getId, getSourceLocation, setId, toString

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

couldHaveSyntaxVersionAtLeast, equals, getNearestAncestor, getSyntaxVersionUpperBound, hasAncestor, hashCode, maybeSetSyntaxVersionUpperBound, setParent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.template.soy.soytree.SoyNode.CommandNode

getCommandName

Methods inherited from interface com.google.template.soy.soytree.SoyNode

getId, getParent, setId

Methods inherited from interface com.google.template.soy.basetree.Node

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSourceLocation, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Constructor Detail

LetContentNode

public LetContentNode(int id,
                      SourceLocation location,
                      String varName,
                      @Nullable
                      CommandTagAttribute kindAttr,
                      ErrorReporter errorReporter)

Method Detail

forVariable

public static LetContentNode forVariable(int id,
                                         SourceLocation sourceLocation,
                                         String varName,
                                         @Nullable
                                         SanitizedContentKind contentKind)

Creates a LetContentNode for a compiler-generated variable. Use this in passes that rewrite the tree and introduce local temporary variables.

getKind

public SoyNode.Kind getKind()

Description copied from interface: SoyNode

Returns this node's kind (corresponding to this node's specific type).

Specified by:

getKind in interface SoyNode

getContentKind

@Nullable
public SanitizedContentKind getContentKind()

Description copied from interface: SoyNode.RenderUnitNode

Returns the content kind for strict autoescape, or null if not specified or not applicable.

Specified by:

getContentKind in interface SoyNode.RenderUnitNode

getCommandText

public String getCommandText()

Description copied from interface: SoyNode.CommandNode

Returns the command text (may be the empty string).

Specified by:

getCommandText in interface SoyNode.CommandNode

toSourceString

public String toSourceString()

Description copied from interface: Node

Builds a Soy source string that could be the source for this node. Note that this is not the actual original source string, but a (SORT OF, NOT QUITE) canonical equivalent.

Note: Some nodes do not have a direct mapping to Soy source (such as nodes created during some optimization passes). Thus this method may not always be supported.

Specified by:

toSourceString in interface Node

Returns:

A Soy string that could be the source for this node.

copy

public LetContentNode copy(CopyState copyState)

Description copied from interface: SoyNode

Copies this node. The copy's parent pointer is set to null.

All copy() overrides should follow this contract:

• only leaf classes (in the class hierarchy) should have non-abstract clone methods
• all leaf classes should be final
• all leaf copy constructors should be private
• all clone methods should look exactly like:

  
   {@literal @}Override public T copy(CopyState copyState) {
     return new T(this, copyState);
   }
   

• all non-leaf copy constructors should be protected

TODO(lukes): The usecases for a copy method are few and far between. Making the AST nodes immutable (or at least unmodifiable) would be preferable to maintaining our copy() methods.

Don't clone nodes unless you know what you're doing. The Soy AST is not actually a tree (it contains back edges from variables to their definitions), and naively copying nodes can result in pointers into stale ASTs

The copied nodes will have the same ids as the original nodes. If you need to copy a subtree with new ids assigned to the copied nodes, use SoyTreeUtils.cloneWithNewIds(T, com.google.template.soy.base.internal.IdGenerator).

Specified by:

copy in interface Node

Specified by:

copy in interface SoyNode

Returns:

A clone of this code.

numChildren

public int numChildren()

Description copied from interface: ParentNode

Gets the number of children.

Specified by:

numChildren in interface ParentNode<SoyNode.StandaloneNode>

Returns:

The number of children.

getChild

public SoyNode.StandaloneNode getChild(int index)

Description copied from interface: ParentNode

Gets the child at the given index.

Specified by:

getChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

index - The index of the child to get.

Returns:

The child at the given index.

getChildIndex

public int getChildIndex(Node child)

Description copied from interface: ParentNode

Finds the index of the given child.

Specified by:

getChildIndex in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

child - The child to find the index of.

Returns:

The index of the given child, or -1 if the given child is not a child of this node.

getChildren

public List<SoyNode.StandaloneNode> getChildren()

Description copied from interface: ParentNode

Gets the list of children.

Note: The returned list may not be a copy. Please do not modify the list directly. Instead, use the other methods in this class that are intended for modifying children. Also, if you're iterating over the children list as you're modifying it, then you should first make a copy of the children list to iterate over, in order to avoid ConcurrentModificationException.

Specified by:

getChildren in interface ParentNode<SoyNode.StandaloneNode>

Returns:

The list of children.

addChild

public void addChild(SoyNode.StandaloneNode child)

Description copied from interface: ParentNode

Adds the given child.

Specified by:

addChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

child - The child to add.

addChild

public void addChild(int index,
                     SoyNode.StandaloneNode child)

Description copied from interface: ParentNode

Adds the given child at the given index (shifting existing children if necessary).

Specified by:

addChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

index - The index to add the child at.

child - The child to add.

removeChild

public void removeChild(int index)

Description copied from interface: ParentNode

Removes the child at the given index.

Specified by:

removeChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

index - The index of the child to remove.

removeChild

public void removeChild(SoyNode.StandaloneNode child)

Description copied from interface: ParentNode

Removes the given child.

Specified by:

removeChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

child - The child to remove.

replaceChild

public void replaceChild(int index,
                         SoyNode.StandaloneNode newChild)

Description copied from interface: ParentNode

Replaces the child at the given index with the given new child.

Specified by:

replaceChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

index - The index of the child to replace.

newChild - The new child.

replaceChild

public void replaceChild(SoyNode.StandaloneNode currChild,
                         SoyNode.StandaloneNode newChild)

Description copied from interface: ParentNode

Replaces the given current child with the given new child.

Specified by:

replaceChild in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

currChild - The current child to be replaced.

newChild - The new child.

clearChildren

public void clearChildren()

Description copied from interface: ParentNode

Clears the list of children.

Specified by:

clearChildren in interface ParentNode<SoyNode.StandaloneNode>

addChildren

public void addChildren(List<? extends SoyNode.StandaloneNode> children)

Description copied from interface: ParentNode

Adds the given children.

Specified by:

addChildren in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

children - The children to add.

addChildren

public void addChildren(int index,
                        List<? extends SoyNode.StandaloneNode> children)

Description copied from interface: ParentNode

Adds the given children at the given index (shifting existing children if necessary).

Specified by:

addChildren in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

index - The index to add the children at.

children - The children to add.

appendSourceStringForChildren

public void appendSourceStringForChildren(StringBuilder sb)

Description copied from interface: ParentNode

Appends the source strings for all the children to the given StringBuilder.

Specified by:

appendSourceStringForChildren in interface ParentNode<SoyNode.StandaloneNode>

Parameters:

sb - The StringBuilder to which to append the children's source strings.

getCommandName

public String getCommandName()

Description copied from interface: SoyNode.CommandNode

Returns the Soy command name.

Specified by:

getCommandName in interface SoyNode.CommandNode

getTagString

protected String getTagString()

Returns:

A Soy tag string that could be the Soy tag for this node. Note that this may not necessarily be the actual original Soy tag, but a (sort of) canonical equivalent.

getTagString

protected final String getTagString(boolean selfEnding)