kamo 0.9.4

A library to assist in the creation of an interpreter or compiler and its associated runtime.
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

use crate::parser::{code, Input, ParseResult, Parser, Span};

use super::SequenceError;

/// Creates a parser that parses `element` followed by `postfix`. The parser
/// will return the result of `element`.
///
/// # Examples
///
/// ```rust
/// # use kamo::{Position, parser::{
/// #     prelude::*, CharacterError, SequenceError, code, Input, Span
/// # }};
/// let mut parser = terminated(tag("let"), char(')'));
///
/// assert_eq!(parser(Input::new("let)")), Ok(("let", Input::new(""))));
/// assert_eq!(parser(Input::new("abc)")), Err(ParseError::new(
///     Position::new(0, 1, 1),
///     code::ERR_TAG,
///     CharacterError::Tag("let")
/// )));
/// assert_eq!(parser(Input::new("let(")), Err(ParseError::new(
///     Position::new(3, 1, 4),
///     code::ERR_TERMINATED,
///     SequenceError::Terminated
/// )));
/// 
/// let error = parser(Input::new("let")).expect_err("error output");
/// 
/// assert!(error.is_eof());
/// assert_eq!(error, ParseError::new(
///     Position::new(3, 1, 4),
///     code::ERR_TERMINATED,
///     SequenceError::Terminated
/// ));
/// 
/// let error = parser(Input::new("")).expect_err("error output");
/// 
/// assert!(error.is_eof());
/// assert_eq!(error, ParseError::new(
///     Position::new(0, 1, 1),
///     code::ERR_TAG,
///     CharacterError::Tag("let")
/// ));
/// ```
pub fn terminated<'a, 'b, F1, F2, O1, O2>(
    mut element: F1,
    mut postfix: F2,
) -> impl FnMut(Input<'a>) -> ParseResult<'a, O1>
where
    O1: 'b,
    O2: 'b,
    F1: Parser<'a, 'b, O1> + 'b,
    F2: Parser<'a, 'b, O2> + 'b,
{
    move |input| {
        let (output, cursor) = element.parse(input)?;
        let (_, cursor) = postfix.parse(cursor).map_err(|mut err| {
            err.push(
                Span::new(cursor.position(), err.span().end()),
                code::ERR_TERMINATED,
                SequenceError::Terminated,
            );
            err
        })?;

        Ok((output, cursor))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::{
        parser::{character::CharacterError, prelude::*, ParseError},
        Position,
    };

    #[test]
    fn terminated_success() {
        let (output, input) =
            terminated(tag("let"), char(')'))(Input::new("let)")).expect("valid output");

        assert_eq!(output, "let");
        assert_eq!(input, Input::from(""));
        assert_eq!(input.current(), None);
        assert_eq!(input.position(), Position::new(4, 1, 5));
    }

    #[test]
    fn terminated_failure() {
        let error =
            terminated(tag("let"), char(')'))(Input::new("abc)")).expect_err("invalid output");

        assert_eq!(
            error,
            ParseError::new(
                Position::new(0, 1, 1),
                code::ERR_TAG,
                CharacterError::Tag("let")
            )
        );

        let error =
            terminated(tag("let"), char(')'))(Input::new("let(")).expect_err("invalid output");

        assert_eq!(
            error,
            ParseError::new(
                Position::new(3, 1, 4),
                code::ERR_TERMINATED,
                SequenceError::Terminated
            )
        );

        let error =
            terminated(tag("let"), char(')'))(Input::new("let")).expect_err("invalid output");

        assert!(error.is_eof());
        assert_eq!(
            error,
            ParseError::eof(Position::new(3, 1, 4)).and(
                Position::new(3, 1, 4),
                code::ERR_TERMINATED,
                SequenceError::Terminated
            )
        );
    }
}