Class DataflowGraphBuilder
Hierarchy (View Summary)
- DataflowGraph
- DataflowGraphBuilder
Hierarchy-Diagram
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
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
Retrieves the id-map to the normalized AST attached to the dataflow graph
Returns undefined | AstIdMap
unknown
Retrieves the set of vertices which have side effects that we do not know anything about.
Returns Set<UnknownSidEffect>
Methods
Staticfrom
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
- data: DataflowGraphJson
add
add
Parameters
- from: ReferenceForEdge
- to: ReferenceForEdge
- type: number
Returns this
- addEdge(
    from: NodeId | ReferenceForEdge,
    to: NodeId | ReferenceForEdge,
    type: number,
): thisParameters
- from: NodeId | ReferenceForEdge
- to: NodeId | ReferenceForEdge
- type: number
Returns this
add
- addVertex(
    vertex: DataflowGraphVertexArgument & Omit<
        DataflowGraphVertexInfo,
        string
        | number,
    >,
    asRoot?: boolean,
    overwrite?: boolean,
): thisAdds 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.
- overwrite: boolean = false
If true, this will overwrite the vertex if it already exists in the graph (based on the id).
Returns this
- vertex: DataflowGraphVertexArgument & Omit<DataflowGraphVertexInfo, string | number>
argument
Adds an argument edge with from as function call, and to as argument.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
argument
- argumentQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a argument edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
call
- call(
    id: NodeId,
    name: string,
    args: FunctionArgument[],
    info?: {
        builtInEnvironment?: IEnvironment;
        controlDependencies?: ControlDependency[];
        environment?: REnvironmentInformation;
        link?: DataflowGraphVertexAstLink;
        onlyBuiltIn?: boolean;
        origin?: string[];
        reads?: readonly NodeId[];
        returns?: readonly NodeId[];
    },
    asRoot?: boolean,
): DataflowGraphBuilderAdds 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: {
    builtInEnvironment?: IEnvironment;
    controlDependencies?: ControlDependency[];
    environment?: REnvironmentInformation;
    link?: DataflowGraphVertexAstLink;
    onlyBuiltIn?: boolean;
    origin?: string[];
    reads?: readonly NodeId[];
    returns?: readonly NodeId[];
}Additional/optional properties.
- 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
Adds a call edge with from as caller, and to as callee.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
calls
- callsQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a call edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
constant
- constant(
    id: NodeId,
    options?: { controlDependencies?: ControlDependency[] },
    asRoot?: boolean,
): DataflowGraphBuilderAdds a vertex for a constant value (V6).
Parameters
- id: NodeId
AST node ID
Optionaloptions: { controlDependencies?: ControlDependency[] }Additional/optional properties;
- 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
Adds a defined-by edge with from as defined variable, and to as a variable/function contributing to its definition.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
defined
Adds a defined-by-on-call edge with from as definition, and to as variable.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
defined
- definedByOnCallQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a defined-by-on-call edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
defined
- definedByQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a defined-by edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
define
- defineFunction(
    id: NodeId,
    exitPoints: readonly NodeId[],
    subflow: DataflowFunctionFlowInformation,
    info?: {
        builtInEnvironment?: IEnvironment;
        controlDependencies?: ControlDependency[];
        environment?: REnvironmentInformation;
    },
    asRoot?: boolean,
): DataflowGraphBuilderAdds 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: {
    builtInEnvironment?: IEnvironment;
    controlDependencies?: ControlDependency[];
    environment?: REnvironmentInformation;
}Additional/optional properties.
- 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
Adds a defines-on-call edge with from as variable, and to as its definition
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
defines
- definesOnCallQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a defines-on-call edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
define
- defineVariable(
    id: NodeId,
    name?: string,
    info?: { controlDependencies?: ControlDependency[]; definedBy?: NodeId[] },
    asRoot?: boolean,
): DataflowGraphBuilderAdds a vertex for a variable definition (V4).
Parameters
- id: NodeId
AST node ID
Optionalname: stringVariable name
Optionalinfo: { controlDependencies?: ControlDependency[]; definedBy?: NodeId[] }Additional/optional properties.
- 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
Returns MapIterator<[NodeId, OutgoingEdges<DataflowGraphEdge>]>
the ids of all edges in the graph together with their edge information
get
- get(
    id: NodeId,
    includeDefinedFunctions?: boolean,
): 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
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
Parameters
- nodeId: NodeId
Returns undefined | NodeId[]
get
- getVertex(
    id: NodeId,
    includeDefinedFunctions?: boolean,
): undefined | DataflowGraphVertexInfoGet 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
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
Parameters
- id: NodeId
Returns undefined | IngoingEdges<DataflowGraphEdge>
is
Returns true if the root level of the graph contains a node with the given id.
Parameters
- id: NodeId
Returns boolean
mark
merge
- mergeWith(
    otherGraph:
        | undefined
        | DataflowGraph<DataflowGraphVertexInfo, DataflowGraphEdge>,
    mergeRootVertices?: boolean,
): thisMerges 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
Adds a non-standard evaluation edge with from as vertex, and to as vertex.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
nse
- nseQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a non-standard evaluation edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
outgoing
Parameters
- id: NodeId
Returns undefined | OutgoingEdges<DataflowGraphEdge>
overwrite
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
Adds a read edge.
Parameters
- from: NodeId
NodeId of the source vertex
- to: DataflowGraphEdgeTarget
Either a single or multiple target ids. If you pass multiple this will construct a single edge for each of them.
Returns DataflowGraphBuilder
- from: NodeId
reads
- readsQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    input: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a read edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
Either a node id or a query to find the node id.
- to: ToQueryParam
Either a node id or a query to find the node id.
- input: ReadonlyFlowrAnalysisProvider
The input to search in i.e. the dataflow graph.
Returns Promise<DataflowGraphBuilder>
- from: FromQueryParam
returns
Adds a return edge with from as function, and to as exit point.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
returns
- returnsQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a return edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
root
Returns ReadonlySet<NodeId>
set
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
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
Adds a side-effect-on-call edge with from as vertex, and to as vertex.
Parameters
- from: NodeId
- to: DataflowGraphEdgeTarget
Returns DataflowGraphBuilder
See
reads for parameters.
side
- sideEffectOnCallQuery(
    from: FromQueryParam,
    to: ToQueryParam,
    data: ReadonlyFlowrAnalysisProvider,
): Promise<DataflowGraphBuilder>Adds a side-effect-on-call edge with a query for the from and/or to vertices.
Parameters
- from: FromQueryParam
- to: ToQueryParam
- data: ReadonlyFlowrAnalysisProvider
Returns Promise<DataflowGraphBuilder>
See
readsQuery for parameters.
update
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: NodeId,
    name?: string,
    info?: Partial<DataflowGraphVertexUse>,
    asRoot?: boolean,
): DataflowGraphBuilderAdds 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
Parameters
- includeDefinedFunctions: boolean
If true this will iterate over function definitions as well and not just the toplevel
Returns MapIterator<[NodeId, DataflowGraphVertexInfo]>
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.