compiler/io.github.aplcornell.viaduct.analysis/NameAnalysis

NameAnalysis

Associates each use of a Name with its declaration, and every Name declaration with the set of its uses.

For example, Temporary variables are associated with LetNodes, ObjectVariables with DeclarationNodes, and JumpLabels with InfiniteLoopNodes.

Types

Companion

object Companion : AnalysisProvider<NameAnalysis>

Functions

argumentUses

fun argumentUses(node: ObjectVariableDeclarationNode): Set<FunctionArgumentNode>

Returns the set of arguments where node is used.

calls

fun calls(function: FunctionDeclarationNode): Set<FunctionCallNode>

Returns the set of calls to the given function declaration.

check

fun check()

Asserts that every referenced Name has a declaration, and that no Name is declared multiple times in the same scope.

correspondingBreaks

fun correspondingBreaks(node: InfiniteLoopNode): Set<BreakNode>

Returns the set of BreakNodes that reference node.

correspondingLet

fun correspondingLet(query: QueryNode): LetNode

correspondingLoop

fun correspondingLoop(node: BreakNode): InfiniteLoopNode

Returns the loop that node is breaking out of.

declaration

fun declaration(node: CommunicationNode): HostDeclarationNode

Returns the declaration of the Host in node.

fun declaration(node: FunctionCallNode): FunctionDeclarationNode

Returns the declaration of the function being called in node.

fun declaration(node: ObjectReferenceArgumentNode): ObjectVariableDeclarationNode

fun declaration(node: OutParameterArgumentNode): ParameterNode

Returns the object referenced by the node function argument.

fun declaration(node: OutParameterInitializationNode): ParameterNode

Returns the declaration of the out parameter in node.

fun declaration(node: QueryNode): ObjectVariableDeclarationNode

fun declaration(node: UpdateNode): ObjectVariableDeclarationNode

Returns the statement that declares the ObjectVariable in node.

fun declaration(node: ReadNode): LetNode

Returns the statement that defines the Temporary in node.

enclosingBlock

fun enclosingBlock(stmt: StatementNode): BlockNode

Returns the block that encloses this statement.

enclosingFunction

fun enclosingFunction(node: Node): FunctionDeclarationNode

Returns the function declaration enclosing node.

enclosingFunctionName

fun enclosingFunctionName(node: Node): FunctionName

Returns the function declaration enclosing node.

enclosingStatement

fun enclosingStatement(read: ReadNode): StatementNode

Return the statement enclosing the read node.

functionCall

fun functionCall(argument: FunctionArgumentNode): FunctionCallNode

Returns the function call that contains argument.

functionDeclaration

fun functionDeclaration(parameter: ParameterNode): FunctionDeclarationNode

Returns the function declaration that contains parameter.

involvedLoops

fun involvedLoops(node: Node): List<InfiniteLoopNode>

Returns the list of InfiniteLoopNodes node is contained in.

objectType

fun objectType(node: ObjectVariableDeclarationNode): ObjectTypeNode

Returns the object type declaration for node.

parameter

fun parameter(node: FunctionArgumentNode): ParameterNode

Returns the parameter for which node is the argument.

parameterUsers

fun parameterUsers(parameter: ParameterNode): Set<FunctionArgumentNode>

Returns the set of arguments for ParameterNode.

parameterUses

fun parameterUses(node: ObjectVariableDeclarationNode): Set<ParameterNode>

Returns the set of parameters for which node is used as an argument.

queriers

fun queriers(node: ObjectVariableDeclarationNode): Set<QueryNode>

Returns the set of QueryNodes that reference the ObjectVariable declared by node.

reachableFunctions

fun reachableFunctions(node: Node): PersistentSet<FunctionName>

Returns the set of functions transitively reachable from a statement node.

readers

fun readers(node: LetNode): Set<StatementNode>

Returns the set of StatementNodes that read the Temporary defined by node.

reads

fun reads(node: Node): Set<ReadNode>

Returns all ReadNodes in this node.

updaters

fun updaters(node: ObjectVariableDeclarationNode): Set<UpdateNode>

Returns the set of UpdateNodes that reference the ObjectVariable declared by node.

variables

fun variables(node: StatementNode): Set<FunctionVariable>

Returns the variables used of a node.