gololang.ir

Class Visitors

java.lang.Object

gololang.ir.Visitors

public final class Visitors
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Visitors.DispatchIrVisitor A special adapter class to ease the creation of IR visitors in Golo.

Method Summary

Modifier and Type	Method and Description
static GoloIrVisitor	visitor(FunctionReference function) Creates a visitor from a unique function.
static Visitors.DispatchIrVisitor	visitor(FunctionReference fun, gololang.ir.Visitors.Walk walk) Creates a visitor from a unique function.
static GoloIrVisitor	visitor(java.util.Map<java.lang.Class<? extends GoloElement<?>>,FunctionReference> functions) Creates a visitor from a map of functions.
static Visitors.DispatchIrVisitor	visitor(java.util.Map<java.lang.Class<? extends GoloElement<?>>,FunctionReference> functions, FunctionReference defaultFunction, gololang.ir.Visitors.Walk walk) Creates a visitor from a map of functions.

Methods inherited from class java.lang.Object

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

Method Detail

visitor

public static GoloIrVisitor visitor(java.util.Map<java.lang.Class<? extends GoloElement<?>>,FunctionReference> functions)

Creates a visitor from a map of functions.

This is the same as visitor(functions, null, Walk.PREFIX).

visitor

public static Visitors.DispatchIrVisitor visitor(java.util.Map<java.lang.Class<? extends GoloElement<?>>,FunctionReference> functions,
                                                 FunctionReference defaultFunction,
                                                 gololang.ir.Visitors.Walk walk)

Creates a visitor from a map of functions.

The resulting visitor will use the function corresponding to the class of the element to visit. If the class is not in the map, the default function will be used. If the function is null, no action will be taken for the node, but the subtree will be walked if required, according to the walk parameter.

For instance, the function:

 function numberOfAssignement = |irTree| -> Visitors.visitor!(
   map[
     [AssignmentStatement.class, |acc, elt| -> acc + 1],
     [DestructuringAssignment.class, |acc, elt| -> acc + elt: referencesCount()]
   ],
   |acc, elt| -> acc,
   Visitors$Walk.PREFIX())
   : apply(0, irTree)
 

counts the number of assignment in an IR tree.

Parameters:

functions - a map from IR classes to the golo functions

defaultFunction - the function to apply if the class of the element is not in the map.

walk - when to walk the tree

visitor

public static Visitors.DispatchIrVisitor visitor(FunctionReference fun,
                                                 gololang.ir.Visitors.Walk walk)

Creates a visitor from a unique function.

The resulting visitor will use the given function on each element. It is therefore the function responsibility to match on the element type if necessary.

For instance, the function:

 function numberOfAssignement = |irTree| -> Visitors.visitor!(|acc, elt| -> match {
     when elt oftype AssignmentStatement.class then acc + 1
     when elt oftype DestructuringAssignment.class then acc + elt: referencesCount()
     otherwise acc
   }, Visitors$Walk.PREFIX())
   : apply(0, irTree)
 

counts the number of assignment in an IR tree.

Parameters:

fun - the golo function to apply to elements in the tree

walk - when to walk the tree

visitor

public static GoloIrVisitor visitor(FunctionReference function)

Creates a visitor from a unique function.

This is the same as visitor(function, Walk.PREFIX).