com.google.template.soy.soytree

Class RawTextNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.RawTextNode

All Implemented Interfaces:

Node, SoyNode, SoyNode.StandaloneNode

public final class RawTextNode
extends AbstractSoyNode
implements SoyNode.StandaloneNode

Node representing a contiguous raw text section.

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	RawTextNode.SourceOffsets A helper object to calculate source location offsets inside of RawTextNodes.

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
RawTextNode(int id, String rawText, SourceLocation sourceLocation)
RawTextNode(int id, String rawText, SourceLocation sourceLocation, HtmlContext htmlContext)
RawTextNode(int id, String rawText, SourceLocation sourceLocation, RawTextNode.SourceOffsets offsets)

Method Summary

Modifier and Type	Method and Description
static RawTextNode	concat(List<RawTextNode> nodes) Concatenates the non-empty set of RawTextNodes, preserving source location information.
RawTextNode	copy(CopyState copyState) Copies this node.
HtmlContext	getHtmlContext() Gets the HTML source context (typically tag, attribute value, HTML PCDATA, or plain text) which this node emits in.
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
SoyNode.ParentSoyNode<SoyNode.StandaloneNode>	getParent() Gets this node's parent.
String	getRawText() Returns the raw text string (after processing of special chars and literal blocks).
boolean	isEmpty()
SourceLocation.Point	locationOf(int i)
boolean	missingWhitespaceAt(int index) Returns true if there was whitespace deleted immediately prior to index
void	setHtmlContext(HtmlContext value)
RawTextNode	substring(int newId, int start) Returns a new RawTextNode that represents the given String.substring(int) of this raw text node.
RawTextNode	substring(int newId, int start, int end) Returns a new RawTextNode that represents the given String.substring(int, int) of this raw text node.
SourceLocation	substringLocation(int start, int end) Returns the source location of the given substring.
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, 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.Node

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

Constructor Detail

RawTextNode

public RawTextNode(int id,
                   String rawText,
                   SourceLocation sourceLocation)

Parameters:

id - The id for this node.

rawText - The raw text string.

sourceLocation - The node's source location.

RawTextNode

public RawTextNode(int id,
                   String rawText,
                   SourceLocation sourceLocation,
                   HtmlContext htmlContext)

RawTextNode

public RawTextNode(int id,
                   String rawText,
                   SourceLocation sourceLocation,
                   RawTextNode.SourceOffsets offsets)

Method Detail

getHtmlContext

public HtmlContext getHtmlContext()

Gets the HTML source context (typically tag, attribute value, HTML PCDATA, or plain text) which this node emits in. This is used for incremental DOM codegen.

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

setHtmlContext

public void setHtmlContext(HtmlContext value)

getRawText

public String getRawText()

Returns the raw text string (after processing of special chars and literal blocks).

isEmpty

public boolean isEmpty()

missingWhitespaceAt

public boolean missingWhitespaceAt(int index)

Returns true if there was whitespace deleted immediately prior to index

Parameters:

index - the index in the raw text, this value should be in the range [0, rawText.length()] if rawText.length() is passed, then this is equivalent to asking if there is trailing whitespace missing.

Returns:

true if whitespace was dropped

Throws:

IndexOutOfBoundsException - if index is out of range.

locationOf

public SourceLocation.Point locationOf(int i)

substringLocation

public SourceLocation substringLocation(int start,
                                        int end)

Returns the source location of the given substring.

substring

public RawTextNode substring(int newId,
                             int start)

Returns a new RawTextNode that represents the given String.substring(int) of this raw text node.

Unlike String.substring(int) the range must be non-empty

Parameters:

newId - the new node id to use

start - the start location

substring

public RawTextNode substring(int newId,
                             int start,
                             int end)

Returns a new RawTextNode that represents the given String.substring(int, int) of this raw text node.

Unlike String.substring(int, int) the range must be non-empty

Parameters:

newId - the new node id to use

start - the start location

end - the end location

concat

public static RawTextNode concat(List<RawTextNode> nodes)

Concatenates the non-empty set of RawTextNodes, preserving source location information.

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.

getParent

public SoyNode.ParentSoyNode<SoyNode.StandaloneNode> 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.

copy

public RawTextNode 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.