parol 4.5.0

LL(k) and LALR(1) parser generator for Rust
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
506
507
508
509
use crate::LRParseTable;
use crate::analysis::LookaheadDFA;
use crate::config::{CommonGeneratorConfig, ParserGeneratorConfig};
use crate::generators::parser_model::{
    LookaheadAutomatonModel as LookaheadAutomatonIR, ProductionModel as ProductionIR,
    build_lookahead_automata_model, build_production_model,
    find_start_symbol_index as parser_model_find_start_symbol_index,
};
use crate::generators::parser_render_ir::{
    build_csharp_lalr_parse_table_section_render_ir, build_csharp_llk_production_render_ir,
    build_csharp_non_terminal_names_render_ir, build_lalr_production_render_ir,
    build_non_terminal_metadata_ir, build_terminal_label_map,
};
use crate::generators::{GrammarConfig, NamingHelper};
use anyhow::Result;
use std::collections::BTreeMap;
use std::fmt::Write;

/// Generates the parser part of the parser output file for C# (LL(k)).
pub fn generate_parser_source<C: CommonGeneratorConfig + ParserGeneratorConfig>(
    grammar_config: &GrammarConfig,
    _lexer_source: &str, // Ignored, we regenerate the data class
    config: &C,
    la_dfa: &BTreeMap<String, LookaheadDFA>,
    _ast_type_has_lifetime: bool,
) -> Result<String> {
    generate_parser_source_internal(grammar_config, config, la_dfa)
}

fn generate_parser_source_internal<C: CommonGeneratorConfig + ParserGeneratorConfig>(
    grammar_config: &GrammarConfig,
    config: &C,
    la_dfa: &BTreeMap<String, LookaheadDFA>,
) -> Result<String> {
    let mut source = String::new();

    let non_terminal_metadata = build_non_terminal_metadata_ir(grammar_config);
    let non_terminal_names = non_terminal_metadata.names;
    let start_symbol_index =
        parser_model_find_start_symbol_index(&non_terminal_names, grammar_config)?;
    let non_terminal_names_render_ir =
        build_csharp_non_terminal_names_render_ir(&non_terminal_names);

    let parser_type_name = NamingHelper::to_upper_camel_case(config.user_type_name()) + "Parser";

    writeln!(
        source,
        "// ---------------------------------------------------------"
    )?;
    writeln!(source, "// This file was generated by parol.")?;
    writeln!(source, "// Do not edit this file manually.")?;
    writeln!(source, "// Changes will be overwritten on the next build.")?;
    writeln!(
        source,
        "// ---------------------------------------------------------"
    )?;
    writeln!(source)?;

    writeln!(source, "using System;")?;
    writeln!(source, "using System.Collections.Generic;")?;
    writeln!(source, "using Parol.Runtime;")?;
    writeln!(source, "using Parol.Runtime.Scanner;")?;
    writeln!(source)?;
    writeln!(source, "namespace {} {{", config.module_name())?;
    writeln!(source, "    /// <summary>")?;
    writeln!(
        source,
        "    /// Parser facade generated by parol for this grammar."
    )?;
    writeln!(
        source,
        "    /// Provides parse tables and convenience entry points."
    )?;
    writeln!(source, "    /// </summary>")?;
    writeln!(source, "    public class {} {{", parser_type_name)?;

    // Lexer Source (Scanner data class only)
    let scanner_data =
        crate::generators::cs_lexer_generator::generate_scanner_data(grammar_config, config)?;
    writeln!(source, "{}", scanner_data)?;
    writeln!(source)?;

    // Max K
    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Maximum lookahead k used by the generated grammar."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public const int MaxK = {};",
        grammar_config.lookahead_size
    )?;
    writeln!(source)?;

    // Non-Terminal Names
    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Ordered non-terminal names used by the parser tables."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly string[] NonTerminalNames = ["
    )?;
    for row in &non_terminal_names_render_ir.rows {
        writeln!(source, "            {}", row)?;
    }
    writeln!(source, "        ];")?;
    writeln!(source)?;

    // Lookahead Automata
    let lookahead_automata_ir = build_lookahead_automata_model(la_dfa, &non_terminal_names);
    generate_lookahead_automata(&mut source, &lookahead_automata_ir)?;
    writeln!(source)?;

    let production_ir = build_production_model(grammar_config, &non_terminal_names)?;
    generate_productions(&mut source, grammar_config, &production_ir)?;
    writeln!(source)?;

    // Parse Methods
    generate_parse_methods(&mut source, config, &parser_type_name, start_symbol_index)?;

    writeln!(source, "    }}")?;
    writeln!(source, "}}")?;

    Ok(source)
}

fn generate_lookahead_automata(
    source: &mut String,
    lookahead_automata_ir: &[LookaheadAutomatonIR],
) -> Result<()> {
    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Lookahead DFAs indexed by non-terminal index."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly LookaheadDfa[] LookaheadAutomata = ["
    )?;
    for automaton_ir in lookahead_automata_ir {
        writeln!(
            source,
            "            /* {} - \"{}\" */",
            automaton_ir.non_terminal_index, automaton_ir.non_terminal_name
        )?;
        writeln!(source, "            new(")?;
        writeln!(source, "                {},", automaton_ir.prod0)?;
        writeln!(source, "                [")?;
        for transition in &automaton_ir.transitions {
            writeln!(
                source,
                "                    new({}, {}, {}, {}),",
                transition.from_state, transition.term, transition.to_state, transition.prod_num
            )?;
        }
        writeln!(source, "                ],")?;
        writeln!(source, "                {} // k", automaton_ir.k)?;
        writeln!(source, "            ),")?;
    }
    writeln!(source, "        ];")?;
    Ok(())
}

fn generate_productions(
    source: &mut String,
    _grammar_config: &GrammarConfig,
    production_ir: &[ProductionIR],
) -> Result<()> {
    let production_render_ir = build_csharp_llk_production_render_ir(production_ir);

    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Production table consumed by the LL(k) parser runtime."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly Production[] Productions = ["
    )?;
    for p in &production_render_ir {
        writeln!(source, "            // {} - {}", p.production_index, p.text)?;
        writeln!(source, "            new Production(")?;
        writeln!(source, "                {},", p.lhs_index)?;
        writeln!(source, "                [")?;
        for symbol_source in &p.symbols {
            writeln!(source, "                    {},", symbol_source)?;
        }
        writeln!(source, "                ]")?;
        writeln!(source, "            ),")?;
    }
    writeln!(source, "        ];")?;
    Ok(())
}

fn generate_parse_methods(
    source: &mut String,
    config: &impl CommonGeneratorConfig,
    _parser_type_name: &str,
    start_symbol_index: usize,
) -> Result<()> {
    let scanner_type_name = NamingHelper::to_upper_camel_case(config.user_type_name()) + "Scanner";
    let actions_interface_name = format!(
        "I{}Actions",
        NamingHelper::to_upper_camel_case(config.user_type_name())
    );
    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Parses input with strongly typed user actions."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        /// <param name=\"input\">Input text to parse.</param>"
    )?;
    writeln!(
        source,
        "        /// <param name=\"fileName\">Logical file name used for diagnostics.</param>"
    )?;
    writeln!(
        source,
        "        /// <param name=\"userActions\">Typed semantic action receiver.</param>"
    )?;
    writeln!(
        source,
        "        public static void Parse(string input, string fileName, {} userActions) {{",
        actions_interface_name
    )?;
    writeln!(
        source,
        "            ParseInternal(input, fileName, userActions);"
    )?;
    writeln!(source, "        }}")?;
    writeln!(source)?;

    writeln!(
        source,
        "        private static void ParseInternal(string input, string fileName, IUserActions userActions) {{"
    )?;
    writeln!(source, "            var parser = new LLKParser(")?;
    writeln!(source, "                {},", start_symbol_index)?;
    writeln!(source, "                LookaheadAutomata,")?;
    writeln!(source, "                Productions,")?;
    writeln!(
        source,
        "                {}Data.TerminalNames,",
        scanner_type_name
    )?;
    writeln!(source, "                NonTerminalNames")?;
    writeln!(source, "            );")?;
    writeln!(source)?;
    writeln!(
        source,
        "            var tokens = Scanner.Scan(input, fileName, {}Data.MatchFunction, {}Data.ScannerModes, {}Data.SkipTokensByScannerMode);",
        scanner_type_name, scanner_type_name, scanner_type_name
    )?;
    writeln!(
        source,
        "            parser.Parse(tokens, userActions, fileName);"
    )?;
    writeln!(source, "        }}")?;

    Ok(())
}

/// Generates the parser part of the parser output file for C# (LALR(1)).
pub fn generate_lalr1_parser_source<C: CommonGeneratorConfig + ParserGeneratorConfig>(
    grammar_config: &GrammarConfig,
    _lexer_source: &str,
    config: &C,
    parse_table: &LRParseTable,
    _ast_type_has_lifetime: bool,
) -> Result<String> {
    generate_lalr1_parser_source_internal(grammar_config, config, parse_table)
}

fn generate_lalr1_parser_source_internal<C: CommonGeneratorConfig + ParserGeneratorConfig>(
    grammar_config: &GrammarConfig,
    config: &C,
    parse_table: &LRParseTable,
) -> Result<String> {
    let mut source = String::new();

    let non_terminal_metadata = build_non_terminal_metadata_ir(grammar_config);
    let non_terminal_names = non_terminal_metadata.names;
    let start_symbol_index =
        parser_model_find_start_symbol_index(&non_terminal_names, grammar_config)?;
    let non_terminal_names_render_ir =
        build_csharp_non_terminal_names_render_ir(&non_terminal_names);
    let production_ir = build_production_model(grammar_config, &non_terminal_names)?;
    let production_render_ir = build_lalr_production_render_ir(&production_ir);

    let parser_type_name = NamingHelper::to_upper_camel_case(config.user_type_name()) + "Parser";

    writeln!(
        source,
        "// ---------------------------------------------------------"
    )?;
    writeln!(source, "// This file was generated by parol.")?;
    writeln!(source, "// Do not edit this file manually.")?;
    writeln!(source, "// Changes will be overwritten on the next build.")?;
    writeln!(
        source,
        "// ---------------------------------------------------------"
    )?;
    writeln!(source)?;

    writeln!(source, "using System;")?;
    writeln!(source, "using System.Collections.Generic;")?;
    writeln!(source, "using Parol.Runtime;")?;
    writeln!(source, "using Parol.Runtime.Scanner;")?;
    writeln!(source)?;
    writeln!(source, "namespace {} {{", config.module_name())?;
    writeln!(source, "    /// <summary>")?;
    writeln!(
        source,
        "    /// LALR(1) parser facade generated by parol for this grammar."
    )?;
    writeln!(
        source,
        "    /// Provides parse table data and convenience entry points."
    )?;
    writeln!(source, "    /// </summary>")?;
    writeln!(source, "    public class {} {{", parser_type_name)?;

    let scanner_data =
        crate::generators::cs_lexer_generator::generate_scanner_data(grammar_config, config)?;
    writeln!(source, "{}", scanner_data)?;
    writeln!(source)?;

    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Ordered non-terminal names used by parser diagnostics."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly string[] NonTerminalNames = ["
    )?;
    for row in &non_terminal_names_render_ir.rows {
        writeln!(source, "            {}", row)?;
    }
    writeln!(source, "        ];")?;
    writeln!(source)?;

    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// LALR(1) production metadata consumed by the parser runtime."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly LRProduction[] Productions = ["
    )?;
    for p in &production_render_ir {
        writeln!(source, "            // {} - {}", p.production_index, p.text)?;
        writeln!(source, "            new LRProduction({}, [", p.lhs_index)?;
        for is_semantic_child in &p.semantic_children {
            writeln!(
                source,
                "                {},",
                if *is_semantic_child { "true" } else { "false" }
            )?;
        }
        writeln!(source, "            ]),")?;
    }
    writeln!(source, "        ];")?;
    writeln!(source)?;

    emit_lalr_parse_table(
        &mut source,
        grammar_config,
        parse_table,
        &non_terminal_names,
    )?;
    writeln!(source)?;

    emit_lalr_parse_methods(&mut source, config, &parser_type_name, start_symbol_index)?;

    writeln!(source, "    }}")?;
    writeln!(source, "}}")?;

    Ok(source)
}

fn emit_lalr_parse_table(
    source: &mut String,
    grammar_config: &GrammarConfig,
    parse_table: &LRParseTable,
    non_terminal_names: &[String],
) -> Result<()> {
    let terminals = grammar_config
        .cfg
        .get_ordered_terminals()
        .iter()
        .map(|(t, _, l, _)| (*t, l.clone()))
        .collect::<Vec<_>>();
    let terminal_labels = build_terminal_label_map(&terminals);
    let parse_table_render_ir = build_csharp_lalr_parse_table_section_render_ir(
        parse_table,
        &terminal_labels,
        non_terminal_names,
    );

    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Canonical LALR(1) parse table used by the parser runtime."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        public static readonly LRParseTable ParseTable = new("
    )?;

    writeln!(source, "            [")?;
    for action_row in &parse_table_render_ir.action_rows {
        writeln!(source, "                {}", action_row)?;
    }
    writeln!(source, "            ],")?;

    writeln!(source, "            [")?;
    for state_row in &parse_table_render_ir.state_rows {
        writeln!(source, "{}", state_row)?;
    }
    writeln!(source, "            ]")?;
    writeln!(source, "        );")?;

    Ok(())
}
fn emit_lalr_parse_methods(
    source: &mut String,
    config: &impl CommonGeneratorConfig,
    _parser_type_name: &str,
    start_symbol_index: usize,
) -> Result<()> {
    let scanner_type_name = NamingHelper::to_upper_camel_case(config.user_type_name()) + "Scanner";
    let actions_interface_name = format!(
        "I{}Actions",
        NamingHelper::to_upper_camel_case(config.user_type_name())
    );
    writeln!(source, "        /// <summary>")?;
    writeln!(
        source,
        "        /// Parses input with strongly typed user actions."
    )?;
    writeln!(source, "        /// </summary>")?;
    writeln!(
        source,
        "        /// <param name=\"input\">Input text to parse.</param>"
    )?;
    writeln!(
        source,
        "        /// <param name=\"fileName\">Logical file name used for diagnostics.</param>"
    )?;
    writeln!(
        source,
        "        /// <param name=\"userActions\">Typed semantic action receiver.</param>"
    )?;
    writeln!(
        source,
        "        public static void Parse(string input, string fileName, {} userActions) {{",
        actions_interface_name
    )?;
    writeln!(
        source,
        "            ParseInternal(input, fileName, userActions);"
    )?;
    writeln!(source, "        }}")?;
    writeln!(source)?;

    writeln!(
        source,
        "        private static void ParseInternal(string input, string fileName, IUserActions userActions) {{"
    )?;
    writeln!(source, "            var parser = new LRParser(")?;
    writeln!(source, "                {},", start_symbol_index)?;
    writeln!(source, "                ParseTable,")?;
    writeln!(source, "                Productions,")?;
    writeln!(
        source,
        "                {}Data.TerminalNames,",
        scanner_type_name
    )?;
    writeln!(source, "                NonTerminalNames")?;
    writeln!(source, "            );")?;
    writeln!(source)?;
    writeln!(
        source,
        "            var tokens = Scanner.Scan(input, fileName, {}Data.MatchFunction, {}Data.ScannerModes, {}Data.SkipTokensByScannerMode);",
        scanner_type_name, scanner_type_name, scanner_type_name
    )?;
    writeln!(
        source,
        "            parser.Parse(tokens, userActions, fileName);"
    )?;
    writeln!(source, "        }}")?;

    Ok(())
}