welly-parser 0.3.0

An artisanal parser for the Welly programming language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use super::{Location, Loc, Precedence, Op, MaybeExpr, Expr};

/// Represents an [`Op`] that is missing its right operand.
#[derive(Debug)]
pub struct Waiting {
    /// The left operand, if any.
    expr: MaybeExpr,

    /// The `Op`.
    op: Loc<Op>,

    /// The right precedence of `Op`.
    right: Precedence,
}

/// Represents an alternating sequence of [`Expr`]s and [`Op`]s, starting
/// with an `Expr`.
///
/// Each `Op` has a left precedence higher than the right precedence of the
/// preceding `Op` (otherwise we can replace an `Expr` `Op` `Expr` sequence
/// with an [`Expr::Op`]).
#[derive(Default, Debug)]
pub struct Stack {
    /// A sequence of (`Expr`, `Op`) pairs.
    ops: Vec<Waiting>,

    /// The final `Expr`, if any.
    expr: MaybeExpr,
}

impl Stack {
    /// Tests whether the sequence ends with an [`Expr`].
    pub fn has_expr(&self) -> bool { self.expr.is_some() }

    /// Returns the right-precedence of the last `Op`.
    fn right(&self) -> Option<Precedence> { self.ops.last().map(|w| w.right) }

    /// Before beginning a new [`Expr`], ensure that `self.expr` is `None` by
    /// inserting an [`Op::Missing`] if necessary.
    ///
    /// - loc - the [`Location`] before which to report a missing operator, if
    ///   necessary.
    fn insert_missing(&mut self, loc: Location) {
        let expr = self.expr.take();
        if expr.is_some() {
            // We have a left operand we weren't expecting.
            let op = Loc(Op::Missing, loc);
            let right = Precedence::MIN;
            self.ops.push(Waiting {expr, op, right});
        }
    }

    /// Before appending something with left-precedence `left`, see if the
    /// preceding `Op`s have a higher right-precedence, and if so construct
    /// some `Expr::Op`s.
    fn partial_flush(&mut self, left: Precedence) {
        while let Some(right) = self.right() {
            if right < left { break }
            let Waiting {expr, op, ..} = self.ops.pop().unwrap();
            let expr = Expr::Op(expr, op, self.expr.take());
            self.expr = Some(Box::new(expr));
        }
    }

    /// Collapse this `Stack` down to a single [`Expr`], if non-empty.
    pub fn flush(mut self) -> MaybeExpr {
        let mut ret = self.expr;
        while let Some(Waiting {expr, op, ..}) = self.ops.pop() {
            ret = Some(Box::new(Expr::Op(expr, op, ret)));
        }
        ret
    }

    /// Append an [`Op`].
    ///
    /// `Op`s can be nonfix, prefix, postfix or infix.
    pub fn op(&mut self, op: Loc<Op>) {
        let (left, right) = op.0.precedence();
        if let Some(left) = left {
            self.partial_flush(left);
        } else {
            self.insert_missing(op.1);
        }
        if let Some(right) = right {
            let expr = self.expr.take();
            self.ops.push(Waiting {expr, op, right});
        } else {
            let expr = Expr::Op(self.expr.take(), op, None);
            self.expr = Some(Box::new(expr));
        }
    }

    /// Append a non-[`Op`] that has no operands.
    ///
    /// - loc - the [`Location`] before which to report a missing operator, if
    ///   necessary.
    pub fn nonfix(&mut self, nonfix: Expr, loc: Location) {
        self.insert_missing(loc);
        self.expr = Some(Box::new(nonfix));
    }

    /// Append a non-[`Op`] that has a left operand.
    pub fn postfix(&mut self, left: Precedence, postfix: impl FnOnce(MaybeExpr) -> Expr) {
        self.partial_flush(left);
        let expr = postfix(self.expr.take());
        self.expr = Some(Box::new(expr));
    }
}