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

• getBasicBlockElements: function

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

    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)[]

    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: CfgVertex | undefined,
    ): Set<NodeId> | undefined

    The functions a call may dispatch to, see collectCallTargets for how these are resolved.

    Parameters

    • this: void
    • vertex: CfgVertex | undefined

    Returns Set<NodeId> | undefined

• getChildren: function

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

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

    Parameters

    • this: void
    • vertex: CfgVertex | undefined

    Returns NodeId[] | undefined

• getId: function

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

    Get the id of the given vertex, which directly relates to the AST node, e.g. CfgVertex.getId(CfgVertex.makeExpression('node-1')) gives 'node-1'.

    Type Parameters

    • T extends CfgVertex | undefined

    Parameters

    • this: void
    • vertex: T

    Returns T extends undefined ? NodeId | undefined : NodeId

    See

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

• getType: function

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

    Get the type of the given vertex, e.g. CfgVertex.getType(CfgVertex.makeExpression('node-1')) gives CfgVertexType.Expression.

    Parameters

    • this: void
    • vertex: CfgVertex

    Returns CfgVertexType

    See

    • CfgVertex#isExpression|isExpression(), CfgVertex#isStatement|isStatement(), CfgVertex#isBlock|isBlock() - for ways to check the type of a vertex against a specific type
    • 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: CfgVertex | undefined,
    ): vertex is CfgBasicBlockVertex

    Check whether the given vertex is a basic block vertex.

    Parameters

    • this: void
    • vertex: CfgVertex | undefined

    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: CfgVertex | undefined,
    ): vertex is CfgExpressionVertex

    Check whether the given vertex is an expression vertex.

    Parameters

    • this: void
    • vertex: CfgVertex | undefined

    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

• isStatement: function

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

    Check whether the given vertex is a statement vertex.

    Parameters

    • this: void
    • vertex: CfgVertex | undefined

    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)[],
    ): CfgBasicBlockVertex

    Create a new basic block vertex with the given id and elements.

    Parameters

    • this: void
    • id: NodeId

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

    • elems: readonly (CfgStatementVertex | CfgExpressionVertex)[]

      the vertices that are part of this block in the order they run, only connected by FDs; a vertex should never occur in multiple blocks

    Returns CfgBasicBlockVertex

    See

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

• makeExpression: function

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

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

    Parameters

    • this: void
    • id: NodeId

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

    • children: { callTargets?: Set<NodeId>; children?: NodeId[] } = {}

      child nodes attached to this one

    Returns CfgExpressionVertex

    See

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

• makeExprOrStm: function

  • makeExprOrStm(
        this: void,
        id: NodeId,
        type: Statement | Expression,
        __namedParameters?: { callTargets?: Set<NodeId>; children?: 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[] } = {}

    Returns CfgStatementVertex | CfgExpressionVertex

• makeStatement: function

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

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

    Parameters

    • this: void
    • id: NodeId

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

    • children: { callTargets?: Set<NodeId>; children?: NodeId[] } = {}

      child nodes attached to this one

    Returns CfgStatementVertex

    See

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

• Readonlyname: "CfgVertex"

• setBasicBlockElements: function

  • setBasicBlockElements(
        this: void,
        vertex: CfgBasicBlockVertex,
        elems: readonly (CfgStatementVertex | CfgExpressionVertex)[],
    ): 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)[]

    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

• 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}`

• 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