Oops that shouldn't have happened! Please enable Java-Script to use our site!

  • Class: LogicalAndExpression

    compiler.LogicalAndExpression

    Logical-and expression, representing an expression which can be used to combine multiple conditions. It will evaluate to true if all conditions are true.

    Since

    0.1.0

    Example

    false && false // false
true && false // false
false && true // false
true && true // true

    Hierarchy

    Table of contents

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • new LogicalAndExpression(antlrRuleCtx, parent)

    Parameters

    Name Type
    antlrRuleCtx LogicalAndExpressionContext
    parent CompilableASTNode<SemanticData, TypeData>

    Overrides

    LogicalExpression.constructor

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:78

    Properties

    _antlrRuleCtx

    • Readonly Private _antlrRuleCtx: LogicalAndExpressionContext

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

    Overrides

    LogicalExpression._antlrRuleCtx

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:40

    _children

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

    Inherited from

    LogicalExpression._children

    Defined in

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

    _errors

    • Protected _errors: KipperError[]

    Inherited from

    LogicalExpression._errors

    Defined in

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

    _parent

    • Protected _parent: CompilableNodeParent

    Inherited from

    LogicalExpression._parent

    Defined in

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

    _scopeCtx

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

    Inherited from

    LogicalExpression._scopeCtx

    Defined in

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

    _semanticData

    • Protected _semanticData: undefined | LogicalAndExpressionSemantics

    Inherited from

    LogicalExpression._semanticData

    Defined in

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

    _skippedSemanticAnalysis

    • Protected _skippedSemanticAnalysis: boolean

    Inherited from

    LogicalExpression._skippedSemanticAnalysis

    Defined in

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

    _skippedSemanticTypeChecking

    • Protected _skippedSemanticTypeChecking: boolean

    Inherited from

    LogicalExpression._skippedSemanticTypeChecking

    Defined in

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

    _skippedTargetSemanticAnalysis

    • Protected _skippedTargetSemanticAnalysis: boolean

    Inherited from

    LogicalExpression._skippedTargetSemanticAnalysis

    Defined in

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

    _typeSemantics

    • Protected _typeSemantics: undefined | LogicalAndExpressionTypeSemantics

    Inherited from

    LogicalExpression._typeSemantics

    Defined in

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

    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

    LogicalExpression.checkForWarnings

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:128

    targetCodeGenerator

    • Readonly targetCodeGenerator: TargetASTNodeCodeGenerator<LogicalAndExpression, TranslatedExpression>

    Code generator function that is specific for the target language.

    Since

    0.8.0

    Overrides

    LogicalExpression.targetCodeGenerator

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:138

    targetSemanticAnalysis

    • Readonly targetSemanticAnalysis: undefined | TargetASTNodeSemanticAnalyser<LogicalAndExpression>

    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

    LogicalExpression.targetSemanticAnalysis

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:137

    kind

    ▪ Static Readonly kind: 66

    The static kind for this AST Node.

    Since

    0.11.0

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:46

    ruleName

    ▪ Static Readonly ruleName: "RULE_logicalAndExpression"

    The static rule name for this AST Node.

    Since

    0.11.0

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:64

    Accessors

    antlrRuleCtx

    • get antlrRuleCtx(): LogicalAndExpressionContext

    The antlr context containing the antlr4 metadata for this expression.

    Returns

    LogicalAndExpressionContext

    Overrides

    LogicalExpression.antlrRuleCtx

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:133

    children

    • get children(): Children[]

    The children of this AST node.

    Since

    0.8.0

    Returns

    Children[]

    Inherited from

    LogicalExpression.children

    Defined in

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

    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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.hasFailed

    Defined in

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

    kind

    • get kind(): 66

    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

    66

    Overrides

    LogicalExpression.kind

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:56

    parent

    • get parent(): CompilableNodeParent

    Returns the parent that has this node as a child.

    Since

    0.8.0

    Returns

    CompilableNodeParent

    Inherited from

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.programCtx

    Defined in

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

    ruleName

    • get ruleName(): "RULE_logicalAndExpression"

    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_logicalAndExpression"

    Overrides

    LogicalExpression.ruleName

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:74

    scope

    • get scope(): LocalScope | GlobalScope

    The scope of this AST node.

    Since

    0.8.0

    Returns

    LocalScope | GlobalScope

    Inherited from

    LogicalExpression.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

    LogicalExpression.scopeCtx

    Defined in

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

    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

    LogicalExpression.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

    LogicalExpression.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

    Name Type Description
    value undefined | Semantics The semantic data that should be written onto this AST node.

    Returns

    void

    Inherited from

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    Name Type Description
    value undefined | TypeSemantics The semantic data that should be written onto this AST node.

    Returns

    void

    Inherited from

    LogicalExpression.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

    Name Type Description
    error KipperError The error to add.

    Returns

    void

    Inherited from

    LogicalExpression.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

    Name Type
    newChild Expression<ExpressionSemantics, ExpressionTypeSemantics, CompilableASTNode<SemanticData, TypeData>>

    Returns

    void

    Inherited from

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.getAntlrRuleChildren

    Defined in

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

    getSemanticData

    ▸ getSemanticData(): LogicalAndExpressionSemantics

    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

    LogicalAndExpressionSemantics

    Inherited from

    LogicalExpression.getSemanticData

    Defined in

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

    getTypeSemanticData

    ▸ getTypeSemanticData(): LogicalAndExpressionTypeSemantics

    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

    LogicalAndExpressionTypeSemantics

    Inherited from

    LogicalExpression.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

    Name Type Description
    error KipperError | Error The error to handle.

    Returns

    void

    Inherited from

    LogicalExpression.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

    LogicalExpression.hasSideEffects

    Defined in

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

    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

    LogicalExpression.primarySemanticAnalysis

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:90

    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

    LogicalExpression.primarySemanticTypeChecking

    Defined in

    kipper/core/src/compiler/ast/nodes/expressions/logical-expression/logical-and-expression/logical-and-expression.ts:115

    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

    LogicalExpression.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

    LogicalExpression.semanticAnalysis

    Defined in

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

    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

    LogicalExpression.semanticTypeChecking

    Defined in

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

    semanticallyAnalyseChildren

    ▸ Protected semanticallyAnalyseChildren(): Promise<void>

    Runs semanticAnalysis of all children nodes.

    Since

    0.10.0

    Returns

    Promise<void>

    Inherited from

    LogicalExpression.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

    LogicalExpression.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

    LogicalExpression.targetSemanticallyAnalyseChildren

    Defined in

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

    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

    LogicalExpression.translateCtxAndChildren

    Defined in

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

    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

    LogicalExpression.wrapUpSemanticAnalysis

    Defined in

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