Class RootCstNodeImpl

A composite CST node contains other nodes, but no directly associated token.

The content array must not be modified directly; use the CstNodeBuilder methods instead to ensure that the container references of the child nodes are set correctly.

Hierarchy (View Summary)

CompositeCstNodeImpl
- RootCstNodeImpl

Implements

RootCstNode

Index

Constructors

constructor

new RootCstNodeImpl(input?: string): RootCstNodeImpl
Parameters
- Optionalinput: string
Returns RootCstNodeImpl
Overrides CompositeCstNodeImpl.constructor
- Defined in packages/langium/src/parser/cst-node-builder.ts:399

Properties

container

container: CompositeCstNode | undefined = undefined

The container node in the CST

content

content: CstNode[] = []

This array must not be modified directly; use the CstNodeBuilder methods instead to ensure that the container references of the child nodes are set correctly.

grammarSource

grammarSource: GrammarAST.AbstractElement | undefined = undefined

The grammar element from which this node was parsed

Accessors

astNode

get astNode(): AstNode
The AST node created from this CST node

Returns AstNode
Implementation of RootCstNode.astNode

Inherited from CompositeCstNodeImpl.astNode
- Defined in packages/langium/src/parser/cst-node-builder.ts:320
set astNode(value: AstNode | undefined): void
The AST node created from this CST node
Parameters
- value: AstNode | undefined
Returns void
Implementation of RootCstNode.astNode

Inherited from CompositeCstNodeImpl.astNode
- Defined in packages/langium/src/parser/cst-node-builder.ts:332

end

get end(): number
Returns number
Implementation of RootCstNode.end

Inherited from CompositeCstNodeImpl.end
- Defined in packages/langium/src/parser/cst-node-builder.ts:348

fullText

get fullText(): string
Returns string
Implementation of RootCstNode.fullText
- Defined in packages/langium/src/parser/cst-node-builder.ts:395

hidden

get hidden(): boolean
Whether the token is hidden, i.e. not explicitly part of the containing grammar rule

Returns boolean
Implementation of RootCstNode.hidden

Inherited from CompositeCstNodeImpl.hidden
- Defined in packages/langium/src/parser/cst-node-builder.ts:336

length

get length(): number
Returns number
Implementation of RootCstNode.length

Inherited from CompositeCstNodeImpl.length
- Defined in packages/langium/src/parser/cst-node-builder.ts:344

offset

get offset(): number
Returns number
Implementation of RootCstNode.offset

Inherited from CompositeCstNodeImpl.offset
- Defined in packages/langium/src/parser/cst-node-builder.ts:340

range

get range(): Range
Returns Range
Implementation of RootCstNode.range

Inherited from CompositeCstNodeImpl.range
- Defined in packages/langium/src/parser/cst-node-builder.ts:352

root

get root(): RootCstNode
The root CST node.

The root is resolved by walking up the container chain on every access. Avoid repeated accesses in loops over many nodes of the same tree; resolve the root once instead.

Returns RootCstNode
Implementation of RootCstNode.root

Inherited from CompositeCstNodeImpl.root
- Defined in packages/langium/src/parser/cst-node-builder.ts:211

text

get text(): string
The actual text covered by this node.

The text is extracted from the document content on every access. When processing many nodes of the same tree, prefer resolving root.fullText once and slicing it with the nodes' offset and end values.

Returns string
Implementation of RootCstNode.text

Overrides CompositeCstNodeImpl.text
- Defined in packages/langium/src/parser/cst-node-builder.ts:391

Class RootCstNodeImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns RootCstNodeImpl

Properties

container

content

grammarSource

Accessors

astNode

Returns AstNode

Parameters

Returns void

end

Returns number

fullText

Returns string

hidden

Returns boolean

length

Returns number

offset

Returns number

range

Returns Range

root

Returns RootCstNode

text

Returns string

Settings

On This Page