GenJsCodeVisitor (Closure Templates)

java.lang.Object
- com.google.template.soy.basetree.AbstractNodeVisitor<SoyNode,R>
- - com.google.template.soy.soytree.AbstractSoyNodeVisitor<R>
  - - com.google.template.soy.html.AbstractHtmlSoyNodeVisitor<List<String>>
    - - com.google.template.soy.jssrc.internal.GenJsCodeVisitor

All Implemented Interfaces:

NodeVisitor<SoyNode,List<String>>

Direct Known Subclasses:

GenIncrementalDomCodeVisitor
```
public class GenJsCodeVisitor
extends AbstractHtmlSoyNodeVisitor<List<String>>
```
Visitor for generating full JS code (i.e. statements) for parse tree nodes.
Precondition: MsgNode should not exist in the tree.
gen(com.google.template.soy.soytree.SoyFileSetNode, com.google.template.soy.soytree.TemplateRegistry, com.google.template.soy.error.ErrorReporter) should be called on a full parse tree. JS source code will be generated for all the Soy files. The return value is a list of strings, each string being the content of one generated JS file (corresponding to one Soy file).

Field Summary

Fields
Modifier and Type	Field and Description
`protected ErrorReporter`	`errorReporter`
`protected GenCallCodeUtils`	`genCallCodeUtils` Instance of GenCallCodeUtils to use.
`protected GenJsExprsVisitor`	`genJsExprsVisitor` The GenJsExprsVisitor used for the current template.
`protected IsComputableAsJsExprsVisitor`	`isComputableAsJsExprsVisitor` The IsComputableAsJsExprsVisitor used by this instance.
`protected JsExprTranslator`	`jsExprTranslator` Instance of JsExprTranslator to use.
`protected SoyJsSrcOptions`	`jsSrcOptions` The options for generating JS source code.
`protected Deque<Map<String,JsExpr>>`	`localVarTranslations` The current stack of replacement JS expressions for the local variables (and foreach-loop special functions) current in scope.
`protected TemplateAliases`	`templateAliases` Used for looking up the local name for a given template call to a fully qualified template name.
`protected TemplateRegistry`	`templateRegistry`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenJsCodeVisitor(SoyJsSrcOptions jsSrcOptions, JsExprTranslator jsExprTranslator, DelTemplateNamer delTemplateNamer, GenCallCodeUtils genCallCodeUtils, IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor, CanInitOutputVarVisitor canInitOutputVarVisitor, GenJsExprsVisitor.GenJsExprsVisitorFactory genJsExprsVisitorFactory, GenDirectivePluginRequiresVisitor genDirectivePluginRequiresVisitor, SoyTypeOps typeOps)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addCodeToRequireGeneralDeps(SoyFileNode soyFile)` Helper for visitSoyFileNode(SoyFileNode) to add code to require general dependencies.
`protected void`	`addCodeToRequireGoogModuleDeps(SoyFileNode soyFile)` Helper for visitSoyFileNode(SoyFileNode) to add code to require goog.module dependencies.
`protected void`	`addGoogRequire(String namespace, boolean suppressExtra)` Emit goog.require for namespace if namespace has not already been emitted.
`protected CodeBuilder<JsExpr>`	`createCodeBuilder()`
`List<String>`	`exec(SoyNode node)` Deprecated. Call `gen(com.google.template.soy.soytree.SoyFileSetNode, com.google.template.soy.soytree.TemplateRegistry, com.google.template.soy.error.ErrorReporter)` instead.
`List<String>`	`gen(SoyFileSetNode node, TemplateRegistry registry, ErrorReporter errorReporter)`
`protected void`	`generateFunctionBody(TemplateNode node)` Generates the function body.
`protected void`	`generateNonExpressionIfNode(IfNode node)` Generates the JavaScript code for an {if} block that cannot be done as an expression.
`protected void`	`genParamTypeChecks(TemplateNode node)` Generate code to verify the runtime types of the input params.
`protected GenJsCodeVisitorAssistantForMsgs`	`getAssistantForMsgs()`
`protected String`	`getGoogModuleNamespace(String soyNamespace)`
`protected CodeBuilder<JsExpr>`	`getJsCodeBuilder()`
`protected String`	`getJsTypeName(SoyType type)` Returns the name of the JS type used to represent the given SoyType at runtime.
`protected String`	`getTemplateReturnType(TemplateNode node)`
`protected void`	`visitCallNode(CallNode node)` Example:
`protected void`	`visitCallParamContentNode(CallParamContentNode node)`
`protected void`	`visitChildren(SoyNode.ParentSoyNode<?> node)` Helper to visit all the children of a node, in order.
`protected void`	`visitDebuggerNode(DebuggerNode node)` Example:
`protected void`	`visitForeachNode(ForeachNode node)` Example:
`protected void`	`visitForeachNonemptyNode(ForeachNonemptyNode node)` Example:
`protected void`	`visitForNode(ForNode node)` Example:
`void`	`visitForUseByAssistants(SoyNode node)` This method must only be called by assistant visitors, in particular GenJsCodeVisitorAssistantForMsgs.
`protected void`	`visitIfNode(IfNode node)` Example:
`protected void`	`visitLetContentNode(LetContentNode node)` Example:
`protected void`	`visitLetValueNode(LetValueNode node)` Example:
`protected void`	`visitLogNode(LogNode node)` Example:
`protected void`	`visitMsgFallbackGroupNode(MsgFallbackGroupNode node)`
`protected void`	`visitMsgHtmlTagNode(MsgHtmlTagNode node)`
`protected void`	`visitPrintNode(PrintNode node)`
`protected void`	`visitSoyFileNode(SoyFileNode node)` Example:
`protected void`	`visitSoyFileSetNode(SoyFileSetNode node)`
`protected void`	`visitSoyNode(SoyNode node)`
`protected void`	`visitSwitchNode(SwitchNode node)` Example:
`protected void`	`visitTemplateNode(TemplateNode node)` Outputs a `TemplateNode`, generating the function open and close, along with a a debug template name.

Methods inherited from class com.google.template.soy.html.AbstractHtmlSoyNodeVisitor
visit, visitHtmlAttributeNode, visitHtmlCloseTagNode, visitHtmlOpenTagEndNode, visitHtmlOpenTagNode, visitHtmlOpenTagStartNode, visitHtmlVoidTagNode

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
- jsSrcOptions
```
protected final SoyJsSrcOptions jsSrcOptions
```
  The options for generating JS source code.
- jsExprTranslator
```
protected final JsExprTranslator jsExprTranslator
```
  Instance of JsExprTranslator to use.
- genCallCodeUtils
```
protected final GenCallCodeUtils genCallCodeUtils
```
  Instance of GenCallCodeUtils to use.
- isComputableAsJsExprsVisitor
```
protected final IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor
```
  The IsComputableAsJsExprsVisitor used by this instance.
- localVarTranslations
```
protected Deque<Map<String,JsExpr>> localVarTranslations
```
  The current stack of replacement JS expressions for the local variables (and foreach-loop special functions) current in scope.
- genJsExprsVisitor
```
protected GenJsExprsVisitor genJsExprsVisitor
```
  The GenJsExprsVisitor used for the current template.
- templateRegistry
```
protected TemplateRegistry templateRegistry
```
- errorReporter
```
protected ErrorReporter errorReporter
```
- templateAliases
```
protected TemplateAliases templateAliases
```
  Used for looking up the local name for a given template call to a fully qualified template name. This is created on a per SoyFileNode basis.

Constructor Detail

GenJsCodeVisitor

@Inject
protected GenJsCodeVisitor(SoyJsSrcOptions jsSrcOptions,
                       JsExprTranslator jsExprTranslator,
                       DelTemplateNamer delTemplateNamer,
                       GenCallCodeUtils genCallCodeUtils,
                       IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor,
                       CanInitOutputVarVisitor canInitOutputVarVisitor,
                       GenJsExprsVisitor.GenJsExprsVisitorFactory genJsExprsVisitorFactory,
                       GenDirectivePluginRequiresVisitor genDirectivePluginRequiresVisitor,
                       SoyTypeOps typeOps)

Method Detail
- gen
```
public List<String> gen(SoyFileSetNode node,
               TemplateRegistry registry,
               ErrorReporter errorReporter)
```
- exec
```
@Deprecated
public final List<String> exec(SoyNode node)
```
  Deprecated. Call gen(com.google.template.soy.soytree.SoyFileSetNode, com.google.template.soy.soytree.TemplateRegistry, com.google.template.soy.error.ErrorReporter) instead.
  
  Description copied from interface: NodeVisitor
  
  Executes the function defined by this visitor.
  
  Specified by:
  
  exec in interface NodeVisitor<SoyNode,List<String>>
  
  Overrides:
  
  exec in class AbstractNodeVisitor<SoyNode,List<String>>
  
  Parameters:
  node - The node to execute the function on.
- visitForUseByAssistants
```
public void visitForUseByAssistants(SoyNode node)
```
  This method must only be called by assistant visitors, in particular GenJsCodeVisitorAssistantForMsgs.
- visitChildren
```
protected void visitChildren(SoyNode.ParentSoyNode<?> node)
```
  Description copied from class: AbstractSoyNodeVisitor
  
  Helper to visit all the children of a node, in order.
  
  Overrides:
  
  visitChildren in class AbstractSoyNodeVisitor<List<String>>
  
  Parameters:
  node - The parent node whose children to visit.
  See Also:
  AbstractSoyNodeVisitor.visitChildrenAllowingConcurrentModification(com.google.template.soy.soytree.SoyNode.ParentSoyNode<?>)
- visitSoyFileSetNode
```
protected void visitSoyFileSetNode(SoyFileSetNode node)
```
  Overrides:
  
  visitSoyFileSetNode in class AbstractSoyNodeVisitor<List<String>>
- createCodeBuilder
```
protected CodeBuilder<JsExpr> createCodeBuilder()
```
  Returns:
  A new CodeBuilder to create the contents of a file with.
- getJsCodeBuilder
```
protected CodeBuilder<JsExpr> getJsCodeBuilder()
```
  Returns:
  The CodeBuilder used for generating file contents.
- visitSoyFileNode
```
protected void visitSoyFileNode(SoyFileNode node)
```
  Example:
```
 // This file was automatically generated from my-templates.soy.
 // Please don't edit this file by hand.

 if (typeof boo == 'undefined') { var boo = {}; }
 if (typeof boo.foo == 'undefined') { boo.foo = {}; }

 ...
 
```
  Overrides:
  
  visitSoyFileNode in class AbstractSoyNodeVisitor<List<String>>
- getGoogModuleNamespace
```
protected String getGoogModuleNamespace(String soyNamespace)
```
  Parameters:
  soyNamespace - The namespace as declared by the user.
  
  Returns:
  The namespace to import/export templates.
- addCodeToRequireGeneralDeps
```
protected void addCodeToRequireGeneralDeps(SoyFileNode soyFile)
```
  Helper for visitSoyFileNode(SoyFileNode) to add code to require general dependencies.
  
  Parameters:
  soyFile - The node we're visiting.
- addGoogRequire
```
protected void addGoogRequire(String namespace,
                  boolean suppressExtra)
```
  Emit goog.require for namespace if namespace has not already been emitted.
  
  Parameters:
  namespace - The JS namespace to require if not already required.
  suppressExtra - Whether to add a @suppress {extraRequire} annotation for requires that may be unused.
- addCodeToRequireGoogModuleDeps
```
protected void addCodeToRequireGoogModuleDeps(SoyFileNode soyFile)
```
  Helper for visitSoyFileNode(SoyFileNode) to add code to require goog.module dependencies. This file should produce one or more calls to goog.module.get. Note that this does not cause the modules to be pulled in by Closure and an additional goog.require for the same namespace is needed in addCodeToRequireGeneralDeps.
  
  Parameters:
  soyFile - The node we're visiting.
- getTemplateReturnType
```
protected String getTemplateReturnType(TemplateNode node)
```
  Parameters:
  node - The template node that is being generated
  
  Returns:
  The JavaScript type of the content generated by this template.
- visitTemplateNode
```
protected void visitTemplateNode(TemplateNode node)
```
  Outputs a TemplateNode, generating the function open and close, along with a a debug template name.
  If aliasing is not performed (which is always the case for V1 templates), this looks like:
```
 my.namespace.func = function(opt_data, opt_sb) {
   ...
 };
 if (goog.DEBUG) {
   my.namespace.func.soyTemplateName = 'my.namespace.func';
 }
 
```
  If aliasing is performed, this looks like:
```
 function $func(opt_data, opt_sb) {
   ...
 }
 exports.func = $func;
 if (goog.DEBUG) {
   $func.soyTemplateName = 'my.namespace.func';
 }
 Note that the alias is not exactly the function name as in may conflict with a reserved
 JavaScript identifier.
 
```
  Overrides:
  
  visitTemplateNode in class AbstractSoyNodeVisitor<List<String>>
- generateFunctionBody
```
protected void generateFunctionBody(TemplateNode node)
```
  Generates the function body.
- getAssistantForMsgs
```
protected GenJsCodeVisitorAssistantForMsgs getAssistantForMsgs()
```
- visitMsgFallbackGroupNode
```
protected void visitMsgFallbackGroupNode(MsgFallbackGroupNode node)
```
  Overrides:
  
  visitMsgFallbackGroupNode in class AbstractSoyNodeVisitor<List<String>>
- visitMsgHtmlTagNode
```
protected void visitMsgHtmlTagNode(MsgHtmlTagNode node)
```
  Overrides:
  
  visitMsgHtmlTagNode in class AbstractSoyNodeVisitor<List<String>>
- visitPrintNode
```
protected void visitPrintNode(PrintNode node)
```
  Overrides:
  
  visitPrintNode in class AbstractSoyNodeVisitor<List<String>>
- visitLetValueNode
```
protected void visitLetValueNode(LetValueNode node)
```
  Example:
```
   {let $boo: $foo.goo[$moo] /}
 
```
  might generate
```
   var boo35 = opt_data.foo.goo[opt_data.moo];
 
```
  Overrides:
  
  visitLetValueNode in class AbstractSoyNodeVisitor<List<String>>
- visitLetContentNode
```
protected void visitLetContentNode(LetContentNode node)
```
  Example:
```
   {let $boo}
     Hello {$name}
   {/let}
 
```
  might generate
```
   var boo35 = 'Hello ' + opt_data.name;
 
```
  Overrides:
  
  visitLetContentNode in class AbstractSoyNodeVisitor<List<String>>
- visitIfNode
```
protected void visitIfNode(IfNode node)
```
  Example:
```
   {if $boo.foo > 0}
     ...
   {/if}
 
```
  might generate
```
   if (opt_data.boo.foo > 0) {
     ...
   }
 
```
  Overrides:
  
  visitIfNode in class AbstractSoyNodeVisitor<List<String>>
- generateNonExpressionIfNode
```
protected void generateNonExpressionIfNode(IfNode node)
```
  Generates the JavaScript code for an {if} block that cannot be done as an expression.
- visitSwitchNode
```
protected void visitSwitchNode(SwitchNode node)
```
  Example:
```
   {switch $boo}
     {case 0}
       ...
     {case 1, 2}
       ...
     {default}
       ...
   {/switch}
 
```
  might generate
```
   switch (opt_data.boo) {
     case 0:
       ...
       break;
     case 1:
     case 2:
       ...
       break;
     default:
       ...
   }
 
```
  Overrides:
  
  visitSwitchNode in class AbstractSoyNodeVisitor<List<String>>
- visitForeachNode
```
protected void visitForeachNode(ForeachNode node)
```
  Example:
```
   {foreach $foo in $boo.foos}
     ...
   {ifempty}
     ...
   {/foreach}
 
```
  might generate
```
   var fooList2 = opt_data.boo.foos;
   var fooListLen2 = fooList2.length;
   if (fooListLen2 > 0) {
     ...
   } else {
     ...
   }
 
```
  Overrides:
  
  visitForeachNode in class AbstractSoyNodeVisitor<List<String>>
- visitForeachNonemptyNode
```
protected void visitForeachNonemptyNode(ForeachNonemptyNode node)
```
  Example:
```
   {foreach $foo in $boo.foos}
     ...
   {/foreach}
 
```
  might generate
```
   for (var fooIndex2 = 0; fooIndex2 < fooListLen2; fooIndex2++) {
     var fooData2 = fooList2[fooIndex2];
     ...
   }
 
```
  Overrides:
  
  visitForeachNonemptyNode in class AbstractSoyNodeVisitor<List<String>>
- visitForNode
```
protected void visitForNode(ForNode node)
```
  Example:
```
   {for $i in range(1, $boo)}
     ...
   {/for}
 
```
  might generate
```
   var iLimit4 = opt_data.boo;
   for (var i4 = 1; i4 < iLimit4; i4++) {
     ...
   }
 
```
  Overrides:
  
  visitForNode in class AbstractSoyNodeVisitor<List<String>>
- visitCallNode
```
protected void visitCallNode(CallNode node)
```
  Example:
```
   {call some.func data="all" /}
   {call some.func data="$boo.foo" /}
   {call some.func}
     {param goo: 88 /}
   {/call}
   {call some.func data="$boo"}
     {param goo}
       Hello {$name}
     {/param}
   {/call}
 
```
  might generate
```
   output += some.func(opt_data);
   output += some.func(opt_data.boo.foo);
   output += some.func({goo: 88});
   output += some.func(soy.$$assignDefaults({goo: 'Hello ' + opt_data.name}, opt_data.boo);
 
```
  Overrides:
  
  visitCallNode in class AbstractSoyNodeVisitor<List<String>>
- visitCallParamContentNode
```
protected void visitCallParamContentNode(CallParamContentNode node)
```
  Overrides:
  
  visitCallParamContentNode in class AbstractSoyNodeVisitor<List<String>>
- visitLogNode
```
protected void visitLogNode(LogNode node)
```
  Example:
```
   {log}Blah {$boo}.{/log}
 
```
  might generate
```
   window.console.log('Blah ' + opt_data.boo + '.');
 
```
  If the log msg is not computable as JS exprs, then it will be built in a local var logMsg_s##, e.g.
```
   var logMsg_s14 = ...
   window.console.log(logMsg_s14);
 
```
  Overrides:
  
  visitLogNode in class AbstractSoyNodeVisitor<List<String>>
- visitDebuggerNode
```
protected void visitDebuggerNode(DebuggerNode node)
```
  Example:
```
   {debugger}
 
```
  generates
```
   debugger;
 
```
  Overrides:
  
  visitDebuggerNode in class AbstractSoyNodeVisitor<List<String>>
- visitSoyNode
```
protected void visitSoyNode(SoyNode node)
```
  Overrides:
  
  visitSoyNode in class AbstractSoyNodeVisitor<List<String>>
  
  Parameters:
  node - the visited node.
- getJsTypeName
```
protected String getJsTypeName(SoyType type)
```
  Returns the name of the JS type used to represent the given SoyType at runtime. Can be overridden by subclasses to provide a different mapping.
- genParamTypeChecks
```
protected void genParamTypeChecks(TemplateNode node)
```
  Generate code to verify the runtime types of the input params. Also typecasts the input parameters and assigns them to local variables for use in the template.
  
  Parameters:
  node - the template node.

Class GenJsCodeVisitor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.google.template.soy.html.AbstractHtmlSoyNodeVisitor

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

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

Methods inherited from class java.lang.Object

Field Detail

jsSrcOptions

jsExprTranslator

genCallCodeUtils

isComputableAsJsExprsVisitor

localVarTranslations

genJsExprsVisitor

templateRegistry

errorReporter

templateAliases

Constructor Detail

GenJsCodeVisitor

Method Detail

gen

exec

visitForUseByAssistants

visitChildren

visitSoyFileSetNode

createCodeBuilder

getJsCodeBuilder

visitSoyFileNode

getGoogModuleNamespace

addCodeToRequireGeneralDeps

addGoogRequire

addCodeToRequireGoogModuleDeps

getTemplateReturnType

visitTemplateNode

generateFunctionBody

getAssistantForMsgs

visitMsgFallbackGroupNode

visitMsgHtmlTagNode

visitPrintNode

visitLetValueNode

visitLetContentNode

visitIfNode

generateNonExpressionIfNode

visitSwitchNode

visitForeachNode

visitForeachNonemptyNode

visitForNode

visitCallNode

visitCallParamContentNode

visitLogNode

visitDebuggerNode

visitSoyNode

getJsTypeName

genParamTypeChecks