ezregexp/

parser.rs

//! Parse a regular expression into a pattern

use crate::builder::Pattern;
use regex_syntax::ast::{
    parse::Parser, Alternation, Assertion, AssertionKind, Ast, Class, ClassPerl, ClassPerlKind,
    ClassUnicode, ClassUnicodeKind, Concat, Error, Group, GroupKind, Literal, Repetition, RepetitionKind,
    RepetitionOp, RepetitionRange,
};

/// Explain a regex: turn it into a pattern
pub fn explain(regex: &str) -> Result<Pattern, Error> {
    let mut p = Parser::new();
    p.parse(regex).and_then(|a| {
        //println!("ast: {:?}", a);
        do_explain(&a)
    })
}

/// Do the explaining
fn do_explain(ast: &Ast) -> Result<Pattern, Error> {
    match ast {
        Ast::Concat(Concat { asts, .. }) => Ok(simplify(
            asts.iter()
                .map(|a| do_explain(a))
                .collect::<Result<Vec<Pattern>, Error>>()?,
        )),
        Ast::Literal(Literal { c, .. }) => Ok(Pattern::Text(format!("{}", c))),
        Ast::Alternation(Alternation { asts, .. }) => Ok(Pattern::Or(
            asts.iter()
                .map(|a| do_explain(a))
                .collect::<Result<Vec<Pattern>, Error>>()?,
        )),
        Ast::Group(Group { ast, kind:GroupKind::CaptureName(n),.. }) => do_explain(ast).map(|p| Pattern::Named{exp:Box::new(p),name:n.name.clone()}),
        Ast::Group(Group { ast, .. }) => do_explain(ast),
        Ast::Repetition(Repetition { ast, op, .. }) => {
            let bds = bounds(op);
            Ok(Pattern::Many {
                exp: Box::new(do_explain(ast)?),
                low: bds.0,
                high: bds.1,
            })
        }
        Ast::Class(Class::Perl(ClassPerl {
            kind: ClassPerlKind::Digit,
            negated:false,
            ..
        })) => Ok(Pattern::Digit),
        Ast::Class(Class::Perl(ClassPerl {
            kind: ClassPerlKind::Digit,
            negated:true,
            ..
        })) => Ok(Pattern::Not(Box::new(Pattern::Digit))),
        Ast::Class(Class::Perl(ClassPerl {
            kind: ClassPerlKind::Word,
            negated:false,
            ..
        })) => Ok(Pattern::WordCharacter),
        Ast::Class(Class::Perl(ClassPerl {
            kind: ClassPerlKind::Word,
            negated:true,
            ..
        })) => Ok(Pattern::Not(Box::new(Pattern::WordCharacter))),
        Ast::Assertion(Assertion {
            kind: AssertionKind::StartLine,
            ..
        }) => Ok(Pattern::InputStart),
        Ast::Assertion(Assertion {
            kind: AssertionKind::EndLine,
            ..
        }) => Ok(Pattern::InputEnd),
        Ast::Class(Class::Unicode(ClassUnicode {
            kind: ClassUnicodeKind::OneLetter(c),
            negated: false,
            ..
        })) if *c == 'N' => Ok(Pattern::Letter),
        Ast::Class(Class::Unicode(ClassUnicode {
            kind: ClassUnicodeKind::OneLetter(c),
            negated: true,
            ..
        })) if *c == 'N' => Ok(Pattern::Not(Box::new(Pattern::Letter))),
        Ast::Dot{..} => Ok(Pattern::Any),
        _ => Ok(Pattern::Raw(String::new())),
    }
}

/// Extract bound from a RepetitionOp
fn bounds(op: &RepetitionOp) -> (u32, u32) {
    match &op.kind {
        RepetitionKind::ZeroOrOne => (0, 1),
        RepetitionKind::ZeroOrMore => (0, 0),
        RepetitionKind::OneOrMore => (1, 0),
        RepetitionKind::Range(r) => match r {
            RepetitionRange::AtLeast(m) => (*m, 0),
            RepetitionRange::Exactly(m) => (*m, *m),
            RepetitionRange::Bounded(l, h) => (*l, *h),
        },
    }
}

/// Simplify a list of patterns
fn simplify(exps: Vec<Pattern>) -> Pattern {
    let mut nexps = vec![];
    for p in exps.into_iter() {
        if let Pattern::Text(t) = p {
            let op0 = nexps.pop();
            if let Some(Pattern::Text(mut t0)) = op0 {
                t0.push_str(&t);
                nexps.push(Pattern::Text(t0));
            } else {
                if let Some(p0) = op0 {
                    nexps.push(p0);
                }
                nexps.push(Pattern::Text(t));
            }
        } else {
            if matches!(&p, Pattern::Raw(s) if s.is_empty()){
                // ignore
            } else {
                nexps.push(p);
            }
            
        }
    }
    if nexps.len() == 1 {
        nexps.pop().unwrap()
    } else {
        Pattern::Sequence(nexps)
    }
}

/*
struct ExplainState {
    stack:Vec<State>,
}

enum State {
    Root,
    String,
    Expression,
}

impl Default for ExplainState {
    fn default() -> Self {
        ExplainState{stack:vec![State::Root]}
    }


}

impl ExplainState {
    fn string(&mut self) -> bool {
        if let Some(State::String) = self.stack.last(){
            return false;
        } else {
            self.stack.push(State::String);
        }
        true
    }

    fn unstring(&mut self) -> bool {
        if let Some(State::String) = self.stack.last(){
            self.stack.pop();
            return true;
        }
        false
    }

    fn is_root(&self) -> bool {
        if let Some(State::Root) = self.stack.last(){
            return true;
        }
        false
    }
}
*/

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

    #[test]
    fn test_basic_explain() {
        assert_explain(r#"text("Handel")"#,"Handel");
        assert_explain(r#"word_character()"#,r"\w");
        assert_explain(r#"letter()"#,r"\pN");
        assert_explain(r#"either(("gray", "grey"))"#,"gray|grey");
        assert_explain(r#"start_with("gr").and_either(("a", "e")).and_then("y")"#,"gr(a|e)y");
        assert_explain(r#"start_with("colo").and_maybe("u").and_then("r")"#,"colou?r");
        assert_explain(r#"digit().many(2, 3)"#,r#"\d{2,3}"#);
        assert_explain(r#"at_start().and_then(digit()).times(4).and_then("-").and_then(digit()).times(2).and_then("-").and_then(digit()).times(2).must_end()"#,r"^\d{4}-\d{2}-\d{2}$");
        assert_explain(r#"any_except(digit()).and_then(any_except(letter())).and_then(any_except(word_character()))"#,r#"\D\PN\W"#);
        assert_explain(r#"start_with(digit().times(4).named("y")).and_then("-").and_then(digit().times(2).named("m")).and_then("-").and_then(digit().times(2).named("d"))"#,r#"(?x)
    (?P<y>\d{4})  # the year
    -
    (?P<m>\d{2}) # the month
    -
    (?P<d>\d{2})   # the day
    "#);
    }

    fn assert_explain(expected: &str, regex: &str){
        assert_eq!(
            Ok(expected.to_owned()),
            explain(regex).map(|p| p.to_code())
        );
    }
}