syn-grammar 0.8.0

A parser generator for Rust that compiles EBNF-like grammars into syn::parse::Parse implementations.
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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
use syn::parse::Parser;
use syn_grammar::grammar;
use syn_grammar::testing::Testable;

// --- Test Action Block Statements ---
#[test]
fn test_action_block_statements() {
    grammar! {
        grammar action_stmt {
            pub rule main -> i32 = "x" -> {
                let a = 10;
                let b = 32;
                a + b
            }
        }
    }

    action_stmt::parse_main
        .parse_str("x")
        .test()
        .assert_success_is(42);
}

// --- Test Built-ins ---
#[test]
fn test_builtins() {
    grammar! {
        grammar builtins_test {
            pub rule test_int -> i32 = i:i32 -> { i }
            pub rule test_str -> String = s:string -> { s.value }
        }
    }

    builtins_test::parse_test_int
        .parse_str("123")
        .test()
        .assert_success_is(123);

    builtins_test::parse_test_str
        .parse_str("\"hello\"")
        .test()
        .assert_success_is("hello".to_string());
}

// --- Test Repetition ---
#[test]
fn test_repetition() {
    grammar! {
        grammar repetition_test {
            pub rule star -> Vec<i32> = ( items:i32* ) -> { items }
            pub rule plus -> Vec<i32> = ( items:i32+ ) -> { items }
            pub rule opt -> Option<i32> = ( item:i32? ) -> { item }
        }
    }

    repetition_test::parse_star
        .parse_str("1 2 3")
        .test()
        .assert_success_is(vec![1, 2, 3]);

    repetition_test::parse_star
        .parse_str("")
        .test()
        .assert_success_is(vec![]);

    repetition_test::parse_plus
        .parse_str("1 2")
        .test()
        .assert_success_is(vec![1, 2]);

    repetition_test::parse_plus
        .parse_str("")
        .test()
        .assert_failure_contains("expected integer");

    repetition_test::parse_opt
        .parse_str("42")
        .test()
        .assert_success_is(Some(42));

    repetition_test::parse_opt
        .parse_str("")
        .test()
        .assert_success_is(None);
}

// --- Test Nested Repetition & Complex Types ---
#[test]
fn test_nested_repetition_complex() {
    grammar! {
        grammar complex_rep {
            pub rule main -> Vec<Vec<i32>> =
                // ( ( integer )* )*
                // We use delimiters to keep structure simple for the parser
                ( groups:group* ) -> { groups }

            rule group -> Vec<i32> =
                paren(items:i32*) -> { items }
        }
    }

    // "(1 2) (3)" -> [[1, 2], [3]]
    complex_rep::parse_main
        .parse_str("(1 2) (3)")
        .test()
        .assert_success_is(vec![vec![1, 2], vec![3]]);
}

// --- Test Cut Operator ---
#[test]
fn test_cut_operator() {
    grammar! {
        grammar cut_test {
            pub rule main -> i32 =
                // If "let" is seen, commit to this arm.
                // If "let" is followed by something other than integer, fail immediately.
                "let" => i:i32 -> { i }
              | i:i32 -> { i }
        }
    }

    // "let 42" -> 42
    cut_test::parse_main
        .parse_str("let 42")
        .test()
        .assert_success_is(42);

    // "42" -> 42 (second arm)
    cut_test::parse_main
        .parse_str("42")
        .test()
        .assert_success_is(42);

    // "let bad" -> Error (expected integer), does NOT backtrack to second arm
    cut_test::parse_main
        .parse_str("let bad")
        .test()
        .assert_failure_contains("expected integer");
}

// --- Test Left Recursion ---
#[test]
fn test_left_recursion() {
    grammar! {
        grammar expr_test {
            pub rule expr -> i32 =
                l:expr "+" r:term -> { l + r }
              | l:expr "-" r:term -> { l - r }
              | t:term -> { t }

            rule term -> i32 =
                l:term "*" r:factor -> { l * r }
              | f:factor -> { f }

            rule factor -> i32 =
                i:i32 -> { i }
              | paren(e:expr) -> { e }
        }
    }

    // 1 + 2 * 3 -> 7
    expr_test::parse_expr
        .parse_str("1 + 2 * 3")
        .test()
        .assert_success_is(7);

    // (1 + 2) * 3 -> 9
    expr_test::parse_expr
        .parse_str("(1 + 2) * 3")
        .test()
        .assert_success_is(9);

    // 1 - 2 - 3 -> (1 - 2) - 3 = -4 (Left associative)
    expr_test::parse_expr
        .parse_str("1 - 2 - 3")
        .test()
        .assert_success_is(-4);
}

// --- Test Keywords vs Idents ---
#[test]
fn test_keywords_vs_idents() {
    grammar! {
        grammar kw_test {
            pub rule main -> String =
                "fn" name:ident -> { name.to_string() }
        }
    }

    kw_test::parse_main
        .parse_str("fn foo")
        .test()
        .assert_success_is("foo".to_string());

    // "fn fn" -> Error (expected ident, got keyword fn - syn behavior)
    // Actually syn::parse_ident fails on keywords unless raw identifiers are used.
    kw_test::parse_main
        .parse_str("fn fn")
        .test()
        .assert_failure_contains("expected identifier");
}

// --- Test Basic Sequence ---
#[test]
fn test_basic_sequence() {
    grammar! {
        grammar seq_test {
            pub rule main -> (i32, i32) = a:i32 b:i32 -> { (a, b) }
        }
    }

    seq_test::parse_main
        .parse_str("10 20")
        .test()
        .assert_success_is((10, 20));
}

// --- Test Epsilon Alternative ---
#[test]
fn test_epsilon_alternative() {
    grammar! {
        grammar epsilon {
            pub rule main -> Option<i32> =
                i:i32 -> { Some(i) }
              | -> { None }
        }
    }

    epsilon::parse_main
        .parse_str("42")
        .test()
        .assert_success_is(Some(42));
    epsilon::parse_main
        .parse_str("")
        .test()
        .assert_success_is(None);
}

// --- Test Rule Arguments ---
#[test]
fn test_rule_arguments() {
    grammar! {
        grammar args {
            pub rule main -> i32 = "start" v:value(10) -> { v }
            rule value(offset: i32) -> i32 = i:i32 -> { i + offset }
        }
    }

    args::parse_main
        .parse_str("start 5")
        .test()
        .assert_success_is(15);
}

// --- Test Multiple Arguments ---
#[test]
fn test_multiple_arguments() {
    grammar! {
        grammar multi_args {
            pub rule main -> i32 = "calc" v:calc(2, 3) -> { v }
            rule calc(mult: i32, base: i32) -> i32 = i:i32 -> { base + (i * mult) }
        }
    }

    // 10 * 2 + 3 = 23
    multi_args::parse_main
        .parse_str("calc 10")
        .test()
        .assert_success_is(23);
}

// --- Test Complex Return Types ---
// For simplicity in this test, we won't return Result<_,_> because syn::Error doesn't impl PartialEq easily.
// We'll wrap in Option.
#[test]
fn test_complex_return_types() {
    grammar! {
        grammar types {
            pub rule main -> Vec<Option<i32>> =
                items:item* -> { items }

            rule item -> Option<i32> =
                i:i32 -> { Some(i) }
              | s:string -> { None }
        }
    }

    types::parse_main
        .parse_str("10 \"skip\" 20")
        .test()
        .assert_success_is(vec![Some(10), None, Some(20)]);
}

// --- Test Cut in Repetition ---
#[test]
fn test_cut_in_repetition() {
    grammar! {
        grammar cut_rep {
            pub rule main -> Vec<i32> =
                // Once we see "item", we commit to `integer`.
                // If `integer` is missing after "item", we error and abort the loop (and the rule).
                ( "item" => i:i32 )* -> { i }
        }
    }

    cut_rep::parse_main
        .parse_str("item 1 item 2")
        .test()
        .assert_success_is(vec![1, 2]);

    // "item 1 item" -> Fail (expected integer after second item)
    cut_rep::parse_main
        .parse_str("item 1 item")
        .test()
        .assert_failure_contains("expected integer");
}

// --- Test Backtracking Priority ---
#[test]
fn test_backtracking_priority() {
    grammar! {
        grammar priority {
            pub rule main -> i32 =
                // Longest match first
                "a" "b" "c" -> { 3 }
              | "a" "b"     -> { 2 }
              | "a"         -> { 1 }
        }
    }

    priority::parse_main
        .parse_str("a b c")
        .test()
        .assert_success_is(3);
    priority::parse_main
        .parse_str("a b")
        .test()
        .assert_success_is(2);
    priority::parse_main
        .parse_str("a")
        .test()
        .assert_success_is(1);
}

// --- Test Use Statements ---
#[test]
fn test_use_statements() {
    grammar! {
        grammar use_stmt {
            use std::collections::HashMap;

            pub rule main -> HashMap<String, i32> =
                "map" -> { HashMap::new() }
        }
    }

    use_stmt::parse_main
        .parse_str("map")
        .test()
        .assert_success();
}

// --- Test Left Recursion Field Access ---
#[test]
fn test_left_recursion_field_access() {
    grammar! {
        grammar field_access {
            pub rule expr -> String =
                l:expr "." r:ident -> { format!("{}.{}", l, r) }
              | i:ident -> { i.to_string() }
        }
    }

    field_access::parse_expr
        .parse_str("a.b.c")
        .test()
        .assert_success_is("a.b.c".to_string());
}

// --- Test Multi-token Literals ---
#[test]
fn test_multi_token_literals() {
    grammar! {
        grammar multi_tok {
            pub rule main -> bool =
                "?." -> { true }
        }
    }

    // Matches strict adjacency
    multi_tok::parse_main
        .parse_str("?.")
        .test()
        .assert_success_is(true);
    // Fails on space
    multi_tok::parse_main
        .parse_str("? .")
        .test()
        .assert_failure_contains("expected '?.', found space between tokens");
}

// --- Test Extended Literals ---
#[test]
fn test_extended_literals() {
    grammar! {
        grammar ext_lit {
            pub rule attr -> () = "@detached" -> { () }
        }
    }

    ext_lit::parse_attr
        .parse_str("@detached")
        .test()
        .assert_success();
    ext_lit::parse_attr
        .parse_str("@ detached")
        .test()
        .assert_failure_contains("expected '@detached', found space between tokens");
}

// --- Test Attributes on Rules ---
#[test]
fn test_attributes_on_rules() {
    grammar! {
        grammar attr_rules {
            /// Doc comment
            #[allow(dead_code)]
            pub rule main -> () = "a" -> { () }
        }
    }
    attr_rules::parse_main
        .parse_str("a")
        .test()
        .assert_success();
}

// --- Test Plus Operator Validation ---
#[test]
fn test_plus_operator_validation() {
    grammar! {
        grammar plus_val {
            pub rule list -> Vec<i32> = i:i32+ -> { i }
        }
    }
    plus_val::parse_list
        .parse_str("1 2")
        .test()
        .assert_success_is(vec![1, 2]);
    plus_val::parse_list
        .parse_str("")
        .test()
        .assert_failure_contains("expected integer");
}

// --- Test Math Expression (Integration) ---
#[test]
fn test_math_expression() {
    grammar! {
        grammar math {
            pub rule expr -> i32 =
                l:expr "+" r:term -> { l + r }
              | l:expr "-" r:term -> { l - r }
              | t:term            -> { t }

            rule term -> i32 =
                l:term "*" r:factor -> { l * r }
              | l:term "/" r:factor -> { l / r }
              | f:factor            -> { f }

            rule factor -> i32 =
                i:i32               -> { i }
              | paren(e:expr)      -> { e }
        }
    }

    math::parse_expr
        .parse_str("10 + 2 * 3")
        .test()
        .assert_success_is(16);
    math::parse_expr
        .parse_str("(10 + 2) * 3")
        .test()
        .assert_success_is(36);
}

// --- Test Rust Types and Blocks ---
#[test]
fn test_rust_types_and_blocks() {
    grammar! {
        grammar rust_features {
            pub rule type_parser -> syn::Type = t:rust_type -> { t }
            pub rule block_parser -> syn::Block = b:rust_block -> { b }
        }
    }

    rust_features::parse_type_parser
        .parse_str("Vec<i32>")
        .test()
        .assert_success();

    rust_features::parse_block_parser
        .parse_str("{ let x = 1; }")
        .test()
        .assert_success();
}