yapcol 0.4.0

Yet Another Parser Combinator Library - YAPCoL
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

use crate::{InputToken, Parser};

/// Parses at least one occurrence of `operand_parser`, separated by `operator_parser`, in a
/// left-associative manner.
///
/// # Outcome
///
/// This combinator combines all values parsed by `operand_parser` into a final one using functions
/// returned by `operator_parser`, in a left-associative manner.
///
/// # Input consumption
///
/// This combinator consumes input if:
/// - It succeeds and any of its argument parsers consume input upon success.
/// - Any of its argument parsers fail while consuming input.
///
/// # Look-ahead and backtracking
///
/// This combinator doesn't perform any lookahead and won't backtrack upon failure.
///
/// # Arguments
///
/// - `operand_parser`: Parses operands that will be combined into a final value, in a
///   left-associative manner.
/// - `operator_parser`: Operator's parser, which consumes input and returns a function that
///   combines output values into one.
///
/// # Examples
///
/// ```
/// // Implements evaluation of the subtraction ('-') operator as left-associative.
/// use yapcol::{Error, Input, chain_left, satisfy};
///
/// let operand = satisfy(|c: &char| c.to_digit(10));
///
/// let operator = satisfy(|c: &char| match c {
/// 	'-' => Some(|a, b| a - b),
/// 	_ => None,
/// });
///
/// let tokens: Vec<_> = "3-1-1".chars().collect();
/// let mut input = Input::new_from_chars(tokens, None);
/// let parser = chain_left(&operand, &operator);
/// let output = parser(&mut input);
/// assert_eq!(output, Ok(1)); // (3 - 1) - 1 = 1, not 3 - (1 - 1) = 3
/// ```
pub fn chain_left<P, IT, O, OP, F>(operand_parser: &P, operator_parser: &OP) -> impl Parser<IT, O>
where
	P: Parser<IT, O>,
	IT: InputToken,
	OP: Parser<IT, F>,
	F: Fn(O, O) -> O,
{
	move |input| {
		let mut operand1 = operand_parser(input)?;
		while let Ok(operator) = operator_parser(input) {
			let operand2 = operand_parser(input)?;
			operand1 = operator(operand1, operand2);
		}
		Ok(operand1)
	}
}

/// Parses at least one occurrence of `operand_parser`, separated by `operator_parser`, in a
/// right-associative manner.
///
/// # Outcome
///
/// This combinator combines all values parsed by `operand_parser` into a final one using functions
/// returned by `operator_parser`, in a right-associative manner.
///
/// # Input consumption
///
/// This combinator consumes input if:
/// - It succeeds and any of its argument parsers consume input upon success.
/// - Any of its argument parsers fail while consuming input.
///
/// # Look-ahead and backtracking
///
/// This combinator doesn't perform any lookahead and won't backtrack upon failure.
///
/// # Arguments
///
/// - `operand_parser`: Parses operands that will be combined into a final value, in a
///   right-associative manner.
/// - `operator_parser`: Operator's parser, which consumes input and returns a function that
///   combines output values into one.
///
/// # Examples
///
/// ```
/// // Implements evaluation of the subtraction ('-') operator as right-associative.
/// use yapcol::{Error, Input, chain_right, satisfy};
///
/// let operand = satisfy(|c: &char| c.to_digit(10));
///
/// let operator = satisfy(|c: &char| match c {
/// 	'-' => Some(|a, b| a - b),
/// 	_ => None,
/// });
///
/// let tokens: Vec<_> = "3-1-1".chars().collect();
/// let mut input = Input::new_from_chars(tokens, None);
/// let parser = chain_right(&operand, &operator);
/// let output = parser(&mut input);
/// assert_eq!(output, Ok(3)); // 3 - (1 - 1) = 3, not (3 - 1) - 1 = 1
/// ```
pub fn chain_right<P, IT, O, OP, F>(operand_parser: &P, operator_parser: &OP) -> impl Parser<IT, O>
where
	P: Parser<IT, O>,
	IT: InputToken,
	OP: Parser<IT, F>,
	F: Fn(O, O) -> O,
{
	move |input| {
		let operand1 = operand_parser(input)?;
		match operator_parser(input) {
			Ok(operator) => {
				let operand2 = chain_right(operand_parser, operator_parser)(input)?;
				let output = operator(operand1, operand2);
				Ok(output)
			}
			Err(_) => Ok(operand1),
		}
	}
}

#[cfg(test)]
mod tests {
	mod chain_left {
		use crate::input::CharToken;
		use crate::*;

		/// Implements a left-associative parser for subtraction operation and evaluates it.
		fn parse_evaluate_left_subtraction() -> impl Parser<CharToken, i32> {
			|input| {
				let operand = satisfy(|c: &char| c.to_digit(10).map(|x| x as i32));
				let operator = satisfy(|c: &char| match c {
					'-' => Some(|a, b| a - b),
					_ => None,
				});

				chain_left(&operand, &operator)(input)
			}
		}

		#[test]
		fn empty() {
			let mut input = Input::new_from_chars("".chars(), None);
			let output = parse_evaluate_left_subtraction()(&mut input);
			assert_eq!(output, Err(Error::EndOfInput(None)));
		}

		#[test]
		fn one_operand() {
			let mut input = Input::new_from_chars("1".chars(), None);
			let output = parse_evaluate_left_subtraction()(&mut input);
			assert_eq!(output, Ok(1));
		}

		#[test]
		fn two_operands() {
			let mut input = Input::new_from_chars("9-7".chars(), None);
			let output = parse_evaluate_left_subtraction()(&mut input);
			assert_eq!(output, Ok(2));
		}

		#[test]
		fn tree_operands() {
			// (3 - 1) - 2 = 0, not 3 - (1 - 2) = 4
			let mut input = Input::new_from_chars("3-1-2".chars(), None);
			let output = parse_evaluate_left_subtraction()(&mut input);
			assert_eq!(output, Ok(0));
		}
	}

	mod chain_right {
		use crate::input::CharToken;
		use crate::*;

		/// Implements a right-associative parser for subtraction operation and evaluates it.
		fn parse_evaluate_right_subtraction() -> impl Parser<CharToken, i32> {
			|input| {
				let operand = satisfy(|c: &char| c.to_digit(10).map(|x| x as i32));
				let operator = satisfy(|c: &char| match c {
					'-' => Some(|a, b| a - b),
					_ => None,
				});

				chain_right(&operand, &operator)(input)
			}
		}

		#[test]
		fn empty() {
			let mut input = Input::new_from_chars("".chars(), None);
			let output = parse_evaluate_right_subtraction()(&mut input);
			assert_eq!(output, Err(Error::EndOfInput(None)));
		}

		#[test]
		fn one_operand() {
			let mut input = Input::new_from_chars("1".chars(), None);
			let output = parse_evaluate_right_subtraction()(&mut input);
			assert_eq!(output, Ok(1));
		}

		#[test]
		fn two_operands() {
			let mut input = Input::new_from_chars("9-7".chars(), None);
			let output = parse_evaluate_right_subtraction()(&mut input);
			assert_eq!(output, Ok(2));
		}

		#[test]
		fn tree_operands() {
			// 3 - (1 - 2) = 4, not (3 - 1) - 2 = 0
			let mut input = Input::new_from_chars("3-1-2".chars(), None);
			let output = parse_evaluate_right_subtraction()(&mut input);
			assert_eq!(output, Ok(4));
		}
	}
}