com.google.template.soy.msgs.internal

Class InsertMsgsVisitor

java.lang.Object

com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>

com.google.template.soy.soytree.AbstractSoyNodeVisitor<Void>

com.google.template.soy.msgs.internal.InsertMsgsVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,Void>

public final class InsertMsgsVisitor
extends AbstractSoyNodeVisitor<Void>

Visitor for inserting translated messages into Soy tree. This pass replaces the MsgFallbackGroupNodes in the tree with sequences of RawTextNodes and other nodes. The only exception is plural/select messages. This pass currently does not replace MsgFallbackGroupNodes that contain plural/select messages.

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

If the Soy tree doesn't contain plural/select messages, then after this pass, the Soy tree should no longer contain MsgFallbackGroupNodes, MsgNodes, MsgPlaceholderNodes, or MsgHtmlTagNodes. If the Soy tree contains plural/select messages, then the only messages left in the tree after this pass runs should be the plural/select messages.

Note that the Soy tree is usually simplifiable after this pass is run (e.g. it usually contains consecutive RawTextNodes). It's usually advisable to run a simplification pass after this pass.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InsertMsgsVisitor.EncounteredPlrselMsgException Exception thrown when a plural or select message is encountered.

Field Summary

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

errorReporter

Constructor Summary

Constructors

Constructor and Description
InsertMsgsVisitor(SoyMsgBundle msgBundle, boolean dontErrorOnPlrselMsgs, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
Void	exec(SoyNode node) Executes the function defined by this visitor.
protected void	visitMsgFallbackGroupNode(MsgFallbackGroupNode node)
protected void	visitMsgHtmlTagNode(MsgHtmlTagNode node)
protected void	visitSoyNode(SoyNode node)

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

visit, visitCallBasicNode, visitCallDelegateNode, visitCallNode, visitCallParamContentNode, visitCallParamNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitCssNode, visitDebuggerNode, visitForeachIfemptyNode, visitForeachNode, visitForeachNonemptyNode, visitForNode, visitGoogMsgDefNode, visitGoogMsgRefNode, visitIfCondNode, visitIfElseNode, visitIfNode, visitLetContentNode, visitLetNode, visitLetValueNode, visitLogNode, visitLoopNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgPluralRemainderNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitPrintNode, visitRawTextNode, visitSoyFileNode, visitSoyFileSetNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitSwitchNode, visitTemplateBasicNode, visitTemplateDelegateNode, visitTemplateNode, visitXidNode

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

visitChildren, visitChildrenAllowingConcurrentModification

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertMsgsVisitor

public InsertMsgsVisitor(@Nullable
                         SoyMsgBundle msgBundle,
                         boolean dontErrorOnPlrselMsgs,
                         ErrorReporter errorReporter)

Parameters:

msgBundle - The bundle of translated messages, or null to use the messages from the Soy source.

dontErrorOnPlrselMsgs - If set to true, then this pass won't report an error when encountering a plural or select message. Instead, plural and select messages will simply not be replaced (MsgNode left in the tree as-is). If set to false, then this pass will throw an InsertMsgsVisitor.EncounteredPlrselMsgException when encountering a plural or select message.

Method Detail

exec

public Void exec(SoyNode node)

Description copied from interface: NodeVisitor

Executes the function defined by this visitor.

Specified by:

exec in interface NodeVisitor<SoyNode,Void>

Overrides:

exec in class AbstractNodeVisitor<SoyNode,Void>

Parameters:

node - The node to execute the function on.

visitMsgFallbackGroupNode

protected void visitMsgFallbackGroupNode(MsgFallbackGroupNode node)

Overrides:

visitMsgFallbackGroupNode in class AbstractSoyNodeVisitor<Void>

visitMsgHtmlTagNode

protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)

Overrides:

visitMsgHtmlTagNode in class AbstractSoyNodeVisitor<Void>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<Void>

Parameters:

node - the visited node.