marser 0.1.0

//! Matcher execution driver: [`MatchRunner`] wraps [`crate::context::ParserContext`], records
//! match attempts with the [`crate::error::ErrorHandler`], and restores input position on failure.
//!
//! # Invariants
//!
//! - **Input position** — [`MatchRunner::run_match`] saves `old_pos` before [`Matcher::match_with_runner`].
//!   On `Ok(false)` (soft miss) it restores `input` to `old_pos`. On `Ok(true)` the stream stays
//!   advanced. On `Err` it restores position and clears context error stack to the pre-match
//!   length after `register_failure`.
//! - **Error handler pairing** — Every attempt calls `register_start`, then exactly one of
//!   `register_success` or `register_failure` for that index (see [`crate::error::ErrorHandler`]).
//! - **Recovery mode** — [`MatchRunner::is_in_error_recovery_mode`] reflects
//!   [`crate::context::ParserContext::is_in_error_recovery`] for diagnostics that differ in the
//!   second pass.
//! - **Deferred captures** — [`MatchRunner::register_result`] stores [`crate::parser::capture::BoundResult`]
//!   values at lifetime `'src`; they must not outlive the parse.

use std::marker::PhantomData;

use crate::{
    context::ParserContext,
    error::{MatcherRunError, error_handler::ErrorHandler},
    input::{Input, InputStream},
    matcher::Matcher,
    parser::capture::{BoundResult, MatchResult},
};

/// Runs matchers for one parse invocation over input lifetime `'src`.
///
/// `'a` is the lifetime of the runner borrow passed into nested `match_with_runner` calls.
/// Deferred captures are stored as [`BoundResult`] trait objects at lifetime **`'src`**
/// (the parse / input-stream invocation), so values may borrow the input for `'src`.
pub(crate) trait MatchRunner<'a, 'src, Inp>
where
    Inp: Input<'src>,
{
    type MRes: MatchResult;
    fn run_match_inner<Match, EHandler: ErrorHandler>(
        &mut self,
        matcher: &'a Match,
        error_handler: &mut EHandler,
        input: &mut InputStream<'src, Inp>,
    ) -> Result<bool, MatcherRunError>
    where
        Match: Matcher<'src, Inp, Self::MRes>,
        'src: 'a,
        Self: Sized;
    #[inline]
    fn run_match<Match, EHandler: ErrorHandler>(
        &mut self,
        matcher: &'a Match,
        error_handler: &mut EHandler,
        input: &mut InputStream<'src, Inp>,
    ) -> Result<bool, MatcherRunError>
    where
        Match: Matcher<'src, Inp, Self::MRes>,
        'src: 'a,
        Self: Sized,
    {
        let old_pos = input.get_pos();
        let idx = error_handler.register_start(old_pos.clone().into());
        let old_stack_len = self.get_parser_context().error_stack.len();
        let result = self.run_match_inner(matcher, error_handler, input);
        if error_handler.is_real() {
            error_handler.register_watermark(input.get_pos().into());
        }
        let result = if let Err(err) = result {
            if error_handler.is_real() {
                error_handler.register_failure(matcher.maybe_label(), idx);
            } else {
                error_handler.register_failure(None::<&'static str>, idx);
            }
            // move back error stack to the previous state
            self.get_parser_context()
                .error_stack
                .truncate(old_stack_len);
            return Err(err);
        } else {
            result.unwrap()
        };
        if !result {
            input.set_pos(old_pos.clone());
            if error_handler.is_real() {
                error_handler.register_failure(matcher.maybe_label(), idx);
            } else {
                error_handler.register_failure(None::<&'static str>, idx);
            }
            // move back error stack to the previous state
            self.get_parser_context()
                .error_stack
                .truncate(old_stack_len);
        } else {
            error_handler.register_success(idx);
        }
        Ok(result)
    }

    fn register_result<Res: BoundResult<Self::MRes> + 'src>(&mut self, result: Res);

    fn get_match_result(self) -> Self::MRes;

    fn get_parser_context(&mut self) -> &mut ParserContext<'src>;

    /// Build a read-only snapshot of captures committed so far and pass it to `f`.
    fn with_snapshot<R, F>(&self, f: F) -> R
    where
        F: FnOnce(<Self::MRes as MatchResult>::Snapshot<'_>) -> R;

    /// `true` when [`ParserContext::is_in_error_recovery`] is set by the global parse driver.
    fn is_in_error_recovery_mode(&self) -> bool;
}

pub(crate) struct NoMemoizeBacktrackingRunner<'a, 'src, Inp, MRes> {
    parser_context: &'a mut ParserContext<'src>,
    _phantom: PhantomData<(&'src (), Inp)>,
    stack: Vec<Box<dyn BoundResult<MRes> + 'src>>,
}

impl<'a, 'src, Inp: Input<'src>, MRes> NoMemoizeBacktrackingRunner<'a, 'src, Inp, MRes> {
    #[inline]
    pub(crate) fn new(parser_context: &'a mut ParserContext<'src>) -> Self {
        Self {
            parser_context,
            _phantom: PhantomData,
            stack: Vec::new(),
        }
    }
}

impl<'a, 'src, Inp: Input<'src>, MRes> MatchRunner<'a, 'src, Inp>
    for NoMemoizeBacktrackingRunner<'a, 'src, Inp, MRes>
where
    MRes: MatchResult,
{
    type MRes = MRes;

    #[inline]
    fn run_match_inner<Match, EHandler: ErrorHandler>(
        &mut self,
        matcher: &'a Match,
        error_handler: &mut EHandler,
        input: &mut InputStream<'src, Inp>,
    ) -> Result<bool, MatcherRunError>
    where
        Match: Matcher<'src, Inp, Self::MRes>,
        'src: 'a,
        Self: Sized,
    {
        let old_stack_len = self.stack.len();
        let result = matcher.match_with_runner(self, error_handler, input)?;
        if !result {
            self.stack.truncate(old_stack_len);
        }
        Ok(result)
    }

    #[inline]
    fn register_result<Res: BoundResult<Self::MRes> + 'src>(&mut self, result: Res) {
        self.stack.push(Box::new(result));
    }

    #[inline]
    fn get_match_result(self) -> Self::MRes {
        let mut mres = Self::MRes::new_empty();
        for res in self.stack.into_iter() {
            res.put_boxed_in_result(&mut mres);
        }
        mres
    }

    #[inline]
    fn get_parser_context(&mut self) -> &mut ParserContext<'src> {
        self.parser_context
    }

    #[inline]
    fn with_snapshot<R, F>(&self, f: F) -> R
    where
        F: FnOnce(MRes::Snapshot<'_>) -> R,
    {
        let mut snap = MRes::new_empty_snapshot();
        for bound in &self.stack {
            bound.put_ref_in_snapshot(&mut snap);
        }
        f(snap)
    }

    #[inline]
    fn is_in_error_recovery_mode(&self) -> bool {
        self.parser_context.is_in_error_recovery
    }
}

pub(crate) struct DirectMatchRunner<'a, 'src, Inp, MRes> {
    parser_context: &'a mut ParserContext<'src>,
    _phantom: PhantomData<(&'src (), Inp)>,
    result: MRes,
}

impl<'a, 'src, Inp: Input<'src>, MRes> DirectMatchRunner<'a, 'src, Inp, MRes> {
    #[inline]
    pub(crate) fn new(parser_context: &'a mut ParserContext<'src>) -> Self
    where
        MRes: MatchResult,
    {
        Self {
            parser_context,
            _phantom: PhantomData,
            result: MRes::new_empty(),
        }
    }
}

impl<'a, 'src, Inp: Input<'src>, MRes> MatchRunner<'a, 'src, Inp>
    for DirectMatchRunner<'a, 'src, Inp, MRes>
where
    MRes: MatchResult,
{
    type MRes = MRes;

    #[inline]
    fn run_match_inner<Match, EHandler: ErrorHandler>(
        &mut self,
        matcher: &'a Match,
        error_handler: &mut EHandler,
        input: &mut InputStream<'src, Inp>,
    ) -> Result<bool, MatcherRunError>
    where
        Match: Matcher<'src, Inp, Self::MRes>,
        'src: 'a,
        Self: Sized,
    {
        matcher.match_with_runner(self, error_handler, input)
    }

    #[inline]
    fn register_result<Res: BoundResult<Self::MRes> + 'src>(&mut self, result: Res) {
        result.put_in_result(&mut self.result);
    }

    #[inline]
    fn get_match_result(self) -> Self::MRes {
        self.result
    }

    #[inline]
    fn get_parser_context(&mut self) -> &mut ParserContext<'src> {
        self.parser_context
    }

    #[inline]
    fn with_snapshot<R, F>(&self, f: F) -> R
    where
        F: FnOnce(MRes::Snapshot<'_>) -> R,
    {
        f(self.result.snapshot())
    }

    #[inline]
    fn is_in_error_recovery_mode(&self) -> bool {
        self.parser_context.is_in_error_recovery
    }
}