BadScript2.Common.BadSourcePosition Class Reference

Describes a specific position inside a source file. More...

Public Member Functions
	BadSourcePosition (string? fileName, string source, int index, int length)
	Constructor for a Source Position.
string	GetExcerpt (int len=10)
	Returns the excerpt of the source code.
string	GetExcerpt (int left, int right)
	Returns the excerpt of the source code.
int	GetLine ()
string	GetPositionInfo ()
	Returns position info. Format: file://[FileName] : Line [Line].
BadSourcePosition	Combine (BadSourcePosition other)
	Combines two Source Positions.

Static Public Member Functions
static BadSourcePosition	Create (string fileName, string source, int index, int length)
	Creates a new Source Position.
static BadSourcePosition	FromFile (string fileName, int index, int length)
	Creates a new Source Position.
static BadSourcePosition	FromSource (string source, int index, int length)
	Creates a new Source Position.

Properties
string?	FileName [get]
	The Filename of the Source Code.
string	Source [get]
	The Source Code.
int	Index [get]
	The Start Index of the Position.
int	Length [get]
	The Length of the Position.
string	Text [get]
	Returns the Position as a string.

Private Member Functions
	BadSourcePosition (string fileName, int index, int length)
	Constructor for a Source Position.

Private Attributes
string?	m_PositionInfo
string?	m_Text

Detailed Description

Describes a specific position inside a source file.

Definition at line 8 of file BadSourcePosition.cs.

Constructor & Destructor Documentation

BadSourcePosition() [1/2]

BadScript2.Common.BadSourcePosition.BadSourcePosition	(	string?	fileName,
		string	source,
		int	index,
		int	length
	)

Constructor for a Source Position.

Parameters

fileName	The (optional but recommended) filename
source	The source code.
index	The Start Index
length	The Length

Definition at line 21 of file BadSourcePosition.cs.

    {
        FileName = fileName?.Replace('\\', '/');
        Source = source;
        Index = index;
        Length = length;
    }

BadSourcePosition() [2/2]

BadScript2.Common.BadSourcePosition.BadSourcePosition ( string  fileName, int  index, int  length  )

private

Constructor for a Source Position.

Parameters

fileName	The filename
index	The Start Index
length	The Length

Definition at line 36 of file BadSourcePosition.cs.

                                                                      : this(fileName,
                                                                             BadFileSystem.ReadAllText(fileName),
                                                                             index,
                                                                             length
                                                                            ) { }

Member Function Documentation

Combine()

BadSourcePosition BadScript2.Common.BadSourcePosition.Combine

(

BadSourcePosition

other

)

Combines two Source Positions.

Parameters

other

The Other position

Returns

Combined Source Position

Exceptions

InvalidOperationException

Gets raised if the filenames do not match

Definition at line 170 of file BadSourcePosition.cs.

    {
        if (FileName != other.FileName && Source != other.Source)
        {
            throw new InvalidOperationException("Cannot combine positions from different sources");
        }
 
        return Index < other.Index
                   ? new BadSourcePosition(FileName, Source, Index, other.Index + other.Length - Index)
                   : new BadSourcePosition(FileName, Source, other.Index, Index + Length - other.Index);
    }

Create()

static BadSourcePosition BadScript2.Common.BadSourcePosition.Create ( string  fileName, string  source, int  index, int  length  )

static

Creates a new Source Position.

Parameters

fileName	The (optional but recommended) filename
source	The source code.
index	The Start Index
length	The Length

Returns

Created SourcePosition

Definition at line 75 of file BadSourcePosition.cs.

    {
        return new BadSourcePosition(fileName, source, index, length);
    }

FromFile()

static BadSourcePosition BadScript2.Common.BadSourcePosition.FromFile ( string  fileName, int  index, int  length  )

static

Creates a new Source Position.

Parameters

fileName	The filename
index	The Start Index
length	The Length

Returns

Created SourcePosition

Definition at line 87 of file BadSourcePosition.cs.

    {
        return new BadSourcePosition(fileName, index, length);
    }

FromSource()

static BadSourcePosition BadScript2.Common.BadSourcePosition.FromSource ( string  source, int  index, int  length  )

static

Creates a new Source Position.

Parameters

source	The source code.
index	The Start Index
length	The Length

Returns

Created SourcePosition

Definition at line 99 of file BadSourcePosition.cs.

    {
        return new BadSourcePosition("<nofile>", source, index, length);
    }

GetExcerpt() [1/2]

string BadScript2.Common.BadSourcePosition.GetExcerpt	(	int	left,
		int	right
	)

Returns the excerpt of the source code.

Parameters

left	The additional Characters before the excerpt
right	The additional Characters after the excerpt

Returns

String Excerpt

Definition at line 122 of file BadSourcePosition.cs.

    {
        int start = Math.Max(0, Index - left);
        int end = Math.Min(Source.Length, Index + Length + right);
 
        return Source.Substring(start, end - start);
    }

GetExcerpt() [2/2]

string BadScript2.Common.BadSourcePosition.GetExcerpt

(

int

len = 10

)

Returns the excerpt of the source code.

Parameters

len	The additional Characters before and after the excerpt

Returns

String Excerpt

Definition at line 110 of file BadSourcePosition.cs.

    {
        return GetExcerpt(len, len);
    }

GetLine()

int BadScript2.Common.BadSourcePosition.GetLine

(

)

Definition at line 130 of file BadSourcePosition.cs.

    {
        int line = 1;
 
        for (int i = 0; i < Index; i++)
        {
            if (Source[i] == '\n')
            {
                line++;
            }
        }
        
        return line;
    }

GetPositionInfo()

string BadScript2.Common.BadSourcePosition.GetPositionInfo

(

)

Returns position info. Format: file://[FileName] : Line [Line].

Returns

String Representation

Definition at line 150 of file BadSourcePosition.cs.

    {
        if (m_PositionInfo != null)
        {
            return m_PositionInfo;
        }
 
        int line = GetLine();
 
        m_PositionInfo = $"file://{FileName} : Line {line}";
 
        return m_PositionInfo;
    }

Member Data Documentation

m_PositionInfo

string? BadScript2.Common.BadSourcePosition.m_PositionInfo

private

Definition at line 10 of file BadSourcePosition.cs.

m_Text

string? BadScript2.Common.BadSourcePosition.m_Text

private

Definition at line 12 of file BadSourcePosition.cs.

Property Documentation

FileName

string? BadScript2.Common.BadSourcePosition.FileName

get

The Filename of the Source Code.

Definition at line 45 of file BadSourcePosition.cs.

{ get; }

Index

int BadScript2.Common.BadSourcePosition.Index

get

The Start Index of the Position.

Definition at line 55 of file BadSourcePosition.cs.

{ get; }

Length

int BadScript2.Common.BadSourcePosition.Length

get

The Length of the Position.

Definition at line 60 of file BadSourcePosition.cs.

{ get; }

Source

string BadScript2.Common.BadSourcePosition.Source

get

The Source Code.

Definition at line 50 of file BadSourcePosition.cs.

{ get; }

Text

string BadScript2.Common.BadSourcePosition.Text

get

Returns the Position as a string.

Definition at line 65 of file BadSourcePosition.cs.

---

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

• src/BadScript2/Common/BadSourcePosition.cs