OptionalcleanEnv: REnvironmentInformationOptionalidMap: AstIdMapProtectedrootContains the vertices of the root level graph (i.e., included those vertices from the complete graph, that are nested within function definitions)
Retrieves the id-map to the normalized AST attached to the dataflow graph
Retrieves the set of vertices which have side effects that we do not know anything about.
StaticfromConstructs 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.
The JSON data to construct the graph from
Adds a new vertex to the graph, for ease of use, some arguments are optional and filled automatically.
The vertex to add
A clean environment to use if no environment is given in the vertex
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.
If true, this will overwrite the vertex if it already exists in the graph (based on the id).
Adds an argument edge with from as function call, and to as argument.
Adds a argument edge with a query for the from and/or to vertices.
Adds a vertex for a function call (V2).
AST node ID
Function name
Function arguments; may be empty
Optionalinfo: {Additional/optional properties.
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)
Adds a call edge with from as caller, and to as callee.
Adds a call edge with a query for the from and/or to vertices.
Adds a vertex for a constant value (V6).
AST node ID
Optionaloptions: { cds?: ControlDependency[] }
Additional/optional properties;
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)
Adds a defined-by edge with from as defined variable, and to as a variable/function contributing to its definition.
Adds a defined-by-on-call edge with from as definition, and to as variable.
Adds a defined-by-on-call edge with a query for the from and/or to vertices.
Adds a defined-by edge with a query for the from and/or to vertices.
Adds a vertex for a function definition (V1).
AST node ID
Node IDs for exit point vertices.
Subflow data graph for the defined function.
Optionalinfo: {Additional/optional properties.
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)
Adds a defines-on-call edge with from as variable, and to as its definition
Adds a defines-on-call edge with a query for the from and/or to vertices.
Adds a vertex for a variable definition (V4).
AST node ID
Optionalname: string
Variable name
Optionalinfo: { cds?: ControlDependency[]; definedBy?: NodeId[] }
Additional/optional properties.
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)
the ids of all edges in the graph together with their edge information
Get the DataflowGraphVertexInfo attached to a node as well as all outgoing edges.
The id of the node to get
If true this will search function definitions as well and not just the toplevel
the node info for the given id (if it exists)
Given a node in the normalized AST this either: returns the id if the node directly exists in the DFG returns the ids of all vertices in the DFG that are linked to this returns undefined if the node is not part of the DFG and not linked to any node
Get the DataflowGraphVertexInfo attached to a root-level vertex.
The id of the node to get
the node info for the given id (if it exists)
Get the DataflowGraphVertexInfo attached to a vertex.
The id of the node to get
the node info for the given id (if it exists)
Returns true if the graph contains a node with the given id.
The id to check for
If true this will check function definitions as well and not just the toplevel
Returns true if the root level of the graph contains a node with the given id.
Merges the other graph into this one (in-place). The return value is only for convenience.
The graph to merge into this one
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
Adds a non-standard evaluation edge with from as vertex, and to as vertex.
Adds a non-standard evaluation edge with a query for the from and/or to vertices.
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 false flags.
Adds a read edge.
NodeId of the source vertex
Either a single or multiple target ids. If you pass multiple this will construct a single edge for each of them.
Adds a read edge with a query for the from and/or to vertices.
Either a node id or a query to find the node id.
Either a node id or a query to find the node id.
The input to search in i.e. the dataflow graph.
Adds a return edge with from as function, and to as exit point.
Adds a return edge with a query for the from and/or to vertices.
Marks a vertex in the graph to be a definition
The reference to the vertex to mark as definition
The id of the source vertex of the def, if available
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)
Adds a side-effect-on-call edge with from as vertex, and to as vertex.
Adds a side-effect-on-call edge with a query for the from and/or to vertices.
Marks a vertex in the graph to be a function call with the new information
The information about the new function call node
Adds a vertex for variable use (V5). Intended for creating dataflow graphs as part of function tests.
AST node id
Optionalname: string
Variable name
Optionalinfo: Partial<DataflowGraphVertexUse>
Additional/optional properties; i.e., scope, when, or environment.
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)
If true this will iterate over function definitions as well and not just the toplevel
the ids of all toplevel vertices in the graph together with their vertex information
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.