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 languages.
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
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 tokens. |
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 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Empty()
This action empties the list of tokens.
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(t)
Parameters
- Libraries.Language.Object: The to be compared.
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 stream.
GetToken(integer i)
This method returns a token at a particular position in the lex.
Parameters
- integer i: The index of the token to get
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 empty.
Read(Libraries.System.File file)
This action is used to read a text file and converts it into a token stream.
Parameters
- Libraries.System.File: The file to read and lex.
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
- text value: The text value to lex.