com.google.template.soy.jssrc.internal

Class GenJsCodeVisitorAssistantForMsgs

java.lang.Object

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

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

com.google.template.soy.jssrc.internal.GenJsCodeVisitorAssistantForMsgs

All Implemented Interfaces:

NodeVisitor<SoyNode,Void>

public class GenJsCodeVisitorAssistantForMsgs
extends AbstractSoyNodeVisitor<Void>

Assistant visitor for GenJsCodeVisitor to handle messages.

Precondition: MsgNode should not exist in the tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected GenJsCodeVisitor	master Master instance of GenJsCodeVisitor.
protected TranslationContext	translationContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenJsCodeVisitorAssistantForMsgs(GenJsCodeVisitor master, SoyJsSrcOptions jsSrcOptions, JsExprTranslator jsExprTranslator, GenCallCodeUtils genCallCodeUtils, IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor, TemplateAliases functionAliases, GenJsExprsVisitor genJsExprsVisitor, TranslationContext translationContext, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method and Description
Void	exec(SoyNode node) Executes the function defined by this visitor.
String	generateMsgGroupVariable(MsgFallbackGroupNode node) Generates Javascript statements that declare a translated variable, returning the variable name for the caller to output (as an expression).
protected CodeChunk.WithValue	genGoogMsgPlaceholder(MsgPlaceholderNode msgPhNode) Returns a code chunk for the given placeholder node.
protected JsCodeBuilder	jsCodeBuilder() The JsCodeBuilder to build the current JS file being generated (during a run).
protected void	visitMsgHtmlTagNode(MsgHtmlTagNode node) Example:
protected void	visitSoyNode(SoyNode node)

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

visit, visitCallBasicNode, visitCallDelegateNode, visitCallNode, visitCallParamContentNode, visitCallParamNode, visitCallParamValueNode, visitChildren, visitChildrenAllowingConcurrentModification, visitDebuggerNode, visitForeachIfemptyNode, visitForeachNode, visitForeachNonemptyNode, visitHtmlAttributeNode, visitHtmlAttributeValueNode, visitHtmlCloseTagNode, visitHtmlCommentNode, visitHtmlOpenTagNode, visitIfCondNode, visitIfElseNode, visitIfNode, visitLetContentNode, visitLetNode, visitLetValueNode, visitLogNode, visitLoopNode, visitMsgFallbackGroupNode, visitMsgNode, visitMsgPlaceholderNode, visitMsgPluralCaseNode, visitMsgPluralDefaultNode, visitMsgPluralNode, visitMsgSelectCaseNode, visitMsgSelectDefaultNode, visitMsgSelectNode, visitMsgSubstUnitNode, visitPrintDirectiveNode, visitPrintNode, visitRawTextNode, visitSoyFileNode, visitSoyFileSetNode, visitSwitchCaseNode, visitSwitchDefaultNode, visitSwitchNode, visitTemplateBasicNode, visitTemplateDelegateNode, visitTemplateNode, visitVeLogNode

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

Field Detail

master

protected final GenJsCodeVisitor master

Master instance of GenJsCodeVisitor.

translationContext

protected final TranslationContext translationContext

Constructor Detail

GenJsCodeVisitorAssistantForMsgs

protected GenJsCodeVisitorAssistantForMsgs(GenJsCodeVisitor master,
                                           SoyJsSrcOptions jsSrcOptions,
                                           JsExprTranslator jsExprTranslator,
                                           GenCallCodeUtils genCallCodeUtils,
                                           IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor,
                                           TemplateAliases functionAliases,
                                           GenJsExprsVisitor genJsExprsVisitor,
                                           TranslationContext translationContext,
                                           ErrorReporter errorReporter)

Parameters:

master - The master GenJsCodeVisitor instance.

jsExprTranslator - Instance of JsExprTranslator to use.

genCallCodeUtils - Instance of GenCallCodeUtils to use.

isComputableAsJsExprsVisitor - The IsComputableAsJsExprsVisitor to use.

genJsExprsVisitor - The current GenJsExprsVisitor.

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.

jsCodeBuilder

protected JsCodeBuilder jsCodeBuilder()

The JsCodeBuilder to build the current JS file being generated (during a run).

generateMsgGroupVariable

public String generateMsgGroupVariable(MsgFallbackGroupNode node)

Generates Javascript statements that declare a translated variable, returning the variable name for the caller to output (as an expression). MsgFallbackGroupNodes can only appear in let blocks, which seems like unnecesary overhead since this already generates a perfectly usable variable. However, this design makes incremental DOM codegen, which needs to apply complex transforms on the translated variable, much simpler. Example:

   {msg desc="Link to help content."}Learn more{/msg}
   {msg desc="Tells user how to access a product." hidden="true"}
     Click <a href="}{$url}">here</a> to access {$productName}.
   {/msg}
 

might generate

   /** @desc Link to help content. * /
   var MSG_UNNAMED_9 = goog.getMsg('Learn more');
   var msg_s9 = MSG_UNNAMED_9;
   /** @desc Tells user how to access a product.
    *  @hidden * /
   var MSG_UNNAMED_10 = goog.getMsg(
       'Click {$startLink}here{$endLink} to access {$productName}.',
       {startLink: '<a href="' + opt_data.url + '">',
        endLink: '</a>',
        productName: opt_data.productName});
 

and return "MSG_UNNAMED_10".

genGoogMsgPlaceholder

protected CodeChunk.WithValue genGoogMsgPlaceholder(MsgPlaceholderNode msgPhNode)

Returns a code chunk for the given placeholder node.

visitMsgHtmlTagNode

protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)

Example:

   <a href="http://www.google.com/search?hl=en
     {for $i in range(3)}
       &param{$i}={$i}
     {/for}
   ">
 might generate
 

var htmlTag84 = (new soy.StringBuilder()).append('<a href="'); for (var i80 = 1; i80 < 3; i80++) { htmlTag84.append('&param', i80, '=', i80); } htmlTag84.append('">');

Overrides:

visitMsgHtmlTagNode in class AbstractSoyNodeVisitor<Void>

visitSoyNode

protected void visitSoyNode(SoyNode node)

Overrides:

visitSoyNode in class AbstractSoyNodeVisitor<Void>

Parameters:

node - the visited node.