Struct PrattParser

struct PrattParser<R: RuleType> { ... }

Struct containing operators and precedences, which can perform Pratt parsing on primary, prefix, postfix and infix expressions over Pairs. The tokens in Pairs should alternate in the order: prefix* ~ primary ~ postfix* ~ (infix ~ prefix* ~ primary ~ postfix*)*

Panics

Panics will occur when:

Example

The following pest grammar defines a calculator which can be used for Pratt parsing.

WHITESPACE   =  _{ " " | "\t" | NEWLINE }
  
program      =   { SOI ~ expr ~ EOI }
  expr       =   { prefix* ~ primary ~ postfix* ~ (infix ~ prefix* ~ primary ~ postfix* )* }
    infix    =  _{ add | sub | mul | div | pow }
      add    =   { "+" } // Addition
      sub    =   { "-" } // Subtraction
      mul    =   { "*" } // Multiplication
      div    =   { "/" } // Division
      pow    =   { "^" } // Exponentiation
    prefix   =  _{ neg }
      neg    =   { "-" } // Negation
    postfix  =  _{ fac }
      fac    =   { "!" } // Factorial
    primary  =  _{ int | "(" ~ expr ~ ")" }
      int    =  @{ (ASCII_NONZERO_DIGIT ~ ASCII_DIGIT+ | ASCII_DIGIT) }

Below is a PrattParser that is able to parse an expr in the above grammar. The order of precedence corresponds to the order in which op is called. Thus, mul will have higher precedence than add. Operators can also be chained with | to give them equal precedence.

# use pest::pratt_parser::{Assoc, Op, PrattParser};
# #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
# enum Rule { program, expr, int, add, mul, sub, div, pow, fac, neg }
let pratt =
    PrattParser::new()
        .op(Op::infix(Rule::add, Assoc::Left) | Op::infix(Rule::sub, Assoc::Left))
        .op(Op::infix(Rule::mul, Assoc::Left) | Op::infix(Rule::div, Assoc::Left))
        .op(Op::infix(Rule::pow, Assoc::Right))
        .op(Op::prefix(Rule::neg))
        .op(Op::postfix(Rule::fac));

To parse an expression, call the map_primary, map_prefix, map_postfix, map_infix and parse methods as follows:

# use pest::{iterators::Pairs, pratt_parser::PrattParser};
# #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
# enum Rule { program, expr, int, add, mul, sub, div, pow, fac, neg }
fn parse_expr(pairs: Pairs<Rule>, pratt: &PrattParser<Rule>) -> i32 {
    pratt
        .map_primary(|primary| match primary.as_rule() {
            Rule::int  => primary.as_str().parse().unwrap(),
            Rule::expr => parse_expr(primary.into_inner(), pratt), // from "(" ~ expr ~ ")"
            _          => unreachable!(),
        })
        .map_prefix(|op, rhs| match op.as_rule() {
            Rule::neg  => -rhs,
            _          => unreachable!(),
        })
        .map_postfix(|lhs, op| match op.as_rule() {
            Rule::fac  => (1..lhs+1).product(),
            _          => unreachable!(),
        })
        .map_infix(|lhs, op, rhs| match op.as_rule() {
            Rule::add  => lhs + rhs,
            Rule::sub  => lhs - rhs,
            Rule::mul  => lhs * rhs,
            Rule::div  => lhs / rhs,
            Rule::pow  => (1..rhs+1).map(|_| lhs).product(),
            _          => unreachable!(),
        })
        .parse(pairs)
}

Note that map_prefix, map_postfix and map_infix only need to be specified if the grammar contains the corresponding operators.

Implementations

impl<R: RuleType> PrattParser<R>

fn new() -> Self

Instantiate a new PrattParser.

fn op(self: Self, op: Op<R>) -> Self

Add op to PrattParser.

fn map_primary<'pratt, 'a, 'i, X, T>(self: &'pratt Self, primary: X) -> PrattParserMap<'pratt, 'a, 'i, R, X, T>
where
    X: FnMut(Pair<'i, R>) -> T,
    R: 'pratt

Maps primary expressions with a closure primary.

impl<R> Freeze for PrattParser<R>

impl<R> RefUnwindSafe for PrattParser<R>

impl<R> Send for PrattParser<R>

impl<R> Sync for PrattParser<R>

impl<R> Unpin for PrattParser<R>

impl<R> UnsafeUnpin for PrattParser<R>

impl<R> UnwindSafe for PrattParser<R>

impl<R: RuleType> Default for PrattParser<R>

fn default() -> Self

impl<T> Any for PrattParser<R>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for PrattParser<R>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for PrattParser<R>

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> From for PrattParser<R>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for PrattParser<R>

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for PrattParser<R>

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for PrattParser<R>

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>