com.google.template.soy.soytree

Class SoyFileNode

java.lang.Object

com.google.template.soy.basetree.AbstractNode

com.google.template.soy.soytree.AbstractSoyNode

com.google.template.soy.soytree.AbstractParentSoyNode<TemplateNode>

com.google.template.soy.soytree.SoyFileNode

All Implemented Interfaces:

Node, ParentNode<TemplateNode>, SoyNode, SoyNode.ParentSoyNode<TemplateNode>, SoyNode.SplitLevelTopNode<TemplateNode>

public final class SoyFileNode
extends AbstractParentSoyNode<TemplateNode>
implements SoyNode.SplitLevelTopNode<TemplateNode>

Node representing a Soy file.

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

Modifier and Type	Field and Description
static com.google.common.base.Predicate<SoyFileNode>	MATCH_SRC_FILENODE

Constructor Summary

Constructors

Constructor and Description
SoyFileNode(int id, String filePath, SoyFileKind soyFileKind, NamespaceDeclaration namespaceDeclaration, TemplateNode.SoyFileHeaderInfo headerInfo)

Method Summary

Modifier and Type	Method and Description
SoyFileNode	copy(CopyState copyState) Copies this node.
com.google.common.collect.ImmutableList<AliasDeclaration>	getAliasDeclarations() Returns the syntactic alias directives in the file.
String	getCssBaseNamespace() Returns the CSS base namespace for this file (usable in any template in this file).
String	getDelPackageName() Returns the name of the containing delegate package, or null if none.
String	getFileName() Returns this Soy file's name.
String	getFilePath() Returns the path to the source Soy file ("unknown" if not supplied).
SoyNode.Kind	getKind() Returns this node's kind (corresponding to this node's specific type).
String	getNamespace() Returns this Soy file's namespace.
NamespaceDeclaration	getNamespaceDeclaration() Returns the parsed namespace for the file.
SoyFileSetNode	getParent() Gets this node's parent.
com.google.common.collect.ImmutableList<String>	getRequiredCssNamespaces() Returns the CSS namespaces required by this file (usable in any template in this file).
SourceLocation	getSourceLocation() Deprecated. SoyFileNodes don't have source locations.
SoyFileKind	getSoyFileKind() Returns the kind of this Soy file.
String	toSourceString() Builds a Soy source string that could be the source for this node.

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

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

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

getId, 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, getSyntaxVersionUpperBound, hasAncestor, maybeSetSyntaxVersionUpperBound, setParent

Field Detail

MATCH_SRC_FILENODE

public static final com.google.common.base.Predicate<SoyFileNode> MATCH_SRC_FILENODE

Constructor Detail

SoyFileNode

public SoyFileNode(int id,
                   String filePath,
                   SoyFileKind soyFileKind,
                   NamespaceDeclaration namespaceDeclaration,
                   TemplateNode.SoyFileHeaderInfo headerInfo)

Parameters:

id - The id for this node.

filePath - The path to the Soy source file.

soyFileKind - The kind of this Soy file.

namespaceDeclaration - This Soy file's namespace and attributes. Nullable for backwards compatibility only.

headerInfo - Other file metadata, (e.g. delpackages, aliases)

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

getSoyFileKind

public SoyFileKind getSoyFileKind()

Returns the kind of this Soy file.

getDelPackageName

@Nullable
public String getDelPackageName()

Returns the name of the containing delegate package, or null if none.

getNamespace

public String getNamespace()

Returns this Soy file's namespace.

getNamespaceDeclaration

public NamespaceDeclaration getNamespaceDeclaration()

Returns the parsed namespace for the file.

getRequiredCssNamespaces

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

Returns the CSS namespaces required by this file (usable in any template in this file).

getCssBaseNamespace

@Nullable
public String getCssBaseNamespace()

Returns the CSS base namespace for this file (usable in any template in this file).

getAliasDeclarations

public com.google.common.collect.ImmutableList<AliasDeclaration> getAliasDeclarations()

Returns the syntactic alias directives in the file.

getFilePath

public String getFilePath()

Returns the path to the source Soy file ("unknown" if not supplied).

getFileName

@Nullable
public String getFileName()

Returns this Soy file's name.

getSourceLocation

@Deprecated
public SourceLocation getSourceLocation()

Deprecated. SoyFileNodes don't have source locations.

Description copied from class: AbstractSoyNode

The location in the file from which this node was parsed or derived.

This is an optional operation. Some nodes don't have source locations.

Specified by:

getSourceLocation in interface Node

Overrides:

getSourceLocation in class AbstractSoyNode

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 SoyFileSetNode getParent()

Description copied from interface: Node

Gets this node's parent.

Specified by:

getParent in interface Node

Specified by:

getParent in interface SoyNode

Overrides:

getParent in class AbstractSoyNode

Returns:

This node's parent.

copy

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