kitejs/io.github.yuroyami.kitejs.ast/Name

Name

class Name : AstNode

A simple name: an identifier that is not a keyword. Node type is Token.NAME.

Also used for a few non-identifier names that are part of the language syntax, such as the "get" and "set" pseudo-keywords in object initializers.

Constructors

constructor()

constructor(pos: Int)

constructor(pos: Int, len: Int)

constructor(pos: Int, len: Int, name: String)

constructor(pos: Int, name: String)

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

val definingScope: Scope?

The Scope in which this name is defined, or null if it is not defined in the current lexical scope chain.

var double: Double

Only valid when type == Token.NUMBER.

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.

val firstChild: Node?

var identifier: String?

The node's identifier. Setting it also updates the node length.

var inlineComment: AstNode?

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

val isLocalName: Boolean

True when this name is known to be defined as a symbol in a lexical scope other than the top-level one: a local variable, a non-global let binding, a function parameter, a loop variable, and so on. False when it resolves to the top-level scope or is not in the symbol table at all, which may mean an external or built-in name.

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.

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 parent: AstNode?

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

var position: Int

Relative position in the parent.

open override var scope: Scope?

The Scope associated with this node. Only used by (and set by) the code generator, so it is always null in frontend AST-processing code. Use definingScope to find the lexical scope in which this name is defined.

var string: String?

Only valid when the node has String context.

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 addChildToBack(child: Node)

addChildToFront

fun addChildToFront(child: Node)

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?

getExistingIntProp

fun getExistingIntProp(propType: Int): Int

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

fun getProp(propType: Int): Any?

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 length(): Int

The length of this node's identifier, so you can pretend it is a String. Not the same as AstNode.length, which is the source range the node covers.

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 removeChild(child: Node)

fun removeChildren()

fun removeProp(propType: Int)

fun replaceChild(child: Node, newChild: Node)

replaceChildAfter

fun replaceChildAfter(prevChild: Node, newChild: Node)

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

Emits source code for this node. The caller recurses into children, incrementing depth as appropriate.

open override fun toString(): String

fun toStringTree(treeTop: ScriptNode): String?

open override fun visit(visitor: NodeVisitor)

Visits this node. There are no children to visit.

fun withPrefix(prefix: String): Name