Class: CompilableASTNode<Semantics, TypeSemantics>
compiler.CompilableASTNode
Compilable AST Node that can be semantically analysed and translated into a target language.
Since
0.8.0
Type parameters
Name | Type |
---|---|
Semantics |
extends SemanticData = SemanticData |
TypeSemantics |
extends TypeData = TypeData |
Hierarchy
AnalysableASTNode
<Semantics
,TypeSemantics
>↳
CompilableASTNode
↳↳
Declaration
↳↳
Expression
↳↳
Statement
Implements
Table of contents
Constructors
Properties
- _antlrRuleCtx
- _children
- _errors
- _parent
- _semanticData
- _skippedSemanticAnalysis
- _skippedSemanticTypeChecking
- _skippedTargetSemanticAnalysis
- _typeSemantics
- targetCodeGenerator
- targetSemanticAnalysis
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
- checkForWarnings
- ensureSemanticallyValid
- ensureTypeSemanticallyValid
- getAntlrRuleChildren
- getSemanticData
- getTypeSemanticData
- handleSemanticError
- hasSideEffects
- preliminaryTypeChecking
- preliminaryTypeCheckingChildren
- primaryPreliminaryTypeChecking
- primarySemanticAnalysis
- primarySemanticTypeChecking
- recursivelyCheckForWarnings
- semanticAnalysis
- semanticTypeChecking
- semanticallyAnalyseChildren
- semanticallyTypeCheckChildren
- targetSemanticallyAnalyseChildren
- translateCtxAndChildren
- wrapUpSemanticAnalysis
Constructors
constructor
• Protected
new CompilableASTNode<Semantics
, TypeSemantics
>(antlrCtx
, parent
)
Type parameters
Name | Type |
---|---|
Semantics |
extends SemanticData = SemanticData |
TypeSemantics |
extends TypeData = TypeData |
Parameters
Name | Type |
---|---|
antlrCtx |
KipperParserRuleContext |
parent |
CompilableNodeParent |
Overrides
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:49
Properties
_antlrRuleCtx
• Protected
Readonly
_antlrRuleCtx: KipperParserRuleContext
Inherited from
AnalysableASTNode._antlrRuleCtx
Defined in
kipper/core/src/compiler/ast/ast-node.ts:45
_children
• Protected
_children: CompilableNodeChild
[]
Overrides
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:65
_errors
• Protected
_errors: KipperError
[]
Inherited from
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:75
_parent
• Protected
_parent: CompilableNodeParent
Overrides
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:55
_semanticData
• Protected
_semanticData: undefined
| Semantics
Inherited from
AnalysableASTNode._semanticData
Defined in
kipper/core/src/compiler/ast/ast-node.ts:56
_skippedSemanticAnalysis
• Protected
_skippedSemanticAnalysis: boolean
Inherited from
AnalysableASTNode._skippedSemanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:85
_skippedSemanticTypeChecking
• Protected
_skippedSemanticTypeChecking: boolean
Inherited from
AnalysableASTNode._skippedSemanticTypeChecking
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:96
_skippedTargetSemanticAnalysis
• Protected
_skippedTargetSemanticAnalysis: boolean
Inherited from
AnalysableASTNode._skippedTargetSemanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:43
_typeSemantics
• Protected
_typeSemantics: undefined
| TypeSemantics
Inherited from
AnalysableASTNode._typeSemantics
Defined in
kipper/core/src/compiler/ast/ast-node.ts:75
targetCodeGenerator
• Readonly
Abstract
targetCodeGenerator: TargetASTNodeCodeGenerator
<any
, TranslatedCodeLine
| TranslatedCodeLine
[]>
Code generator function that is specific for the target language.
Since
0.8.0
Implementation of
TargetCompilableNode.targetCodeGenerator
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:44
targetSemanticAnalysis
• Readonly
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
Inherited from
AnalysableASTNode.targetSemanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:42
Accessors
antlrRuleCtx
• get
antlrRuleCtx(): KipperParserRuleContext
The antlr rule context containing the antlr4 metadata for this AST node.
Since
0.8.0
Returns
Inherited from
AnalysableASTNode.antlrRuleCtx
Defined in
kipper/core/src/compiler/ast/ast-node.ts:114
children
• get
children(): CompilableNodeChild
[]
The children of this AST node.
Since
0.8.0
Returns
Overrides
AnalysableASTNode.children
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:71
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
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
Inherited from
AnalysableASTNode.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
Inherited from
AnalysableASTNode.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
AnalysableASTNode.hasFailed
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:132
kind
• Abstract
get
kind(): number
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 KipperParser rule fields, for example RULE_expression.
Since
0.10.0
Returns
number
Inherited from
AnalysableASTNode.kind
Defined in
kipper/core/src/compiler/ast/ast-node.ts:101
parent
• get
parent(): CompilableNodeParent
Returns the parent that has this node as a child.
Since
0.8.0
Returns
Overrides
AnalysableASTNode.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
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
Inherited from
AnalysableASTNode.programCtx
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:112
ruleName
• Abstract
get
ruleName(): string
Returns the identifier of this AST node. This is a unique identifier that can be used to differentiate this AST node from other AST nodes.
Since
0.11.0
Returns
string
Inherited from
AnalysableASTNode.ruleName
Defined in
kipper/core/src/compiler/ast/ast-node.ts:108
scope
• get
scope(): LocalScope
| ClassScope
| GlobalScope
The scope of this AST node.
Since
0.8.0
Returns
LocalScope
| ClassScope
| GlobalScope
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
>
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
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
AnalysableASTNode.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
Name | Type | Description |
---|---|---|
value |
undefined | Semantics |
The semantic data that should be written onto this AST node. |
Returns
void
Inherited from
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.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
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
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
AnalysableASTNode.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
Name | Type | Description |
---|---|---|
value |
undefined | TypeSemantics |
The semantic data that should be written onto this AST node. |
Returns
void
Inherited from
AnalysableASTNode.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
Name | Type | Description |
---|---|---|
error |
KipperError |
The error to add. |
Returns
void
Inherited from
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
Name | Type |
---|---|
newChild |
CompilableNodeChild |
Returns
void
Overrides
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:149
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
AnalysableASTNode.checkForWarnings
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:445
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
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.getAntlrRuleChildren
Defined in
kipper/core/src/compiler/ast/ast-node.ts:161
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
AnalysableASTNode.getSemanticData
Defined in
kipper/core/src/compiler/ast/ast-node.ts:174
getTypeSemanticData
▸ getTypeSemanticData(): TypeSemantics
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
TypeSemantics
Inherited from
AnalysableASTNode.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
Name | Type | Description |
---|---|---|
error |
KipperError | Error |
The error to handle. |
Returns
void
Inherited from
AnalysableASTNode.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
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:160
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
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.primaryPreliminaryTypeChecking
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:426
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
AnalysableASTNode.primarySemanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:415
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
AnalysableASTNode.primarySemanticTypeChecking
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:436
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
AnalysableASTNode.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
AnalysableASTNode.semanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:212
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
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.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
AnalysableASTNode.targetSemanticallyAnalyseChildren
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:397
translateCtxAndChildren
▸ translateCtxAndChildren(): Promise
<TranslatedCodeLine
| TranslatedCodeLine
[]>
Generates the typescript code for this item, and all children (if they exist).
Since
0.8.0
Returns
Promise
<TranslatedCodeLine
| TranslatedCodeLine
[]>
Defined in
kipper/core/src/compiler/ast/compilable-ast-node.ts:168
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
AnalysableASTNode.wrapUpSemanticAnalysis
Defined in
kipper/core/src/compiler/ast/analysable-ast-node.ts:301