Libraries.Language.Compile.Parsing.Token Documentation

This class represents a token in a lexical stream.

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer endColumn
integer startLine
text value
integer endIndex
integer endLine
integer category
integer startColumn
integer tokenIndex
integer startIndex
integer channel

Actions Documentation

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.

Parameters

Return

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

Example

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

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetTokenCategory()

Return

integer

IsCommentChannel()

Determines whether the token is on a channel indicating that it is reading a comment.

Return

boolean:

IsMultiLineComment()

Sets the token to a channel indicating that it is reading white space.

Return

boolean:

IsNormalChannel()

Sets the token to a channel indicating that it is reading source code.

Return

boolean:

IsWhiteSpaceChannel()

Determines whether the token is on a channel indicating that it is reading white space.

Return

boolean:

SetToCommentChannel()

Sets the token to a channel indicating that it is reading comments.

SetToNormalChannel()

Sets the token to a channel indicating that it is reading source code.

SetToWhiteSpaceChannel()

Sets the token to a channel indicating that it is reading white space.

ToText()

Returns the value of the token and the category by default

Return

text:

ToTextWithCategory()

Returns the value of the token and the category by default

Return

text: