com.google.template.soy.soytree

Class CallNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractCommandNode

com.google.template.soy.soytree.AbstractParentCommandNode<CallParamNode>

com.google.template.soy.soytree.CallNode

All Implemented Interfaces:

Node, ParentNode<CallParamNode>, SoyNode, SoyNode.CommandNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode, SoyNode.ParentSoyNode<CallParamNode>, SoyNode.SplitLevelTopNode<CallParamNode>, SoyNode.StandaloneNode, SoyNode.StatementNode

Direct Known Subclasses:

CallBasicNode, CallDelegateNode

public abstract class CallNode
extends AbstractParentCommandNode<CallParamNode>
implements SoyNode.StandaloneNode, SoyNode.SplitLevelTopNode<CallParamNode>, SoyNode.StatementNode, SoyNode.ExprHolderNode, SoyNode.MsgPlaceholderInitialNode

Node representing a call.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CallNode.CommandTextInfo Private helper class used by constructors.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALLBACK_BASE_PLACEHOLDER_NAME Fallback base placeholder name.

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

SPACES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CallNode(CallNode orig) Copy constructor.
protected	CallNode(int id, String commandName, CallNode.CommandTextInfo commandTextInfo, com.google.common.collect.ImmutableList<String> escapingDirectiveNames) Protected constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
String	genBasePhName() Generates the base placeholder name for this node.
Object	genSamenessKey() Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.
List<ExprUnion>	getAllExprUnions() Returns the list of expressions in this node.
ExprRootNode<?>	getDataExpr() Returns the expression for the data to pass, or null if not applicable.
com.google.common.collect.ImmutableList<String>	getEscapingDirectiveNames() Returns the escaping directives, applied from left to right.
Collection<TemplateParam>	getParamsToRuntimeCheck(TemplateNode callee) Returns the subset of params of the callee that require runtime type checking when this node is being rendered.
SoyNode.BlockNode	getParent() Gets this node's parent.
String	getTagString() Builds a Soy tag string that could be the Soy tag for this node.
String	getUserSuppliedPhName() Gets the user-supplied placeholder name, or null if not supplied or not applicable.
boolean	isPassingAllData() Returns whether we're passing all of the data (i.e.
boolean	isPassingData() Returns whether we're passing any part of the data (i.e.
protected static Pair<Boolean,ExprRootNode<?>>	parseDataAttributeHelper(String dataAttr, ErrorReporter errorReporter) Private helper function for subclass constructors to parse the 'data' attribute.
void	setEscapingDirectiveNames(com.google.common.collect.ImmutableList<String> escapingDirectiveNames) Sets the inferred escaping directives.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

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

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

buildTagStringHelper, buildTagStringHelper, getCommandName, getCommandText

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

clone, getId, getSourceLocation, setId, setSourceLocation, toString

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

couldHaveSyntaxVersionAtLeast, getNearestAncestor, getSyntaxVersionBound, hasAncestor, maybeSetSyntaxVersionBound, setParent

Methods inherited from class java.lang.Object

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

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

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

Field Detail

FALLBACK_BASE_PLACEHOLDER_NAME

public static final String FALLBACK_BASE_PLACEHOLDER_NAME

Fallback base placeholder name.

See Also:

Constant Field Values

Constructor Detail

CallNode

protected CallNode(int id,
                   String commandName,
                   CallNode.CommandTextInfo commandTextInfo,
                   com.google.common.collect.ImmutableList<String> escapingDirectiveNames)

Protected constructor for use by subclasses.

Parameters:

id - The id for this node.

commandTextInfo - All the info derived from the command text.

escapingDirectiveNames - Call-site escaping directives used by strict autoescaping. This is inferred by the autoescaper and not part of the syntax, and thus is not in the CommandTextInfo.

CallNode

protected CallNode(CallNode orig)

Copy constructor.

Parameters:

orig - The node to copy.

Method Detail

parseDataAttributeHelper

protected static Pair<Boolean,ExprRootNode<?>> parseDataAttributeHelper(String dataAttr,
                                                                        ErrorReporter errorReporter)

Private helper function for subclass constructors to parse the 'data' attribute.

Parameters:

dataAttr - The 'data' attribute in a call.

errorReporter - For reporting syntax errors.

Returns:

A pair (isPassingData, dataExpr) where dataExpr may be null.

isPassingData

public boolean isPassingData()

Returns whether we're passing any part of the data (i.e. has 'data' attribute).

isPassingAllData

public boolean isPassingAllData()

Returns whether we're passing all of the data (i.e. data="all").

getDataExpr

@Nullable
public ExprRootNode<?> getDataExpr()

Returns the expression for the data to pass, or null if not applicable.

getUserSuppliedPhName

public String getUserSuppliedPhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Gets the user-supplied placeholder name, or null if not supplied or not applicable. Note that this raw name can be any identifier (not necessarily in upper-underscore format).

Specified by:

getUserSuppliedPhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The user-supplied placeholder name, or null if not supplied or not applicable.

getTagString

public String getTagString()

Description copied from interface: SoyNode.CommandNode

Builds 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.

Specified by:

getTagString in interface SoyNode.CommandNode

Overrides:

getTagString in class AbstractCommandNode

Returns:

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

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) 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

Overrides:

toSourceString in class AbstractParentCommandNode<CallParamNode>

Returns:

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

getAllExprUnions

public List<ExprUnion> getAllExprUnions()

Description copied from interface: SoyNode.ExprHolderNode

Returns the list of expressions in this node.

Specified by:

getAllExprUnions in interface SoyNode.ExprHolderNode

genBasePhName

public String genBasePhName()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the base placeholder name for this node.

Specified by:

genBasePhName in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The base placeholder name for this node.

genSamenessKey

public Object genSamenessKey()

Description copied from interface: SoyNode.MsgPlaceholderInitialNode

Generates the key object used in comparisons to determine whether two placeholder nodes should be represented by the same placeholder.

Specified by:

genSamenessKey in interface SoyNode.MsgPlaceholderInitialNode

Returns:

The key object for determining whether this node and another node should be represented by the same placeholder.

getParent

public SoyNode.BlockNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Specified by:

getParent in interface SoyNode.StandaloneNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

getParamsToRuntimeCheck

public Collection<TemplateParam> getParamsToRuntimeCheck(TemplateNode callee)

Returns the subset of params of the callee that require runtime type checking when this node is being rendered.

setEscapingDirectiveNames

public void setEscapingDirectiveNames(com.google.common.collect.ImmutableList<String> escapingDirectiveNames)

Sets the inferred escaping directives.

getEscapingDirectiveNames

public com.google.common.collect.ImmutableList<String> getEscapingDirectiveNames()

Returns the escaping directives, applied from left to right. It is an error to call this before the contextual rewriter has been run.