strop-grammar 0.24.0

strop grammar: pure vim operator-pending resolver (motions, text objects, counts)
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
use super::classes::letter_class;
use super::*;

impl Parser<'_> {
    // -------------------------------------------------------------- atoms

    pub(super) fn parse_atom(&mut self) -> Result<Node, QueryError> {
        let at = self.at;
        let ch = self.char_at(at)?;
        match self.mode {
            Magic::Magic => self.parse_atom_magic(ch, at),
            Magic::VeryMagic => self.parse_atom_very(ch, at),
        }
    }

    pub(super) fn parse_atom_magic(&mut self, ch: char, at: usize) -> Result<Node, QueryError> {
        match ch {
            '\\' => self.parse_escape(at),
            '.' => {
                self.at += 1;
                Ok(Node::Any { nl: false })
            }
            '[' => self.parse_class(at),
            '*' => {
                // a star with nothing to repeat is a literal (vim)
                self.at += 1;
                Ok(Node::Literal(b"*".to_vec()))
            }
            '^' => {
                self.at += 1;
                // magic: ^ anchors only at a branch start, else literal
                if self.branch_start {
                    Ok(Node::LineStart)
                } else {
                    Ok(Node::Literal(b"^".to_vec()))
                }
            }
            '$' => {
                let anchor = self.rest_is_branch_end();
                self.at += 1;
                if anchor {
                    Ok(Node::LineEnd)
                } else {
                    Ok(Node::Literal(b"$".to_vec()))
                }
            }
            '~' => Err(QueryError::Unsupported {
                construct: "~ (last substitute pattern)",
                at,
            }),
            _ => {
                self.at += ch.len_utf8();
                Ok(Node::Literal(ch.to_string().into_bytes()))
            }
        }
    }

    /// Magic mode: `$` anchors before `\|`, `\)`, `\n` or the end.
    pub(super) fn rest_is_branch_end(&self) -> bool {
        let rest = &self.pat[(self.at + 1).min(self.pat.len())..];
        rest.is_empty()
            || rest.starts_with(b"\\|")
            || rest.starts_with(b"\\)")
            || rest.starts_with(b"\\n")
    }

    /// An atom whose match consumes a line break (`\n`, `\.`, `\_s`).
    pub(super) fn is_break_atom(n: &Node) -> bool {
        match n {
            Node::Set(s) => s.nl,
            Node::Any { nl } => *nl,
            Node::Break => true,
            Node::Rep { node, .. } => Self::is_break_atom(node),
            _ => false,
        }
    }

    pub(super) fn parse_atom_very(&mut self, ch: char, at: usize) -> Result<Node, QueryError> {
        match ch {
            '\\' => self.parse_escape(at),
            '.' => {
                self.at += 1;
                Ok(Node::Any { nl: false })
            }
            '[' => self.parse_class(at),
            '(' => {
                self.ngroups += 1;
                let idx = self.ngroups;
                self.at += 1;
                let inner = self.parse_alt()?;
                if !self.starts_with(b")") {
                    return Err(QueryError::UnbalancedGroup { at });
                }
                self.at += 1;
                Ok(Node::Group {
                    idx: Some(idx),
                    node: Box::new(inner),
                })
            }
            ')' => Err(QueryError::UnbalancedGroup { at }),
            '^' => {
                self.at += 1;
                Ok(Node::LineStart)
            }
            '$' => {
                self.at += 1;
                Ok(Node::LineEnd)
            }
            '<' => {
                self.at += 1;
                Ok(Node::WordStart)
            }
            '>' => {
                self.at += 1;
                Ok(Node::WordEnd)
            }
            '~' => Err(QueryError::Unsupported {
                construct: "~ (last substitute pattern)",
                at,
            }),
            '@' => {
                let which = match self.peek2() {
                    Some(b'=') => "\\@= (lookahead)",
                    Some(b'!') => "\\@! (negative lookahead)",
                    Some(b'<') => "\\@<= (lookbehind)",
                    _ => "\\@ (lookaround family)",
                };
                Err(QueryError::Unsupported {
                    construct: which,
                    at,
                })
            }
            '&' => Err(QueryError::Unsupported {
                construct: "& (branch conjunction)",
                at,
            }),
            '%' => self.parse_percent(at),
            '*' | '+' | '=' | '?' | '{' => Err(QueryError::BadRepeat { at }),
            _ => {
                self.at += ch.len_utf8();
                Ok(Node::Literal(ch.to_string().into_bytes()))
            }
        }
    }

    /// `\%...` (both modes; `self.at` is on the `\`) and bare `%...`
    /// in very magic (self.at on the `%`).
    pub(super) fn parse_percent(&mut self, at: usize) -> Result<Node, QueryError> {
        let lead_len = if self.mode == Magic::Magic { 2 } else { 1 };
        let item = self.pat.get(at + lead_len).copied();
        match item {
            Some(b'(') => {
                self.at = at + lead_len + 1;
                self.branch_start = true;
                let inner = self.parse_alt()?;
                let close: &[u8] = if self.mode == Magic::Magic {
                    b"\\)"
                } else {
                    b")"
                };
                if !self.starts_with(close) {
                    return Err(QueryError::UnbalancedGroup { at });
                }
                self.at += close.len();
                Ok(Node::Group {
                    idx: None,
                    node: Box::new(inner),
                })
            }
            Some(b'[') => {
                self.at = at + lead_len + 1;
                let items = self.parse_optional_seq(at)?;
                Ok(Node::PrefixOpt(items))
            }
            Some(b'^') => {
                self.at = at + lead_len + 1;
                Ok(Node::BufStart)
            }
            Some(b'$') => {
                self.at = at + lead_len + 1;
                Ok(Node::BufEnd)
            }
            Some(k @ (b'd' | b'x' | b'u' | b'U')) => {
                self.at = at + lead_len;
                self.parse_char_code(at, k)
            }
            Some(b'V') => Err(QueryError::Unsupported {
                construct: "\\%V (visual-area match)",
                at,
            }),
            Some(b'#') => Err(QueryError::Unsupported {
                construct: "\\%# (cursor match)",
                at,
            }),
            Some(b'=') => Err(QueryError::Unsupported {
                construct: "\\%= (regexp engine selector)",
                at,
            }),
            Some(b'l') | Some(b'c') | Some(b'v') => Err(QueryError::Unsupported {
                construct: "\\%l / \\%c / \\%v (line/column match)",
                at,
            }),
            Some(b'0'..=b'9') => Err(QueryError::Unsupported {
                // \%23l / \%23c / \%23v — a number-prefixed position
                construct: "\\%l / \\%c / \\%v (line/column match)",
                at,
            }),
            _ => Err(QueryError::Unsupported {
                construct: "\\% (special item)",
                at,
            }),
        }
    }

    /// `\%[abcd]` body: atoms until `]` (bare `]` in both modes —
    /// vim's E69 expects a plain close here).
    pub(super) fn parse_optional_seq(&mut self, at: usize) -> Result<Vec<Node>, QueryError> {
        let mut items = Vec::new();
        loop {
            match self.peek() {
                None => return Err(QueryError::UnclosedOptional { at }),
                Some(b']') => {
                    self.at += 1;
                    break;
                }
                _ => {
                    let atom = self.parse_atom()?;
                    items.push(self.parse_quantifier(atom)?);
                }
            }
        }
        Ok(items)
    }

    /// `\%d123` / `\%x2a` / `\%u20ac` / `\%U0001f600`. `self.at` is on
    /// the type letter.
    pub(super) fn parse_char_code(&mut self, at: usize, kind: u8) -> Result<Node, QueryError> {
        self.at += 1; // the type letter
        let n: u32 = match kind {
            b'd' => {
                let mut v = 0u32;
                let mut any = false;
                while let Some(c @ b'0'..=b'9') = self.peek() {
                    v = v
                        .checked_mul(10)
                        .and_then(|x| x.checked_add((c - b'0') as u32))
                        .ok_or(QueryError::BadCharCode { at })?;
                    self.at += 1;
                    any = true;
                }
                if !any {
                    return Err(QueryError::BadCharCode { at });
                }
                v
            }
            b'x' | b'u' | b'U' => {
                let width = match kind {
                    b'x' => 2,
                    b'u' => 4,
                    _ => 8,
                };
                let mut v = 0u32;
                for _ in 0..width {
                    let c = self.peek().ok_or(QueryError::BadCharCode { at })?;
                    let d = (c as char)
                        .to_digit(16)
                        .ok_or(QueryError::BadCharCode { at })?;
                    v = v * 16 + d;
                    self.at += 1;
                }
                v
            }
            _ => unreachable!("kind filtered by caller"),
        };
        let ch = char::from_u32(n).ok_or(QueryError::BadCharCode { at })?;
        Ok(Node::Literal(ch.to_string().into_bytes()))
    }

    /// Everything after a backslash, both magic modes; `self.at` is on
    /// the `\`.
    pub(super) fn parse_escape(&mut self, at: usize) -> Result<Node, QueryError> {
        let c = self.peek2().ok_or(QueryError::TrailingBackslash { at })?;
        // Escaped metachars are literals — but WHICH chars are meta
        // depends on the mode: in magic, `\( \) \| \{ \< \>` (and
        // `\@` lookaround) are structural, so their escapes here must
        // fall through to the structural arms below. In very magic,
        // escaping always removes the magic.
        let literal_escape = match self.mode {
            Magic::Magic => matches!(
                c,
                b'.' | b'*'
                    | b'+'
                    | b'='
                    | b'?'
                    | b'['
                    | b']'
                    | b'^'
                    | b'$'
                    | b'~'
                    | b'&'
                    | b'\\'
                    | b'/'
                    | b'#'
                    | b'"'
            ),
            Magic::VeryMagic => matches!(
                c,
                b'.' | b'*'
                    | b'+'
                    | b'='
                    | b'?'
                    | b'['
                    | b']'
                    | b'{'
                    | b'}'
                    | b'('
                    | b')'
                    | b'|'
                    | b'<'
                    | b'>'
                    | b'~'
                    | b'&'
                    | b'@'
                    | b'\\'
                    | b'/'
                    | b'#'
                    | b'"'
            ),
        };
        if literal_escape {
            self.at += 2;
            return Ok(Node::Literal(vec![c]));
        }
        // magic groups open with \( — very magic uses the bare `(`
        // handled in parse_atom_very, so an escaped \( here is magic's
        if c == b'(' {
            self.at += 2; // consume the \( before recursing
            self.ngroups += 1;
            let idx = self.ngroups;
            self.branch_start = true;
            let inner = self.parse_alt()?;
            if !self.starts_with(b"\\)") {
                return Err(QueryError::UnbalancedGroup { at });
            }
            self.at += 2;
            return Ok(Node::Group {
                idx: Some(idx),
                node: Box::new(inner),
            });
        }
        if c == b')' || c == b'|' {
            // a closer/separator reaching atom position is unbalanced
            return Err(QueryError::UnbalancedGroup { at });
        }
        if c == b'@' && self.mode == Magic::Magic {
            let which = match self.pat.get(at + 2).copied() {
                Some(b'=') => "\\@= (lookahead)",
                Some(b'!') => "\\@! (negative lookahead)",
                Some(b'<') => "\\@<= (lookbehind)",
                _ => "\\@ (lookaround family)",
            };
            return Err(QueryError::Unsupported {
                construct: which,
                at,
            });
        }
        // two-char specials
        self.at += 2;
        match c {
            b'<' => return Ok(Node::WordStart),
            b'>' => return Ok(Node::WordEnd),
            b'c' => {
                self.fold = Some(true);
                return Ok(Node::Seq(vec![]));
            }
            b'C' => {
                self.fold = Some(false);
                return Ok(Node::Seq(vec![]));
            }
            b'n' => {
                // one whole line break (\r\n or \n) — CRLF counts as one
                return Ok(Node::Break);
            }
            b'r' => return Ok(Node::Literal(vec![b'\r'])),
            b't' => return Ok(Node::Literal(vec![b'\t'])),
            b'e' => return Ok(Node::Literal(vec![0x1b])),
            b'b' => return Ok(Node::Literal(vec![0x08])),
            b'f' => return Ok(Node::Literal(vec![0x0c])),
            _ => {}
        }
        // \zs / \ze: strict — anything else after \z is a refusal
        if c == b'z' {
            return match self.peek() {
                Some(b's') => {
                    self.at += 1;
                    Ok(Node::SetStart)
                }
                Some(b'e') => {
                    self.at += 1;
                    Ok(Node::SetEnd)
                }
                _ => Err(QueryError::Unsupported {
                    construct: "\\z (only \\zs and \\ze exist)",
                    at,
                }),
            };
        }
        // backreference
        if c.is_ascii_digit() && c != b'0' {
            return Ok(Node::Backref((c - b'0') as usize));
        }
        // \_x newline-extended atoms
        if c == b'_' {
            return match self.peek() {
                Some(b'.') => {
                    self.at += 1;
                    Ok(Node::Any { nl: true })
                }
                Some(b'[') => {
                    let mut node = self.parse_class(self.at)?;
                    if let Node::Set(s) = &mut node {
                        s.nl = true;
                    }
                    Ok(node)
                }
                Some(b'^') => {
                    self.at += 1;
                    Ok(Node::LineStart)
                }
                Some(b'$') => {
                    self.at += 1;
                    Ok(Node::LineEnd)
                }
                Some(letter) => {
                    if let Some(f) = letter_class(letter) {
                        self.at += 1;
                        let mut s = f();
                        s.nl = true;
                        Ok(Node::Set(s))
                    } else {
                        Err(QueryError::Unsupported {
                            construct: "\\_ (newline-extended class)",
                            at,
                        })
                    }
                }
                None => Err(QueryError::TrailingBackslash { at }),
            };
        }
        // letter classes (\d \s \w …)
        if let Some(f) = letter_class(c) {
            return Ok(Node::Set(f()));
        }
        // \% specials: rewind onto the backslash and share the reader
        if c == b'%' {
            self.at -= 2;
            return self.parse_percent(at);
        }
        // magic levels: \v/\m only at the very start (handled there);
        // anywhere else — and \M/\V everywhere — are typed refusals
        if matches!(c, b'v' | b'm' | b'M' | b'V') {
            return Err(QueryError::Unsupported {
                construct: match c {
                    b'v' | b'm' => "magic-level prefix (only at pattern start)",
                    b'M' => "\\M (nomagic)",
                    _ => "\\V (very nomagic)",
                },
                at,
            });
        }
        // unknown escape: the literal char that followed the backslash
        // (vim's rule: `a\qb` matches "aqb" — corpus-pinned)
        let ch = self.char_at(at + 1).map_err(|_| QueryError::Unsupported {
            construct: "invalid UTF-8 in pattern",
            at,
        })?;
        self.at = at + 1 + ch.len_utf8();
        Ok(Node::Literal(ch.to_string().into_bytes()))
    }
}