Variable GraphHelperConst

Type declaration

• diffGraphs:function

  • diffGraphs(
        this: void,
        left: NamedGraph,
        right: NamedGraph,
        config?: Partial<GenericDiffConfiguration>,
    ): GraphDifferenceReport

    Compare two dataflow graphs and return a report on the differences. If you simply want to check whether they equal, use <result>.isEqual().

    Parameters

    • this: void
    • left: NamedGraph
    • right: NamedGraph
    • Optionalconfig: Partial<GenericDiffConfiguration>

    Returns GraphDifferenceReport

    See

    diffOfControlFlowGraphs - for control flow graphs

• invertGraph:function

  • invertGraph(
        this: void,
        graph: DataflowGraph,
        cleanEnv: REnvironmentInformation,
    ): DataflowGraph

    Inverts the given dataflow graph by reversing all edges.

    Parameters

    • this: void
    • graph: DataflowGraph
    • cleanEnv: REnvironmentInformation

    Returns DataflowGraph

• resolveGraphCriteria:function

  • resolveGraphCriteria(
        graph: DataflowGraph,
        ctx: ReadOnlyFlowrAnalyzerContext,
        idMap?: AstIdMap,
    ): DataflowGraph

    Resolves the dataflow graph ids from slicing criterion form to ids. This returns a new graph with the resolved ids. The main use-case for this is testing - if you do not know/want to fix the specific id, you can use, e.g. 2@x as a placeholder for the first x in the second line!

    Parameters

    • graph: DataflowGraph
    • ctx: ReadOnlyFlowrAnalyzerContext
    • OptionalidMap: AstIdMap

    Returns DataflowGraph

• Readonlyvisualize: {
      mermaid: {
          convert(
              this: void,
              config: MermaidGraphConfiguration,
          ): { mermaid: MermaidGraph; string: string };
          name: "DataflowMermaid";
          raw(
              this: void,
              graph:
                  | DataflowInformation
                  | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
              includeEnvironments?: boolean,
              mark?: ReadonlySet<NodeId>,
              simplified?: boolean,
          ): string;
          url(
              this: void,
              graph:
                  | DataflowInformation
                  | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
              includeEnvironments?: boolean,
              mark?: ReadonlySet<NodeId>,
              simplified?: boolean,
          ): string;
      };
      quads: {
          convert: (
              graph: DataflowGraph,
              config: QuadSerializationConfiguration,
          ) => string;
      };
  }

  Maps to the mermaid-centric visualization helper for dataflow graphs and their views

  • Readonlymermaid: {
        convert(
            this: void,
            config: MermaidGraphConfiguration,
        ): { mermaid: MermaidGraph; string: string };
        name: "DataflowMermaid";
        raw(
            this: void,
            graph:
                | DataflowInformation
                | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
            includeEnvironments?: boolean,
            mark?: ReadonlySet<NodeId>,
            simplified?: boolean,
        ): string;
        url(
            this: void,
            graph:
                | DataflowInformation
                | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
            includeEnvironments?: boolean,
            mark?: ReadonlySet<NodeId>,
            simplified?: boolean,
        ): string;
    }

    Mermaid rendering helper for dataflow graphs

    • DataflowMermaid.url, DataflowMermaid.raw - to render the graph as a mermaid graph (e.g., in markdown or the mermaid live editor)
    • DataflowMermaid.convert - for the underyling transformation

    See

    DataflowMermaid

    • convert:function

      • convert(
            this: void,
            config: MermaidGraphConfiguration,
        ): { mermaid: MermaidGraph; string: string }

        Converts a dataflow graph to mermaid graph code that visualizes the graph.

        Parameters

        • this: void
        • config: MermaidGraphConfiguration

        Returns { mermaid: MermaidGraph; string: string }

        See

        DataflowMermaid.url - render the given graph to a url to mermaid.live

    • Readonlyname: "DataflowMermaid"

    • raw:function

      • raw(
            this: void,
            graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
            includeEnvironments?: boolean,
            mark?: ReadonlySet<NodeId>,
            simplified?: boolean,
        ): string

        This is a simplified version of DataflowMermaid.convertToMermaid

        Parameters

        • this: void
        • graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>
        • OptionalincludeEnvironments: boolean
        • Optionalmark: ReadonlySet<NodeId>
        • simplified: boolean = false

        Returns string

    • url:function

      • url(
            this: void,
            graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>,
            includeEnvironments?: boolean,
            mark?: ReadonlySet<NodeId>,
            simplified?: boolean,
        ): string

        Converts a dataflow graph to a mermaid url that visualizes the graph. This is basically a combination of DataflowMermaid.mermaidRaw and Mermaid.codeToUrl.

        Parameters

        • this: void
        • graph: DataflowInformation | DataflowGraph<DataflowGraphVertexInfo, DfEdge>

          the dataflow graph to render
        • OptionalincludeEnvironments: boolean

          whether to include the environment content in the output
        • Optionalmark: ReadonlySet<NodeId>

          which vertices to highlight in the visualization
        • simplified: boolean = false

          whether to show a simplified use of the graph with fewer details on the vertices and edges

        Returns string

  • Readonlyquads: {
        convert: (
            graph: DataflowGraph,
            config: QuadSerializationConfiguration,
        ) => string;
    }

    • Readonlyconvert: (graph: DataflowGraph, config: QuadSerializationConfiguration) => string