Extensions for the Source Reader. More...

Static Public Member Functions
static bool	IsWordStart (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character of the Reader is a valid Word Start Character.

static bool	IsWordChar (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character of the Reader is a valid Word Character.

static bool	IsKey (this BadSourceReader reader, char c, int offset=0)

static bool	IsKey (this BadSourceReader reader, string s, int offset=0)

static bool	IsStringQuote (this BadSourceReader reader, int offset=0, bool singleQuote=false)
	Returns true if the Current Character is a String Quote Character.

static bool	IsNumberStart (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character is a valid Number Character.

static bool	IsDigit (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character is a Digit.

static bool	IsNewLine (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character is a Newline Character.

static void	SkipWhiteSpace (this BadSourceReader reader)
	Skips all whitespace characters.

static void	SkipNewLine (this BadSourceReader reader)
	Skips all newline characters.

static void	SkipToEndOfLine (this BadSourceReader reader)
	Skips all characters untile a newline is found.

static void	SkipWhiteSpaceAndNewLine (this BadSourceReader reader)
	Skips all whitespace and newline characters.

static void	SkipComment (this BadSourceReader reader)
	Skips a comment.

static void	SkipNonToken (this BadSourceReader reader)
	Skips all whitespace, newline characters and comments.

static BadWordToken	ParseWord (this BadSourceReader reader)
	Parses a Word Token.

static BadNumberToken	ParseNumber (this BadSourceReader reader)
	Parses a BadNumberToken.

static BadBooleanToken	ParseBoolean (this BadSourceReader reader)
	Parses a BadBoolean Token.

static BadNullToken	ParseNull (this BadSourceReader reader)
	Parses a BadNullToken.

static ? BadSymbolToken	TryParseSymbols (this BadSourceReader reader, string symbols)
	Tries to parse symbols.

static ? BadSymbolToken	TryParseSymbols (this BadSourceReader reader, IEnumerable< string > symbols)
	Tries to parse a list of symbols.

static BadStringToken	ParseString (this BadSourceReader reader)
	Parses a BadStringToken.

static BadStringToken	ParseMultiLineString (this BadSourceReader reader)
	Parses a Multi Line String.

static bool	IsWhiteSpace (this BadSourceReader reader, int offset=0)
	Returns true if the Current Character is any whitespace or newline characters.

static bool	Last (this BadSourceReader reader, char c)
	Returns true if the last non-whitespace character is the specified character.

Detailed Description

Extensions for the Source Reader.

Definition at line 13 of file BadSourceReaderExtensions.cs.

Member Function Documentation

◆ IsDigit()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsDigit	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character is a Digit.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Current Character is a Digit

Definition at line 84 of file BadSourceReaderExtensions.cs.

    {
        return char.IsDigit(reader.GetCurrentChar(offset));
    }

◆ IsKey() [1/2]

static bool BadScript2.Reader.BadSourceReaderExtensions.IsKey	(	this BadSourceReader	reader,
		char	c,
		int	offset = `0`
	)

static

Definition at line 39 of file BadSourceReaderExtensions.cs.

    {
        return reader.Is(c, offset) && !reader.IsWordChar(offset + 1);
    }

◆ IsKey() [2/2]

static bool BadScript2.Reader.BadSourceReaderExtensions.IsKey	(	this BadSourceReader	reader,
		string	s,
		int	offset = `0`
	)

static

Definition at line 44 of file BadSourceReaderExtensions.cs.

    {
        return reader.Is(s, offset) && !reader.IsWordChar(offset + s.Length);
    }

◆ IsNewLine()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsNewLine	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character is a Newline Character.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Current Character is a NewLine Character

Definition at line 95 of file BadSourceReaderExtensions.cs.

    {
        return reader.Is(offset, BadStaticKeys.NewLine);
    }

◆ IsNumberStart()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsNumberStart	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character is a valid Number Character.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Current Character is a valid Number Character

Definition at line 72 of file BadSourceReaderExtensions.cs.

    {
        return reader.IsDigit(offset) ||
               reader.GetCurrentChar(offset) == BadStaticKeys.DECIMAL_SEPARATOR;
    }

◆ IsStringQuote()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsStringQuote	(	this BadSourceReader	reader,
		int	offset = `0`,
		bool	singleQuote = `false`
	)

static

Returns true if the Current Character is a String Quote Character.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position
singleQuote	Is the string expected to start with '

Returns: True if the Current Character is a Quote

Definition at line 56 of file BadSourceReaderExtensions.cs.

    {
        if (singleQuote)
        {
            return reader.GetCurrentChar(offset) == BadStaticKeys.SINGLE_QUOTE;
        }
 
        return reader.GetCurrentChar(offset) == BadStaticKeys.QUOTE;
    }

◆ IsWhiteSpace()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsWhiteSpace	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character is any whitespace or newline characters.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Current Character is a Whitespace or Newline Character

Definition at line 408 of file BadSourceReaderExtensions.cs.

    {
        return reader.Is(offset, BadStaticKeys.Whitespace) ||
               reader.Is(offset, BadStaticKeys.NewLine);
    }

◆ IsWordChar()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsWordChar	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character of the Reader is a valid Word Character.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Current Character is a valid Word Character

Definition at line 33 of file BadSourceReaderExtensions.cs.

    {
        return char.IsLetterOrDigit(reader.GetCurrentChar(offset)) ||
               reader.GetCurrentChar(offset) == '_';
    }

◆ IsWordStart()

static bool BadScript2.Reader.BadSourceReaderExtensions.IsWordStart	(	this BadSourceReader	reader,
		int	offset = `0`
	)

static

Returns true if the Current Character of the Reader is a valid Word Start Character.

Parameters

reader	The Reader Instance
offset	The Offset from the Current Reader Position

Returns: True if the Character is a Valid Word Start Character

Definition at line 21 of file BadSourceReaderExtensions.cs.

    {
        return char.IsLetter(reader.GetCurrentChar(offset)) ||
               reader.GetCurrentChar(offset) == '_';
    }

◆ Last()

static bool BadScript2.Reader.BadSourceReaderExtensions.Last	(	this BadSourceReader	reader,
		char	c
	)

static

Returns true if the last non-whitespace character is the specified character.

Parameters

reader	The Reader Instance
c	The Character that should be matched

Returns: True if the character is the last non-whitespace character.

Definition at line 420 of file BadSourceReaderExtensions.cs.

    {
        int index = -1;
 
        while (reader.IsWhiteSpace(index))
        {
            index--;
        }
 
        return reader.GetCurrentChar(index) == c;
    }

◆ ParseBoolean()

static BadBooleanToken BadScript2.Reader.BadSourceReaderExtensions.ParseBoolean ( this BadSourceReader reader )

static

Parses a BadBoolean Token.

Parameters

reader The Reader Instance

Returns: The Resulting BadBoolean Token

Exceptions

BadSourceReaderException Gets Raised if the Current Character sequence is not Equal to BadStaticKeys.True and not equal to BadStaticKeys.False

Definition at line 252 of file BadSourceReaderExtensions.cs.

    {
        if (reader.Is(BadStaticKeys.TRUE))
        {
            return new BadBooleanToken(reader.Eat(BadStaticKeys.TRUE));
        }
 
        if (reader.Is(BadStaticKeys.FALSE))
        {
            return new BadBooleanToken(reader.Eat(BadStaticKeys.FALSE));
        }
 
        throw new BadSourceReaderException(
            $"Expected boolean but got '{(reader.IsEof() ? "EOF" : reader.GetCurrentChar())}'",
            reader.MakeSourcePosition(1)
        );
    }

◆ ParseMultiLineString()

static BadStringToken BadScript2.Reader.BadSourceReaderExtensions.ParseMultiLineString ( this BadSourceReader reader )

static

Parses a Multi Line String.

Parameters

reader The Reader Instance

Returns: The Resulting BadStringToken Instance

Exceptions

BadSourceReaderException Gets Raised if the String is not properly terminated

Definition at line 372 of file BadSourceReaderExtensions.cs.

    {
        int start = reader.CurrentIndex;
        reader.Eat(BadStaticKeys.MULTI_LINE_STRING_KEY);
 
        StringBuilder sb = new StringBuilder("\"");
 
        while (!reader.IsStringQuote())
        {
            if (reader.IsEof())
            {
                throw new BadSourceReaderException(
                    "String not terminated",
                    reader.MakeSourcePosition(start, reader.CurrentIndex - start)
                );
            }
 
 
            sb.Append(reader.GetCurrentChar());
 
            reader.MoveNext();
        }
 
        reader.Eat(BadStaticKeys.QUOTE);
 
        sb.Append("\"");
 
        return new BadStringToken(sb.ToString(), reader.MakeSourcePosition(start, reader.CurrentIndex - start));
    }

◆ ParseNull()

static BadNullToken BadScript2.Reader.BadSourceReaderExtensions.ParseNull ( this BadSourceReader reader )

static

Parses a BadNullToken.

Parameters

reader The Reader Instance

Returns: The Resulting BadNullToken Instance

Definition at line 275 of file BadSourceReaderExtensions.cs.

    {
        return new BadNullToken(reader.Eat(BadStaticKeys.NULL));
    }

◆ ParseNumber()

static BadNumberToken BadScript2.Reader.BadSourceReaderExtensions.ParseNumber ( this BadSourceReader reader )

static

Parses a BadNumberToken.

Parameters

reader The Reader Instance

Returns: The Resulting BadNumberToken

Exceptions

BadSourceReaderException Gets raised if the Start Character is not a valid number character

Definition at line 211 of file BadSourceReaderExtensions.cs.

    {
        if (!reader.IsNumberStart())
        {
            throw new BadSourceReaderException(
                $"Expected number start character but got '{(reader.IsEof() ? "EOF" : reader.GetCurrentChar())}'",
                reader.MakeSourcePosition(1)
            );
        }
 
        int start = reader.CurrentIndex;
        reader.MoveNext();
        bool hasDecimal = false;
 
        while (reader.IsDigit() || !hasDecimal && reader.Is(BadStaticKeys.DECIMAL_SEPARATOR))
        {
            if (reader.Is(BadStaticKeys.DECIMAL_SEPARATOR))
            {
                hasDecimal = true;
            }
 
            reader.MoveNext();
        }
 
        if (reader.Last(BadStaticKeys.DECIMAL_SEPARATOR))
        {
            reader.SetPosition(reader.CurrentIndex - 1);
        }
 
        return new BadNumberToken(reader.MakeSourcePosition(start, reader.CurrentIndex - start));
    }

◆ ParseString()

static BadStringToken BadScript2.Reader.BadSourceReaderExtensions.ParseString ( this BadSourceReader reader )

static

Parses a BadStringToken.

Parameters

reader The Reader Instance

Returns: The Resulting BadStringToken Instance

Exceptions

BadSourceReaderException Gets Raised if the Start Character is not a String Quote or the Sequence is not properly terminated.

Definition at line 314 of file BadSourceReaderExtensions.cs.

    {
        if (!reader.IsStringQuote() && !reader.IsStringQuote(0, true))
        {
            throw new BadSourceReaderException(
                $"Expected string start character but got '{(reader.IsEof() ? "EOF" : reader.GetCurrentChar())}'",
                reader.MakeSourcePosition(1)
            );
        }
 
        bool singleQuote = reader.Is(BadStaticKeys.SINGLE_QUOTE);
        int start = reader.CurrentIndex;
        reader.MoveNext();
        bool isEscaped = false;
        StringBuilder sb = new StringBuilder("\"");
 
        while (!reader.IsStringQuote(0, singleQuote))
        {
            if (reader.IsNewLine() || reader.IsEof())
            {
                throw new BadSourceReaderException(
                    "String not terminated",
                    reader.MakeSourcePosition(start, reader.CurrentIndex - start)
                );
            }
 
            if (reader.Is(BadStaticKeys.ESCAPE_CHARACTER))
            {
                isEscaped = true;
                reader.MoveNext();
            }
 
            if (isEscaped)
            {
                isEscaped = false;
                sb.Append(Regex.Unescape($"\\{reader.GetCurrentChar()}"));
            }
            else
            {
                sb.Append(reader.GetCurrentChar());
            }
 
            reader.MoveNext();
        }
 
        reader.Eat(singleQuote ? BadStaticKeys.SINGLE_QUOTE : BadStaticKeys.QUOTE);
 
        sb.Append("\"");
 
        return new BadStringToken(sb.ToString(), reader.MakeSourcePosition(start, reader.CurrentIndex - start));
    }

◆ ParseWord()

static BadWordToken BadScript2.Reader.BadSourceReaderExtensions.ParseWord ( this BadSourceReader reader )

static

Parses a Word Token.

Parameters

reader The Reader Instance

Returns: The Resulting BadWordToken instance.

Exceptions

BadSourceReaderException

Gets Raised if the Current Character is not a Valid Word Start Character

See also: BadSourceReaderExtensions.IsWordStart

Definition at line 184 of file BadSourceReaderExtensions.cs.

    {
        if (!reader.IsWordStart())
        {
            throw new BadSourceReaderException(
                $"Expected word start character but got '{(reader.IsEof() ? "EOF" : reader.GetCurrentChar())}'",
                reader.MakeSourcePosition(1)
            );
        }
 
        int start = reader.CurrentIndex;
        reader.MoveNext();
 
        while (reader.IsWordChar())
        {
            reader.MoveNext();
        }
 
        return new BadWordToken(reader.MakeSourcePosition(start, reader.CurrentIndex - start));
    }

◆ SkipComment()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipComment ( this BadSourceReader reader )

static

Skips a comment.

Parameters

reader The Reader Instance

Definition at line 141 of file BadSourceReaderExtensions.cs.

    {
        if (reader.Is(BadStaticKeys.SINGLE_LINE_COMMENT))
        {
            reader.Eat(BadStaticKeys.SINGLE_LINE_COMMENT);
            reader.SkipToEndOfLine();
            reader.SkipNewLine();
        }
        else if (reader.Is(BadStaticKeys.MULTI_LINE_COMMENT_START))
        {
            reader.Eat(BadStaticKeys.MULTI_LINE_COMMENT_START);
            reader.Seek(BadStaticKeys.MULTI_LINE_COMMENT_END);
            reader.Eat(BadStaticKeys.MULTI_LINE_COMMENT_END);
        }
    }

◆ SkipNewLine()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipNewLine ( this BadSourceReader reader )

static

Skips all newline characters.

Parameters

reader The Reader Instance

Definition at line 114 of file BadSourceReaderExtensions.cs.

    {
        reader.Skip(BadStaticKeys.NewLine);
    }

◆ SkipNonToken()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipNonToken ( this BadSourceReader reader )

static

Skips all whitespace, newline characters and comments.

Parameters

reader The Reader Instance

Definition at line 161 of file BadSourceReaderExtensions.cs.

    {
        int current;
 
        do
        {
            current = reader.CurrentIndex;
            reader.SkipComment();
            reader.SkipWhiteSpaceAndNewLine();
        }
        while (current != reader.CurrentIndex);
    }

◆ SkipToEndOfLine()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipToEndOfLine ( this BadSourceReader reader )

static

Skips all characters untile a newline is found.

Parameters

reader The Reader Instance

Definition at line 123 of file BadSourceReaderExtensions.cs.

    {
        reader.Seek(BadStaticKeys.NewLine);
    }

◆ SkipWhiteSpace()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipWhiteSpace ( this BadSourceReader reader )

static

Skips all whitespace characters.

Parameters

reader The Reader Instance

Definition at line 104 of file BadSourceReaderExtensions.cs.

    {
        reader.Skip(BadStaticKeys.Whitespace);
    }

◆ SkipWhiteSpaceAndNewLine()

static void BadScript2.Reader.BadSourceReaderExtensions.SkipWhiteSpaceAndNewLine ( this BadSourceReader reader )

static

Skips all whitespace and newline characters.

Parameters

reader The Reader Instance

Definition at line 132 of file BadSourceReaderExtensions.cs.

    {
        reader.Skip(BadStaticKeys.Whitespace.Concat(BadStaticKeys.NewLine).ToArray());
    }

◆ TryParseSymbols() [1/2]

static ? BadSymbolToken BadScript2.Reader.BadSourceReaderExtensions.TryParseSymbols	(	this BadSourceReader	reader,
		IEnumerable< string >	symbols
	)

static

Tries to parse a list of symbols.

Parameters

reader	The Reader Instance
symbols	The Symbol Sequences to be parsed

Returns: The Bad Symbol Token if one of the Symbols was matched to the Current Character Sequence. Null otherwise

Definition at line 297 of file BadSourceReaderExtensions.cs.

    {
        string? symbol =
            symbols.FirstOrDefault(x => x.All(c => char.IsLetter(c) || c == '_') ? reader.IsKey(x) : reader.Is(x));
 
        return symbol == null ? null : reader.TryParseSymbols(symbol);
    }

◆ TryParseSymbols() [2/2]

static ? BadSymbolToken BadScript2.Reader.BadSourceReaderExtensions.TryParseSymbols	(	this BadSourceReader	reader,
		string	symbols
	)

static

Tries to parse symbols.

Parameters

reader	The Reader Instance
symbols	The Symbol Sequence to be parsed

Returns: The Bad Symbol Token if the Symbol was matched to the Current Character Sequence. Null otherwise

Definition at line 286 of file BadSourceReaderExtensions.cs.

    {
        return reader.Is(symbols) ? new BadSymbolToken(reader.Eat(symbols)) : null;
    }

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

src/BadScript2/Reader/BadSourceReaderExtensions.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ IsDigit()

◆ IsKey() [1/2]

◆ IsKey() [2/2]

◆ IsNewLine()

◆ IsNumberStart()

◆ IsStringQuote()

◆ IsWhiteSpace()

◆ IsWordChar()

◆ IsWordStart()

◆ Last()

◆ ParseBoolean()

◆ ParseMultiLineString()

◆ ParseNull()

◆ ParseNumber()

◆ ParseString()

◆ ParseWord()

◆ SkipComment()

◆ SkipNewLine()

◆ SkipNonToken()

◆ SkipToEndOfLine()

◆ SkipWhiteSpace()

◆ SkipWhiteSpaceAndNewLine()

◆ TryParseSymbols() [1/2]

◆ TryParseSymbols() [2/2]