Libraries.Language.Compile.Parsing.Lexer Documentation

This is a general purpose class for defining lexers in Quorum. Subclasses implement the interface how they see fit for particular language

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Language.Compile.Parsing.Token token)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Empty()This action empties the list of token
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetIterator()This action returns an iterator over the tokens.
GetSize()This action returns the number of tokens in the token stream.
GetToken(integer i)This method returns a token at a particular position in the lex.
IsEmpty()This action Returns whether or not there are tokens in the token stream
Read(Libraries.System.File file)This action is used to read a text file and converts it into a token stream.
Read(text value)This action is used to read a text value and converts it into a token stream.

Actions Documentation

Add(Libraries.Language.Compile.Parsing.Token token)

Parameters

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Empty()

This action empties the list of token

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

GetIterator()

This action returns an iterator over the tokens. We can use this to automatically iterate over non-documentation tokens, to do lookahead and look back, and other operations that are harder to manage through the raw Get action.

Return

Libraries.Language.Compile.Parsing.TokenIterator: TokenIterator

GetSize()

This action returns the number of tokens in the token stream.

Return

integer: The number of tokens in the strea

GetToken(integer i)

This method returns a token at a particular position in the lex.

Parameters

Return

Libraries.Language.Compile.Parsing.Token:

IsEmpty()

This action Returns whether or not there are tokens in the token stream

Return

boolean: a boolean value to indicate if the stream is empt

Read(Libraries.System.File file)

This action is used to read a text file and converts it into a token stream.

Parameters

Read(text value)

This action is used to read a text value and converts it into a token stream. Subclasses for particular languages define how they read and manage errors.

Parameters