Libraries.Language.Compile.Parsing.Token Documentation

This class represents a token in a lexical stream.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

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

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
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.
GetTokenCategory()
IsCommentChannel()Determines whether the token is on a channel indicating that it is reading a commen
IsNormalChannel()Sets the token to a channel indicating that it is reading source cod
IsWhiteSpaceChannel()Determines whether the token is on a channel indicating that it is reading white spac
SetToCommentChannel()Sets the token to a channel indicating that it is reading comment
SetToNormalChannel()Sets the token to a channel indicating that it is reading source cod
SetToWhiteSpaceChannel()Sets the token to a channel indicating that it is reading white spac
ToText()Returns the value of the token and the category by defau

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.

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.

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.

GetTokenCategory()

Return

integer

IsCommentChannel()

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

Return

boolean:

IsNormalChannel()

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

Return

boolean:

IsWhiteSpaceChannel()

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

Return

boolean:

SetToCommentChannel()

Sets the token to a channel indicating that it is reading comment

SetToNormalChannel()

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

SetToWhiteSpaceChannel()

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

ToText()

Returns the value of the token and the category by defau

Return

text: