GenJsCodeVisitor (Closure Templates)

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

All Implemented Interfaces:

NodeVisitor<SoyNode,List<String>>

Direct Known Subclasses:

GenIncrementalDomCodeVisitor
```
public class GenJsCodeVisitor
extends AbstractSoyNodeVisitor<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 SoyJsSrcOptions`	`jsSrcOptions` The options for generating JS source code.
`protected TemplateAliases`	`templateAliases` Used for looking up the local name for a given template call to a fully qualified template name.
`protected TemplateRegistry`	`templateRegistry`
`protected TranslationContext`	`templateTranslationContext`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GenJsCodeVisitor(SoyJsSrcOptions jsSrcOptions, DelTemplateNamer delTemplateNamer, GenCallCodeUtils genCallCodeUtils, IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor, CanInitOutputVarVisitor canInitOutputVarVisitor, GenJsExprsVisitor.GenJsExprsVisitorFactory genJsExprsVisitorFactory, SoyTypeRegistry typeRegistry)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected JsCodeBuilder`	`createChildJsCodeBuilder()`
`protected JsCodeBuilder`	`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 CodeChunk`	`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 CodeChunk`	`genParamTypeChecks(TemplateNode node)` Generate code to verify the runtime types of the input params.
`protected GenJsCodeVisitorAssistantForMsgs`	`getAssistantForMsgs()`
`protected String`	`getGoogModuleNamespace(String soyNamespace)`
`protected JsCodeBuilder`	`getJsCodeBuilder()`
`protected String`	`getTemplateReturnType(TemplateNode node)`
`protected CodeChunk.WithValue`	`sanitize(CodeChunk.WithValue templateBody, SanitizedContentKind contentKind)`
`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 CodeChunk`	`visitChildrenReturningCodeChunk(SoyNode.ParentSoyNode<?> node)` Visits the children of the given node, returning a `CodeChunk` encapsulating its JavaScript code.
`protected void`	`visitDebuggerNode(DebuggerNode node)` Example:
`protected void`	`visitForNode(ForNode node)` Example:
`protected void`	`visitForNonemptyNode(ForNonemptyNode node)`
`void`	`visitForUseByAssistants(SoyNode node)` This method must only be called by assistant visitors, in particular GenJsCodeVisitorAssistantForMsgs.
`CodeChunk`	`visitForUseByAssistantsAsCodeChunk(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.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.
- genCallCodeUtils
```
protected final GenCallCodeUtils genCallCodeUtils
```
  Instance of GenCallCodeUtils to use.
- isComputableAsJsExprsVisitor
```
protected final IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor
```
  The IsComputableAsJsExprsVisitor used by this instance.
- genJsExprsVisitor
```
protected GenJsExprsVisitor genJsExprsVisitor
```
  The GenJsExprsVisitor used for the current template.
- templateRegistry
```
protected TemplateRegistry templateRegistry
```
- errorReporter
```
protected ErrorReporter errorReporter
```
- templateTranslationContext
```
protected TranslationContext templateTranslationContext
```
- 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

protected GenJsCodeVisitor(SoyJsSrcOptions jsSrcOptions,
                           DelTemplateNamer delTemplateNamer,
                           GenCallCodeUtils genCallCodeUtils,
                           IsComputableAsJsExprsVisitor isComputableAsJsExprsVisitor,
                           CanInitOutputVarVisitor canInitOutputVarVisitor,
                           GenJsExprsVisitor.GenJsExprsVisitorFactory genJsExprsVisitorFactory,
                           SoyTypeRegistry typeRegistry)

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.
- visitForUseByAssistantsAsCodeChunk
```
public CodeChunk visitForUseByAssistantsAsCodeChunk(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 JsCodeBuilder createCodeBuilder()
```
  Returns:
  
  A new CodeBuilder to create the contents of a file with.
- createChildJsCodeBuilder
```
protected JsCodeBuilder createChildJsCodeBuilder()
```
  Returns:
  
  A child CodeBuilder that inherits from the current builder.
- getJsCodeBuilder
```
protected JsCodeBuilder getJsCodeBuilder()
```
  Returns:
  
  The CodeBuilder used for generating file contents.
- visitChildrenReturningCodeChunk
```
protected CodeChunk visitChildrenReturningCodeChunk(SoyNode.ParentSoyNode<?> node)
```
  Visits the children of the given node, returning a CodeChunk encapsulating its JavaScript code. The chunk is indented one level from the current indent level.
  This is needed to prevent infinite recursion when a visit() method needs to visit its children and return a CodeChunk.
  Unlike TranslateExprNodeVisitor, GenJsCodeVisitor does not return anything as the result of visiting a subtree. To get recursive chunk-building, we use a hack, swapping out the JsCodeBuilder and using the unsound CodeChunk.treatRawStringAsStatementLegacyOnly(java.lang.String, java.lang.Iterable<com.google.template.soy.jssrc.dsl.GoogRequire>) API.
- 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.
- 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
```
@CheckReturnValue
protected CodeChunk generateFunctionBody(TemplateNode node)
```
  Generates the function body.
- sanitize
```
protected final CodeChunk.WithValue sanitize(CodeChunk.WithValue templateBody,
                                             @Nullable
                                             SanitizedContentKind contentKind)
```
- 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.
  TODO(user): Instead of interleaving JsCodeBuilders like this, consider refactoring GenJsCodeVisitor to return CodeChunks for each sub-Template level SoyNode.
- 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>>
- visitForNode
```
protected void visitForNode(ForNode node)
```
  Example:
```
   {for $foo in $boo.foos}
     ...
   {ifempty}
     ...
   {/for}
 
```
  might generate
```
   var foo2List = opt_data.boo.foos;
   var foo2ListLen = foo2List.length;
   if (foo2ListLen > 0) {
     ...
   } else {
     ...
   }
 
```
  Overrides:
  
  visitForNode in class AbstractSoyNodeVisitor<List<String>>
- visitForNonemptyNode
```
protected void visitForNonemptyNode(ForNonemptyNode node)
```
  Overrides:
  
  visitForNonemptyNode 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.
- genParamTypeChecks
```
@CheckReturnValue
protected CodeChunk 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.soytree.AbstractSoyNodeVisitor

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

Methods inherited from class java.lang.Object

Field Detail

jsSrcOptions

genCallCodeUtils

isComputableAsJsExprsVisitor

genJsExprsVisitor

templateRegistry

errorReporter

templateTranslationContext

templateAliases

Constructor Detail

GenJsCodeVisitor

Method Detail

gen

exec

visitForUseByAssistants

visitForUseByAssistantsAsCodeChunk

visitChildren

visitSoyFileSetNode

createCodeBuilder

createChildJsCodeBuilder

getJsCodeBuilder

visitChildrenReturningCodeChunk

visitSoyFileNode

getGoogModuleNamespace

getTemplateReturnType

visitTemplateNode

generateFunctionBody

sanitize

getAssistantForMsgs

visitMsgFallbackGroupNode

visitMsgHtmlTagNode

visitPrintNode

visitLetValueNode

visitLetContentNode

visitIfNode

generateNonExpressionIfNode

visitSwitchNode

visitForNode

visitForNonemptyNode

visitCallNode

visitCallParamContentNode

visitLogNode

visitDebuggerNode

visitSoyNode

genParamTypeChecks