Represents a Debugging Step. More...

Inheritance diagram for BadScript2.Debugging.BadDebuggerStep:

Public Member Functions
	BadDebuggerStep (BadExecutionContext context, BadSourcePosition position, object? stepSource)
	Creates a new Debugger Step.

string	GetInfo ()
	Returns a string representation of the Step.

string	GetSourceView (int[] breakpoints, out int topInSource, out int lineInSource, int lineDelta=4)
	Returns a line listing of the Step.

string	GetSourceView (int top, int bottom, int[] breakpoints, out int topInSource, out int lineInSource)
	Returns a line listing of the Step.

override string	ToString ()
	Returns string representation of the Step.

string[]	GetLines (int top, int bottom, out int topInSource, out int lineInSource)
	Returns a line excerpt of the Step.

bool	Equals (BadDebuggerStep other)
	Returns true if the Step is equal to another object.

override bool	Equals (object? obj)
	Returns true if the Step is equal to another object.

override int	GetHashCode ()
	Returns the Hash Code of the Step.

Static Public Member Functions
static bool	operator== (BadDebuggerStep left, BadDebuggerStep right)
	Implements the == operator.

static bool	operator!= (BadDebuggerStep left, BadDebuggerStep right)
	Implements the != operator.

Public Attributes
readonly? object	StepSource
	The Source of the Step.

readonly BadExecutionContext	Context
	The Execution Context of where the Step was executed.

readonly BadSourcePosition	Position
	The Source Position of the Step.

Detailed Description

Represents a Debugging Step.

Definition at line 12 of file BadDebuggerStep.cs.

Constructor & Destructor Documentation

◆ BadDebuggerStep()

BadScript2.Debugging.BadDebuggerStep.BadDebuggerStep	(	BadExecutionContext	context,
		BadSourcePosition	position,
		object?	stepSource
	)

Creates a new Debugger Step.

Parameters

context	The Execution Context of where the Step was executed
position	The Source Position of the Step
stepSource	The Source of the Step

Definition at line 35 of file BadDebuggerStep.cs.

    {
        Context = context;
        Position = position;
        StepSource = stepSource;
    }

Member Function Documentation

◆ Equals() [1/2]

bool BadScript2.Debugging.BadDebuggerStep.Equals ( BadDebuggerStep other )

Returns true if the Step is equal to another object.

Parameters

other The other object

Returns: True if equal

Definition at line 156 of file BadDebuggerStep.cs.

    {
        return Equals(StepSource, other.StepSource) && Context.Equals(other.Context) && Position.Equals(other.Position);
    }

◆ Equals() [2/2]

override bool BadScript2.Debugging.BadDebuggerStep.Equals ( object? obj )

Returns true if the Step is equal to another object.

Parameters

obj	The other object

Returns: True if equal

Definition at line 166 of file BadDebuggerStep.cs.

    {
        return obj is BadDebuggerStep other && Equals(other);
    }

◆ GetHashCode()

override int BadScript2.Debugging.BadDebuggerStep.GetHashCode ( )

Returns the Hash Code of the Step.

Returns

Definition at line 175 of file BadDebuggerStep.cs.

    {
        return BadHashCode.Combine(StepSource, Context, Position);
    }

◆ GetInfo()

string BadScript2.Debugging.BadDebuggerStep.GetInfo ( )

Returns a string representation of the Step.

Returns: String representation

Definition at line 46 of file BadDebuggerStep.cs.

    {
        return
            $"######################################\nDebug Step at {Position.GetPositionInfo()}\n\nStepSource: {StepSource}\n\nContext: {Context.Scope.Name}: {Context.Scope}\n\n######################################\n";
    }

◆ GetLines()

string[] BadScript2.Debugging.BadDebuggerStep.GetLines	(	int	top,
		int	bottom,
		out int	topInSource,
		out int	lineInSource
	)

Returns a line excerpt of the Step.

Parameters

topInSource	Indicates the start line of the excerpt
lineInSource	Indicates Current line of the code
top	The Amount of lines before the Source Position
bottom	The Amount of lines after the Source Position

Returns: String Representation

Definition at line 122 of file BadDebuggerStep.cs.

    {
        lineInSource = 1;
 
        for (int i = 0; i < Position.Index; i++)
        {
            if (Position.Source[i] == '\n')
            {
                lineInSource++;
            }
        }
 
        topInSource = Math.Max(1, lineInSource - top);
 
        string[] lines = Position.Source.Split('\n');
 
 
        List<string> lns = new List<string>();
 
        for (int i = topInSource - 1;
             i < topInSource - 1 + Math.Min(top + bottom, lines.Length - (topInSource - 1));
             i++)
        {
            lns.Add(lines[i]);
        }
 
        return lns.ToArray();
    }

◆ GetSourceView() [1/2]

string BadScript2.Debugging.BadDebuggerStep.GetSourceView	(	int	top,
		int	bottom,
		int[]	breakpoints,
		out int	topInSource,
		out int	lineInSource
	)

Returns a line listing of the Step.

Parameters

breakpoints	The Line numbers of the breakpoints
topInSource	Indicates the start line of the excerpt
lineInSource	Indicates Current line of the code
top	The Amount of lines before the Source Position
bottom	The Amount of lines after the Source Position

Returns: String Representation

Definition at line 76 of file BadDebuggerStep.cs.

    {
        StringBuilder sb = new StringBuilder($"File: {Position.FileName}\n");
        string[] lines = GetLines(top, bottom, out topInSource, out lineInSource);
 
        for (int i = 0; i < lines.Length; i++)
        {
            int ln = topInSource + i;
            string line = lines[i];
            string prefix = ln.ToString();
 
            if (ln == lineInSource)
            {
                prefix = ">>";
            }
            else
            {
                if (breakpoints.Any(breakpoint => ln == breakpoint))
                {
                    prefix = "@";
                }
            }
 
            sb.AppendLine($"{prefix}\t| {line}");
        }
 
        return sb.ToString();
    }

◆ GetSourceView() [2/2]

string BadScript2.Debugging.BadDebuggerStep.GetSourceView	(	int[]	breakpoints,
		out int	topInSource,
		out int	lineInSource,
		int	lineDelta = `4`
	)

Returns a line listing of the Step.

Parameters

breakpoints	The Line numbers of the breakpoints
topInSource	Indicates the start line of the excerpt
lineInSource	Indicates Current line of the code
lineDelta	The Amount of lines before and after the Source Position

Returns: String Representation

Definition at line 61 of file BadDebuggerStep.cs.

    {
        return GetSourceView(lineDelta, lineDelta, breakpoints, out topInSource, out lineInSource);
    }

◆ operator!=()

static bool BadScript2.Debugging.BadDebuggerStep.operator!=	(	BadDebuggerStep	left,
		BadDebuggerStep	right
	)

static

Implements the != operator.

Parameters

left	The left side
right	The right side

Returns: True if not equal

Definition at line 197 of file BadDebuggerStep.cs.

    {
        return !left.Equals(right);
    }

◆ operator==()

static bool BadScript2.Debugging.BadDebuggerStep.operator==	(	BadDebuggerStep	left,
		BadDebuggerStep	right
	)

static

Implements the == operator.

Parameters

left	The left side
right	The right side

Returns: True if equal

Definition at line 186 of file BadDebuggerStep.cs.

    {
        return left.Equals(right);
    }

◆ ToString()

override string BadScript2.Debugging.BadDebuggerStep.ToString ( )

Returns string representation of the Step.

Returns: String representation

Definition at line 109 of file BadDebuggerStep.cs.

    {
        return GetInfo();
    }

Member Data Documentation

◆ Context

readonly BadExecutionContext BadScript2.Debugging.BadDebuggerStep.Context

The Execution Context of where the Step was executed.

Definition at line 22 of file BadDebuggerStep.cs.

◆ Position

readonly BadSourcePosition BadScript2.Debugging.BadDebuggerStep.Position

The Source Position of the Step.

Definition at line 27 of file BadDebuggerStep.cs.

◆ StepSource

readonly? object BadScript2.Debugging.BadDebuggerStep.StepSource

The Source of the Step.

Definition at line 17 of file BadDebuggerStep.cs.

The documentation for this struct was generated from the following file:

src/BadScript2/Debugging/BadDebuggerStep.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BadDebuggerStep()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ GetInfo()

◆ GetLines()

◆ GetSourceView() [1/2]

◆ GetSourceView() [2/2]

◆ operator!=()

◆ operator==()

◆ ToString()

Member Data Documentation

◆ Context

◆ Position

◆ StepSource