Variable DfEdge

Type Declaration

• doesNotIncludeType: function

  • doesNotIncludeType(
        this: void,
        __namedParameters: DfEdgeLike,
        any: EdgeType,
    ): boolean

    Check if the given-edge type does not include the given type. As types are bitmasks, you can combine multiple types with a bitwise OR (|). Counterpart of DfEdge#includesType.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • any: EdgeType

    Returns boolean

• hasAnyType: function

  • hasAnyType(this: void, __namedParameters: DfEdgeLike): boolean

    Whether the edge carries any type at all. Counterpart of DfEdge#hasNoType.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns boolean

    Example

    DfEdge.hasAnyType({ types: EdgeType.Reads }) // true
    DfEdge.hasAnyType({ types: 0 })              // false
    Copy

• hasNoType: function

  • hasNoType(this: void, __namedParameters: DfEdgeLike): boolean

    Whether the edge carries no type at all. Such an edge states nothing and has to be removed, not kept. Counterpart of DfEdge#hasAnyType.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns boolean

• includesType: function

  • includesType(
        this: void,
        __namedParameters: DfEdgeLike,
        typesToInclude: EdgeType,
    ): boolean

    Check if the given-edge type has any of the given types. As types are bitmasks, you can combine multiple types with a bitwise OR (|).

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • typesToInclude: EdgeType

    Returns boolean

    Example

    edgeIncludesType({ types: EdgeType.Reads }, EdgeType.Reads | EdgeType.DefinedBy) // true
    Copy

    Counterpart of DfEdge#doesNotIncludeType.

• isOnlyControlFlow: function

  • isOnlyControlFlow(this: void, __namedParameters: DfEdgeLike): boolean

    Whether the edge carries nothing but control flow, i.e. it exists only because the ControlFlowGraph is a view on the dataflow graph.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns boolean

    See

    ControlFlowEdgeTypes

• isOnlyType: function

  • isOnlyType(this: void, __namedParameters: DfEdgeLike, only: EdgeType): boolean

    Check whether the edge carries the given types and nothing else. Strict counterpart of DfEdge#includesType, which already holds if one of the bits is set.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • only: EdgeType

    Returns boolean

    Example

    DfEdge.isOnlyType({ types: EdgeType.Reads | EdgeType.Calls }, EdgeType.Reads)                  // false
    DfEdge.isOnlyType({ types: EdgeType.Reads | EdgeType.Calls }, EdgeType.Reads | EdgeType.Calls) // true
    Copy

• Readonlyname: "DfEdge"

• splitTypes: function

  • splitTypes(this: void, __namedParameters: DfEdgeLike): EdgeType[]

    Takes joint edge types and splits them into their individual components.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns EdgeType[]

    Example

    DfEdge.splitTypes({ types: EdgeType.Reads | EdgeType.DefinedBy });
    // returns [EdgeType.Reads, EdgeType.DefinedBy]
    Copy

• typesToNames: function

  • typesToNames(this: void, __namedParameters: DfEdgeLike): Set<EdgeTypeName>

    Takes joint edge types and returns their human-readable names.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns Set<EdgeTypeName>

• typeToName: function

  • typeToName(this: void, type: EdgeType): string

    Only use this function to retrieve a human-readable name if you know that it is a single bitmask. Otherwise, use DfEdge#typesToNames which handles these cases.

    Parameters

    • this: void
    • type: EdgeType

    Returns string

• without: function

  • without(this: void, __namedParameters: DfEdgeLike, drop: number): DfEdge

    The same edge without the given types, e.g. to look at the dataflow part of an edge on its own.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • drop: number

    Returns DfEdge