Class: AssignmentExpression

compiler.AssignmentExpression

Assignment expression, which assigns an expression to a variable. This class only represents assigning a value to an existing variable, but not creating a new one.

This expression will evaluate to the value that was assigned to the identifier.

Since

0.1.0

Example

x = 4
x += 5
x -= 12
x *= 2
x /= 5
x %= 55

Hierarchy

• Expression<AssignmentExpressionSemantics, AssignmentExpressionTypeSemantics, Expression>

  ↳ AssignmentExpression

Table of contents

Constructors

• constructor

Properties

• _antlrRuleCtx
• _children
• _errors
• _parent
• _semanticData
• _skippedSemanticAnalysis
• _skippedSemanticTypeChecking
• _skippedTargetSemanticAnalysis
• _typeSemantics
• checkForWarnings
• targetCodeGenerator
• targetSemanticAnalysis
• kind
• ruleName

Accessors

• antlrRuleCtx
• children
• codeGenerator
• compileConfig
• errors
• hasFailed
• kind
• parent
• parser
• programCtx
• ruleName
• scope
• scopeCtx
• semanticAnalyser
• semanticData
• skippedSemanticAnalysis
• skippedSemanticTypeChecking
• sourceCode
• target
• tokenStream
• typeSemantics

Methods

• addError
• addNewChild
• ensureSemanticallyValid
• ensureTypeSemanticallyValid
• getAntlrRuleChildren
• getSemanticData
• getTypeSemanticData
• handleSemanticError
• hasSideEffects
• preliminaryTypeChecking
• preliminaryTypeCheckingChildren
• primaryPreliminaryTypeChecking
• primarySemanticAnalysis
• primarySemanticTypeChecking
• recursivelyCheckForWarnings
• semanticAnalysis
• semanticTypeChecking
• semanticallyAnalyseChildren
• semanticallyTypeCheckChildren
• targetSemanticallyAnalyseChildren
• translateCtxAndChildren
• wrapUpSemanticAnalysis

Constructors

constructor

• new AssignmentExpression(antlrRuleCtx, parent)

Parameters

Overrides

Expression.constructor

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:67

Properties

_antlrRuleCtx

• Readonly Private _antlrRuleCtx: AssignmentExpressionContext

The private field '_antlrRuleCtx' that actually stores the variable data, which is returned inside the this.antlrRuleCtx.

Overrides

Expression._antlrRuleCtx

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:65

_children

• Protected _children: Expression<ExpressionSemantics, ExpressionTypeSemantics, CompilableASTNode<SemanticData, TypeData>>[]

Inherited from

Expression._children

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:37

_errors

• Protected _errors: KipperError[]

Inherited from

Expression._errors

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:75

_parent

• Protected _parent: CompilableNodeParent

Inherited from

Expression._parent

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:55

_semanticData

• Protected _semanticData: undefined | AssignmentExpressionSemantics

Inherited from

Expression._semanticData

Defined in

kipper/core/src/compiler/ast/ast-node.ts:56

_skippedSemanticAnalysis

• Protected _skippedSemanticAnalysis: boolean

Inherited from

Expression._skippedSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:85

_skippedSemanticTypeChecking

• Protected _skippedSemanticTypeChecking: boolean

Inherited from

Expression._skippedSemanticTypeChecking

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:96

_skippedTargetSemanticAnalysis

• Protected _skippedTargetSemanticAnalysis: boolean

Inherited from

Expression._skippedTargetSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:43

_typeSemantics

• Protected _typeSemantics: undefined | AssignmentExpressionTypeSemantics

Inherited from

Expression._typeSemantics

Defined in

kipper/core/src/compiler/ast/ast-node.ts:75

checkForWarnings

• checkForWarnings: undefined = undefined

Semantically analyses the code inside this AST node and checks for possible warnings or problematic code.

This will log all warnings using programCtx.logger and store them in warnings.

Since

0.9.0

Overrides

Expression.checkForWarnings

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:179

targetCodeGenerator

• Readonly targetCodeGenerator: TargetASTNodeCodeGenerator<AssignmentExpression, TranslatedExpression>

Code generator function that is specific for the target language.

Since

0.8.0

Overrides

Expression.targetCodeGenerator

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:182

targetSemanticAnalysis

• Readonly targetSemanticAnalysis: undefined | TargetASTNodeSemanticAnalyser<AssignmentExpression>

Semantic analyser function that is specific for the target. This only should perform logical analysis and not interpret the code/modify the semanticData field.

If this is undefined then it means there is no target specific semantic analysis that needs to be done.

Since

0.8.0

Overrides

Expression.targetSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:181

kind

▪ Static Readonly kind: 81

The static kind for this AST Node.

Since

0.11.0

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:52

ruleName

▪ Static Readonly ruleName: "RULE_assignmentExpression"

The static rule name for this AST Node.

Since

0.11.0

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:58

Accessors

antlrRuleCtx

• get antlrRuleCtx(): AssignmentExpressionContext

The antlr context containing the antlr4 metadata for this expression.

Returns

AssignmentExpressionContext

Overrides

Expression.antlrRuleCtx

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:99

children

• get children(): Children[]

The children of this AST node.

Since

0.8.0

Returns

Children[]

Inherited from

Expression.children

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:39

codeGenerator

• get codeGenerator(): KipperTargetCodeGenerator

The code generator, which will generate the code for this specific token into the this.target target language.

Since

0.8.0

Returns

KipperTargetCodeGenerator

Inherited from

Expression.codeGenerator

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:104

compileConfig

• get compileConfig(): EvaluatedCompileConfig

The compilation config for the program of this AST node.

Since

0.10.0

Returns

EvaluatedCompileConfig

Inherited from

Expression.compileConfig

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:120

errors

• get errors(): KipperError[]

The errors that were caused by this node. Includes all errors from children.

Since

0.10.0

Returns

KipperError[]

Inherited from

Expression.errors

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:81

hasFailed

• get hasFailed(): boolean

Returns true if the this.primarySemanticAnalysis semantic analysis or this.primarySemanticTypeChecking type checking of this node or any children nodes failed.

This indicates that the node is not valid and can not be translated.

Since

0.10.0

Returns

boolean

Inherited from

Expression.hasFailed

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:132

kind

• get kind(): 81

Returns the kind of this AST node. This represents the specific type of the antlrRuleCtx that this AST node wraps.

This may be compared using the rule fields, for example RULE_expression.

Since

0.10.0

Returns

81

Overrides

Expression.kind

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:80

parent

• get parent(): CompilableNodeParent

Returns the parent that has this node as a child.

Since

0.8.0

Returns

CompilableNodeParent

Inherited from

Expression.parent

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:61

parser

• get parser(): KipperParser

The parser that generated the parse tree and antlr rule context.

Since

0.8.0

Returns

KipperParser

Inherited from

Expression.parser

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:79

programCtx

• get programCtx(): KipperProgramContext

The file context instance containing the metadata for the listener and this AST node.

Since

0.8.0

Returns

KipperProgramContext

Inherited from

Expression.programCtx

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:112

ruleName

• get ruleName(): "RULE_assignmentExpression"

Returns the rule name of this AST Node. This represents the specific type of the antlrRuleCtx that this AST node wraps.

This may be compared using the rule fields, for example RULE_expression.

Since

0.11.0

Returns

"RULE_assignmentExpression"

Overrides

Expression.ruleName

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:92

scope

• get scope(): LocalScope | ClassScope | GlobalScope

The scope of this AST node.

Since

0.8.0

Returns

LocalScope | ClassScope | GlobalScope

Inherited from

Expression.scope

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:112

scopeCtx

• get scopeCtx(): ScopeNode<LocalScope | ClassScope | GlobalScope>

The context / AST node of the scope.

Since

0.8.0

Returns

ScopeNode<LocalScope | ClassScope | GlobalScope>

Inherited from

Expression.scopeCtx

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:120

semanticAnalyser

• get semanticAnalyser(): KipperTargetSemanticAnalyser

The translation-specific semantic analyser, which will perform semantic analysis specific for the this.target target language.

Since

0.8.0

Returns

KipperTargetSemanticAnalyser

Inherited from

Expression.semanticAnalyser

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:138

semanticData

• get semanticData(): undefined | Semantics

Returns the semantic data of this AST node.

Since

0.8.0

Returns

undefined | Semantics

Inherited from

Expression.semanticData

Defined in

kipper/core/src/compiler/ast/ast-node.ts:62

• set semanticData(value): void

Sets the semantic data of this AST node.

Since

0.8.0

Parameters

Returns

void

Inherited from

Expression.semanticData

Defined in

kipper/core/src/compiler/ast/ast-node.ts:71

skippedSemanticAnalysis

• get skippedSemanticAnalysis(): boolean

Returns true if the this.primarySemanticAnalysis semantic analysis of this node was skipped, due to required semantic data being missing. This indicates that the node is impossible to analyse as the required semantic data from other nodes is missing.

Returns

boolean

Inherited from

Expression.skippedSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:92

skippedSemanticTypeChecking

• get skippedSemanticTypeChecking(): boolean

Returns true if the this.primarySemanticTypeChecking type checking of this node was skipped, due to required semantic data being missing. This indicates that the node is impossible to type check as the required semantic data from other nodes is missing.

Since

0.10.0

Returns

boolean

Inherited from

Expression.skippedSemanticTypeChecking

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:104

sourceCode

• get sourceCode(): string

The Kipper source code that was used to generate this CompilableASTNode.

Any left-over whitespaces will be removed using trim().

Since

0.8.0

Returns

string

Inherited from

Expression.sourceCode

Defined in

kipper/core/src/compiler/ast/ast-node.ts:133

target

• get target(): KipperCompileTarget

The compilation translation for this specific token.

Since

0.8.0

Returns

KipperCompileTarget

Inherited from

Expression.target

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:95

tokenStream

• get tokenStream(): TokenStream

Returns the token stream source for this token.

Since

0.8.0

Returns

TokenStream

Inherited from

Expression.tokenStream

Defined in

kipper/core/src/compiler/ast/compilable-ast-node.ts:87

typeSemantics

• get typeSemantics(): undefined | TypeSemantics

Returns the type data of this AST node.

Since

0.10.0

Returns

undefined | TypeSemantics

Inherited from

Expression.typeSemantics

Defined in

kipper/core/src/compiler/ast/ast-node.ts:81

• set typeSemantics(value): void

Sets the type data of this AST node.

Since

0.10.0

Parameters

Returns

void

Inherited from

Expression.typeSemantics

Defined in

kipper/core/src/compiler/ast/ast-node.ts:90

Methods

addError

▸ addError(error): void

Adds the specified error to the list of errors caused by this node.

This is not the same as reportError, since that function automatically logs the error as well and this function does not! This is only intended to keep track if a node has failed.

Parameters

Returns

void

Inherited from

Expression.addError

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:143

addNewChild

▸ addNewChild(newChild): void

Adds new child ctx item to this AST node. The child item should be in the order that they appeared in the this.antlrCtx parse tree.

This will also automatically set the parent of newChild to this instance.

Since

0.8.0

Parameters

Returns

void

Inherited from

Expression.addNewChild

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:70

ensureSemanticallyValid

▸ Protected ensureSemanticallyValid(): void

Ensures that this node successfully passed the semantic analysis. This will be primarily used by statements and declarations, which depend on other nodes to be semantically valid.

This is done by checking if the hasFailed property is set to true and if the semanticData property is undefined. If both of these conditions are met, then the node failed in an intended way and the parent should not continue processing, as it will cause errors.

This is used to help the control flow and also to ensure that other nodes do not try to access the semantic data of a node that failed, as that would cause an UndefinedSemanticsError.

Intentionally this will also likely cause an UndefinedSemanticsError in case the semantic data is missing and hasFailed is returning false. Since that's an automatic contradiction, it's better to ignore it here and let the UndefinedSemanticsError be thrown later.

Throws

If the child failed and the semantic data is undefined. Note that this is not like UndefinedSemanticsError, as that error is thrown when the semantic data is undefined in an unintended or unexpected way. This error on the other will be handled by the compiler and influence the control flow.

Since

0.10.0

Returns

void

Inherited from

Expression.ensureSemanticallyValid

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:168

ensureTypeSemanticallyValid

▸ Protected ensureTypeSemanticallyValid(): void

Ensures that this node successfully passed the type checking step of semantic analysis. This will be primarily used by statements and declarations, which depend on other nodes to be semantically valid.

This is done by checking if the hasFailed property is set to true and if the typeSemantics property is undefined. If both of these conditions are met, then the child failed in an intended way and the parent should not continue processing, as it will cause errors.

This is used to help the control flow and also to ensure that the parent node does not try to access the type semantic data of a child node that has failed.

Intentionally this will also likely cause an UndefinedSemanticsError in case the semantic data is missing and hasFailed is returning false. Since that's an automatic contradiction, it's better to ignore it here and let the UndefinedSemanticsError be thrown later.

Throws

If the child failed and the semantic data is undefined. Note that this is not like UndefinedSemanticsError, as that error is thrown when the semantic data is undefined in an unintended or unexpected way. This error on the other will be handled by the compiler and influence the control flow.

Since

0.10.0

Returns

void

Inherited from

Expression.ensureTypeSemanticallyValid

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:195

getAntlrRuleChildren

▸ getAntlrRuleChildren(): ParseTree[]

Returns the children of the antlrRuleCtx and throws an error in case they are undefined.

Throws

If antlrRuleCtx.children is undefined.

Since

0.8.0

Returns

ParseTree[]

Inherited from

Expression.getAntlrRuleChildren

Defined in

kipper/core/src/compiler/ast/ast-node.ts:161

getSemanticData

▸ getSemanticData(): AssignmentExpressionSemantics

Returns the semantic data of this AST node and throws an error in case it is undefined.

Throws

If semanticData is undefined.

Since

0.8.0

Returns

AssignmentExpressionSemantics

Inherited from

Expression.getSemanticData

Defined in

kipper/core/src/compiler/ast/ast-node.ts:174

getTypeSemanticData

▸ getTypeSemanticData(): AssignmentExpressionTypeSemantics

Returns the type semantic data of this AST node and throws an error in case it is undefined.

Throws

UndefinedSemanticsError If semanticData is undefined.

Since

0.10.0

Returns

AssignmentExpressionTypeSemantics

Inherited from

Expression.getTypeSemanticData

Defined in

kipper/core/src/compiler/ast/ast-node.ts:187

handleSemanticError

▸ Protected handleSemanticError(error): void

Handles the specified error that occurred during the semantic analysis of this node in a standardised way.

Since

0.10.0

Parameters

Returns

void

Inherited from

Expression.handleSemanticError

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:343

hasSideEffects

▸ hasSideEffects(): boolean

Returns whether this AST node has any side effects. This means that the node will change the state of the program in some way and not only return a value.

This specifically can mean it assigns or modifies a variable, calls a function, or throws an error.

Since

0.11.0

Returns

boolean

Overrides

Expression.hasSideEffects

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:103

preliminaryTypeChecking

▸ preliminaryTypeChecking(): Promise<void>

Performs preliminary type checking on this AST node and all this.children children nodes. This uses the this.semanticData semantic data that was evaluated during this.semanticAnalysis semantic analysis.

This preliminarily sets the this.typeSemantics type semantics of this node and allows the use of this.getTypeSemanticData in any child that may need the data, without getting any error.

This is a special step in the type checking process, where the type semantics are evaluated before the actual type checking is done. This is useful for cases where children need parent data to be already evaluated, like for example inside a class when the class type is needed for checking the "this" keyword.

We will call this "Ahead of time" type evaluation, as it is done before the actual proper type checking of the node, preceding any other type checking in the entire tree.

Since

0.12.0

Returns

Promise<void>

Inherited from

Expression.preliminaryTypeChecking

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:246

preliminaryTypeCheckingChildren

▸ Protected preliminaryTypeCheckingChildren(): Promise<void>

Runs preliminaryTypeChecking of all children nodes.

Since

0.12.0

Returns

Promise<void>

Inherited from

Expression.preliminaryTypeCheckingChildren

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:367

primaryPreliminaryTypeChecking

▸ Protected Optional primaryPreliminaryTypeChecking(): Promise<void>

Preliminary type checks the code inside this AST node.

This is a special step in the type checking process, where the type semantics are evaluated before the actual type checking is done. This is useful for cases where children need parent data to be already evaluated, like for example inside a class when the class type is needed for checking the "this" keyword.

Since

0.12.0

Returns

Promise<void>

Inherited from

Expression.primaryPreliminaryTypeChecking

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:426

primarySemanticAnalysis

▸ primarySemanticAnalysis(): Promise<void>

Performs the semantic analysis for this Kipper token. This will log all warnings using programCtx.logger and throw errors if encountered.

This will not run in case that this.hasFailed is true, as that indicates that the semantic analysis of the children has already failed and as such no parent node should run type checking.

Returns

Promise<void>

Overrides

Expression.primarySemanticAnalysis

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:114

primarySemanticTypeChecking

▸ primarySemanticTypeChecking(): Promise<void>

Performs type checking for this AST Node. This will log all warnings using programCtx.logger and throw errors if encountered.

This will not run in case that this.hasFailed is true, as that indicates that the type checking of the children has already failed and as such no parent node should run type checking.

Since

0.7.0

Returns

Promise<void>

Overrides

Expression.primarySemanticTypeChecking

Defined in

kipper/core/src/compiler/ast/nodes/expressions/assignment-expression/assignment-expression.ts:161

recursivelyCheckForWarnings

▸ recursivelyCheckForWarnings(): Promise<void>

Recursively checks for warnings by calling this function on all this.children children and calling checkForWarnings on this class as well.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.recursivelyCheckForWarnings

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:327

semanticAnalysis

▸ semanticAnalysis(): Promise<void>

Semantically analyses the code inside this AST node and all this.children children nodes.

This function will recursively call itself on the this.children instances and analyse the deepest children nodes first, working up as the tokens get more complex. This way the parent tokens can access the semantics of the children and properly process itself.

This function will set the this.semanticData property and allow the use of this.getSemanticData, without getting any error.

Since

0.8.0

Returns

Promise<void>

Inherited from

Expression.semanticAnalysis

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:93

semanticTypeChecking

▸ semanticTypeChecking(): Promise<void>

Performs type checking on this AST node and all this.children children nodes. This uses the this.semanticData semantic data that was evaluated during this.semanticAnalysis semantic analysis.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.semanticTypeChecking

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:118

semanticallyAnalyseChildren

▸ Protected semanticallyAnalyseChildren(): Promise<void>

Runs semanticAnalysis of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.semanticallyAnalyseChildren

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:352

semanticallyTypeCheckChildren

▸ Protected semanticallyTypeCheckChildren(): Promise<void>

Runs semanticTypeChecking of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.semanticallyTypeCheckChildren

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:382

targetSemanticallyAnalyseChildren

▸ Protected targetSemanticallyAnalyseChildren(): Promise<void>

Runs semanticTypeChecking of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.targetSemanticallyAnalyseChildren

Defined in

kipper/core/src/compiler/ast/analysable-ast-node.ts:397

translateCtxAndChildren

▸ translateCtxAndChildren(): Promise<TranslatedExpression>

Generates the typescript code for this item, and all children (if they exist).

Every item in the array represents a token of the expression.

Returns

Promise<TranslatedExpression>

Inherited from

Expression.translateCtxAndChildren

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:166

wrapUpSemanticAnalysis

▸ wrapUpSemanticAnalysis(): Promise<void>

Wrap-up semantic analysis, which analyses this AST node and all this.children children nodes, and checks whether they are semantically valid for the this.target target language. This uses the this.semanticData semantic data and this.typeData type data that was evaluated during the previous this.semanticAnalysis semantic analysis and this.semanticTypeChecking type checking steps.

Since

0.10.0

Returns

Promise<void>

Inherited from

Expression.wrapUpSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/nodes/expressions/expression.ts:143