Variable CfgVertex

Type declaration

• equal:function

  • equal(this: void, a: CfgVertex, b: CfgVertex): boolean

    Check whether two vertices are equal, i.e., they have the same type, id, and if they are basic block vertices, they also have the same elements in the same order.

    Parameters

    • this: void
    • a: CfgVertex
    • b: CfgVertex

    Returns boolean

• fromExitId:function

  • fromExitId(this: void, exitId: NodeId): NodeId

    Converts the given id from a canonical end marker lift to the original id (i.e., it removes '-end' as a suffix if it is present).

    Parameters

    • this: void
    • exitId: NodeId

    Returns NodeId

    See

    CfgVertex#toExitId|toExitId() - for a way to convert the given id to a canonical end marker lift (i.e., it adds '-end' as a suffix)

• getBasicBlockElements:function

  • getBasicBlockElements(
        this: void,
        vertex: CfgBasicBlockVertex,
    ): readonly (CfgStatementVertex | CfgExpressionVertex | CfgMarkerVertex)[]

    Get the elements of a basic block vertex, i.e., the vertices that are part of this block, only connected by FDs, vertices should never occur in multiple bbs.

    Parameters

    • this: void
    • vertex: CfgBasicBlockVertex

    Returns readonly (CfgStatementVertex | CfgExpressionVertex | CfgMarkerVertex)[]

    See

    • CfgVertex#isBlock|isBlock() - for a way to check whether a vertex is a basic block vertex before trying to get the elements
    • CfgVertex#setBasicBlockElements|setBasicBlockElements() - for a way to set the elements of a basic block vertex

• getCallTargets:function

  • getCallTargets(
        this: void,
        vertex: undefined | CfgVertex,
    ): undefined | Set<NodeId>

    Get the call targets of a statement or expression vertex, which links all targets of this call.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns undefined | Set<NodeId>

• getChildren:function

  • getChildren(this: void, vertex: undefined | CfgVertex): undefined | NodeId[]

    Get the children of a statement or expression vertex, i.e., the child nodes attached to this one.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns undefined | NodeId[]

• getEnd:function

  • getEnd(this: void, vertex: undefined | CfgVertex): undefined | NodeId[]

    Get the ids of the mid-markers attached to this vertex, which should directly relate to the AST nodes of the mid markers.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns undefined | NodeId[]

    See

    • CfgVertex#getMid|getMid() - for a way to get the ids of the mid-markers attached to this vertex
    • CfgVertex#setEnd|setEnd() - for a way to set the ids of the end-markers attached to this vertex

• getId:function

  • getId<T extends undefined | CfgVertex>(
        this: void,
        vertex: T,
    ): T extends undefined ? undefined | NodeId : NodeId

    Get the id of the given vertex, which should directly relate to the AST node.

    Type Parameters

    • T extends undefined | CfgVertex

    Parameters

    • this: void
    • vertex: T

    Returns T extends undefined ? undefined | NodeId : NodeId

    Example

    const vertex: CfgVertex = CfgVertex.makeExpr('node-1')
    console.log(CfgVertex.getId(vertex)); // Output: 'node-1'
    Copy

    See

    • CfgVertex#getType|getType() - for a way to get the type of a vertex
    • CfgVertex#getRootId|getRootId() - for a way to get the root id of a vertex

• getMid:function

  • getMid(this: void, vertex: CfgVertex): undefined | NodeId[]

    Get the ids of the mid-markers attached to this vertex, which should directly relate to the AST nodes of the mid markers.

    Parameters

    • this: void
    • vertex: CfgVertex

    Returns undefined | NodeId[]

• getRootId:function

  • getRootId(this: void, vertex: CfgVertex): NodeId

    Get the root id of a vertex, i.e., the id of the AST node it corresponds to. For normal vertices, this is the same as the id of the vertex itself, for end marker vertices, this is the root id stored in the vertex.

    Parameters

    • this: void
    • vertex: CfgVertex

    Returns NodeId

    See

    CfgVertex#unpackRoot|unpackRoot() - for a way to unpack the root id of a marker vertex

• getType:function

  • getType(this: void, vertex: CfgVertex): CfgVertexType

    Get the type of the given vertex.

    Parameters

    • this: void
    • vertex: CfgVertex

    Returns CfgVertexType

    Example

    const vertex: CfgVertex = CfgVertex.makeExpr('node-1')
    console.log(CfgVertex.getType(vertex)); // Output: CfgVertexType.Expression
    Copy

    See

    • CfgVertex#isExpression|isExpression(), CfgVertex#isStatement|isStatement(), CfgVertex#isMarker|isMarker(), CfgVertex#isBlock|isBlock() - for ways to check the type of a vertex against a specific type instead of getting the type and checking it against a specific type
    • CfgVertex#getId|getId() - for a way to get the id of a vertex
    • CfgVertex#typeToString|typeToString() - for a way to convert the type of a vertex to a string for easier debugging and visualization

• isBlock:function

  • isBlock(
        this: void,
        vertex: undefined | CfgVertex,
    ): vertex is CfgBasicBlockVertex

    Check whether the given vertex is a basic block vertex.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns vertex is CfgBasicBlockVertex

    See

    • CfgVertex#makeBlock|makeBlock() - for a way to create basic block vertices
    • CfgVertex#getType|getType() - for a way to get the type of a vertex instead of checking against a given type

• isExpression:function

  • isExpression(
        this: void,
        vertex: undefined | CfgVertex,
    ): vertex is CfgExpressionVertex

    Check whether the given vertex is an expression vertex.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns vertex is CfgExpressionVertex

    See

    • CfgVertex#makeExpression|makeExpression() - for a way to create expression vertices
    • CfgVertex#getType|getType() - for a way to get the type of a vertex instead of checking against a given type

• isMarker:function

  • isMarker(this: void, vertex: undefined | CfgVertex): vertex is CfgMarkerVertex

    Check whether the given vertex is an end marker vertex.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns vertex is CfgMarkerVertex

    See

    • CfgVertex#makeMarker|makeMarker() - for a way to create end marker vertices
    • CfgVertex#getType|getType() - for a way to get the type of a vertex instead of checking against a given type

• isStatement:function

  • isStatement(
        this: void,
        vertex: undefined | CfgVertex,
    ): vertex is CfgStatementVertex

    Check whether the given vertex is a statement vertex.

    Parameters

    • this: void
    • vertex: undefined | CfgVertex

    Returns vertex is CfgStatementVertex

    See

    • CfgVertex#makeStatement|makeStatement() - for a way to create statement vertices
    • CfgVertex#getType|getType() - for a way to get the type of a vertex instead of checking against a given type

• makeBlock:function

  • makeBlock(
        this: void,
        id: NodeId,
        elems: readonly (
            CfgStatementVertex
            | CfgExpressionVertex
            | CfgMarkerVertex
        )[],
    ): CfgBasicBlockVertex

    Create a new basic block vertex with the given id, elements, children, and call targets.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • elems: readonly (CfgStatementVertex | CfgExpressionVertex | CfgMarkerVertex)[]

      the vertices that are part of this block, only connected by FDs, vertices should never occur in multiple bbs

    Returns CfgBasicBlockVertex

    See

    CfgVertex#isBlock|isBlock() - for a way to check whether a vertex is a basic block vertex

• makeExitMarker:function

  • makeExitMarker(this: void, id: NodeId): CfgMarkerVertex

    A convenience function to create a new marker vertex with a canonical id (CfgVertex#toExitId|toExitId()) based on the given id and the given id as root id.

    Parameters

    • this: void
    • id: NodeId

    Returns CfgMarkerVertex

    See

    CfgVertex#makeMarker|makeMarker() - for a way to create end marker vertices with a custom id

• makeExpression:function

  • makeExpression(
        this: void,
        id: NodeId,
        __namedParameters?: {
            callTargets?: Set<NodeId>;
            children?: NodeId[];
            end?: NodeId[];
            mid?: NodeId[];
        },
    ): CfgExpressionVertex

    Create a new expression vertex with the given id, children, call targets, and markers.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • __namedParameters: {
          callTargets?: Set<NodeId>;
          children?: NodeId[];
          end?: NodeId[];
          mid?: NodeId[];
      } = {}

    Returns CfgExpressionVertex

    See

    CfgVertex#isExpression|isExpression() - for a way to check whether a vertex is an expression vertex

• makeExpressionWithEnd:function

  • makeExpressionWithEnd(
        this: void,
        id: NodeId,
        __namedParameters?: {
            callTargets?: Set<NodeId>;
            children?: NodeId[];
            mid?: NodeId[];
        },
    ): CfgExpressionVertex

    A convenience function to create a new expression vertex with a canonical end marker (CfgVertex#toExitId|toExitId()) based on the given id and the given id as root id for the end marker.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • __namedParameters: { callTargets?: Set<NodeId>; children?: NodeId[]; mid?: NodeId[] } = {}

    Returns CfgExpressionVertex

    See

    • CfgVertex#makeExpression|makeExpression() - for a way to create expression vertices with a custom end marker
    • CfgVertex#makeExitMarker|makeExitMarker() - for a helper function to create end marker vertices with a canonical id#
    • CfgVertex#toExitId|toExitId() - for a way to convert the given id to a canonical end marker id

• makeExprOrStm:function

  • makeExprOrStm(
        this: void,
        id: NodeId,
        type: Statement | Expression,
        __namedParameters?: {
            callTargets?: Set<NodeId>;
            children?: NodeId[];
            end?: NodeId[];
            mid?: NodeId[];
        },
    ): CfgStatementVertex
    | CfgExpressionVertex

    A convenience function to create a new vertex which is either a statement or an expression.

    Parameters

    • this: void
    • id: NodeId
    • type: Statement | Expression
    • __namedParameters: {
          callTargets?: Set<NodeId>;
          children?: NodeId[];
          end?: NodeId[];
          mid?: NodeId[];
      } = {}

    Returns CfgStatementVertex | CfgExpressionVertex

• makeMarker:function

  • makeMarker(this: void, id: NodeId, rootId: NodeId): CfgMarkerVertex

    Create a new marker vertex with the given id, root id, children, and call targets.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • rootId: NodeId

      the id of the AST node this end marker corresponds to

    Returns CfgMarkerVertex

    See

    • CfgVertex#isMarker|isMarker() - for a way to check whether a vertex is an end marker vertex
    • CfgVertex#getRootId|getRootId() - for a way to get the root id of an end marker vertex
    • CfgVertex#makeExitMarker|makeExitMarker() - for a helper function to create end marker vertices with a canonical id

• makeStatement:function

  • makeStatement(
        this: void,
        id: NodeId,
        __namedParameters?: {
            callTargets?: Set<NodeId>;
            children?: NodeId[];
            end?: NodeId[];
            mid?: NodeId[];
        },
    ): CfgStatementVertex

    Create a new statement vertex with the given id, children, call targets, and markers.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • __namedParameters: {
          callTargets?: Set<NodeId>;
          children?: NodeId[];
          end?: NodeId[];
          mid?: NodeId[];
      } = {}

    Returns CfgStatementVertex

    See

    CfgVertex#isStatement|isStatement() - for a way to check whether a vertex is a statement vertex

• makeStatementWithEnd:function

  • makeStatementWithEnd(
        this: void,
        id: NodeId,
        __namedParameters?: {
            callTargets?: Set<NodeId>;
            children?: NodeId[];
            mid?: NodeId[];
        },
    ): CfgStatementVertex

    A convenience function to create a new statement vertex with a canonical end marker (CfgVertex#toExitId|toExitId()) based on the given id and the given id as root id for the end marker.

    Parameters

    • this: void
    • id: NodeId

      the id of the vertex, which should directly relate to the AST node
    • __namedParameters: { callTargets?: Set<NodeId>; children?: NodeId[]; mid?: NodeId[] } = {}

    Returns CfgStatementVertex

    See

    • CfgVertex#makeExpression|makeExpression() - for a way to create expression vertices with a custom end marker
    • CfgVertex#makeExitMarker|makeExitMarker() - for a helper function to create end marker vertices with a canonical id#
    • CfgVertex#toExitId|toExitId() - for a way to convert the given id to a canonical end marker id

• mapCallTargets:function

  • mapCallTargets(
        this: void,
        vertex: CfgStatementVertex | CfgExpressionVertex,
        mapFn: (targets: undefined | Set<NodeId>) => Set<NodeId>,
    ): void

    Map the call targets of a statement or expression vertex, which links all targets of this call, to new call targets using the given mapping function.

    Parameters

    • this: void
    • vertex: CfgStatementVertex | CfgExpressionVertex
    • mapFn: (targets: undefined | Set<NodeId>) => Set<NodeId>

    Returns void

    See

    • CfgVertex#getCallTargets|getCallTargets() - for a way to get the call targets of a statement or expression vertex
    • CfgVertex#setCallTargets|setCallTargets() - for a way to set the call targets of a statement or expression vertex to new call targets

• setBasicBlockElements:function

  • setBasicBlockElements(
        this: void,
        vertex: CfgBasicBlockVertex,
        elems: readonly (
            CfgStatementVertex
            | CfgExpressionVertex
            | CfgMarkerVertex
        )[],
    ): void

    Sets in-place Set the elements of a basic block vertex, i.e., the vertices that are part of this block, only connected by FDs, vertices should never occur in multiple bbs.

    Parameters

    • this: void
    • vertex: CfgBasicBlockVertex
    • elems: readonly (CfgStatementVertex | CfgExpressionVertex | CfgMarkerVertex)[]

    Returns void

    See

    • CfgVertex#isBlock|isBlock() - for a way to check whether a vertex is a basic block vertex before trying to set the elements
    • CfgVertex#getBasicBlockElements|getBasicBlockElements() - for a way to get the elements of a basic block vertex

• setCallTargets:function

  • setCallTargets(
        this: void,
        vertex: CfgStatementVertex | CfgExpressionVertex,
        callTargets: Set<NodeId>,
    ): void

    Sets in-place Set the call targets of a statement or expression vertex, which links all targets of this call.

    Parameters

    • this: void
    • vertex: CfgStatementVertex | CfgExpressionVertex
    • callTargets: Set<NodeId>

    Returns void

    See

    • CfgVertex#getCallTargets|getCallTargets() - for a way to get the call targets of a statement or expression vertex
    • CfgVertex#mapCallTargets|mapCallTargets() - for a way to map the call targets of a statement or expression vertex to new call targets

• setEnd:function

  • setEnd(
        this: void,
        vertex: CfgStatementVertex | CfgExpressionVertex,
        endMarkers: undefined | NodeId[],
    ): void

    Sets in-place Set the ids of the end-markers attached to this vertex, which should directly relate to the AST nodes of the end markers.

    Parameters

    • this: void
    • vertex: CfgStatementVertex | CfgExpressionVertex
    • endMarkers: undefined | NodeId[]

    Returns void

    See

    CfgVertex#getEnd|getEnd() - for a way to get the ids of the end-markers attached to this vertex

• setMid:function

  • setMid(
        this: void,
        vertex: CfgStatementVertex | CfgExpressionVertex,
        midMarkers: undefined | NodeId[],
    ): void

    Sets in-place Set the ids of the mid-markers attached to this vertex, which should directly relate to the AST nodes of the mid markers.

    Parameters

    • this: void
    • vertex: CfgStatementVertex | CfgExpressionVertex
    • midMarkers: undefined | NodeId[]

    Returns void

    See

    • CfgVertex#getMid|getMid() - for a way to get the ids of the mid-markers attached to this vertex
    • CfgVertex#setEnd|setEnd() - for a way to set the ids of the end-markers attached to this vertex

• toBasicBlockId:function

  • toBasicBlockId<Id extends NodeId>(this: void, id: Id): `bb-${Id}`

    Converts the given id to a, canonical, basic block lift (i.e., it adds 'bb-' as a prefix).

    Type Parameters

    • Id extends NodeId

    Parameters

    • this: void
    • id: Id

    Returns `bb-${Id}`

• toExitId:function

  • toExitId<Id extends NodeId>(this: void, id: Id): `${Id}-e`

    Converts the given id to a canonical, end marker lift (i.e., it adds '-end' as a suffix).

    Type Parameters

    • Id extends NodeId

    Parameters

    • this: void
    • id: Id

    Returns `${Id}-e`

    See

    CfgVertex#fromExitId|fromExitId() - for a way to convert the given id from a canonical end marker lift to the original id (i.e., it removes '-end' as a suffix if it is present)

• typeToString:function

  • typeToString(this: void, type: CfgVertexType): string

    Convert the given vertex type to a string for easier debugging and visualization.

    Parameters

    • this: void
    • type: CfgVertexType

    Returns string

    See

    • CfgVertexType - for the possible vertex types
    • CfgVertex#getType|getType() - for a way to get the type of a vertex and convert it to a string

• unpackRootId:function

  • unpackRootId(this: void, vertex: CfgMarkerVertex): NodeId

    Unpack the root id of a marker vertex, i.e., get the root id stored in the vertex or derive it from the canonical id if it is not explicitly stored.

    Parameters

    • this: void
    • vertex: CfgMarkerVertex

    Returns NodeId

    See

    CfgVertex#getRootId|getRootId() - for a way to get the root id of a vertex, which uses this function for marker vertices