Struct ParserSemCtx 

pub struct ParserSemCtx<'a, S>
where
    S: TokenSource,
{ /* private fields */ }

Runtime view passed to parser semantic hooks.

The context is intentionally read-only with respect to parser structure: predicates may run speculatively during prediction, and hooks can be called more than once for paths that are later abandoned. Lookahead methods may buffer tokens from the underlying token source, matching normal parser prediction behavior.

Implementations

impl<'a, S> ParserSemCtx<'a, S>

where S: TokenSource,

pub const fn rule_index(&self) -> usize

Rule index that owns the predicate/action coordinate.

pub fn rule_name(&self) -> Option<&str>

Rule name that owns the coordinate, when recognizer metadata has it.

pub const fn coordinate_index(&self) -> usize

Predicate/action index inside the owning rule. Parser actions keyed only by ATN source state report usize::MAX here; use Self::action for the stable action event.

pub fn input_index(&self) -> usize

Current token-stream index.

pub fn la(&mut self, offset: isize) -> i32

Token type at one-based lookahead/lookbehind offset.

pub fn lt(&self, offset: isize) -> Option<TokenView<'_>>

Token at one-based lookahead/lookbehind offset.

pub fn token_text(&self, offset: isize) -> Option<TokenView<'_>>

Borrowing token view for text inspection at a one-based offset.

pub fn token_at(&self, index: usize) -> Option<TokenView<'_>>

Token at an absolute buffered index, including hidden/custom channels.

Unlike Self::lt, this does not apply the token stream’s channel filter and does not move its cursor. It is intended for semantic helpers such as automatic-semicolon-insertion checks that inspect trivia immediately before the current visible token.

pub const fn context(&self) -> Option<&'a ParserRuleContext>

Current generated rule context, when a generated rule predicate supplied one.

pub const fn parse_tree_storage(&self) -> &'a ParseTreeStorage

Flat tree storage containing completed children visible to this hook.

pub const fn token_store(&self) -> &TokenStore

Canonical token store used by completed flat-tree nodes.

pub const fn tree_id(&self) -> Option<NodeId>

Completed parse-tree root ID passed to a replayed action hook.

pub fn tree(&self) -> Option<Node<'_>>

Completed parse tree passed to an action hook, if the action is being replayed after recognition.

pub fn local_int_arg(&self) -> Option<i64>

Integer local argument visible to this predicate coordinate.

pub fn member_int(&self, member: usize) -> Option<i64>

Integer member value observed on the current speculative path.

pub const fn action(&self) -> Option<ParserAction>

Parser action event being replayed, when this context belongs to an action hook.

pub fn action_text(&self) -> String

Text covered by a parser action event.

Mirrors BaseParser::text_interval / $text: when the stop token is EOF the interval ends at the previous visible token, so trailing hidden tokens (and the EOF marker) are excluded rather than blindly subtracting one, which could point at hidden whitespace. CommonTokenStream::text itself guards start > stop, so an empty interval yields "".

Trait Implementations

impl<S> Debug for ParserSemCtx<'_, S>

where S: TokenSource,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.