neure 0.10.1

A fast little combinational parsing library
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use core::fmt::Debug;
use core::marker::PhantomData;

use crate::ctor::Ctor;

use crate::ctor::Handler;
use crate::ctx::Context;
use crate::ctx::Match;
use crate::ctx::new_span_inc;
use crate::err::Error;
use crate::neu::EmptyCond;
use crate::neu::calc_length;
use crate::regex::Regex;
use crate::span::Span;

use super::Condition;
use super::Neu;
use super::NeuCond;

///
/// Matches zero or one context-sensitive element with guaranteed success.
///
/// `Opt` provides optional matching with full context validation, always succeeding in one of two ways:
/// - **One element**: When the first element satisfies both pattern and context conditions
/// - **Zero elements**: When no valid element exists at current position (returns empty span)
///
/// This combinator is the context-aware equivalent of the `?` (optional) operator in regular expressions,
/// but with runtime context validation for the potential match. Unlike standard optional patterns,
/// it performs deep validation of parser state when attempting to match an element.
///
/// # Regex
///
/// Always succeeds with one of two outcomes:
/// - **Single element match**: Returns span covering the matched element
///   - Requires the first element to satisfy BOTH:
///     a. `unit.is_match(item)` returns true
///     b. `cond.check()` returns true for the context
/// - **Empty match**: Returns zero-length span at current position when:
///   - No elements available
///   - First element fails either condition
///   - Context conditions reject the potential match
///
/// # Ctor
///
/// Uses identical matching logic as regex mode, then constructs a value from the result.
/// Handler implementations must handle both cases:
/// - Present value (when one element matched)
/// - Absent value (when zero elements matched)
///
/// # Example
///
/// ```
/// # use neure::prelude::*;
/// #
/// # fn main() -> Result<(), Box<dyn core::error::Error>> {
///     let hex = 'a'..'g';
///     let hex = hex.opt();
///     let mut ctx = CharsCtx::new("aabbccgg");
///
///     assert_eq!(ctx.try_mat(&hex)?, Span::new(0, 1));
/// #   Ok(())
/// # }
/// ```
pub struct Opt<C, U, T, I = EmptyCond>
where
    U: Neu<T>,
{
    unit: U,
    cond: I,
    marker: PhantomData<(C, T)>,
}

impl<C, U, T, I> core::ops::Not for Opt<C, U, T, I>
where
    U: Neu<T>,
{
    type Output = crate::regex::Assert<Self>;

    fn not(self) -> Self::Output {
        crate::regex::not(self)
    }
}

impl<C, U, T, I> Debug for Opt<C, U, T, I>
where
    I: Debug,
    U: Neu<T> + Debug,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("Opt")
            .field("unit", &self.unit)
            .field("cond", &self.cond)
            .finish()
    }
}

impl<C, U, T, I> Default for Opt<C, U, T, I>
where
    I: Default,
    U: Neu<T> + Default,
{
    fn default() -> Self {
        Self {
            unit: Default::default(),
            cond: Default::default(),
            marker: Default::default(),
        }
    }
}

impl<C, U, T, I> Clone for Opt<C, U, T, I>
where
    I: Clone,
    U: Neu<T> + Clone,
{
    fn clone(&self) -> Self {
        Self {
            unit: self.unit.clone(),
            cond: self.cond.clone(),
            marker: self.marker,
        }
    }
}

impl<C, U, T, I> Copy for Opt<C, U, T, I>
where
    I: Copy,
    U: Neu<T> + Copy,
{
}

impl<C, U, T, I> Opt<C, U, T, I>
where
    U: Neu<T>,
{
    pub const fn new(unit: U, cond: I) -> Self {
        Self {
            unit,
            cond,
            marker: PhantomData,
        }
    }

    pub const fn unit(&self) -> &U {
        &self.unit
    }

    pub const fn unit_mut(&mut self) -> &mut U {
        &mut self.unit
    }

    pub fn set_unit(&mut self, unit: U) -> &mut Self {
        self.unit = unit;
        self
    }
}

impl<'a, C, U, I> Condition<'a, C> for Opt<C, U, C::Item, I>
where
    U: Neu<C::Item>,
    C: Context<'a>,
{
    type Out<F> = Opt<C, U, C::Item, F>;

    fn set_cond<F>(self, cond: F) -> Self::Out<F>
    where
        F: NeuCond<'a, C>,
    {
        Opt::new(self.unit, cond)
    }
}

impl<'a, U, C, O, I, H> Ctor<C, O, H> for Opt<C, U, C::Item, I>
where
    C: Match<'a>,
    U: Neu<C::Item>,
    I: NeuCond<'a, C>,
    C: Match<'a>,
    H: Handler<C, Out = O>,
{
    #[inline(always)]
    fn construct(&self, ctx: &mut C, func: &mut H) -> Result<O, Error> {
        let ret = ctx.try_mat(self);

        func.invoke(ctx, &ret?).map_err(Into::into)
    }
}

impl<'a, U, C, I> Regex<C> for Opt<C, U, C::Item, I>
where
    C: Context<'a>,
    U: Neu<C::Item>,
    I: NeuCond<'a, C>,
{
    #[inline(always)]
    fn try_parse(&self, ctx: &mut C) -> Result<Span, crate::err::Error> {
        let mut ret = Ok(Span::new(ctx.offset(), 0));
        let remaining_len = ctx.len() - ctx.offset();

        crate::debug_regex_beg!("Opt", ctx.offset());
        if let Ok(mut iter) = ctx.peek()
            && let Some((offset, item)) = iter.next()
            && self.unit.is_match(&item)
            && self.cond.check(ctx, &(offset, item))?
        {
            let len = calc_length(Some(offset), iter.next().map(|v| v.0), remaining_len);

            ret = Ok(new_span_inc(ctx, len));
        }
        crate::debug_regex_reval!("Opt", ret)
    }
}

///
/// Matches zero or more context-sensitive elements with guaranteed success.
///
/// `Many0` provides greedy repetition with full context validation, always succeeding in one of two ways:
/// - **Sequence match**: Longest possible sequence where every element satisfies both pattern and context conditions
/// - **Empty match**: Zero-length span when no valid elements exist at current position
///
/// This combinator is the context-aware equivalent of the `*` (Kleene star) operator in regular expressions,
/// but with per-element runtime context validation. It maintains parser state consistency through complex
/// context conditions during repetition, enabling sophisticated token-skipping and sequence recognition.
///
/// # Regex
///
/// Always succeeds with one of two outcomes:
/// - **Non-empty sequence**: Returns span covering all matched elements
///   - **Every element** in the sequence must satisfy BOTH:
///     a. `unit.is_match(item)` returns true
///     b. `cond.check()` returns true for the context
///   - Stops at first element that fails either condition
///   - Greedily consumes the longest valid sequence
/// - **Empty sequence**: Returns zero-length span at current position when:
///   - No elements available
///   - First element fails either condition
///   - Context conditions reject the potential match
///
/// # Ctor
///
/// Uses identical matching logic as regex mode, then constructs a value from the result.
/// Handler implementations must handle both cases:
/// - Non-empty sequence (when elements matched)
/// - Empty sequence (when zero elements matched)
///
/// # Example
///
/// ```
/// # use neure::prelude::*;
/// #
/// # fn main() -> Result<(), Box<dyn core::error::Error>> {
///     let hex = 'a'..'g';
///     let hex = hex.many0();
///     let mut ctx = CharsCtx::new("aabbccgg");
///
///     assert_eq!(ctx.try_mat(&hex)?, Span::new(0, 6));
/// #   Ok(())
/// # }
/// ```
pub struct Many0<C, U, T, I = EmptyCond>
where
    U: Neu<T>,
{
    unit: U,
    cond: I,
    marker: PhantomData<(C, T)>,
}

impl<C, U, T, I> core::ops::Not for Many0<C, U, T, I>
where
    U: Neu<T>,
{
    type Output = crate::regex::Assert<Self>;

    fn not(self) -> Self::Output {
        crate::regex::not(self)
    }
}

impl<C, U, T, I> Debug for Many0<C, U, T, I>
where
    I: Debug,
    U: Neu<T> + Debug,
{
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_struct("Many0")
            .field("unit", &self.unit)
            .field("cond", &self.cond)
            .finish()
    }
}

impl<C, U, T, I> Default for Many0<C, U, T, I>
where
    I: Default,
    U: Neu<T> + Default,
{
    fn default() -> Self {
        Self {
            unit: Default::default(),
            cond: Default::default(),
            marker: Default::default(),
        }
    }
}

impl<C, U, T, I> Clone for Many0<C, U, T, I>
where
    I: Clone,
    U: Neu<T> + Clone,
{
    fn clone(&self) -> Self {
        Self {
            unit: self.unit.clone(),
            cond: self.cond.clone(),
            marker: self.marker,
        }
    }
}

impl<C, U, T, I> Copy for Many0<C, U, T, I>
where
    I: Copy,
    U: Neu<T> + Copy,
{
}

impl<C, U, T, I> Many0<C, U, T, I>
where
    U: Neu<T>,
{
    pub const fn new(unit: U, cond: I) -> Self {
        Self {
            unit,
            cond,
            marker: PhantomData,
        }
    }

    pub const fn unit(&self) -> &U {
        &self.unit
    }

    pub const fn unit_mut(&mut self) -> &mut U {
        &mut self.unit
    }

    pub fn set_unit(&mut self, unit: U) -> &mut Self {
        self.unit = unit;
        self
    }
}

impl<'a, C, U, I> Condition<'a, C> for Many0<C, U, C::Item, I>
where
    U: Neu<C::Item>,
    C: Context<'a>,
{
    type Out<F> = Many0<C, U, C::Item, F>;

    fn set_cond<F>(self, cond: F) -> Self::Out<F>
    where
        F: NeuCond<'a, C>,
    {
        Many0::new(self.unit, cond)
    }
}

impl<'a, U, C, O, I, H> Ctor<C, O, H> for Many0<C, U, C::Item, I>
where
    C: Match<'a>,
    U: Neu<C::Item>,
    I: NeuCond<'a, C>,
    C: Match<'a>,
    H: Handler<C, Out = O>,
{
    #[inline(always)]
    fn construct(&self, ctx: &mut C, func: &mut H) -> Result<O, Error> {
        let ret = ctx.try_mat(self);

        func.invoke(ctx, &ret?).map_err(Into::into)
    }
}

impl<'a, U, C, I> Regex<C> for Many0<C, U, C::Item, I>
where
    C: Context<'a>,
    U: Neu<C::Item>,
    I: NeuCond<'a, C>,
{
    #[inline(always)]
    fn try_parse(&self, ctx: &mut C) -> Result<Span, crate::err::Error> {
        let mut beg = None;
        let mut end = None;
        let mut ret = Ok(Span::new(ctx.offset(), 0));
        let remaining_len = ctx.len() - ctx.offset();

        crate::debug_regex_beg!("Many0", ctx.offset());
        if let Ok(mut iter) = ctx.peek() {
            for pair in iter.by_ref() {
                if !self.unit.is_match(&pair.1) || !self.cond.check(ctx, &pair)? {
                    end = Some(pair);
                    break;
                }
                if beg.is_none() {
                    beg = Some(pair.0);
                }
            }
            if let Some(start) = beg {
                let len = calc_length(Some(start), end.map(|v| v.0), remaining_len);

                ret = Ok(new_span_inc(ctx, len));
            }
        }
        crate::debug_regex_reval!("Many0", ret)
    }
}