Documentation

checkNodeTreeEx msg nodeTree. Checks if nodeTree has |a non empty path, and if so throws an error.

createOrGetEnv tries to get local env, but if it doesn't exist |creates an empty one and puts it in the state.

returns the local context for the current node

modify current locals environment, creating a new one if it doesn't |already exist.

createOrGetMembers nodeId. Returns the value environment for a |given node, creating a new empty one if it doesn't already exist.

modifys a generator state's member environment for a node. If |no environment exists yet, it creates a new one.

updates the generator state's member environment for a node.

createVar type generates a fresh id for each scalar part of the |the type, and composes them into an id tree for the VarV.

newVar ids type generates fresh vars for the id tree and type, |and adds the bindings to the local environment.

newStructVar idTree tyTree. Creates a new struct variable |for every id in the idTree. Differs from newVar, in that newVar |creates a new variable for every scalar part of the type, rather |than a struct for each id.

newVal - add a val to thhis env

alignVars destIds srcTy srcIds. Returns a list of mappings |from ids in destIds to their equivalent ids and types in srcTy and srcId, |expanding srcId to access struct members when needed.

makeStructAccessors rootId tree. Makes variable names for |accessing the tuple struct called rootId's members that correspond to leaves in tree.

aliasVar destIds srcIds. Gets the var(s) at srcIds, |and aligns them with the destIds to create some new |local names for existing vars.

varExp destId srcId strTem type. Creates a new binding |in the local env called destId, which is bound to the |expression strTem where v is replaced with | the var name of the var srcId, with the given type. |Note: the expression is re-evaluated at each reference.

ifnVarInit decName publicName localNames type val. If a public var already exists |called publicName, then assign it to localNames, otherwise create |a new local var called localNames, and assign it to publicName. Also create |initializing declaration called decName that inits with val. If val is |(LitV NulVal) then doesn't init with any parameters.

ifnVar decName publicName localNames varTy. Works as ifnVarInit, only val has values Nothing.

getLocalVal gets a value from the current node's |local environment, or throws an error if it doesn't exist.

setLocalVal id val. Binds val to the name id |in the local env.

getLVal varId. Returns the value of the var called varId |in the current local environment or throws an error if it is |not defined.

getVal srcNode srcId. Gets the public member called srcId at |srcNode and returns it.

getValMaybe srcNode srcId. Looks up the public member called srcId |in srcNode's public members. Throws an error if no public env exists |for srcNode.

getVal2 srcNode srcId bindGenF. Gets the public member value stored at node |srcNode under srcId, then applies bindGenF to create new local var-value bindings |from the value, and updates the current node's local environment by adding these |bindings.

setVal destNode destId val. Sets the public member called destId at destNode |to val.

setVal destNode destId srcId valGenF. Gets all the local vals in srcId, combines |them into a new val using valGenF, and then adds this to destNode's public |members under destId.

getVar -- gets a var from an object's environment into the local context |if there is no members environment set yet, or the var doesn't exist, it throws |an error.

ifVarExists destId srcNode srcId thenAction elseAction. Like getVar, only if the var |doesn't exist it performs elseAction, and if it does, in after binding |it to destId locally, it performs thenAction.

isVarsExist vars thenAction elseAction. Checks if all the vars in the list |[(destId, srcNode, srcId)] exist. If they do, binds them to the destIds in the |local env, and performs thenAction. Else performs elseAction.

treeValToVar vals. Takes a tree of Var vals and composes them to form a |Var val.

setFun node procId argIdTree proc. Creates a new template procedure and |adds it to the public members of the node given.

callFun node procId valIdTree. Gets the procedure stored at procId in node's |public members, and invokes it with the node as the current node.

callAll node procId valIdTree. Gets all of node's outputs |and invokes the procedure called procId at each of them, |with the parameters implied by valIdTree. Returns number of consumers.

callConsumers node procId valIdTree. Gets all of node's consumers |and invokes the procedure callec procId at each of them, with the |parameters implied by valIdTree. Then gets all members of the |preceding nodes that have changed, merges the changes, and applies |them to node's public members. Returns the number of consumers.

shouldBeGlobal node. Returns true if the value returned |by node should be a global var (e.g. is used in a funNode).

tryCall node procId valIdTree. Calls node.procId if it exists, |and does nothing otherwise.

getCode destId srcNode srcId. Gets the code from srcNode.srcId |and adds it to the local context under destId.

setCode destNode destId tem. Expands tem using the current |local vars, and then sets destNode's public member called destId |to the expanded code.

addCode destNode destId tem. Expands tem using the |current local vars, gets the current value of destId |at destNode, appends the expanded template, and saves it |back to the state. destId must already exist or it will |throw an error!

output streamId template expands the template using the values of the current node's |local vars and appends it to the stream identified by streamId. If the stream does not |yet exist, creates it, and appends the expanded template to it.

outputDecl node dec. Checks to see if declaration should |be global by calling shouldBeGlobal, and outputs to |main or globals as appropriate.

getGlobal envName key. Looks up a value with key in the globals Map called envName.

setGlobal key val. Inserts, updates, or deletes the value of key in the |globals map.

runGen genId destVarId argVars. Runs the generator called genId |with arguments from argVars, and binds the result to destVarId in the current local |vars environment.

runGenV genId destVarId varIds. Runs the generator called genId |with arguments from the local variables refered to as varIds, |and assigns the result to destVarId in the locals environment.

getFun node. Returns a GraphV for the function graph |stored in node. TODO Will there ever be Lambdas that take Lambdas as arguments? Because if so we need to support having trees of any kind of Vals passed to Lambda input nodes, including GraphVs.

evalFun funVal inVarVal outVarVal. Creates a new copy of |the graph funVal with new node ids, then assigns input and output |vars to it, and generates the code for the graph.

eval funId inVarId outVarId. Generates the code to |implement the graph stored as funId in the local env |with the vars stored as inVarId and outVarId in the |local env.

genFun codeVarName funVal inVars outVars. Generates code to implement |funVal using input vars inVars and outVars outVars (stored in local env). |Stores the resultant code in the local env as codeVarName.

appFun codeVarName funNode inVars outVars. Generates code for the |lambda at funNode, with inVars and outVars, assigning the generated |code to codeVarName in the local environment.

getNestedGraph graph. Checks if graph returns another |graph, and if it does, returns that nested graph.

getGraphTy graph. Returns the type of the function |represented by the graph.

getGraphTyV val. Returns the type of the graph in the |variable, type, or node respectively.

genTyFunV codeVarName funTy inVars outVars. Generates code for |the function stored in funTy, with inVars and outVars.

genProjFun []. Generates a class for this projection function, with |proj() and inject() members. (Does not cache in globals).

generateVisitor graph node performs whatever generation actions |are required for each node in the graph.

geneateVisitor2 graph node. Tries to call the procedure |gen for each node.

generareVisitor3 graph node. Propagates enabled trees |throughout graph, so discover which nodes should be visited |and which should not.

visitIfEnabled visitFun graph node. Applies visitFun unless node's enabled |flag tree is all false (i.e. there is no true)

generateM graph. Visits graph, calling generateVisitor at |each node.

generate graph. Generates code for the graph given.