Class ScopeRegion<TInstruction>

Namespace

Echo.ControlFlow.Regions

Assembly

Echo.ControlFlow.dll

Represents a simple unordered region defining an inner scope in the control flow graph.

public class ScopeRegion<TInstruction> : ControlFlowRegion<TInstruction>, IScopeControlFlowRegion<TInstruction>, IControlFlowRegion<TInstruction>, ISubGraph where TInstruction : notnull

Type Parameters

TInstruction

The type of data that each node in the graph stores.

Inheritance

object

ControlFlowRegion<TInstruction>

ScopeRegion<TInstruction>

Implements

IScopeControlFlowRegion<TInstruction>

IControlFlowRegion<TInstruction>

ISubGraph

Inherited Members

ControlFlowRegion<TInstruction>.ParentGraph

ControlFlowRegion<TInstruction>.ParentRegion

ControlFlowRegion<TInstruction>.Tag

ControlFlowRegion<TInstruction>.GetNodeByOffset(long)

ControlFlowRegion<TInstruction>.GetSuccessors()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ControlFlowRegionExtensions.GetParentExceptionHandler<TInstruction>(IControlFlowRegion<TInstruction>)

ControlFlowRegionExtensions.GetParentHandler<TInstruction>(IControlFlowRegion<TInstruction>)

Constructors

ScopeRegion()

Creates a new empty scope region with no extra semantics attached.

public ScopeRegion()

ScopeRegion(ScopeRegionType)

Creates a new empty scope region of the provided scope type.

public ScopeRegion(ScopeRegionType type)

Parameters

type ScopeRegionType

The type.

Properties

EntryPoint

Gets or sets the first node that is executed in the region.

public ControlFlowNode<TInstruction>? EntryPoint { get; set; }

Property Value

ControlFlowNode<TInstruction>

Nodes

Gets a collection of top-level nodes that this region consists of.

public RegionNodeCollection<TInstruction> Nodes { get; }

Property Value

RegionNodeCollection<TInstruction>

Remarks

This collection does not include any nodes in the nested sub regions.

Regions

Gets a collection of nested subregions that this region defines.

public RegionCollection<TInstruction, ControlFlowRegion<TInstruction>> Regions { get; }

Property Value

RegionCollection<TInstruction, ControlFlowRegion<TInstruction>>

ScopeType

Gets or sets the type of scope.

public ScopeRegionType ScopeType { get; set; }

Property Value

ScopeRegionType

Methods

GetEntryPoint()

Obtains the first node that is executed in the region (if available).

public override ControlFlowNode<TInstruction>? GetEntryPoint()

Returns

ControlFlowNode<TInstruction>

The node, or null if no entrypoint was specified.

GetNodes()

Gets a collection of all nodes in the control flow graph region. This includes all nodes in the nested regions.

public override IEnumerable<ControlFlowNode<TInstruction>> GetNodes()

Returns

IEnumerable<ControlFlowNode<TInstruction>>

The nodes.

GetSubRegions()

Gets a collection of all nested regions defined in this region.

public override IEnumerable<ControlFlowRegion<TInstruction>> GetSubRegions()

Returns

IEnumerable<ControlFlowRegion<TInstruction>>

The subregions.

RemoveNode(ControlFlowNode<TInstruction>)

Removes the node from the region.

public override bool RemoveNode(ControlFlowNode<TInstruction> node)

Parameters

node ControlFlowNode<TInstruction>

The node to remove.

Returns

bool

true if the node was found and removed, false otherwise.