Struct chalk_parse::parser::__parse__Goal::__StateMachine

pub(crate) struct __StateMachine<'input> {
    input: &'input str,
    __phantom: PhantomData<&'input ()>,
}

Fields

input: &'input str

__phantom: PhantomData<&'input ()>

Trait Implementations

impl<'input> ParserDefinition for __StateMachine<'input>

type Location = usize

Represents a location in the input text. If you are using the default tokenizer, this will be a usize.

type Error = &'static str

Represents a “user error” – this can get produced by reduce() if the grammar includes =>? actions.

type Token = Token<'input>

The type emitted by the user’s tokenizer (excluding the location information).

type TokenIndex = usize

We assign a unique index to each token in the grammar, which we call its index. When we pull in a new Token from the input, we then match against it to determine its index. Note that the actual Token is retained too, as it may carry additional information (e.g., an ID terminal often has a string value associated with it; this is not important to the parser, but the semantic analyzer will want it).

type Symbol = __Symbol<'input>

The type representing things on the LALRPOP stack. Represents the union of terminals and nonterminals.

type Success = Box<Goal>

Type produced by reducing the start symbol.

type StateIndex = i16

Identifies a state. Typically an i8, i16, or i32 (depending on how many states you have).

type Action = i16

Identifies an action.

type ReduceIndex = i16

Identifies a reduction.

type NonterminalIndex = usize

Identifies a nonterminal.

fn start_location(&self) -> Self::Location

Returns a location representing the “start of the input”.

fn start_state(&self) -> Self::StateIndex

Returns the initial state.

fn token_to_index(&self, token: &Self::Token) -> Option<usize>

Converts the user’s tokens into an internal index; this index is then used to index into actions and the like. When using an internal tokenizer, these indices are directly produced. When using an external tokenier, however, this function matches against the patterns given by the user: it is fallible therefore as these patterns may not be exhaustive. If a token value is found that doesn’t match any of the patterns the user supplied, then this function returns None, which is translated into a parse error by LALRPOP (“unrecognized token”).

fn action(&self, state: i16, integer: usize) -> i16

Given the top-most state and the pending terminal, returns an action. This can be either SHIFT(state), REDUCE(action), or ERROR.

fn error_action(&self, state: i16) -> i16

Returns the action to take if an error occurs in the given state. This function is the same as the ordinary action, except that it applies not to the user’s terminals but to the “special terminal” !.

fn eof_action(&self, state: i16) -> i16

Action to take if EOF occurs in the given state. This function is the same as the ordinary action, except that it applies not to the user’s terminals but to the “special terminal” $.

fn goto(&self, state: i16, nt: usize) -> i16

If we reduce to a nonterminal in the given state, what state do we go to? This is infallible due to the nature of LR(1) grammars.

fn token_to_symbol( &self, token_index: usize, token: Self::Token, ) -> Self::Symbol

“Upcast” a terminal into a symbol so we can push it onto the parser stack.

fn expected_tokens(&self, state: i16) -> Vec<String>

Returns the expected tokens in a given state. This is used for error reporting.

fn expected_tokens_from_states(&self, states: &[i16]) -> Vec<String>

Returns the expected tokens in a given state. This is used in the same way as expected_tokens but allows more precise reporting of accepted tokens in some cases.

fn uses_error_recovery(&self) -> bool

True if this grammar supports error recovery.

fn error_recovery_symbol(&self, recovery: ErrorRecovery<Self>) -> Self::Symbol

Given error information, creates an error recovery symbol that we push onto the stack (and supply to user actions).

fn reduce( &mut self, action: i16, start_location: Option<&Self::Location>, states: &mut Vec<i16>, symbols: &mut Vec<SymbolTriple<Self>>, ) -> Option<ParseResult<Self>>

Execute a reduction in the given state: that is, execute user code. The start location indicates the “starting point” of the current lookahead that is triggering the reduction (it is None for EOF).

fn simulate_reduce(&self, action: i16) -> SimulatedReduce<Self>

Returns information about how many states will be popped during a reduction, and what nonterminal would be produced as a result.