Class DataflowGraphBuilder
Hierarchy (view full)
- DataflowGraph
- DataflowGraphBuilder
Hierarchy-Diagram
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Dataflow Graph Builder(idMap): DataflowGraphBuilder Parameters
- idMap: undefined | AstIdMap
Returns DataflowGraphBuilder
Properties
Protectedroot
Contains the vertices of the root level graph (i.e., included those vertices from the complete graph, that are nested within function definitions)
Accessors
id
unknown
- get unknownSideEffects(): Set<UnknownSidEffect>
Retrieves the set of vertices which have side effects that we do not know anything about.
Returns Set<UnknownSidEffect>
Methods
Staticfrom
- from
Json(data): DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge> Constructs a dataflow graph instance from the given JSON data and returns the result. This can be useful for data sent by the flowR server when analyzing it further.
Parameters
- data: DataflowGraphJson
The JSON data to construct the graph from
Returns DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge>
- data: DataflowGraphJson
add
add
- add
Edge(from, to, type): this Returns this
- add
Edge(from, to, type): this Parameters
- from: ReferenceForEdge
- to: ReferenceForEdge
- type: EdgeType
Returns this
- add
Edge(from, to, type): this Parameters
- from: NodeId | ReferenceForEdge
- to: NodeId | ReferenceForEdge
- type: EdgeType
Returns this
add
- add
Vertex(vertex, asRoot?): this Adds a new vertex to the graph, for ease of use, some arguments are optional and filled automatically.
Parameters
- vertex: DataflowGraphVertexArgument & Omit<DataflowGraphVertexInfo, string | number>
The vertex to add
- asRoot: boolean = true
If false, this will only add the vertex but do not add it to the rootIds|root vertices of the graph. This is probably only of use, when you construct dataflow graphs for tests.
Returns this
- vertex: DataflowGraphVertexArgument & Omit<DataflowGraphVertexInfo, string | number>
argument
- argument(from, to): DataflowGraphBuilder
Adds an argument edge (E9) with from as function call, and to as argument.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
call
- call(id, name, args, info?, asRoot?): DataflowGraphBuilder
Adds a vertex for a function call (V2).
Parameters
- id: NodeId
AST node ID
- name: string
Function name
- args: FunctionArgument[]
Function arguments; may be empty
Optionalinfo: {
    controlDependencies?: ControlDependency[];
    environment?: REnvironmentInformation;
    onlyBuiltIn?: boolean;
    reads?: readonly NodeId[];
    returns?: readonly NodeId[];
}Additional/optional properties.
OptionalcontrolDependencies?: ControlDependency[] Optionalenvironment?: REnvironmentInformationOptionalonlyBuilt In?: boolean Optionalreads?: readonly NodeId[]Optionalreturns?: readonly NodeId[]
- asRoot: boolean = true
should the vertex be part of the root vertex set of the graph (i.e., be a valid entry point), or is it nested (e.g., as part of a function definition)
Returns DataflowGraphBuilder
- id: NodeId
calls
- calls(from, to): DataflowGraphBuilder
Adds a call edge (E5) with from as caller, and to as callee.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
constant
- constant(id, options?, asRoot?): DataflowGraphBuilder
Adds a vertex for a constant value (V6).
Parameters
- id: NodeId
AST node ID
Optionaloptions: {
    controlDependencies?: ControlDependency[];
}Additional/optional properties;
OptionalcontrolDependencies?: ControlDependency[]
- asRoot: boolean = true
should the vertex be part of the root vertex set of the graph (i.e., be a valid entry point), or is it nested (e.g., as part of a function definition)
Returns DataflowGraphBuilder
- id: NodeId
defined
- defined
By(from, to): DataflowGraphBuilder Adds a defined-by edge (E2), with from as defined variable, and to as a variable/function contributing to its definition.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
define
- define
Function(id, exitPoints, subflow, info?, asRoot?): DataflowGraphBuilder Adds a vertex for a function definition (V1).
Parameters
- id: NodeId
AST node ID
- exitPoints: readonly NodeId[]
Node IDs for exit point vertices.
- subflow: DataflowFunctionFlowInformation
Subflow data graph for the defined function.
Optionalinfo: {
    controlDependencies?: ControlDependency[];
    environment?: REnvironmentInformation;
}Additional/optional properties.
OptionalcontrolDependencies?: ControlDependency[] Optionalenvironment?: REnvironmentInformation
- asRoot: boolean = true
should the vertex be part of the root vertex set of the graph (i.e., be a valid entry point), or is it nested (e.g., as part of a function definition)
Returns DataflowGraphBuilder
- id: NodeId
defines
- defines
On Call(from, to): DataflowGraphBuilder Adds a defines-on-call edge (E7) with from as variable, and to as its definition
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
define
- define
Variable(id, name?, info?, asRoot?): DataflowGraphBuilder Adds a vertex for a variable definition (V4).
Parameters
- id: NodeId
AST node ID
Optionalname: stringVariable name
Optionalinfo: {
    controlDependencies?: ControlDependency[];
    definedBy?: NodeId[];
}Additional/optional properties.
OptionalcontrolDependencies?: ControlDependency[] OptionaldefinedBy?: NodeId[]
- asRoot: boolean = true
Should the vertex be part of the root vertex set of the graph (i.e., be a valid entry point), or is it nested (e.g., as part of a function definition)
Returns DataflowGraphBuilder
- id: NodeId
edges
- edges(): IterableIterator<[NodeId, OutgoingEdges<DataflowGraphEdge>], any, any>
Returns IterableIterator<[NodeId, OutgoingEdges<DataflowGraphEdge>], any, any>
the ids of all edges in the graph together with their edge information
get
- get(id, includeDefinedFunctions?): undefined | [DataflowGraphVertexInfo, OutgoingEdges<DataflowGraphEdge>]
Get the DataflowGraphVertexInfo attached to a node as well as all outgoing edges.
Parameters
- id: NodeId
The id of the node to get
- includeDefinedFunctions: boolean = true
If true this will search function definitions as well and not just the toplevel
Returns undefined | [DataflowGraphVertexInfo, OutgoingEdges<DataflowGraphEdge>]
the node info for the given id (if it exists)
- id: NodeId
get
- get
Vertex(id, includeDefinedFunctions?): undefined | DataflowGraphVertexInfo Get the DataflowGraphVertexInfo attached to a vertex.
Parameters
- id: NodeId
The id of the node to get
- includeDefinedFunctions: boolean = true
If true this will search function definitions as well and not just the toplevel
Returns undefined | DataflowGraphVertexInfo
the node info for the given id (if it exists)
- id: NodeId
has
- has
Vertex(id, includeDefinedFunctions?): boolean Returns true if the graph contains a node with the given id.
Parameters
- id: NodeId
The id to check for
- includeDefinedFunctions: boolean = true
If true this will check function definitions as well and not just the toplevel
Returns boolean
- id: NodeId
ingoing
- ingoing
Edges(id): undefined | IngoingEdges<DataflowGraphEdge> Parameters
- id: NodeId
Returns undefined | IngoingEdges<DataflowGraphEdge>
is
- is
Root(id): boolean Returns true if the root level of the graph contains a node with the given id.
Parameters
- id: NodeId
Returns boolean
mark
merge
- merge
With(otherGraph, mergeRootVertices?): this Merges the other graph into this one (in-place). The return value is only for convenience.
Parameters
- otherGraph: undefined | DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge>
The graph to merge into this one
- mergeRootVertices: boolean = true
If false, this will only merge the vertices and edges but exclude the root vertices this is probably only of use in the context of function definitions
Returns this
- otherGraph: undefined | DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge>
nse
- nse(from, to): DataflowGraphBuilder
Adds a non-standard evaluation edge with from as vertex, and to as vertex.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
outgoing
- outgoing
Edges(id): undefined | OutgoingEdges<DataflowGraphEdge> Parameters
- id: NodeId
Returns undefined | OutgoingEdges<DataflowGraphEdge>
overwrite
- overwrite
Root Ids(ids): DataflowGraphBuilder explicitly overwrite the root ids of the graph, this is just an easier variant in case you working with a lot of functions this saves you a lot of
falseflags.Parameters
- ids: readonly NodeId[]
Returns DataflowGraphBuilder
reads
- reads(from, to): DataflowGraphBuilder
Adds a read edge (E1).
Parameters
- from: NodeId
Vertex/NodeId
- to: DataflowGraphEdgeTarget
see from
Returns DataflowGraphBuilder
- from: NodeId
returns
- returns(from, to): DataflowGraphBuilder
Adds a return edge (E6) with from as function, and to as exit point.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
root
set
- set
Definition Of Vertex(reference): void Marks a vertex in the graph to be a definition
Parameters
- reference: IdentifierReference
The reference to the vertex to mark as definition
Returns void
- reference: IdentifierReference
set
- set
Id Map(idMap): void Allows setting the id-map explicitly (which should only be used when, e.g., you plan to compare two dataflow graphs on the same AST-basis)
Parameters
- idMap: AstIdMap
Returns void
side
- side
Effect On Call(from, to): DataflowGraphBuilder Adds a side-effect-on-call edge with from as vertex, and to as vertex.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
update
- update
To Function Call(info): void Marks a vertex in the graph to be a function call with the new information
Parameters
- info: DataflowGraphVertexFunctionCall
The information about the new function call node
Returns void
- info: DataflowGraphVertexFunctionCall
use
- use(id, name?, info?, asRoot?): DataflowGraphBuilder
Adds a vertex for variable use (V5). Intended for creating dataflow graphs as part of function tests.
Parameters
- id: NodeId
AST node id
Optionalname: stringVariable name
Optionalinfo: Partial<DataflowGraphVertexUse>Additional/optional properties; i.e., scope, when, or environment.
- asRoot: boolean = true
should the vertex be part of the root vertex set of the graph (i.e., be a valid entry point) or is it nested (e.g., as part of a function definition)
Returns DataflowGraphBuilder
- id: NodeId
vertices
- vertices(includeDefinedFunctions): IterableIterator<[NodeId, DataflowGraphVertexInfo], any, any>
Parameters
- includeDefinedFunctions: boolean
If true this will iterate over function definitions as well and not just the toplevel
Returns IterableIterator<[NodeId, DataflowGraphVertexInfo], any, any>
the ids of all toplevel vertices in the graph together with their vertex information
- includeDefinedFunctions: boolean
This DataflowGraphBuilder extends DataflowGraph with builder methods to easily and compactly add vertices and edges to a dataflow graph. Its usage thus simplifies writing tests for dataflow graphs.