Libraries.Language.Compile.Symbol.Variable Documentation

Inherits from: Libraries.Language.Compile.Location, Libraries.Language.Object, Libraries.Language.Compile.Symbol.Symbol

Actions Documentation

AddUsage(Libraries.Language.Compile.Location location)

Parameters

AddUseLocation(Libraries.Language.Compile.Location location)

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.

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)

CreateLocationCopy()

This action is a helper action to get copies of the location.

Return

Libraries.Language.Compile.Location:

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)

GetBytecodeLocation()

Return

integer

GetCodeCompletionItem(Libraries.Language.Compile.Symbol.Class calledFrom)

Parameters

Return

Libraries.Language.Compile.CodeCompletionItem

GetColumnNumber()

Return

integer

GetColumnNumberEnd()

Return

integer

GetDefaultGetterName()

This action determines what the default name for a getter would be for the variable.

Return

text:

GetDefaultSetterName()

This action determines what the default name for a setter would be for the variable.

Return

text:

GetDisplayName()

Return

text

GetDisplayNameWithGenerics()

Return

text

GetDisplayNameWithGenericsAsWeb()

Return

text

GetDocumentation()

Return

Libraries.Language.Compile.Symbol.Documentation

GetFile()

Return

Libraries.System.File

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

GetIndex()

Return

integer

GetIndexEnd()

Return

integer

GetJavaScriptName()

Return

text

GetLineNumber()

Return

integer

GetLineNumberEnd()

Return

integer

GetName()

Return

text

GetParameterLocation()

Return

integer

GetParentClass()

This action returns the class this variable is contained in. It does not return the type of the variable.

Return

Libraries.Language.Compile.Symbol.Class:

GetPythonName()

Return

text

GetStaticKey()

Return

text

GetType()

Return

Libraries.Language.Compile.Symbol.Type

GetTypeLocation()

Return

Libraries.Language.Compile.Location

GetUsageLocations()

Return

Libraries.Containers.Iterator

GetUseLocationIterator(Libraries.System.File file)

Parameters

Return

Libraries.Containers.Iterator

HasExplicitModifier()

Return

boolean

IsConstant()

Return

boolean

IsDefined()

particular variable

Return

boolean:

IsDefinedInAlwaysBlock()

This action determines what the default name for a setter would be for the variable.

Return

boolean:

IsField()

Return

boolean

IsFirstAssignment()

Return

boolean

IsParameter()

Return

boolean

IsPrivate()

Return

boolean

IsPublic()

Return

boolean

IsUsed()

Return

boolean

IsVisibleToDebugger()

This action sets the class this variable is contained in. It does not set the type of the variable.

Return

boolean:

RemoveUseLocations(Libraries.System.File file)

Parameters

SetBytecodeLocation(integer int)

Parameters

  • integer int

SetColumnNumber(integer column)

Parameters

  • integer column

SetColumnNumberEnd(integer column)

Parameters

  • integer column

SetConstant(boolean bool)

Parameters

  • boolean bool

SetDefinedInAlwaysBlock(boolean defined)

This action determines what the default name for a getter would be for the variable.

Parameters

  • boolean defined

SetDocumentation(Libraries.Language.Compile.Symbol.Documentation documentation)

Parameters

SetFile(Libraries.System.File file)

Parameters

SetFirstAssignment(boolean isFirstAssignment)

Parameters

  • boolean isFirstAssignment

SetHasExplicitModifier(boolean hasModifier)

Parameters

  • boolean hasModifier

SetIndex(integer index)

Parameters

  • integer index

SetIndexEnd(integer index)

Parameters

  • integer index

SetIsDefined(boolean defined)

check if the class has a "use" for this parent

Parameters

  • boolean defined

SetIsField(boolean field)

Parameters

  • boolean field

SetIsParameter(boolean isParameter)

Parameters

  • boolean isParameter

SetLineNumber(integer line)

Parameters

  • integer line

SetLineNumberEnd(integer line)

Parameters

  • integer line

SetLocation(Libraries.Language.Compile.Location location)

This action uses the location and resets the current error's data.

Parameters

SetName(text name)

Parameters

  • text name

SetParameterLocation(integer int)

Parameters

  • integer int

SetParentClass(Libraries.Language.Compile.Symbol.Class c)

This action sets the class this variable is contained in. It does not set the type of the variable.

Parameters

SetPrivate()

SetPublic()

SetType(Libraries.Language.Compile.Symbol.Type type)

Parameters

SetTypeLocation(Libraries.Language.Compile.Location location)

Parameters

SetVisibleToDebugger(boolean visible)

This action returns the class this variable is contained in. It does not return the type of the variable.

Parameters

  • boolean visible

ToText()

This action is a helper action to get copies of the location.

Return

text: