kitejs/io.github.yuroyami.kitejs.ast/Comment

Comment

class Comment(pos: Int, len: Int, type: Token.CommentType, value: String) : AstNode

A comment. Node type is Token.COMMENT.

JavaScript has five comment shapes: line comments, block comments, jsdoc comments (block comments with formatting conventions), and the two HTML forms. SpiderMonkey and Rhino support the HTML syntax, where everything from  is a line comment. That exists to parse scripts hidden from very old browsers inside HTML comment delimiters.

The node start position is relative to the parent as usual, but comments are always stored directly in the AstRoot, so it is also an absolute offset.

Parameters

len

the length including the delimiters

Constructors

Comment

constructor(pos: Int, len: Int, type: Token.CommentType, value: 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.

astRoot

val astRoot: AstRoot?

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

bigInt

open var bigInt: KBigInt?

Only valid when type == Token.BIGINT.

column

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.

commentType

var commentType: Token.CommentType

The comment style.

double

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.

enclosingScope

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.

firstChild

val firstChild: Node?

inlineComment

var inlineComment: AstNode?

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

jsDoc

val jsDoc: String?

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

jsDocNode

var jsDocNode: Comment?

The JsDoc Comment attached to this node, or null.

lastChild

val lastChild: Node?

lastSibling

val lastSibling: Node

length

var length: Int

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

lineno

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.

parent

var parent: AstNode?

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

position

var position: Int

Relative position in the parent.

scope

open var scope: Scope?

Only valid when the node has String context.

string

var string: String?

Only valid when the node has String context.

type

open var type: Int

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

value

var value: String

The comment text. Setting it also updates the node length.

Functions

addChild

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.

addChildAfter

fun addChildAfter(newChild: Node, node: Node)

Add newChild after node.

addChildBefore

fun addChildBefore(newChild: Node, node: Node)

Add newChild before node.

addChildrenToBack

fun addChildrenToBack(children: Node)

addChildrenToFront

fun addChildrenToFront(children: Node)

addChildToBack

fun addChildToBack(child: Node)

addChildToFront

fun addChildToFront(child: Node)

compareTo

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.

debugPrint

open fun debugPrint(): String

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

depth

fun depth(): Int

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

getChildBefore