kparse 3.0.5

//!
//! Provides some extra parser combinators.
//!

use crate::{Code, KParseError, TrackedSpan};
use nom::error::{ErrorKind, ParseError};
use nom::{AsBytes, AsChar, IResult, InputIter, InputLength, InputTake, Parser, Slice};
use std::fmt::Debug;
use std::ops::{Range, RangeFrom, RangeTo};

/// Tracked execution of a parser.
///
/// ```rust
/// use nom::bytes::complete::tag;
/// use nom::Parser;
/// use kparse::combinators::{err_into, with_code, track, map_res};
/// use kparse::examples::{ExParserResult, ExSpan, ExTagB, ExTokenizerResult};
/// use kparse::KParseError;
///
/// fn parse_b(input: ExSpan<'_>) -> ExParserResult<'_, AstB> {
///     err_into(track(ExTagB,
///         map_res(nom_parse_b, |span| Ok(AstB { span }))
///     ))(input)
/// }
///
/// fn nom_parse_b(i: ExSpan<'_>) -> ExTokenizerResult<'_, ExSpan<'_>> {
///     with_code(tag("b"), ExTagB).parse(i)
/// }
///
/// struct AstB<'s> {
///     pub span: ExSpan<'s>,
/// }
///
/// ```
///
/// The same can be achieved in a imperative style.
///
/// ```
/// use nom::bytes::complete::tag;
/// use nom::Parser;
/// use kparse::{Track, KParser};
/// use kparse::examples::{ExParserResult, ExSpan, ExTagA, ExTokenizerResult};
/// use kparse::prelude::*;
///
/// fn parse_a(input: ExSpan<'_>) -> ExParserResult<'_, AstA> {
///     Track.enter(ExTagA, input);
///     let (rest, tok) = nom_parse_a.err_into().parse(input).track()?;
///     Track.ok(rest, tok, AstA { span: tok })
/// }
///
/// fn nom_parse_a(i: ExSpan<'_>) -> ExTokenizerResult<'_, ExSpan<'_>> {
///     tag("a").with_code(ExTagA).parse(i)
/// }
///
/// #[derive(Debug)]
/// struct AstA<'s> {
///     pub span: ExSpan<'s>,
/// }
/// ```
///
#[inline]
pub fn track<PA, C, I, O, E>(
    func: C,
    mut parser: PA,
) -> impl FnMut(I) -> Result<(I, O), nom::Err<E>>
where
    PA: Parser<I, O, E>,
    C: Code,
    I: Clone + Debug,
    I: TrackedSpan<C>,
    I: InputTake + InputLength + InputIter + AsBytes,
    nom::Err<E>: KParseError<C, I>,
{
    move |input| -> Result<(I, O), nom::Err<E>> {
        input.track_enter(func);
        match parser.parse(input.clone()) {
            Ok((rest, token)) => {
                rest.track_ok(input);
                rest.track_exit();
                Ok((rest, token))
            }
            Err(err) => match err.parts() {
                None => Err(err),
                Some((code, span, e)) => {
                    span.track_err(code, e);
                    span.track_exit();
                    Err(err)
                }
            },
        }
    }
}

/// Converts the error type with the From trait.
///
/// The same function is available as postfix function `parser.err_into()` for parsers
/// and as `Result::err_into()` for Result's.
#[inline]
pub fn err_into<PA, I, O, E1, E2>(mut parser: PA) -> impl FnMut(I) -> Result<(I, O), nom::Err<E2>>
where
    PA: Parser<I, O, E1>,
    E2: From<E1>,
{
    move |i| -> Result<(I, O), nom::Err<E2>> {
        match parser.parse(i) {
            Ok((r, o)) => Ok((r, o)),
            Err(nom::Err::Error(e)) => Err(nom::Err::Error(e.into())),
            Err(nom::Err::Failure(e)) => Err(nom::Err::Failure(e.into())),
            Err(nom::Err::Incomplete(e)) => Err(nom::Err::Incomplete(e)),
        }
    }
}

/// Takes a parser and converts the error.
///
/// This is also available as postfix fn `parser.with_code(..)` for parsers.
///
/// ```rust
/// use nom::bytes::complete::tag;
/// use nom::Parser;
/// use kparse::combinators::with_code;
/// use kparse::examples::{ExSpan, ExTagB, ExTokenizerResult};
///
/// fn nom_parse_b(i: ExSpan<'_>) -> ExTokenizerResult<'_, ExSpan<'_>> {
///     with_code(tag("b"), ExTagB)(i)
/// }
/// ```
#[inline]
pub fn with_code<PA, C, I, O, E>(
    mut parser: PA,
    code: C,
) -> impl FnMut(I) -> Result<(I, O), nom::Err<E>>
where
    PA: Parser<I, O, E>,
    E: KParseError<C, I>,
    C: Code,
    I: AsBytes + Clone,
{
    move |i| -> Result<(I, O), nom::Err<E>> {
        match parser.parse(i) {
            Ok((r, v)) => Ok((r, v)),
            Err(nom::Err::Error(e)) => Err(nom::Err::Error(e.with_code(code))),
            Err(nom::Err::Failure(e)) => Err(nom::Err::Error(e.with_code(code))),
            Err(nom::Err::Incomplete(e)) => Err(nom::Err::Incomplete(e)),
        }
    }
}

/// Takes a parser and a transformation of the parser result.
///
/// This is also available as postfix fn `parser.map_res()` for parsers.
///
/// ```rust
/// use nom::character::complete::digit1;
/// use nom::combinator::consumed;
/// use nom::{AsChar, InputTakeAtPosition, Parser};
/// use nom::sequence::terminated;
/// use kparse::combinators::map_res;
/// use kparse::examples::ExCode::ExNumber;
/// use kparse::examples::{ExParserError, ExSpan, ExTokenizerError, ExTokenizerResult};
///
/// fn nom_number(i: ExSpan<'_>) -> ExTokenizerResult<'_, (ExSpan<'_>, u32)> {
///     consumed(map_res(terminated(digit1, nom_ws), |v| {
///         match (*v).parse::<u32>() {
///             Ok(vv) => Ok(vv),
///             Err(_) => Err(ExTokenizerError::new(ExNumber, v).failure()),
///         }
///     }))(i)
/// }
///
/// fn nom_ws(i: ExSpan<'_>) -> ExTokenizerResult<'_, ExSpan<'_>> {
///     i.split_at_position_complete(|item| {
///         let c = item.as_char();
///         !(c == ' ' || c == '\t')
///     })
/// }
/// ```
#[inline]
pub fn map_res<PA, TR, I, O1, O2, E>(
    mut parser: PA,
    map: TR,
) -> impl FnMut(I) -> Result<(I, O2), nom::Err<E>>
where
    PA: Parser<I, O1, E>,
    TR: Fn(O1) -> Result<O2, nom::Err<E>>,
    O1: Clone,
    I: AsBytes + Clone,
{
    move |input| -> IResult<I, O2, E> {
        parser
            .parse(input)
            .and_then(|(rest, tok)| Ok((rest, map(tok)?)))
    }
}

/// Same as nom::char but return the input type instead of the char.
#[inline]
pub fn pchar<I, Error: ParseError<I>>(c: char) -> impl Fn(I) -> IResult<I, I, Error>
where
    I: Slice<RangeTo<usize>> + Slice<RangeFrom<usize>> + InputIter,
    <I as InputIter>::Item: AsChar,
{
    fchar(move |cc| c == cc)
}

/// Same as nom::char but return the input type instead of the char.
#[inline]
pub fn fchar<I, FN, Error: ParseError<I>>(c_fn: FN) -> impl Fn(I) -> IResult<I, I, Error>
where
    I: Slice<RangeTo<usize>> + Slice<RangeFrom<usize>> + InputIter,
    <I as InputIter>::Item: AsChar,
    FN: Fn(char) -> bool,
{
    move |i: I| match i.iter_elements().next() {
        None => Err(nom::Err::Error(Error::from_error_kind(i, ErrorKind::Char))),
        Some(v) => {
            let cc = v.as_char();
            if c_fn(cc) {
                Ok((i.slice(cc.len()..), i.slice(..cc.len())))
            } else {
                Err(nom::Err::Error(Error::from_error_kind(i, ErrorKind::Char)))
            }
        }
    }
}

/// Same as nom::char but return the input type instead of the char.
/// Checks one character but doesn't consume it.
#[inline]
pub fn psense<I, Error: ParseError<I>>(cc: char) -> impl Fn(I) -> IResult<I, I, Error>
where
    I: Slice<Range<usize>> + InputIter + Clone,
    <I as InputIter>::Item: AsChar,
{
    fsense(move |c| c == cc)
}

/// Same as nom::char but return the input type instead of the char.
/// Checks one character but doesn't consume it.
#[inline]
pub fn fsense<I, FN, Error: ParseError<I>>(c_fn: FN) -> impl Fn(I) -> IResult<I, I, Error>
where
    I: Slice<Range<usize>> + InputIter + Clone,
    <I as InputIter>::Item: AsChar,
    FN: Fn(char) -> bool,
{
    move |i: I| match i.iter_elements().next() {
        None => Err(nom::Err::Error(Error::from_error_kind(i, ErrorKind::Char))),
        Some(v) => {
            let cc = v.as_char();
            if c_fn(cc) {
                Ok((i.clone(), i.slice(0..0)))
            } else {
                Err(nom::Err::Error(Error::from_error_kind(i, ErrorKind::Char)))
            }
        }
    }
}

/// Similiar to [nom::multi::separated_list0], but allows a trailing separator.
pub fn separated_list_trailing0<PASep, PA, I, O1, O2, E>(
    mut sep: PASep,
    mut f: PA,
) -> impl FnMut(I) -> Result<(I, Vec<O2>), nom::Err<E>>
where
    I: Clone + InputLength,
    PASep: Parser<I, O1, E>,
    PA: Parser<I, O2, E>,
    E: ParseError<I>,
{
    move |mut i| {
        let mut res = Vec::new();

        match f.parse(i.clone()) {
            Ok((rest, o)) => {
                res.push(o);
                i = rest;
            }
            Err(nom::Err::Error(_)) => return Ok((i, res)),
            Err(e) => return Err(e),
        }

        loop {
            let len = i.input_len();

            match sep.parse(i.clone()) {
                Ok((rest, _)) => i = rest,
                Err(nom::Err::Error(_)) => return Ok((i, res)),
                Err(e) => return Err(e),
            }

            match f.parse(i.clone()) {
                Ok((rest, o)) => {
                    res.push(o);
                    i = rest;
                }
                Err(nom::Err::Error(_)) => return Ok((i, res)),
                Err(e) => return Err(e),
            }

            if i.input_len() == len {
                return Err(nom::Err::Error(E::from_error_kind(
                    i,
                    ErrorKind::SeparatedList,
                )));
            }
        }
    }
}

/// Similiar to [nom::multi::separated_list1], but allows a trailing separator.
pub fn separated_list_trailing1<PASep, PA, I, O1, O2, E>(
    mut sep: PASep,
    mut f: PA,
) -> impl FnMut(I) -> Result<(I, Vec<O2>), nom::Err<E>>
where
    I: Clone + InputLength,
    PASep: Parser<I, O1, E>,
    PA: Parser<I, O2, E>,
    E: ParseError<I>,
{
    move |mut i| {
        let mut res = Vec::new();

        match f.parse(i) {
            Err(e) => return Err(e),
            Ok((rest, o)) => {
                res.push(o);
                i = rest;
            }
        }

        loop {
            let len = i.input_len();

            match sep.parse(i.clone()) {
                Ok((rest, _)) => i = rest,
                Err(nom::Err::Error(_)) => return Ok((i, res)),
                Err(e) => return Err(e),
            }

            match f.parse(i.clone()) {
                Ok((rest, o)) => {
                    res.push(o);
                    i = rest;
                }
                Err(nom::Err::Error(_)) => return Ok((i, res)),
                Err(e) => return Err(e),
            }

            if i.input_len() == len {
                return Err(nom::Err::Error(E::from_error_kind(
                    i,
                    ErrorKind::SeparatedList,
                )));
            }
        }
    }
}