SugarExpansionVisitor (golo 3.4.0 API)

java.lang.Object
- gololang.ir.AbstractGoloIrVisitor
- - org.eclipse.golo.compiler.SugarExpansionVisitor

All Implemented Interfaces:

GoloIrVisitor
```
public class SugarExpansionVisitor
extends AbstractGoloIrVisitor
```
Visitor to expand some syntactic sugar.
Modify the IR to transform some nodes, in order to expand syntactic sugar, such as case and match statements, foreach loops, list comprehension, and so on.

Constructor Summary

Constructors
Constructor and Description

SugarExpansionVisitor()

Constructors
Constructor and Description
`SugarExpansionVisitor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`visitBinaryOperation(BinaryOperation op)`
`void`	`visitBlock(Block block)` Generate the local function corresponding to this closure.
`void`	`visitCaseStatement(CaseStatement caseStatement)` Case expansion.
`void`	`visitClosureReference(ClosureReference closure)`
`void`	`visitCollectionComprehension(CollectionComprehension collection)` Collection comprehension expansion.
`void`	`visitCollectionLiteral(CollectionLiteral collection)` Literal expansion.
`void`	`visitConstantStatement(ConstantStatement constantStatement)` Converts a literal function reference into a call to `Predefined.fun`.
`void`	`visitDestructuringAssignment(DestructuringAssignment assignment)` Destructuring assignment expansion.
`void`	`visitForEachLoopStatement(ForEachLoopStatement foreachStatement)` ForEach expansion.
`void`	`visitFunction(GoloFunction function)`
`void`	`visitFunctionInvocation(FunctionInvocation fun)`
`void`	`visitMatchExpression(MatchExpression matchExpression)` Match expansion.
`void`	`visitMethodInvocation(MethodInvocation invoke)`
`void`	`visitModule(GoloModule module)`
`void`	`visitReferenceLookup(ReferenceLookup ref)`
`void`	`visitReturnStatement(ReturnStatement ret)` Special returned values.
`void`	`visitStruct(Struct struct)` Add struct factories if they don't already exist.
`void`	`visitTryCatchFinally(TryCatchFinally tryCatchFinally)`
`void`	`visitUnaryOperation(UnaryOperation op)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SugarExpansionVisitor
```
public SugarExpansionVisitor()
```
- Method Detail
  - visitModule
```
public void visitModule(GoloModule module)
```
    Specified by:
    
    visitModule in interface GoloIrVisitor
    
    Overrides:
    
    visitModule in class AbstractGoloIrVisitor
  - visitBlock
```
public void visitBlock(Block block)
```
    Generate the local function corresponding to this closure.
    
    Specified by:
    
    visitBlock in interface GoloIrVisitor
    
    Overrides:
    
    visitBlock in class AbstractGoloIrVisitor
  - visitClosureReference
```
public void visitClosureReference(ClosureReference closure)
```
    Specified by:
    
    visitClosureReference in interface GoloIrVisitor
    
    Overrides:
    
    visitClosureReference in class AbstractGoloIrVisitor
  - visitFunction
```
public void visitFunction(GoloFunction function)
```
    Specified by:
    
    visitFunction in interface GoloIrVisitor
    
    Overrides:
    
    visitFunction in class AbstractGoloIrVisitor
  - visitCaseStatement
```
public void visitCaseStatement(CaseStatement caseStatement)
```
    Case expansion.
    Convert a CaseStatement node into a imbrication of ConditionalBranching, and replace it in the parent node. For instance:
```
 case {
   when cond1 { block1 }
   when cond2 { block2 }
   otherwise { block3 }
 }
 
```
    is converted into the equivalent of
```
 if cond1 { block1 }
 else if cond2 { block2 }
 else { block3 }
 
```
    Specified by:
    
    visitCaseStatement in interface GoloIrVisitor
    
    Overrides:
    
    visitCaseStatement in class AbstractGoloIrVisitor
  - visitMatchExpression
```
public void visitMatchExpression(MatchExpression matchExpression)
```
    Match expansion.
    Convert a MatchExpression node into a block containing a CaseStatement. For instance
```
 match {
   when cond1 then val1
   when cond2 then val2
   otherwise val3
 }
 
```
    is converted into the equivalent of
```
 tmp = null
 case {
   when cond1 { tmp = val1 }
   when cond2 { tmp = val2 }
   otherwise { tmp = val3 }
 }
 tmp
 
```
    Specified by:
    
    visitMatchExpression in interface GoloIrVisitor
    
    Overrides:
    
    visitMatchExpression in class AbstractGoloIrVisitor
  - visitReturnStatement
```
public void visitReturnStatement(ReturnStatement ret)
```
    Special returned values.
    Deal with special return cases:
    - when returning a MatchExpression, convert it to a CaseStatement containing ReturnStatement instead of assignments. For instance
      return match { when cond1 then val1 when cond2 then val2 otherwise val3 }
      is converted into the equivalent of
      case { when cond1 { return val1 } when cond2 { return val2 } otherwise { return val3 } }
      This will allows for better optimisations (e.g. TCE).
    Specified by:
    
    visitReturnStatement in interface GoloIrVisitor
    
    Overrides:
    
    visitReturnStatement in class AbstractGoloIrVisitor
  - visitCollectionLiteral
```
public void visitCollectionLiteral(CollectionLiteral collection)
```
    Literal expansion.
    Converts a collection literal into a call to gololang.Predefined.<type>.
    
    Specified by:
    
    visitCollectionLiteral in interface GoloIrVisitor
    
    Overrides:
    
    visitCollectionLiteral in class AbstractGoloIrVisitor
  - visitConstantStatement
```
public void visitConstantStatement(ConstantStatement constantStatement)
```
    Converts a literal function reference into a call to Predefined.fun.
    
    Specified by:
    
    visitConstantStatement in interface GoloIrVisitor
    
    Overrides:
    
    visitConstantStatement in class AbstractGoloIrVisitor
  - visitCollectionComprehension
```
public void visitCollectionComprehension(CollectionComprehension collection)
```
    Collection comprehension expansion.
    Convert a list comprehension expression into a block initialising a collection from nested loops defined in the comprehension. For instance
```
 list[ f(x, y) foreach x in col1 foreach y in col2 ]
 
```
    is converted to the equivalent of
```
 let collection = list[]
 foreach x in col1 {
   foreach y in col2 {
     collection: add(f(x, y))
   }
 }
 
```
    Specified by:
    
    visitCollectionComprehension in interface GoloIrVisitor
    
    Overrides:
    
    visitCollectionComprehension in class AbstractGoloIrVisitor
  - visitForEachLoopStatement
```
public void visitForEachLoopStatement(ForEachLoopStatement foreachStatement)
```
    ForEach expansion.
    Convert a ForEachLoopStatement into a loop using the associated iterator. For instance:
```
 foreach x in expr {
   block
 }
 
```
    is converted to:
```
 for (__$$_iterator_0 = expr: iterator(), __$$_iterator_0: hasNext(),) {
   let x = __$$_iterator_0: next()
   block
 }
 
```
    Specified by:
    
    visitForEachLoopStatement in interface GoloIrVisitor
    
    Overrides:
    
    visitForEachLoopStatement in class AbstractGoloIrVisitor
  - visitDestructuringAssignment
```
public void visitDestructuringAssignment(DestructuringAssignment assignment)
```
    Destructuring assignment expansion.
    
    Specified by:
    
    visitDestructuringAssignment in interface GoloIrVisitor
    
    Overrides:
    
    visitDestructuringAssignment in class AbstractGoloIrVisitor
  - visitStruct
```
public void visitStruct(Struct struct)
```
    Add struct factories if they don't already exist.
    
    Specified by:
    
    visitStruct in interface GoloIrVisitor
    
    Overrides:
    
    visitStruct in class AbstractGoloIrVisitor
  - visitBinaryOperation
```
public void visitBinaryOperation(BinaryOperation op)
```
    Specified by:
    
    visitBinaryOperation in interface GoloIrVisitor
    
    Overrides:
    
    visitBinaryOperation in class AbstractGoloIrVisitor
  - visitUnaryOperation
```
public void visitUnaryOperation(UnaryOperation op)
```
    Specified by:
    
    visitUnaryOperation in interface GoloIrVisitor
    
    Overrides:
    
    visitUnaryOperation in class AbstractGoloIrVisitor
  - visitReferenceLookup
```
public void visitReferenceLookup(ReferenceLookup ref)
```
    Specified by:
    
    visitReferenceLookup in interface GoloIrVisitor
    
    Overrides:
    
    visitReferenceLookup in class AbstractGoloIrVisitor
  - visitFunctionInvocation
```
public void visitFunctionInvocation(FunctionInvocation fun)
```
    Specified by:
    
    visitFunctionInvocation in interface GoloIrVisitor
    
    Overrides:
    
    visitFunctionInvocation in class AbstractGoloIrVisitor
  - visitMethodInvocation
```
public void visitMethodInvocation(MethodInvocation invoke)
```
    Specified by:
    
    visitMethodInvocation in interface GoloIrVisitor
    
    Overrides:
    
    visitMethodInvocation in class AbstractGoloIrVisitor
  - visitTryCatchFinally
```
public void visitTryCatchFinally(TryCatchFinally tryCatchFinally)
```
    Specified by:
    
    visitTryCatchFinally in interface GoloIrVisitor
    
    Overrides:
    
    visitTryCatchFinally in class AbstractGoloIrVisitor

Class SugarExpansionVisitor

Constructor Summary

Method Summary

Methods inherited from class gololang.ir.AbstractGoloIrVisitor

Methods inherited from class java.lang.Object

Constructor Detail

SugarExpansionVisitor

Method Detail

visitModule

visitBlock

visitClosureReference

visitFunction

visitCaseStatement

visitMatchExpression

visitReturnStatement

visitCollectionLiteral

visitConstantStatement

visitCollectionComprehension

visitForEachLoopStatement

visitDestructuringAssignment

visitStruct

visitBinaryOperation

visitUnaryOperation

visitReferenceLookup

visitFunctionInvocation

visitMethodInvocation

visitTryCatchFinally