Libraries.Language.Compile.Context.DocumentationContext Documentation

Inherits from: Libraries.Language.Object, Libraries.Language.Compile.Context.ParseContext

Variables Table

VariablesDescription
text document

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)

EnterDocumentation(Libraries.Language.Compile.QuorumSourceListener listener)

Parameters

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)

ExitDocumentation(Libraries.Language.Compile.QuorumSourceListener listener)

Parameters

GetDocumentation()

Return

Libraries.Language.Compile.Context.DocumentationContext

GetFirstToken()

Return

Libraries.Language.Compile.Parsing.Token

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()

GetLastToken()

Return

Libraries.Language.Compile.Parsing.Token

GetLocation()

Return

Libraries.Language.Compile.Location

SetDocumentation(Libraries.Language.Compile.Context.DocumentationContext documentation)

Parameters

SetFirstToken(Libraries.Language.Compile.Parsing.Token firstToken)

Parameters

SetLastToken(Libraries.Language.Compile.Parsing.Token lastToken)

Parameters

SetLocation(Libraries.Language.Compile.Location loc)

Parameters

Traverse(Libraries.Language.Compile.QuorumSourceListener listener)

Parameters