Implements the Source Code Reader. More...

Public Member Functions
	BadSourceReader (string fileName, string source, int start, int end)
	Creates a new Source Code Reader.

	BadSourceReader (string fileName, string source)
	Creates a new Source Code Reader.

void	SetPosition (int index)
	Sets the Current Index of the Reader.

bool	IsEof (int offset=0)
	Returns true if the reader is at the end of the source code.

BadSourcePosition	MakeSourcePosition (int length)
	Creates a source position with the specified length and the current index of the reader.

BadSourcePosition	MakeSourcePosition (int index, int length)
	Creates a source position with the specified length and index.

char	GetCurrentChar (int offset=0)
	Returns the Current Character.

void	MoveNext ()
	Moves the Reader to the next character in the source code.

bool	Is (char c, int offset=0)
	Returns true if the current character matches the specified character.

bool	Is (string s, int offset=0)
	Returns true if the string matches the specified character.

bool	Is (params char[] chars)
	Returns true if any of the characters match the specified character.

bool	Is (params string[] s)
	Returns true if any of the strings match the specified character.

bool	Is (int offset, params char[] chars)
	Returns true if any of the characters match the specified character.

bool	Is (int offset, params string[] s)
	Returns true if any of the strings match the specified String.

BadSourcePosition	Eat (char c)
	Asserts that the current character matches the specified character.

BadSourcePosition	Eat (params char[] c)
	Asserts that the current character matches one of the specified characters.

BadSourcePosition	Eat (string s)
	Asserts that the current String matches the specified String.

BadSourcePosition	Eat (params string[] s)
	Asserts that the current string matches one of the specified strings.

void	Seek (char c)
	Skips over any character that is not equal to the specified character.

void	Seek (string s)
	Skips over any string that is not equal to the specified string.

void	Seek (params char[] c)
	Skips over any character that is not equal to any of the specified characters.

void	Seek (params string[] s)
	Skips over any character that is not equal to any of the specified strings.

void	Skip (char c)
	If the current character is equal to the specified character, it will be skipped.

void	Skip (params char[] c)
	If the current character is equal to any of the specified characters, it will be skipped.

Static Public Member Functions
static BadSourceReader	FromFile (string fileName)
	Creates a new Source Code Reader from a File.

Properties
string	Preview `[get]`
	Preview of the Source Code.

string	Source `[get]`
	The Source Code.

string	FileName `[get]`
	The Filename of the Source Code.

int	CurrentIndex `[get, private set]`
	The Current Index of the Reader.

char	CurrentChar `[get]`
	The Current Character of the Reader.

Private Attributes
readonly int	m_EndIndex

readonly string	m_Source
	The Source Code.

readonly int	m_StartIndex
	Start Index of the Source Code.

Detailed Description

Implements the Source Code Reader.

Definition at line 12 of file BadSourceReader.cs.

Constructor & Destructor Documentation

◆ BadSourceReader() [1/2]

BadScript2.Reader.BadSourceReader.BadSourceReader	(	string	fileName,
		string	source,
		int	start,
		int	end
	)

Creates a new Source Code Reader.

Parameters

fileName	Filename of the Source Code
source	The Source Code
start	The Start Index of the Source Code
end	The End Index of the Source Code

Exceptions

ArgumentOutOfRangeException Gets raised if the start or end index is invalid.

Definition at line 35 of file BadSourceReader.cs.

    {
        FileName = fileName;
        m_Source = source;
 
        if (start < 0 || start >= end)
        {
            throw new ArgumentOutOfRangeException(nameof(start));
        }
 
        if (end > source.Length)
        {
            throw new ArgumentOutOfRangeException(nameof(end));
        }
 
        m_StartIndex = start;
        m_EndIndex = end;
        CurrentIndex = start;
    }

◆ BadSourceReader() [2/2]

BadScript2.Reader.BadSourceReader.BadSourceReader	(	string	fileName,
		string	source
	)

Creates a new Source Code Reader.

Parameters

fileName	The Filename of the Source Code
source	The Source Code

Definition at line 60 of file BadSourceReader.cs.

60: this(fileName, source, 0, source.Length) { }

Member Function Documentation

◆ Eat() [1/4]

BadSourcePosition BadScript2.Reader.BadSourceReader.Eat ( char c )

Asserts that the current character matches the specified character.

Parameters

c	The Character to be matched

Returns: The Source Position (Current Reader position with length 1) of the Character

Exceptions

BadSourceReaderException Gets raised if the character does not match the specified one

Definition at line 234 of file BadSourceReader.cs.

    {
        if (!Is(c))
        {
            throw new BadSourceReaderException(
                $"Expected '{c}' but got '{(IsEof() ? "EOF" : GetCurrentChar())}'",
                MakeSourcePosition(1)
            );
        }
 
        MoveNext();
 
        return MakeSourcePosition(1);
    }

◆ Eat() [2/4]

BadSourcePosition BadScript2.Reader.BadSourceReader.Eat ( params char[] c )

Asserts that the current character matches one of the specified characters.

Parameters

c	The Characters to be matched

Returns: The Source Position (Current Reader position with length 1) of the Character

Exceptions

BadSourceReaderException Gets raised if the character does not match any of the specified ones

Definition at line 255 of file BadSourceReader.cs.

    {
        if (!c.Any(x => Is(x)))
        {
            throw new BadSourceReaderException(
                $"Expected '{string.Join("' or '", c)}' but got '{(IsEof() ? "EOF" : GetCurrentChar())}'",
                MakeSourcePosition(1)
            );
        }
 
        MoveNext();
 
        return MakeSourcePosition(1);
    }

◆ Eat() [3/4]

BadSourcePosition BadScript2.Reader.BadSourceReader.Eat ( params string[] s )

Asserts that the current string matches one of the specified strings.

Parameters

s	The strings to be matched

Returns: The Source Position (Current Reader position with length of the string) of the string

Exceptions

BadSourceReaderException Gets raised if the string does not match any of the specified ones

Definition at line 302 of file BadSourceReader.cs.

    {
        string? str = s.FirstOrDefault(x => Is(x));
 
        if (str == null)
        {
            throw new BadSourceReaderException(
                $"Expected '{string.Join("' or '", s)}' but got '{(IsEof() ? "EOF" : GetCurrentChar())}'",
                MakeSourcePosition(1)
            );
        }
 
        return Eat(str);
    }

◆ Eat() [4/4]

BadSourcePosition BadScript2.Reader.BadSourceReader.Eat ( string s )

Asserts that the current String matches the specified String.

Parameters

s	The String to be matched

Returns: The Source Position (Current Reader position with length of the string) of the Character

Exceptions

BadSourceReaderException Gets raised if the String does not match the specified one

Definition at line 276 of file BadSourceReader.cs.

    {
        int start = CurrentIndex;
 
        for (int i = 0; i < s.Length; i++)
        {
            if (!Is(s[i]))
            {
                throw new BadSourceReaderException(
                    $"Expected '{s}' but got '{(IsEof() ? "EOF" : GetCurrentChar())}'",
                    MakeSourcePosition(start, i)
                );
            }
 
            MoveNext();
        }
 
        return MakeSourcePosition(start, s.Length);
    }

◆ FromFile()

static BadSourceReader BadScript2.Reader.BadSourceReader.FromFile ( string fileName )

static

Creates a new Source Code Reader from a File.

Parameters

fileName The File Name

Returns: BadSourceReader instance with the contents of the specified file.

Definition at line 101 of file BadSourceReader.cs.

    {
        return new BadSourceReader(fileName, BadFileSystem.ReadAllText(fileName));
    }

◆ GetCurrentChar()

char BadScript2.Reader.BadSourceReader.GetCurrentChar ( int offset = 0 )

Returns the Current Character.

Parameters

offset The Offset from the Current Reader Position

Returns: Current Character. EOF if IsEOF(offset) equals true.

Definition at line 142 of file BadSourceReader.cs.

    {
        return IsEof(offset) ? '\0' : m_Source[CurrentIndex + offset];
    }

◆ Is() [1/6]

bool BadScript2.Reader.BadSourceReader.Is	(	char	c,
		int	offset = `0`
	)

Returns true if the current character matches the specified character.

Parameters

c	The Character to be matched.
offset	The Offset from the Current Reader Position

Returns: True if the Character matches the current one.

Definition at line 161 of file BadSourceReader.cs.

    {
        return GetCurrentChar(offset) == c;
    }

◆ Is() [2/6]

bool BadScript2.Reader.BadSourceReader.Is	(	int	offset,
		params char[]	chars
	)

Returns true if any of the characters match the specified character.

Parameters

offset	The Offset from the Current Reader Position
chars	The Characters to be matched.

Returns: True if any of the characters match the current one.

Definition at line 211 of file BadSourceReader.cs.

    {
        return chars.Any(x => Is(x, offset));
    }

◆ Is() [3/6]

bool BadScript2.Reader.BadSourceReader.Is	(	int	offset,
		params string[]	s
	)

Returns true if any of the strings match the specified String.

Parameters

offset	The Offset from the Current Reader Position
s	The strings to be matched.

Returns: True if any of the strings match the current one.

Definition at line 222 of file BadSourceReader.cs.

    {
        return s.Any(x => Is(x, offset));
    }

◆ Is() [4/6]

bool BadScript2.Reader.BadSourceReader.Is ( params char[] chars )

Returns true if any of the characters match the specified character.

Parameters

chars The Characters to be matched.

Returns: True if any of the characters matches the current one.

Definition at line 190 of file BadSourceReader.cs.

    {
        return Is(0, chars);
    }

◆ Is() [5/6]

bool BadScript2.Reader.BadSourceReader.Is ( params string[] s )

Returns true if any of the strings match the specified character.

Parameters

s	The strings to be matched.

Returns: True if any of the strings matches the current one.

Definition at line 200 of file BadSourceReader.cs.

    {
        return Is(0, s);
    }

◆ Is() [6/6]

bool BadScript2.Reader.BadSourceReader.Is	(	string	s,
		int	offset = `0`
	)

Returns true if the string matches the specified character.

Parameters

s	The Character to be matched.
offset	The Offset from the Current Reader Position

Returns: True if the string matches the current one.

Definition at line 172 of file BadSourceReader.cs.

    {
        for (int i = 0; i < s.Length; i++)
        {
            if (!Is(s[i], offset + i))
            {
                return false;
            }
        }
 
        return true;
    }

◆ IsEof()

bool BadScript2.Reader.BadSourceReader.IsEof ( int offset = 0 )

Returns true if the reader is at the end of the source code.

Parameters

offset The Offset from the Current Reader Position

Returns: True if the Reader is at the end of the source code.

Definition at line 111 of file BadSourceReader.cs.

    {
        return CurrentIndex + offset >= m_EndIndex && CurrentIndex + offset >= m_StartIndex;
    }

◆ MakeSourcePosition() [1/2]

BadSourcePosition BadScript2.Reader.BadSourceReader.MakeSourcePosition	(	int	index,
		int	length
	)

Creates a source position with the specified length and index.

Parameters

index	The Start index
length	The Length of the Position

Returns: A new BadSourcePosition Instance.

Definition at line 132 of file BadSourceReader.cs.

    {
        return BadSourcePosition.Create(FileName, m_Source, index, length);
    }

◆ MakeSourcePosition() [2/2]

BadSourcePosition BadScript2.Reader.BadSourceReader.MakeSourcePosition ( int length )

Creates a source position with the specified length and the current index of the reader.

Parameters

length The Length of the Position

Returns: A new BadSourcePosition Instance.

Definition at line 121 of file BadSourceReader.cs.

    {
        return MakeSourcePosition(CurrentIndex, length);
    }

◆ MoveNext()

void BadScript2.Reader.BadSourceReader.MoveNext ( )

Moves the Reader to the next character in the source code.

Definition at line 150 of file BadSourceReader.cs.

    {
        CurrentIndex++;
    }

◆ Seek() [1/4]

void BadScript2.Reader.BadSourceReader.Seek ( char c )

Skips over any character that is not equal to the specified character.

Parameters

c	The character to be matched.

Definition at line 321 of file BadSourceReader.cs.

    {
        while (!IsEof() && GetCurrentChar() != c)
        {
            MoveNext();
        }
    }

◆ Seek() [2/4]

void BadScript2.Reader.BadSourceReader.Seek ( params char[] c )

Skips over any character that is not equal to any of the specified characters.

Parameters

c	The characters to be matched.

Definition at line 345 of file BadSourceReader.cs.

    {
        while (!IsEof() && !Is(c))
        {
            MoveNext();
        }
    }

◆ Seek() [3/4]

void BadScript2.Reader.BadSourceReader.Seek ( params string[] s )

Skips over any character that is not equal to any of the specified strings.

Parameters

s	The strings to be matched.

Definition at line 357 of file BadSourceReader.cs.

    {
        while (!IsEof() && !Is(s))
        {
            MoveNext();
        }
    }

◆ Seek() [4/4]

void BadScript2.Reader.BadSourceReader.Seek ( string s )

Skips over any string that is not equal to the specified string.

Parameters

s	The string to be matched.

Definition at line 333 of file BadSourceReader.cs.

    {
        while (!IsEof() && !Is(s))
        {
            MoveNext();
        }
    }

◆ SetPosition()

void BadScript2.Reader.BadSourceReader.SetPosition ( int index )

Sets the Current Index of the Reader.

Parameters

index The new Index

Definition at line 91 of file BadSourceReader.cs.

    {
        CurrentIndex = index;
    }

◆ Skip() [1/2]

void BadScript2.Reader.BadSourceReader.Skip ( char c )

If the current character is equal to the specified character, it will be skipped.

Parameters

c	The character to be matched.

Definition at line 369 of file BadSourceReader.cs.

    {
        if (Is(c))
        {
            MoveNext();
        }
    }

◆ Skip() [2/2]

void BadScript2.Reader.BadSourceReader.Skip ( params char[] c )

If the current character is equal to any of the specified characters, it will be skipped.

Parameters

c	The characters to be matched.

Definition at line 381 of file BadSourceReader.cs.

    {
        bool exit = false;
 
        while (!exit)
        {
            exit = true;
 
            if (!c.Any(ch => Is(ch)))
            {
                continue;
            }
 
            MoveNext();
            exit = false;
        }
    }

Member Data Documentation

◆ m_EndIndex

readonly int BadScript2.Reader.BadSourceReader.m_EndIndex

private

Definition at line 14 of file BadSourceReader.cs.

◆ m_Source

readonly string BadScript2.Reader.BadSourceReader.m_Source

private

The Source Code.

Definition at line 19 of file BadSourceReader.cs.

◆ m_StartIndex

readonly int BadScript2.Reader.BadSourceReader.m_StartIndex

private

Start Index of the Source Code.

Definition at line 24 of file BadSourceReader.cs.

Property Documentation

◆ CurrentChar

char BadScript2.Reader.BadSourceReader.CurrentChar

get

The Current Character of the Reader.

Definition at line 85 of file BadSourceReader.cs.

◆ CurrentIndex

int BadScript2.Reader.BadSourceReader.CurrentIndex

getprivate set

The Current Index of the Reader.

Definition at line 80 of file BadSourceReader.cs.

80{ get; private set; }

◆ FileName

string BadScript2.Reader.BadSourceReader.FileName

get

The Filename of the Source Code.

Definition at line 75 of file BadSourceReader.cs.

75{ get; }

◆ Preview

string BadScript2.Reader.BadSourceReader.Preview

get

Preview of the Source Code.

Definition at line 65 of file BadSourceReader.cs.

◆ Source

string BadScript2.Reader.BadSourceReader.Source

get

The Source Code.

Definition at line 70 of file BadSourceReader.cs.

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

src/BadScript2/Reader/BadSourceReader.cs

Public Member Functions

Static Public Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BadSourceReader() [1/2]

◆ BadSourceReader() [2/2]

Member Function Documentation

◆ Eat() [1/4]

◆ Eat() [2/4]

◆ Eat() [3/4]

◆ Eat() [4/4]

◆ FromFile()

◆ GetCurrentChar()

◆ Is() [1/6]

◆ Is() [2/6]

◆ Is() [3/6]

◆ Is() [4/6]

◆ Is() [5/6]

◆ Is() [6/6]

◆ IsEof()

◆ MakeSourcePosition() [1/2]

◆ MakeSourcePosition() [2/2]

◆ MoveNext()

◆ Seek() [1/4]

◆ Seek() [2/4]

◆ Seek() [3/4]

◆ Seek() [4/4]

◆ SetPosition()

◆ Skip() [1/2]

◆ Skip() [2/2]

Member Data Documentation

◆ m_EndIndex

◆ m_Source

◆ m_StartIndex

Property Documentation

◆ CurrentChar

◆ CurrentIndex

◆ FileName

◆ Preview

◆ Source