avail/avail.descriptor.phrases/DeclarationPhraseDescriptor/DeclarationKind

DeclarationKind

enum DeclarationKind : Enum<DeclarationPhraseDescriptor.DeclarationKind> , IntegerEnumSlotDescriptionEnum

These are the kinds of arguments, variables, constants, and labels that can be declared. There are also optional initializing expressions, fixed values (for module constants), and fixed variable objects (for module variables).

Author

Mark van Gulik

Entries

PRIMITIVE_FAILURE_REASON

PRIMITIVE_FAILURE_REASON("primitive failure reason", true, false, PhraseKind.PRIMITIVE_FAILURE_REASON_PHRASE)

A local constant, declared within a block.

MODULE_CONSTANT

MODULE_CONSTANT("module constant", false, true, PhraseKind.MODULE_CONSTANT_PHRASE)

A constant declared at the outermost (module) scope.

MODULE_VARIABLE

MODULE_VARIABLE("module variable", true, true, PhraseKind.MODULE_VARIABLE_PHRASE)

A variable declared at the outermost (module) scope.

LOCAL_CONSTANT

LOCAL_CONSTANT("local constant", false, false, PhraseKind.LOCAL_CONSTANT_PHRASE)

A local constant, declared within a block.

LOCAL_VARIABLE

LOCAL_VARIABLE("local variable", true, false, PhraseKind.LOCAL_VARIABLE_PHRASE)

A local variable, declared within a block.

LABEL

LABEL("label", false, false, PhraseKind.LABEL_PHRASE)

A label declaration at the start of a block.

ARGUMENT

ARGUMENT("argument", false, false, PhraseKind.ARGUMENT_PHRASE)

An argument to a block.

Types

Companion

object Companion

Functions

emitEffectForOn

open fun emitEffectForOn( tokens: A_Tuple, declarationNode: A_Phrase, codeGenerator: AvailCodeGenerator)

If this is an ordinary declaration then it was handled on a separate pass. Do nothing by default.

emitVariableAssignmentForOn

open fun emitVariableAssignmentForOn( tokens: A_Tuple, declarationNode: A_Phrase, codeGenerator: AvailCodeGenerator)

Emit an assignment to this variable.

emitVariableReferenceForOn

open fun emitVariableReferenceForOn( tokens: A_Tuple, declarationNode: A_Phrase, codeGenerator: AvailCodeGenerator)

Emit a reference to this variable.

emitVariableValueForOn

open fun emitVariableValueForOn( tokens: A_Tuple, declarationNode: A_Phrase, codeGenerator: AvailCodeGenerator)

Emit a use of this variable.

kindName

fun kindName(): A_String

Return an Avail string describing this kind of declaration.

nativeKindName

fun nativeKindName(): String

Answer a Java String describing this kind of declaration.

phraseKind

fun phraseKind(): PhraseTypeDescriptor.PhraseKind

Return the instance of the enumeration PhraseKind that is associated with this kind of declaration.

abstract fun print( self: A_Phrase, builder: StringBuilder, recursionMap: IdentityHashMap<A_BasicObject, Void>, indent: Int)

Print a declaration of this kind.

Properties

fieldName

open override val fieldName: String

Answer the name of this enumeration value.

fieldOrdinal

open override val fieldOrdinal: Int

Answer an integer that identifies this enumeration value uniquely within this enumeration subclass (i.e., any enumeration class implementing this interface). These values are allocated sequentially to the enumeration values, starting at zero.

isModuleScoped

val isModuleScoped: Boolean

Whether this entity occurs at the module scope.

isVariable

val isVariable: Boolean

Whether this entity can be modified.

name

val name: String

ordinal

val ordinal: Int