kitejs/io.github.yuroyami.kitejs.ast/GeneratorExpressionLoop

GeneratorExpressionLoop

class GeneratorExpressionLoop(pos: Int = -1, len: Int = 1) : ForInLoop

One for clause inside a generator expression. Unlike ArrayComprehensionLoop it does not support the for each form.

Constructors

GeneratorExpressionLoop

constructor(pos: Int = -1, len: Int = 1)

Properties

absolutePosition

val absolutePosition: Int

The absolute document position, computed by adding this node's relative position to the relative positions of all its parents.

val astRoot: AstRoot?

The AstRoot at the top of this node's parent chain, or null if there is none.

open var bigInt: KBigInt?

Only valid when type == Token.BIGINT.

open var body: AstNode?

The loop body. Setting it reparents the body and grows this node to include it.

val childScopes: List<Scope>?

The scopes whose parent is this scope, or null if there are none.

open val column: Int

The column where this node is defined in source, one-based. -1 means it was never initialized. May be overridden by subclasses.

var continueTarget: Node?

var defaultTarget: Node?

var double: Double

Only valid when type == Token.NUMBER.

var eachPosition: Int

Position of the each keyword in a for each..in loop, relative to this node.

enclosingFunction

val enclosingFunction: FunctionNode?

The innermost enclosing function, or null. The search begins with the parent.

val enclosingScope: Scope?

The innermost enclosing Scope, or null. The search begins with the parent. This is not the same as the defining scope for a Name.

var finallyTarget: Node?

val firstChild: Node?

var inlineComment: AstNode?

Comments on the same line as the statement, for example the trailing comment in if (x == 2) // note.

var inPosition: Int

Position of the in or of keyword, relative to this node.

open override var isForEach: Boolean

var isForOf: Boolean

var iteratedObject: AstNode?

The object being iterated. Setting it reparents the node.

var iterator: AstNode?

The loop variable. Setting it reparents the node.

val jsDoc: String?

The JsDoc comment string attached to this node, or null.

var jsDocNode: Comment?

The JsDoc Comment attached to this node, or null.

var jumpStatement: Jump?

val lastChild: Node?

val lastSibling: Node

var length: Int

Number of characters spanned by this node in the source text.

open override val lineno: Int

The line number recorded for this node. If none was recorded, searches the parent chain and returns -1 when nothing is found.

var loop: Jump?

var lp: Int

Left paren position, -1 if missing.

var parent: AstNode?

The node parent, or null. Setting it adjusts this node's start position to be relative to the new parent.

var parentScope: Scope?

var position: Int

Relative position in the parent.

var rp: Int

Right paren position, -1 if missing.

open var scope: Scope?

Only valid when the node has String context.

val statements: List<AstNode>

A copy of the child list, with each child cast to an AstNode. Throws once the code generator has begun the tree transformation and non-AstNode children appear.

var string: String?

Only valid when the node has String context.

var symbolTable: MutableMap<String, Symbol>?

Insertion-ordered so that iteration follows declaration order.

var target: Node?

var top: ScriptNode?

The current script or function scope.

open var type: Int

The node type, e.g. Token.NAME.

Functions

fun addChild(kid: AstNode)

Adds a child to the end of the block. Sets the child's parent to this node, rewrites the child position to be relative, and grows this node to include the child.

fun addChildAfter(newChild: Node, node: Node)

Add newChild after node.

fun addChildBefore(newChild: Node, node: Node)

Add newChild before node.

addChildrenToBack

fun addChildrenToBack(children: Node)

addChildrenToFront

fun addChildrenToFront(children: Node)

fun addChildScope(child: Scope)

Adds a scope to the child list and sets the child's parent scope to this scope.

fun addChildToBack(child: Node)

addChildToFront

fun addChildToFront(child: Node)

clearParentScope

fun clearParentScope()

Used only for code generation.

open operator override fun compareTo(other: AstNode): Int

Sorts by start position, then by length, then arbitrarily by hash code. Lets Comment and error nodes be mixed into a sorted collection of other AST nodes.

open fun debugPrint(): String

A debugging representation of the parse tree starting at this node. Each line reads abs-pos name position length [identifier].

fun depth(): Int

The depth of this node. The root is depth 0, its children depth 1, and so on.

fun getChildBefore(child: Node): Node?

getDefiningScope

fun getDefiningScope(name: String): Scope?

The scope in which name is defined: this scope, one of its parents, or null when the name is not defined anywhere in this scope chain.

getExistingIntProp

fun getExistingIntProp(propType: Int): Int

fun getIntProp(propType: Int, defaultValue: Int): Int

fun getProp(propType: Int): Any?

fun getSymbol(name: String): Symbol?

Looks up a symbol in this scope, or null if it is not there.

fun hasChildren(): Boolean

hasConsistentReturnUsage

fun hasConsistentReturnUsage(): Boolean

Checks that every return usage in a function body is consistent with strict mode. See the END_* flags for what the analysis reports.

open override fun hasSideEffects(): Boolean

open operator override fun iterator(): MutableIterator<Node>

fun labelId(): Int

fun labelId(labelId: Int)

fun makeIndent(indent: Int): String

Constructs an indentation string of indent steps.

fun putIntProp(propType: Int, prop: Int)

fun putProp(propType: Int, prop: Any?)

fun putSymbol(symbol: Symbol)

Enters a symbol into this scope.

fun removeChild(child: Node)

fun removeChildren()

fun removeProp(propType: Int)

fun replaceChild(child: Node, newChild: Node)

replaceChildAfter

fun replaceChildAfter(prevChild: Node, newChild: Node)

fun replaceWith(newScope: Scope)

Used by the parser. Repoints this scope's child scopes at newScope and copies this scope's symbols into it.

fun resetTargets()

Recursively unlabel every TARGET or YIELD node in the tree. Used only for inlining finally blocks where jsr instructions used to be.

fun setBounds(position: Int, end: Int)

Sets the start and end positions; the length becomes end - position.

setLineColumnNumber

fun setLineColumnNumber(lineno: Int, column: Int)

fun setParens(lp: Int, rp: Int)

Sets both paren positions.

fun setRelative(parentPosition: Int)

Makes this node's position relative to a parent. The current position is assumed to be absolute and is decremented by parentPosition.

fun shortName(): String

A short, descriptive name for the node, such as "ArrayComprehension".

open override fun toSource(depth: Int = 0): String

Jumps are only used during code generation and cannot render source.

open override fun toString(): String

fun toStringTree(treeTop: ScriptNode): String?

open override fun visit(visitor: NodeVisitor)

Jumps are only used during code generation and do not support the visitor interface.