commonMain.org.antlr.v4.kotlinruntime.TokenStream.kt Maven / Gradle / Ivy
// Copyright 2017-present Strumenta and contributors, licensed under Apache 2.0.
// Copyright 2024-present Strumenta and contributors, licensed under BSD 3-Clause.
package org.antlr.v4.kotlinruntime
import org.antlr.v4.kotlinruntime.misc.Interval
/**
* An [IntStream] whose symbols are [Token] instances.
*/
public interface TokenStream : IntStream {
/**
* Gets the underlying [TokenSource] which provides tokens for this stream.
*/
public val tokenSource: TokenSource
/**
* Return the text of all tokens in the stream.
*
* This method behaves like the following code, including potential
* exceptions from the calls to [IntStream.size] and [getText],
* but may be optimized by the specific implementation.
*
* ```
* val stream: TokenStream = ...
* val text = stream.getText(Interval(0, stream.size()))
* ```
*
* @return The text of all tokens in the stream
*/
public val text: String
/**
* Get the [Token] instance associated with the value returned by `LA(k)`.
*
* This method has the same pre- and post-conditions as [IntStream.LA].
* In addition, when the preconditions of this method are met,
* the return value is non-`null` and the value of `LT(k).type == LA(k)`.
*
* @see IntStream.LA
*/
@Suppress("FunctionName")
public fun LT(k: Int): Token?
/**
* Gets the [Token] at the specified [index] in the stream.
*
* When the preconditions of this method are met, the return value is non-`null`.
*
* The preconditions for this method are the same as the preconditions of
* [IntStream.seek]. If the behavior of `seek(index)` is
* unspecified for the current state and given [index], then the
* behavior of this method is also unspecified.
*
* The symbol referred to by [index] differs from `seek()` only
* in the case of filtering streams where [index] lies before the end
* of the stream. Unlike `seek()`, this method does not adjust
* [index] to point to a non-ignored symbol.
*
* @throws IllegalArgumentException If [index] is less than 0
* @throws UnsupportedOperationException If the stream does not support
* retrieving the token at the specified index
*/
public operator fun get(index: Int): Token
/**
* Return the text of all tokens within the specified [interval].
*
* This method behaves like the following code, including potential exceptions
* for violating preconditions of [get], but may be optimized by the
* specific implementation:
*
* ```
* val stream: TokenStream = ...
* var text = ""
* var i = interval.a
*
* while (i <= interval.b) {
* text += stream.get(i++).text
* }
* ```
*
* @param interval The interval of tokens within this stream to get text for
* @return The text of all tokens within the specified interval in this stream
*/
public fun getText(interval: Interval): String
/**
* Return the text of all tokens in the source interval of the specified [ctx].
*
* This method behaves like the following code, including potential
* exceptions from the call to [getText], but may be optimized by the
* specific implementation.
*
* If `ctx.sourceInterval` does not return a valid interval of
* tokens provided by this stream, the behavior is unspecified.
*
* ```
* val stream: TokenStream = ...
* val text = stream.getText(ctx.sourceInterval)
* ```
*
* @param ctx The context providing the source interval of tokens to get text for
* @return The text of all tokens within the source interval of [ctx]
*/
public fun getText(ctx: RuleContext): String
/**
* Return the text of all tokens in this stream between [start] and [stop] (inclusive).
*
* If the specified [start] or [stop] token was not provided by
* this stream, or if the [stop] occurred before the [start] token,
* the behavior is unspecified.
*
* For streams which ensure that the [Token.tokenIndex] method is
* accurate for all of its provided tokens, this method behaves like the
* following code. Other streams may implement this method in other ways
* provided the behavior is consistent with this at a high level.
*
* ```
* val stream = TokenStream = ...
* var text = ""
* var i = start.tokenIndex
*
* while (i <= stop.tokenIndex) {
* text += stream.get(i++).text
* }
* ```
*
* @param start The first token in the interval to get text for
* @param stop The last token in the interval to get text for (inclusive)
* @return The text of all tokens lying between the specified [start] and [stop] tokens
*
* @throws UnsupportedOperationException If this stream does not support
* this method for the specified tokens
*/
public fun getText(start: Token, stop: Token): String?
}