Class LeafCstNodeImpl

A leaf CST node corresponds to a token in the input token stream.

Hierarchy (View Summary)

AbstractCstNode
- LeafCstNodeImpl

Implements

LeafCstNode

Index

Constructors

Properties

container grammarSource

Accessors

astNode end hidden length offset range root text tokenType

Constructors

constructor

new LeafCstNodeImpl(
    offset: number,
    length: number,
    startLine: number,
    startColumn: number,
    endLine: number,
    endColumn: number,
    tokenType: TokenType,
    hidden?: boolean,
): LeafCstNodeImpl
All position values are 0-based and the end position is exclusive, following the LSP convention (see the Range type).
Parameters
- offset: number
- length: number
- startLine: number
- startColumn: number
- endLine: number
- endColumn: number
- tokenType: TokenType
- hidden: boolean = false
Returns LeafCstNodeImpl
Overrides AbstractCstNode.constructor
- Defined in packages/langium/src/parser/cst-node-builder.ts:280

Properties

container

container: CompositeCstNode | undefined = undefined

The container node in the CST

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

Overrides AbstractCstNode.astNode
- Defined in packages/langium/src/parser/cst-node-builder.ts:255

end

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

Overrides AbstractCstNode.end
- Defined in packages/langium/src/parser/cst-node-builder.ts:243

hidden

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

Returns boolean
Implementation of LeafCstNode.hidden

Overrides AbstractCstNode.hidden
- Defined in packages/langium/src/parser/cst-node-builder.ts:247

length

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

Overrides AbstractCstNode.length
- Defined in packages/langium/src/parser/cst-node-builder.ts:239

offset

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

Overrides AbstractCstNode.offset
- Defined in packages/langium/src/parser/cst-node-builder.ts:235

range

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

Overrides AbstractCstNode.range
- Defined in packages/langium/src/parser/cst-node-builder.ts:263

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

Inherited from AbstractCstNode.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 LeafCstNode.text

Inherited from AbstractCstNode.text
- Defined in packages/langium/src/parser/cst-node-builder.ts:220

tokenType

get tokenType(): TokenType
Returns TokenType
Implementation of LeafCstNode.tokenType
- Defined in packages/langium/src/parser/cst-node-builder.ts:251