com.google.template.soy.soytree

Class MsgNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.MsgNode

All Implemented Interfaces:

Node, ParentNode<SoyNode.StandaloneNode>, SoyNode, SoyNode.BlockCommandNode, SoyNode.BlockNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgBlockNode, SoyNode.ParentSoyNode<SoyNode.StandaloneNode>

public final class MsgNode
extends AbstractSoyNode
implements SoyNode.ExprHolderNode, SoyNode.MsgBlockNode

Node representing a 'msg' block. Every child must be a RawTextNode, MsgPlaceholderNode, MsgPluralNode, or MsgSelectNode.

The AST will be one of the following

• A single RawTextNode
• A mix of RawTextNode and MsgPlaceholderNode
• A single MsgPluralNode
• A single MsgSelectNode

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsgNode.PlaceholderInfo

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

Constructor Summary

Constructors

Constructor and Description
MsgNode(int id, SourceLocation location, String commandName, List<CommandTagAttribute> attributes, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
void	addChild(int index, N child) Adds the given child at the given index (shifting existing children if necessary).
void	addChild(N child) Adds the given child.
void	addChildren(int index, List<? extends N> children) Adds the given children at the given index (shifting existing children if necessary).
void	addChildren(List<? extends N> children) Adds the given children.
void	appendSourceStringForChildren(StringBuilder sb) Appends the source strings for all the children to the given StringBuilder.
void	calculateSubstitutionInfo(ErrorReporter reporter)
void	clearChildren() Clears the list of children.
MsgNode	copy(CopyState copyState) Copies this node.
void	ensureSubstUnitInfoHasNotBeenAccessed() This class lazily allocates some datastructures for accessing data about nested placeholders.
List<ExprRootNode>	getAndRemoveGenderExprs() Returns the list of expressions for gender values and sets that field to null.
N	getChild(int index) Gets the child at the given index.
int	getChildIndex(Node child) Finds the index of the given child.
List<N>	getChildren() Gets the list of children.
String	getCommandName() Returns the Soy command name.
String	getCommandText() Returns the command text (may be the empty string).
String	getContentType() Returns the content type for the TC.
String	getDesc() Returns the description string for translators.
com.google.common.collect.ImmutableList<ExprRootNode>	getExprList() Returns the list of expressions in this node.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getMeaning() Returns the meaning string if set, otherwise null (usually null).
MsgNode.PlaceholderInfo	getPlaceholder(MsgPlaceholderNode placeholderNode) Gets the placeholder name for a given placeholder node.
String	getPluralVarName(MsgPluralNode pluralNode) Gets the variable name associated with a given plural node.
MsgPlaceholderNode	getRepPlaceholderNode(String placeholderName) Gets the representative placeholder node for a given placeholder name.
MsgPluralNode	getRepPluralNode(String pluralVarName) Gets the representative plural node for a given plural variable name.
MsgSelectNode	getRepSelectNode(String selectVarName) Gets the representative select node for a given select variable name.
String	getSelectVarName(MsgSelectNode selectNode) Gets the variable name associated with a given select node.
protected String	getTagString()
protected String	getTagString(boolean selfEnding)
com.google.common.collect.ImmutableMap<String,SoyNode.MsgSubstUnitNode>	getVarNameToRepNodeMap() Getter for the generated map from substitution unit var name to representative node.
boolean	isHidden() Returns whether the message should be added as 'hidden' in the TC.
boolean	isPlrselMsg() Returns whether this is a plural or select message.
boolean	isPluralMsg() Returns whether this is a plural message.
boolean	isRawTextMsg() Returns whether this is a raw text message.
boolean	isSelectMsg() Returns whether this is a select message.
int	numChildren() Gets the number of children.
void	removeChild(int index) Removes the child at the given index.
void	removeChild(N child) Removes the given child.
void	replaceChild(int index, N newChild) Replaces the child at the given index with the given new child.
void	replaceChild(N currChild, N 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.AbstractSoyNode

getId, getParent, 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

getId, setId

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

addChild, addChild, addChildren, addChildren, appendSourceStringForChildren, clearChildren, getChild, getChildIndex, getChildren, numChildren, removeChild, removeChild, replaceChild, replaceChild

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

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

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

getCommandName

Constructor Detail

MsgNode

public MsgNode(int id,
               SourceLocation location,
               String commandName,
               List<CommandTagAttribute> attributes,
               ErrorReporter errorReporter)

Method Detail

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

getAndRemoveGenderExprs

@Nullable
public List<ExprRootNode> getAndRemoveGenderExprs()

Returns the list of expressions for gender values and sets that field to null.

Note that this node's command text will still contain the substring genders="...". We think this is okay since the command text is only used for reporting errors (in fact, it might be good as a reminder of how the msg was originally written).

calculateSubstitutionInfo

public void calculateSubstitutionInfo(ErrorReporter reporter)

getExprList

public com.google.common.collect.ImmutableList<ExprRootNode> getExprList()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getExprList in interface SoyNode.ExprHolderNode

getMeaning

@Nullable
public String getMeaning()

Returns the meaning string if set, otherwise null (usually null).

getDesc

public String getDesc()

Returns the description string for translators.

isHidden

public boolean isHidden()

Returns whether the message should be added as 'hidden' in the TC.

getContentType

public String getContentType()

Returns the content type for the TC.

isPlrselMsg

public boolean isPlrselMsg()

Returns whether this is a plural or select message.

isSelectMsg

public boolean isSelectMsg()

Returns whether this is a select message.

isPluralMsg

public boolean isPluralMsg()

Returns whether this is a plural message.

isRawTextMsg

public boolean isRawTextMsg()

Returns whether this is a raw text message.

ensureSubstUnitInfoHasNotBeenAccessed

public void ensureSubstUnitInfoHasNotBeenAccessed()

This class lazily allocates some datastructures for accessing data about nested placeholders. This method ensures that generation and access to that data structure hasn't happened yet. This is important if passes are adding new placeholder nodes.

getRepPlaceholderNode

public MsgPlaceholderNode getRepPlaceholderNode(String placeholderName)

Gets the representative placeholder node for a given placeholder name.

Parameters:

placeholderName - The placeholder name.

Returns:

The representative placeholder node for the given placeholder name.

getPlaceholder

public MsgNode.PlaceholderInfo getPlaceholder(MsgPlaceholderNode placeholderNode)

Gets the placeholder name for a given placeholder node.

Parameters:

placeholderNode - The placeholder node.

Returns:

The placeholder name for the given placeholder node.

getRepPluralNode

public MsgPluralNode getRepPluralNode(String pluralVarName)

Gets the representative plural node for a given plural variable name.

Parameters:

pluralVarName - The plural variable name.

Returns:

The representative plural node for the given plural variable name.

getPluralVarName

public String getPluralVarName(MsgPluralNode pluralNode)

Gets the variable name associated with a given plural node.

Parameters:

pluralNode - The plural node.

Returns:

The plural variable name for the given plural node.

getRepSelectNode

public MsgSelectNode getRepSelectNode(String selectVarName)

Gets the representative select node for a given select variable name.

Parameters:

selectVarName - The select variable name.

Returns:

The representative select node for the given select variable name.

getSelectVarName

public String getSelectVarName(MsgSelectNode selectNode)

Gets the variable name associated with a given select node.

Parameters:

selectNode - The select node.

Returns:

The select variable name for the given select node.

getVarNameToRepNodeMap

public com.google.common.collect.ImmutableMap<String,SoyNode.MsgSubstUnitNode> getVarNameToRepNodeMap()

Getter for the generated map from substitution unit var name to representative node.

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 MsgNode 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<N extends SoyNode>

Returns:

The number of children.

getChild

public N getChild(int index)

Description copied from interface: ParentNode

Gets the child at the given index.

Specified by:

getChild in interface ParentNode<N extends SoyNode>

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<N extends SoyNode>

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<N> 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<N extends SoyNode>

Returns:

The list of children.

addChild

public void addChild(N child)

Description copied from interface: ParentNode

Adds the given child.

Specified by:

addChild in interface ParentNode<N extends SoyNode>

Parameters:

child - The child to add.

addChild

public void addChild(int index,
                     N 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<N extends SoyNode>

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<N extends SoyNode>

Parameters:

index - The index of the child to remove.

removeChild

public void removeChild(N child)

Description copied from interface: ParentNode

Removes the given child.

Specified by:

removeChild in interface ParentNode<N extends SoyNode>

Parameters:

child - The child to remove.

replaceChild

public void replaceChild(int index,
                         N newChild)

Description copied from interface: ParentNode

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

Specified by:

replaceChild in interface ParentNode<N extends SoyNode>

Parameters:

index - The index of the child to replace.

newChild - The new child.

replaceChild

public void replaceChild(N currChild,
                         N newChild)

Description copied from interface: ParentNode

Replaces the given current child with the given new child.

Specified by:

replaceChild in interface ParentNode<N extends SoyNode>

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<N extends SoyNode>

addChildren

public void addChildren(List<? extends N> children)

Description copied from interface: ParentNode

Adds the given children.

Specified by:

addChildren in interface ParentNode<N extends SoyNode>

Parameters:

children - The children to add.

addChildren

public void addChildren(int index,
                        List<? extends N> 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<N extends SoyNode>

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<N extends SoyNode>

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)