Mercurial > lbo > hg > rcombinators
view src/combinators.rs @ 21:d90066bf03d0
Add more documentation
author | Lewin Bormann <lewin@lewin-bormann.info> |
---|---|
date | Tue, 04 Jun 2019 23:30:18 +0200 |
parents | 728109a7df09 |
children | 435e4e609128 |
line wrap: on
line source
use crate::parser::{ParseError, ParseResult, Parser}; use crate::state::ParseState; /// Transform applies a function (which may fail) to the result of a parser. Transform only /// succeeds if the applied function succeeds, too. pub struct Transform<R, R2, P: Parser<Result = R>, F: Fn(R) -> ParseResult<R2>> { f: F, p: P, } impl<R, R2, P: Parser<Result = R>, F: Fn(R) -> ParseResult<R2>> Transform<R, R2, P, F> { /// Create a new Transform parser using f. pub fn new(p: P, f: F) -> Transform<R, R2, P, F> { Transform { f: f, p: p } } } impl<R, R2, P: Parser<Result = R>, F: Fn(R) -> ParseResult<R2>> Parser for Transform<R, R2, P, F> { type Result = R2; fn parse( &mut self, st: &mut ParseState<impl Iterator<Item = char>>, ) -> ParseResult<Self::Result> { match self.p.parse(st) { Ok(o) => (self.f)(o), Err(e) => Err(e), } } } pub struct Alternative<T>(T); impl<T> Alternative<T> { pub fn new(tuple: T) -> Alternative<T> { Alternative(tuple) } } macro_rules! alt_impl { ( ( $($ptype:ident/$ix:tt),* ) ) => { impl<R, $($ptype : Parser<Result=R>, )*> Parser for Alternative<($($ptype,)*)> { type Result = R; fn parse(&mut self, st: &mut ParseState<impl Iterator<Item = char>>) -> ParseResult<Self::Result> { $( let hold = st.hold(); match (self.0).$ix.parse(st) { Err(_) => (), Ok(o) => { st.release(hold); return Ok(o) } } st.reset(hold); )* return Err(ParseError::Fail("no alternative matched", st.index())) } } } } alt_impl!((P0 / 0, P1 / 1)); alt_impl!((P0 / 0, P1 / 1, P2 / 2)); alt_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3)); alt_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4)); alt_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5)); alt_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6)); alt_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7 )); alt_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8 )); alt_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8, P9 / 9 )); /// Sequence concatenates parsers and only succeeds if all of them do. T is always a tuple in order /// for Sequence to implement the Parser trait. The result is a tuple of all the parser results. /// /// Individual parsers need to have result types implementing Default. pub struct Sequence<T>(T); impl<T> Sequence<T> { pub fn new(tuple: T) -> Sequence<T> { Sequence(tuple) } } /// Macro for implementing sequence parsers for arbitrary tuples. Not for public use. macro_rules! seq_impl { ( ( $($ptype:ident/$ix:tt),+ ) ) => { impl<$($ptype : Parser<Result=impl Default>, )*> Parser for Sequence<($($ptype,)*)> { type Result = ($($ptype::Result,)*); fn parse(&mut self, st: &mut ParseState<impl Iterator<Item = char>>) -> ParseResult<Self::Result> { let hold = st.hold(); let mut result = Self::Result::default(); $( let r = (self.0).$ix.parse(st); if r.is_err() { st.reset(hold); return Err(r.err().unwrap()); } result.$ix = r.unwrap(); )* st.release(hold); return Ok(result); } } } } seq_impl!((P0 / 0, P1 / 1)); seq_impl!((P0 / 0, P1 / 1, P2 / 2)); seq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3)); seq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4)); seq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5)); seq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6)); seq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7 )); seq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8 )); seq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8, P9 / 9 )); /// PartialSequence concatenates parsers and tries to parse as far as possible. /// /// Individual parsers need to have result types implementing Default. pub struct PartialSequence<T>(T); impl<T> PartialSequence<T> { pub fn new(tuple: T) -> PartialSequence<T> { PartialSequence(tuple) } } /// Macro for implementing sequence parsers for arbitrary tuples. Not for public use. macro_rules! pseq_impl { ( ( $($ptype:ident/$ix:tt),+ ) ) => { impl<$($ptype : Parser<Result=impl Default>, )*> Parser for PartialSequence<($($ptype,)*)> { type Result = ($(Option<$ptype::Result>,)*); fn parse(&mut self, st: &mut ParseState<impl Iterator<Item = char>>) -> ParseResult<Self::Result> { let hold = st.hold(); let mut result = Self::Result::default(); $( let r = (self.0).$ix.parse(st); if r.is_err() { st.release(hold); return Ok(result); } result.$ix = Some(r.unwrap()); )* st.release(hold); return Ok(result); } } } } pseq_impl!((P0 / 0, P1 / 1)); pseq_impl!((P0 / 0, P1 / 1, P2 / 2)); pseq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3)); pseq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4)); pseq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5)); pseq_impl!((P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6)); pseq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7 )); pseq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8 )); pseq_impl!(( P0 / 0, P1 / 1, P2 / 2, P3 / 3, P4 / 4, P5 / 5, P6 / 6, P7 / 7, P8 / 8, P9 / 9 )); pub enum RepeatSpec { /// Any is equivalent to Min(0). Any, Min(usize), Max(usize), Between(usize, usize), } pub struct Repeat<P: Parser> { inner: P, repeat: RepeatSpec, } impl<P: Parser> Repeat<P> { pub fn new(p: P, r: RepeatSpec) -> Repeat<P> { Repeat { inner: p, repeat: r, } } } impl<R, P: Parser<Result = R>> Parser for Repeat<P> { type Result = Vec<R>; fn parse( &mut self, st: &mut ParseState<impl Iterator<Item = char>>, ) -> ParseResult<Self::Result> { let (min, max) = match self.repeat { RepeatSpec::Any => (0, std::usize::MAX), RepeatSpec::Min(min) => (min as usize, std::usize::MAX), RepeatSpec::Max(max) => (0, max as usize), RepeatSpec::Between(min, max) => (min as usize, max as usize), }; let mut v: Self::Result = Vec::new(); let hold = st.hold(); for i in 0.. { match self.inner.parse(st) { Ok(r) => v.push(r), Err(e) => { if i >= min { st.release(hold); return Ok(v); } else { st.reset(hold); return Err(e); } } } if i >= max - 1 { st.release(hold); return Ok(v); } } unreachable!() } } /// Maybe is a combinator returning Option<T> for a parser returning T, meaning it does not stop /// parsing if an optional input was not encountered. It is very similar to a `Repeat` parser with /// `RepeatSpec::Max(1)`. pub struct Maybe<Inner: Parser> { inner: Inner, } impl<Inner: Parser> Maybe<Inner> { pub fn new(p: Inner) -> Maybe<Inner> { Maybe { inner: p } } } impl<R, P: Parser<Result = R>> Parser for Maybe<P> { type Result = Option<R>; fn parse( &mut self, st: &mut ParseState<impl Iterator<Item = char>>, ) -> ParseResult<Self::Result> { match self.inner.parse(st) { Ok(r) => Ok(Some(r)), Err(_) => Ok(None), } } } /// Ignore ignores the result of an inner parser, effectively hiding the result. Useful if consumed /// input should not be processed further, and simplifies types in combined parsers. pub struct Ignore<Inner: Parser> { inner: Inner, } impl<Inner: Parser> Ignore<Inner> { pub fn new(p: Inner) -> Ignore<Inner> { Ignore { inner: p } } } impl<R, P: Parser<Result = R>> Parser for Ignore<P> { type Result = (); fn parse( &mut self, st: &mut ParseState<impl Iterator<Item = char>>, ) -> ParseResult<Self::Result> { match self.inner.parse(st) { Ok(_) => Ok(()), Err(e) => Err(e), } } } #[cfg(test)] mod tests { use super::*; use crate::parser::Parser; use crate::primitives::*; #[test] fn test_pair() { let mut p = Sequence::new((Int64::new(), StringParser::new(" aba".to_string()))); let mut ps = ParseState::new("123 aba"); assert_eq!(Ok((123, " aba".to_string())), p.parse(&mut ps)); } #[test] fn test_long_seq() { let s = || StringParser::new("a"); let mut p = Sequence::new((s(), s(), s(), s(), s(), s(), s(), s(), s(), s())); let mut ps = ParseState::new("aaaaaaaaaa"); assert_eq!( Ok(( "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string(), "a".to_string() )), p.parse(&mut ps) ); } #[test] fn test_alternative() { let mut p = Alternative::new(( StringParser::new("ab"), StringParser::new("de"), StringParser::new(" "), Transform::new(Int64::new(), |i| Ok(i.to_string())), )); let mut ps = ParseState::new("de 34"); assert_eq!(Ok("de".to_string()), p.parse(&mut ps)); assert_eq!(Ok(" ".to_string()), p.parse(&mut ps)); assert_eq!(Ok("34".to_string()), p.parse(&mut ps)); } #[test] fn test_repeat() { let mut ps = ParseState::new("aaa aaa aaaa aaaa"); assert_eq!( 3, Repeat::new(StringParser::new("a"), RepeatSpec::Any) .parse(&mut ps) .unwrap() .len() ); assert!(StringParser::new(" ").parse(&mut ps).is_ok()); assert_eq!( 3, Repeat::new(StringParser::new("a"), RepeatSpec::Min(2)) .parse(&mut ps) .unwrap() .len() ); assert!(StringParser::new(" ").parse(&mut ps).is_ok()); assert_eq!( 3, Repeat::new(StringParser::new("a"), RepeatSpec::Max(3)) .parse(&mut ps) .unwrap() .len() ); assert!(StringParser::new("a ").parse(&mut ps).is_ok()); assert_eq!( 3, Repeat::new(StringParser::new("a"), RepeatSpec::Between(1, 3)) .parse(&mut ps) .unwrap() .len() ); assert!(StringParser::new("a").parse(&mut ps).is_ok()); } #[test] fn test_partial_sequence() { let mut p = PartialSequence::new((StringParser::new("a"), StringParser::new("c"), Int64::new())); let mut ps = ParseState::new("acde"); assert_eq!( Ok((Some("a".to_string()), Some("c".to_string()), None)), p.parse(&mut ps) ); let mut p = PartialSequence::new(( Sequence::new((Int64::new(), StringParser::new(" "), Int64::new())), StringParser::new("x"), )); let mut ps = ParseState::new("12 -12 nothing else"); assert_eq!( Ok((Some((12, " ".to_string(), -12)), None)), p.parse(&mut ps) ); } }