Class: Declaration<Semantics, TypeData>

compiler.Declaration

The base abstract AST node class for all declarations/declarations, which wrap their corresponding KipperParserRuleContext rule context classes that were generated by the KipperParser.

These AST nodes can be created with the DeclarationASTNodeFactory class.

Note! Any function, variable or parameter declaration in Kipper will be registered in a Scope, which will define the visibility of the variable. The only exception is a ParameterDeclaration, which is bound to a function and its local scope.

Since

0.1.0

Type parameters

Hierarchy

• CompilableASTNode<Semantics, TypeData>

  ↳ Declaration

  ↳↳ ParameterDeclaration

  ↳↳ FunctionDeclaration

  ↳↳ VariableDeclaration

Table of contents

Constructors

• constructor

Properties

• _antlrRuleCtx
• _children
• _errors
• _parent
• _scopeCtx
• _scopeDeclaration
• _semanticData
• _skippedSemanticAnalysis
• _skippedSemanticTypeChecking
• _skippedTargetSemanticAnalysis
• _typeSemantics
• targetCodeGenerator
• targetSemanticAnalysis

Accessors

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

Methods

• addError
• addNewChild
• checkForWarnings
• ensureScopeDeclarationAvailableIfNeeded
• ensureSemanticallyValid
• ensureTypeSemanticallyValid
• getAntlrRuleChildren
• getScopeDeclaration
• getSemanticData
• getTypeSemanticData
• handleSemanticError
• hasSideEffects
• primarySemanticAnalysis
• primarySemanticTypeChecking
• recursivelyCheckForWarnings
• semanticAnalysis
• semanticTypeChecking
• semanticallyAnalyseChildren
• semanticallyTypeCheckChildren
• targetSemanticallyAnalyseChildren
• translateCtxAndChildren
• wrapUpSemanticAnalysis

Constructors

constructor

• Protected new Declaration<Semantics, TypeData>(antlrRuleCtx, parent)

Type parameters

Parameters

Overrides

CompilableASTNode.constructor

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:69

Properties

_antlrRuleCtx

• Readonly Private _antlrRuleCtx: ParserDeclarationContext

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

Overrides

CompilableASTNode._antlrRuleCtx

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:41

_children

• Protected _children: CompilableNodeChild[]

Inherited from

CompilableASTNode._children

Defined in

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

_errors

• Protected _errors: KipperError[]

Inherited from

CompilableASTNode._errors

Defined in

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

_parent

• Protected _parent: CompilableNodeParent

Inherited from

CompilableASTNode._parent

Defined in

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

_scopeCtx

• Protected _scopeCtx: undefined | ScopeNode<LocalScope | FunctionScope> | KipperProgramContext

Inherited from

CompilableASTNode._scopeCtx

Defined in

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

_scopeDeclaration

• Private _scopeDeclaration: undefined | ScopeDeclaration

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

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:48

_semanticData

• Protected _semanticData: undefined | Semantics

Inherited from

CompilableASTNode._semanticData

Defined in

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

_skippedSemanticAnalysis

• Protected _skippedSemanticAnalysis: boolean

Inherited from

CompilableASTNode._skippedSemanticAnalysis

Defined in

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

_skippedSemanticTypeChecking

• Protected _skippedSemanticTypeChecking: boolean

Inherited from

CompilableASTNode._skippedSemanticTypeChecking

Defined in

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

_skippedTargetSemanticAnalysis

• Protected _skippedTargetSemanticAnalysis: boolean

Inherited from

CompilableASTNode._skippedTargetSemanticAnalysis

Defined in

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

_typeSemantics

• Protected _typeSemantics: undefined | TypeData

Inherited from

CompilableASTNode._typeSemantics

Defined in

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

targetCodeGenerator

• Abstract targetCodeGenerator: TargetASTNodeCodeGenerator<any, TranslatedCodeLine[]>

Code generator function that is specific for the target language.

Since

0.8.0

Overrides

CompilableASTNode.targetCodeGenerator

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:141

targetSemanticAnalysis

• Abstract targetSemanticAnalysis: undefined | TargetASTNodeSemanticAnalyser<any>

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

CompilableASTNode.targetSemanticAnalysis

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:140

Accessors

antlrRuleCtx

• get antlrRuleCtx(): ParserDeclarationContext

The antlr context containing the antlr4 metadata for this expression.

Returns

ParserDeclarationContext

Overrides

CompilableASTNode.antlrRuleCtx

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:80

children

• get children(): CompilableNodeChild[]

The children of this AST node.

Since

0.8.0

Returns

CompilableNodeChild[]

Inherited from

CompilableASTNode.children

Defined in

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

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

CompilableASTNode.codeGenerator

Defined in

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

compileConfig

• get compileConfig(): EvaluatedCompileConfig

The compilation config for the program of this AST node.

Since

0.10.0

Returns

EvaluatedCompileConfig

Inherited from

CompilableASTNode.compileConfig

Defined in

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

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

CompilableASTNode.errors

Defined in

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

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

CompilableASTNode.hasFailed

Defined in

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

kind

• Abstract get kind(): ASTDeclarationKind

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 ParseRuleKindMapping.RULE_expression.

Since

0.10.0

Returns

ASTDeclarationKind

Overrides

CompilableASTNode.kind

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:57

parent

• get parent(): CompilableNodeParent

Returns the parent that has this node as a child.

Since

0.8.0

Returns

CompilableNodeParent

Inherited from

CompilableASTNode.parent

Defined in

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

parser

• get parser(): KipperParser

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

Since

0.8.0

Returns

KipperParser

Inherited from

CompilableASTNode.parser

Defined in

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

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

CompilableASTNode.programCtx

Defined in

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

ruleName

• Abstract get ruleName(): ASTDeclarationRuleName

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 ParseRuleKindMapping.RULE_statement.

Since

0.11.0

Returns

ASTDeclarationRuleName

Overrides

CompilableASTNode.ruleName

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:67

scope

• get scope(): LocalScope | GlobalScope

The scope of this AST node.

Since

0.8.0

Returns

LocalScope | GlobalScope

Inherited from

CompilableASTNode.scope

Defined in

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

scopeCtx

• get scopeCtx(): ScopeNode<LocalScope | FunctionScope> | KipperProgramContext

The context / AST node of the scope.

Since

0.8.0

Returns

ScopeNode<LocalScope | FunctionScope> | KipperProgramContext

Inherited from

CompilableASTNode.scopeCtx

Defined in

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

scopeDeclaration

• get scopeDeclaration(): undefined | ScopeDeclaration

The ScopeDeclaration context instance for this declaration, which is used to register the declaration in the parent scope.

Since

0.10.0

Returns

undefined | ScopeDeclaration

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:89

• set scopeDeclaration(declaration): void

Parameters

Returns

void

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:93

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

CompilableASTNode.semanticAnalyser

Defined in

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

semanticData

• get semanticData(): undefined | Semantics

Returns the semantic data of this AST node.

Since

0.8.0

Returns

undefined | Semantics

Inherited from

CompilableASTNode.semanticData

Defined in

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

• set semanticData(value): void

Sets the semantic data of this AST node.

Since

0.8.0

Parameters

Returns

void

Inherited from

CompilableASTNode.semanticData

Defined in

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

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

CompilableASTNode.skippedSemanticAnalysis

Defined in

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

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

CompilableASTNode.skippedSemanticTypeChecking

Defined in

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

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

CompilableASTNode.sourceCode

Defined in

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

target

• get target(): KipperCompileTarget

The compilation translation for this specific token.

Since

0.8.0

Returns

KipperCompileTarget

Inherited from

CompilableASTNode.target

Defined in

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

tokenStream

• get tokenStream(): TokenStream

Returns the token stream source for this token.

Since

0.8.0

Returns

TokenStream

Inherited from

CompilableASTNode.tokenStream

Defined in

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

typeSemantics

• get typeSemantics(): undefined | TypeSemantics

Returns the type data of this AST node.

Since

0.10.0

Returns

undefined | TypeSemantics

Inherited from

CompilableASTNode.typeSemantics

Defined in

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

• set typeSemantics(value): void

Sets the type data of this AST node.

Since

0.10.0

Parameters

Returns

void

Inherited from

CompilableASTNode.typeSemantics

Defined in

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

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

CompilableASTNode.addError

Defined in

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

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

CompilableASTNode.addNewChild

Defined in

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

checkForWarnings

▸ Protected Optional Abstract checkForWarnings(): Promise<void>

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.

If this is undefined then it means there is no warning checks that needs to be done.

Since

0.9.0

Returns

Promise<void>

Inherited from

CompilableASTNode.checkForWarnings

Defined in

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

ensureScopeDeclarationAvailableIfNeeded

▸ ensureScopeDeclarationAvailableIfNeeded(): void

Ensures that this node has a scope declaration available. This will be primarily used by declarations in their own analysis.

This will throw an error if the scope declaration is not available.

This is primarily used by the semanticTypeChecking method, which often requires the scope declaration to be available. As such this is a helper method which ensures the control flow is correct and no invalid errors are thrown. (E.g. an internal error is thrown after a normal semantic analysis error).

Intentionally this will also likely cause an UndefinedSemanticsError in case the scopeDeclaration 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 scope declaration is not available.

Since

0.11.0

Returns

void

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:126

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

CompilableASTNode.ensureSemanticallyValid

Defined in

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

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

CompilableASTNode.ensureTypeSemanticallyValid

Defined in

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

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

CompilableASTNode.getAntlrRuleChildren

Defined in

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

getScopeDeclaration

▸ getScopeDeclaration(): ScopeDeclaration

Returns the scope declaration ctx of this declaration and throws an error in case it is undefined.

Throws

UndefinedDeclarationCtx If scopeDeclaration is undefined.

Since

0.10.0

Returns

ScopeDeclaration

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:103

getSemanticData

▸ getSemanticData(): Semantics

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

Semantics

Inherited from

CompilableASTNode.getSemanticData

Defined in

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

getTypeSemanticData

▸ getTypeSemanticData(): TypeData

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

TypeData

Inherited from

CompilableASTNode.getTypeSemanticData

Defined in

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

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

CompilableASTNode.handleSemanticError

Defined in

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

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

Inherited from

CompilableASTNode.hasSideEffects

Defined in

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

primarySemanticAnalysis

▸ Protected Optional Abstract primarySemanticAnalysis(): Promise<void>

Semantically analyses the code inside this AST node.

If this is undefined then it means there is no semantic analysis that needs to be done. This will also automatically make semanticData be defined as an empty object.

Throws

KipperError if the code is not valid.

Since

0.8.0

Returns

Promise<void>

Inherited from

CompilableASTNode.primarySemanticAnalysis

Defined in

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

primarySemanticTypeChecking

▸ Protected Optional Abstract primarySemanticTypeChecking(): Promise<void>

Type checks the code inside this AST node.

If this is undefined then it means there is no type checking that needs to be done. This will also automatically make typeSemantics be defined as an empty object.

Throws

TypeError When a type mismatch or invalid usage is encountered.

Since

0.8.0

Returns

Promise<void>

Inherited from

CompilableASTNode.primarySemanticTypeChecking

Defined in

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

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

CompilableASTNode.recursivelyCheckForWarnings

Defined in

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

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

CompilableASTNode.semanticAnalysis

Defined in

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

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

CompilableASTNode.semanticTypeChecking

Defined in

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

semanticallyAnalyseChildren

▸ Protected semanticallyAnalyseChildren(): Promise<void>

Runs semanticAnalysis of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

CompilableASTNode.semanticallyAnalyseChildren

Defined in

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

semanticallyTypeCheckChildren

▸ Protected semanticallyTypeCheckChildren(): Promise<void>

Runs semanticTypeChecking of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

CompilableASTNode.semanticallyTypeCheckChildren

Defined in

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

targetSemanticallyAnalyseChildren

▸ Protected targetSemanticallyAnalyseChildren(): Promise<void>

Runs semanticTypeChecking of all children nodes.

Since

0.10.0

Returns

Promise<void>

Inherited from

CompilableASTNode.targetSemanticallyAnalyseChildren

Defined in

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

translateCtxAndChildren

▸ translateCtxAndChildren(): Promise<TranslatedCodeLine[]>

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

Since

0.8.0

Returns

Promise<TranslatedCodeLine[]>

Overrides

CompilableASTNode.translateCtxAndChildren

Defined in

kipper/core/src/compiler/ast/nodes/declarations/declaration.ts:136

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

CompilableASTNode.wrapUpSemanticAnalysis

Defined in

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