usage-lib 6.5.0

Library for working with usage specs
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
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
//! A struct per command, and the `Parse` that fills them.
//!
//! The front door. An author calls `Parse(os.Args[1:])` and gets a value with
//! fields rather than a loop over events; everything below — binding, the
//! post-binding rules, the three tables — is unchanged, and this is the shape
//! that makes it usable without knowing any of it.
//!
//! Fields are `string`, `bool` and `[]string`, because that is what a usage spec
//! knows. A spec says what a value is *called* and never what type it is, so
//! turning `"8"` into an `int` stays the caller's business — `argv.Int` and its
//! neighbours exist for exactly that, and inferring a type from an argument's
//! name would be guessing.

use std::collections::{HashMap, HashSet};
use std::fmt::Write as _;

use super::{field_name, Emitted};
use crate::{SpecArg, SpecFlag};

/// The field each entry is assigned to, by key.
///
/// Worked out once and shared by the struct declarations and by `Parse`, so the
/// two cannot disagree about where a value goes.
type Fields = HashMap<String, String>;

struct ClauseFields {
    field: String,
    type_name: String,
    args: Fields,
}

type Clauses = HashMap<String, ClauseFields>;

/// Write every command's struct, then `Parse`.
pub(super) fn emit(out: &mut String, commands: &[Emitted]) {
    let mut assigned: Fields = HashMap::new();
    let mut clauses: Clauses = HashMap::new();
    for e in commands {
        let clause_type = e.cmd.clause.as_ref().map(|clause| {
            let type_name = format!("{}{}Clause", name(e), field_name(&clause.name));
            let mut args = Fields::new();
            let mut taken = HashSet::new();
            let _ = writeln!(
                out,
                "// {type_name} is one `{}` clause instance.",
                clause.name
            );
            let _ = writeln!(out, "type {type_name} struct {{");
            let fields = e
                .clause_args
                .iter()
                .map(|(arg, named)| {
                    let base = field_name(&arg.name);
                    let field = if taken.insert(base.clone()) {
                        base
                    } else {
                        let mut n = 2;
                        loop {
                            let candidate = format!("{base}{n}");
                            if taken.insert(candidate.clone()) {
                                break candidate;
                            }
                            n += 1;
                        }
                    };
                    args.insert(named.key.clone(), field.clone());
                    (field, arg_type(arg), named.key.as_str())
                })
                .collect::<Vec<_>>();
            let name_col = fields.iter().map(|(n, _, _)| n.len()).max().unwrap_or(0);
            let type_col = fields.iter().map(|(_, t, _)| t.len()).max().unwrap_or(0);
            for (field, ty, key) in fields {
                let _ = writeln!(out, "\t{field:<name_col$} {ty:<type_col$} // {key}");
            }
            let _ = writeln!(out, "}}\n");
            (type_name, args)
        });

        let doc = if e.root {
            format!("// {} is the whole command line.", name(e))
        } else {
            format!("// {} is `{}`.", name(e), e.cmd.full_cmd.join(" "))
        };
        let _ = writeln!(out, "{doc}");
        let _ = writeln!(out, "type {} struct {{", name(e));

        let mut fields: Vec<(String, String, String)> = Vec::new();
        let mut taken: HashSet<String> = HashSet::new();
        // A field name has to be unique *within its struct*, and a command can
        // declare a `--shell` flag beside a `shell` subcommand — mise does, and
        // does the same with `version`, `command`, `env` and `tool`. The kind is
        // what disambiguates, because `ShellCmd` says which one it is where
        // `Shell2` says only that there were two.
        let mut claim = |base: String, suffix: &str| -> String {
            if taken.insert(base.clone()) {
                return base;
            }
            let kinded = format!("{base}{suffix}");
            if taken.insert(kinded.clone()) {
                return kinded;
            }
            for n in 2.. {
                let numbered = format!("{kinded}{n}");
                if taken.insert(numbered.clone()) {
                    return numbered;
                }
            }
            unreachable!("the loop returns")
        };

        for (flag, named) in &e.flags {
            let field = claim(field_name(&flag.name), "Flag");
            fields.push((
                field.clone(),
                flag_type(flag).to_string(),
                named.key.clone(),
            ));
            assigned.insert(named.key.clone(), field);
        }
        for (arg, named) in &e.args {
            let field = claim(field_name(&arg.name), "Arg");
            fields.push((field.clone(), arg_type(arg).to_string(), named.key.clone()));
            assigned.insert(named.key.clone(), field);
        }
        if let (Some(clause), Some((type_name, args))) = (&e.cmd.clause, clause_type) {
            let field = claim(field_name(&clause.name), "Clause");
            fields.push((
                field.clone(),
                format!("[]{type_name}"),
                format!("clause {}", clause.name),
            ));
            clauses.insert(
                e.named.key.clone(),
                ClauseFields {
                    field,
                    type_name,
                    args,
                },
            );
        }
        for at in &e.subcommands {
            let sub = &commands[*at];
            // A pointer, and at most one is set: the command line selects one path
            // down the tree.
            let field = claim(field_name(&sub.cmd.name), "Cmd");
            fields.push((
                field.clone(),
                format!("*{}", name(sub)),
                sub.named.key.clone(),
            ));
            assigned.insert(sub.named.key.clone(), field);
        }

        // gofmt aligns a run of field declarations into columns, so this does too.
        let name_col = fields.iter().map(|(n, _, _)| n.len()).max().unwrap_or(0);
        let type_col = fields.iter().map(|(_, t, _)| t.len()).max().unwrap_or(0);
        for (field, ty, key) in &fields {
            let _ = writeln!(out, "\t{field:<name_col$} {ty:<type_col$} // {key}");
        }
        let _ = writeln!(out, "}}\n");
    }

    parse_fn(out, commands, &assigned, &clauses);
}

fn parse_fn(out: &mut String, commands: &[Emitted], assigned: &Fields, clauses: &Clauses) {
    let root = &commands[0];
    let mut strict_keys = commands
        .iter()
        .flat_map(|command| {
            command
                .flags
                .iter()
                .filter(|(flag, _)| {
                    !command.cmd.args_override_self
                        && !flag.var
                        && !flag.count
                        && !flag.arg.as_ref().is_some_and(|arg| arg.var)
                })
                .map(|(_, named)| named.key.as_str())
        })
        .collect::<Vec<_>>();
    strict_keys.sort_unstable();
    strict_keys.dedup();
    let mut strict_negate_keys = commands
        .iter()
        .flat_map(|command| {
            command
                .flags
                .iter()
                .filter(|(flag, _)| !command.cmd.args_override_self && flag.negate.is_some())
                .map(|(_, named)| named.key.as_str())
        })
        .collect::<Vec<_>>();
    strict_negate_keys.sort_unstable();
    strict_negate_keys.dedup();
    let duplicate_state = if strict_keys.is_empty() {
        String::new()
    } else {
        let polarity = if strict_negate_keys.is_empty() {
            ""
        } else {
            "\tpolaritySeen := map[uint64]uint8{}\n"
        };
        format!(
            "\tlevelSeen := map[uint64]int{{}}\n{polarity}\tstrictSeen := map[uint64]bool{{}}\n\tduplicateSeen := map[uint64]bool{{}}\n"
        )
    };
    let duplicate_event = if strict_keys.is_empty() {
        String::new()
    } else {
        let keys = strict_keys.join(", ");
        let per_kind = if strict_negate_keys.is_empty() {
            "\t\t\t\tlevelSeen[ev.Flag.Key]++\n\t\t\t\tif levelSeen[ev.Flag.Key] > 1 {\n\t\t\t\t\tduplicateSeen[ev.Flag.Key] = true\n\t\t\t\t}\n".to_string()
        } else {
            let negate_keys = strict_negate_keys.join(", ");
            format!(
                "\t\t\t\tswitch ev.Flag.Key {{\n\t\t\t\tcase {negate_keys}:\n\t\t\t\t\tpolarity := uint8(1)\n\t\t\t\t\tif ev.Negated {{\n\t\t\t\t\t\tpolarity = 2\n\t\t\t\t\t}}\n\t\t\t\t\tif polaritySeen[ev.Flag.Key]&polarity != 0 {{\n\t\t\t\t\t\tduplicateSeen[ev.Flag.Key] = true\n\t\t\t\t\t}}\n\t\t\t\t\tpolaritySeen[ev.Flag.Key] |= polarity\n\t\t\t\tdefault:\n\t\t\t\t\tlevelSeen[ev.Flag.Key]++\n\t\t\t\t\tif levelSeen[ev.Flag.Key] > 1 {{\n\t\t\t\t\t\tduplicateSeen[ev.Flag.Key] = true\n\t\t\t\t\t}}\n\t\t\t\t}}\n"
            )
        };
        format!(
            "\t\t\tswitch ev.Flag.Key {{\n\t\t\tcase {keys}:\n\t\t\t\tstrictSeen[ev.Flag.Key] = true\n{per_kind}\t\t\t}}\n"
        )
    };
    let duplicate_occurrences = if strict_keys.is_empty() {
        ""
    } else {
        "\t\toccurrences := seen[key]\n\t\tif strictSeen[key] {\n\t\t\toccurrences = 1\n\t\t\tif duplicateSeen[key] {\n\t\t\t\toccurrences = 2\n\t\t\t}\n\t\t}\n"
    };
    let check_occurrences = if strict_keys.is_empty() {
        "seen[key]"
    } else {
        "occurrences"
    };
    let duplicate_command = if strict_keys.is_empty() {
        String::new()
    } else {
        let polarity = if strict_negate_keys.is_empty() {
            ""
        } else {
            "\t\t\tpolaritySeen = map[uint64]uint8{}\n"
        };
        format!("\t\t\tlevelSeen = map[uint64]int{{}}\n{polarity}")
    };
    let has_relationship_values = commands.iter().any(|command| {
        command.flags.iter().any(|(flag, _)| {
            !flag.requires_if.is_empty()
                || !flag.required_if_eq.is_empty()
                || !flag.required_if_eq_all.is_empty()
        }) || command
            .args
            .iter()
            .chain(command.clause_args.iter())
            .any(|(arg, _)| !arg.required_if_eq.is_empty() || !arg.required_if_eq_all.is_empty())
    });
    let has_default_if = commands
        .iter()
        .flat_map(|command| command.flags.iter())
        .any(|(flag, _)| !flag.default_if.is_empty());
    let needs_negated = has_relationship_values || has_default_if;
    let conditional_state = if needs_negated {
        "\tnegated := map[uint64]bool{}\n"
    } else {
        ""
    };
    let conditional_resolved = if has_relationship_values {
        "\tresolved := map[uint64][]string{}\n"
    } else {
        ""
    };
    let conditional_value = if has_relationship_values {
        "\t\tresolved[key] = values\n"
    } else {
        ""
    };
    let clause_state = if clauses.is_empty() {
        ""
    } else {
        "\tclauseGiven := map[uint64][]string{}\n\tclauseInstances := map[uint64][]map[uint64][]string{}\n"
    };
    let clause_arg_values = if clauses.is_empty() {
        "\t\t\tgiven[ev.Arg.Key] = append(given[ev.Arg.Key], values...)\n"
    } else {
        "\t\t\tif p.Command().Clause != nil {\n\t\t\t\tclauseGiven[ev.Arg.Key] = append(clauseGiven[ev.Arg.Key], values...)\n\t\t\t} else {\n\t\t\t\tgiven[ev.Arg.Key] = append(given[ev.Arg.Key], values...)\n\t\t\t}\n"
    };
    let clause_separator_event = if clauses.is_empty() {
        ""
    } else {
        "\t\tcase argv.KindClauseSeparator:\n\t\t\tclauseInstances[ev.Clause.Key] = append(clauseInstances[ev.Clause.Key], clauseGiven)\n\t\t\tclauseGiven = map[uint64][]string{}\n"
    };
    let finish_clause = if clauses.is_empty() {
        ""
    } else {
        "\tif p.Command().Clause != nil {\n\t\tclauseInstances[p.Command().Clause.Key] = append(clauseInstances[p.Command().Clause.Key], clauseGiven)\n\t}\n"
    };
    let _ = writeln!(
        out,
        "// Parse binds a command line and fills the structs above.\n\
         //\n\
         // The rules decided once the last token has been read run here too, so a\n\
         // missing required flag or a value outside its choices comes back rather than\n\
         // reaching your code. A returned error is an *argv.Error; render it with\n\
         // argv.Render.\n\
         //\n\
         // Help and version arrive as errors, because a parse that stops to print a page\n\
         // has produced no value. Check the code before treating one as a failure.\n\
         func Parse(args []string) (*{}, error) {{",
        name(root)
    );
    let _ = writeln!(out, "\tout := &{}{{}}", name(root));

    // One variable per command, assigned on descent. A flag's key can only arrive
    // after its command was selected, so the variable is set by the time anything
    // reads it.
    for e in commands.iter().skip(1) {
        let _ = writeln!(out, "\tvar {}V *{}", e.named.var, name(e));
    }

    let _ = writeln!(
        out,
        "\n\t// Collected by key, so the post-binding rules can judge what arrived\n\
         \t// before any of it is handed back.\n\
         \tgiven := map[uint64][]string{{}}\n\
         \tseen := map[uint64]int{{}}\n\
         {clause_state}\
         {duplicate_state}\
         {conditional_state}\
         \tchain := []*argv.Command{{Root}}\n\
         \n\tp := argv.New(Root, args)\n\
         \tfor p.Next() {{\n\
         \t\tev := p.Event()\n\
         \t\tswitch ev.Kind {{\n\
         \t\tcase argv.KindCommand:\n\
         {duplicate_command}\
         \t\t\tchain = append(chain, ev.Command)\n\
         \t\t\tswitch ev.Command.Key {{"
    );
    for (i, e) in commands.iter().enumerate().skip(1) {
        let owner = match parent_of(commands, i) {
            Some(0) | None => "out".to_string(),
            Some(at) => format!("{}V", commands[at].named.var),
        };
        let _ = writeln!(
            out,
            "\t\t\tcase {}:\n\t\t\t\t{v}V = &{}{{}}\n\t\t\t\t{owner}.{} = {v}V",
            e.named.key,
            name(e),
            assigned[&e.named.key],
            v = e.named.var
        );
    }

    let conditional_event = if needs_negated {
        "\t\t\tnegated[ev.Flag.Key] = ev.Negated\n"
    } else {
        ""
    };
    let _ = writeln!(
        out,
        "\t\t\t}}\n\t\tcase argv.KindFlag:\n\t\t\tseen[ev.Flag.Key]++\n\
         {duplicate_event}\
         {conditional_event}\
         \t\t\tif ev.Flag.BoolValue {{\n\
         \t\t\t\t// Boolean binding is last-one-wins. Replace an earlier attached value even\n\
         \t\t\t\t// when the last occurrence is bare, so relationship polarity follows the field.\n\
         \t\t\t\tif ev.HasValue {{\n\
         \t\t\t\t\tgiven[ev.Flag.Key] = []string{{ev.Value}}\n\
         \t\t\t\t}} else {{\n\
         \t\t\t\t\tgiven[ev.Flag.Key] = []string{{}}\n\
         \t\t\t\t}}\n\
         \t\t\t}} else if ev.HasValue {{\n\
         \t\t\t\tgiven[ev.Flag.Key] = append(given[ev.Flag.Key], argv.SplitValue(ev.Value, ev.Flag.Delimiter, true)...)\n\
         \t\t\t}} else if given[ev.Flag.Key] == nil {{\n\
         \t\t\t\t// Given without a value is still given, and nil would read as\n\
         \t\t\t\t// absent when the fallbacks are applied.\n\
         \t\t\t\tgiven[ev.Flag.Key] = []string{{}}\n\t\t\t}}\n\
         \t\t\tswitch ev.Flag.Key {{"
    );
    for e in commands {
        let owner = owner_of(e);
        for (flag, named) in &e.flags {
            let _ = writeln!(
                out,
                "\t\t\tcase {}:\n{}",
                named.key,
                flag_assign(flag, &owner, &assigned[&named.key])
            );
        }
    }

    let _ = writeln!(
        out,
        "\t\t\t}}\n\t\tcase argv.KindArg:\n\t\t\tseen[ev.Arg.Key]++\n\
         \t\t\tvalues := argv.SplitValue(ev.Value, ev.Arg.Delimiter, ev.Delimit)\n\
         {clause_arg_values}\
         \t\t\tswitch ev.Arg.Key {{"
    );
    for e in commands {
        let owner = owner_of(e);
        for (arg, named) in &e.args {
            let field = &assigned[&named.key];
            let assign = if arg.var {
                format!("\t\t\t\t{owner}.{field} = append({owner}.{field}, values...)")
            } else {
                format!("\t\t\t\t{owner}.{field} = ev.Value")
            };
            let _ = writeln!(out, "\t\t\tcase {}:\n{assign}", named.key);
        }
    }

    let negated_arg = if needs_negated { "negated" } else { "nil" };
    let _ = writeln!(
        out,
        "\t\t\t}}\n{clause_separator_event}\t\t}}\n\t}}\n\
         {finish_clause}\
         \tif err := p.Err(); err != nil {{\n\t\treturn nil, err\n\t}}\n\
         \tif p.Command().ArgRequiredElseHelp && p.CommandStart() == len(args) {{\n\
         \t\treturn nil, &argv.Error{{Code: argv.CodeHelp, Cmd: p.Command()}}\n\t}}\n\
         \n\t// Only the commands the words actually selected are judged: a required\n\
         \t// flag on a command nobody ran is not missing.\n\
         \tvar scope []uint64\n\
         \trequirements := map[uint64]bool{{}}\n\
         \tfor i, cmd := range chain {{\n\
         \t\tcheckRequirements := i == len(chain)-1 || !cmd.SubcommandNegatesReqs\n\
         \t\tfor _, f := range cmd.Flags {{\n\t\t\tscope = append(scope, f.Key)\n\t\t\trequirements[f.Key] = checkRequirements\n\t\t}}\n\
         \t\tfor _, a := range cmd.Args {{\n\t\t\tscope = append(scope, a.Key)\n\t\t\trequirements[a.Key] = checkRequirements\n\t\t}}\n\
         \t}}\n\
         \tsources := map[uint64]argv.Source{{}}\n\
         \tfilled := map[uint64][]string{{}}\n\
         {conditional_resolved}\
         \tfor _, key := range scope {{\n\
         \t\tvalues, source := argv.Fill(Meta.Lookup(key), given[key], argv.LookupEnv)\n\
         \t\tfilled[key] = values\n\
         \t\tsources[key] = source\n\
         \t}}\n\
         \targv.ApplyDefaultIf(Meta, scope, filled, sources, {negated_arg})\n\
         \tfor _, key := range scope {{\n\
         \t\tvalues, source := filled[key], sources[key]\n\
         {conditional_value}\
         {duplicate_occurrences}\
         \t\tentryMeta := Meta.Lookup(key)\n\
         \t\tif entryMeta != nil && !requirements[key] {{\n\t\t\tcopy := *entryMeta\n\t\t\tcopy.Required = false\n\t\t\tentryMeta = &copy\n\t\t}}\n\
         \t\tif err := argv.Check(entryMeta, values, {check_occurrences}); err != nil {{\n\
         \t\t\treturn nil, err\n\t\t}}\n\
         \t\t// What the environment or a default supplied has to reach the field\n\
         \t\t// too. A front door that enforces a default and then hands back the\n\
         \t\t// zero value is worse than one that has no defaults at all.\n\
         \t\t//\n\
         \t\t// Written here rather than in a function of its own because a\n\
         \t\t// subcommand's struct is reachable only from inside this one: the\n\
         \t\t// variable holding it is local, and only the keys of commands the\n\
         \t\t// words selected are in scope, so it is never nil when its key is.\n\
         \t\tif source == argv.FromEnv || source == argv.FromDefault {{\n\
         \t\t\tswitch key {{"
    );
    fallback_cases(out, commands, assigned);
    let _ = writeln!(out, "\t\t\t}}\n\t\t}}\n\t}}");
    let clause_keys = commands
        .iter()
        .flat_map(|command| {
            command
                .clause_args
                .iter()
                .map(|(_, named)| named.key.as_str())
        })
        .collect::<Vec<_>>()
        .join(", ");
    if !clauses.is_empty() {
        let initial_sources = commands
            .iter()
            .flat_map(|command| command.clause_args.iter())
            .map(|(_, named)| format!("{}: argv.Unset", named.key))
            .collect::<Vec<_>>()
            .join(", ");
        let aggregate_values = if has_relationship_values {
            "\t\t\tclauseValues[key] = append(clauseValues[key], values...)\n"
        } else {
            ""
        };
        let aggregate_binding = if has_relationship_values {
            "key, values"
        } else {
            "key"
        };
        let values_state = if has_relationship_values {
            "\tclauseValues := map[uint64][]string{}\n"
        } else {
            ""
        };
        let _ = writeln!(
            out,
            "\tclauseSources := map[uint64]argv.Source{{{initial_sources}}}\n\
             {values_state}\
             \tfor _, instances := range clauseInstances {{\n\
             \t\tfor _, instance := range instances {{\n\
             \t\t\tfor {aggregate_binding} := range instance {{\n\
             \t\t\t\tclauseSources[key] = argv.FromArgv\n\
             {aggregate_values}\
             \t\t\t}}\n\t\t}}\n\t}}"
        );
    }
    let relationship_source = if clauses.is_empty() {
        "\t\treturn sources[k]\n".to_string()
    } else {
        format!(
            "\t\tswitch k {{\n\t\tcase {clause_keys}:\n\t\t\treturn clauseSources[k]\n\t\tdefault:\n\t\t\treturn sources[k]\n\t\t}}\n"
        )
    };
    if has_relationship_values {
        let relationship_values = if clauses.is_empty() {
            "\t\treturn argv.RelationshipValues(Meta.Lookup(k), resolved[k], sources[k], negated[k])\n".to_string()
        } else {
            format!(
                "\t\tswitch k {{\n\t\tcase {clause_keys}:\n\t\t\treturn argv.RelationshipValues(Meta.Lookup(k), clauseValues[k], clauseSources[k], false)\n\t\tdefault:\n\t\t\treturn argv.RelationshipValues(Meta.Lookup(k), resolved[k], sources[k], negated[k])\n\t\t}}\n"
            )
        };
        let _ = writeln!(
            out,
            "\tif err := argv.CheckRelationshipsWithValuesAndRequirements(Meta, scope, func(k uint64) argv.Source {{\n\
             {relationship_source}\t}}, func(k uint64) []string {{\n\
             {relationship_values}\
             \t}}, func(k uint64) bool {{ return requirements[k] }}); err != nil {{\n\t\treturn nil, err\n\t}}"
        );
    } else {
        let _ = writeln!(
            out,
            "\tif err := argv.CheckRelationshipsWithValuesAndRequirements(Meta, scope, func(k uint64) argv.Source {{\n\
             {relationship_source}\t}}, nil, func(k uint64) bool {{ return requirements[k] }}); err != nil {{\n\t\treturn nil, err\n\t}}"
        );
    }
    emit_clause_instances(out, commands, clauses, has_relationship_values);
    let _ = writeln!(out, "\treturn out, nil\n}}\n");
}

/// Validate each clause independently and append its typed value to the command field.
///
/// Clause arguments deliberately stay out of the command-wide `given` and `scope`: reusing
/// those maps would collapse repeated instances into one value and let one instance satisfy
/// another's required argument. Flags remain visible through the source/value callbacks, but
/// are not entries in this pass: flag relationships are judged once against clause values
/// aggregated across every instance, matching the reference parser.
fn emit_clause_instances(
    out: &mut String,
    commands: &[Emitted],
    clauses: &Clauses,
    has_relationship_values: bool,
) {
    for e in commands {
        let Some(fields) = clauses.get(&e.named.key) else {
            continue;
        };
        let keys = e
            .clause_args
            .iter()
            .map(|(_, named)| named.key.as_str())
            .collect::<Vec<_>>();
        let key_list = keys.join(", ");
        let owner = owner_of(e);
        let _ = writeln!(
            out,
            "\t{{\n\t\tclauseScope := []uint64{{{key_list}}}\n\
             \t\tfor _, instance := range clauseInstances[{}] {{\n\
             \t\t\tclauseSources := map[uint64]argv.Source{{}}\n\
             \t\t\tfor _, key := range clauseScope {{\n\
             \t\t\t\tvalues := instance[key]\n\
             \t\t\t\tif values != nil {{\n\t\t\t\t\tclauseSources[key] = argv.FromArgv\n\t\t\t\t}} else {{\n\t\t\t\t\tclauseSources[key] = argv.Unset\n\t\t\t\t}}\n\
             \t\t\t\tif err := argv.Check(Meta.Lookup(key), values, 0); err != nil {{\n\t\t\t\t\treturn nil, err\n\t\t\t\t}}\n\
             \t\t\t}}\n\
             \t\t\tinstanceScope := clauseScope\n",
            e.named.key
        );
        if has_relationship_values {
            let _ = writeln!(
                out,
                "\t\t\tif err := argv.CheckRelationshipsWithValuesAndRequirements(Meta, instanceScope, func(k uint64) argv.Source {{\n\
                 \t\t\t\tswitch k {{\n\t\t\t\tcase {key_list}:\n\t\t\t\t\treturn clauseSources[k]\n\t\t\t\tdefault:\n\t\t\t\t\treturn sources[k]\n\t\t\t\t}}\n\
                 \t\t\t}}, func(k uint64) []string {{\n\
                 \t\t\t\tswitch k {{\n\t\t\t\tcase {key_list}:\n\t\t\t\t\treturn argv.RelationshipValues(Meta.Lookup(k), instance[k], clauseSources[k], false)\n\t\t\t\tdefault:\n\t\t\t\t\treturn argv.RelationshipValues(Meta.Lookup(k), resolved[k], sources[k], negated[k])\n\t\t\t\t}}\n\
                 \t\t\t}}, func(k uint64) bool {{\n\
                 \t\t\t\tswitch k {{\n\t\t\t\tcase {key_list}:\n\t\t\t\t\treturn true\n\t\t\t\tdefault:\n\t\t\t\t\treturn requirements[k]\n\t\t\t\t}}\n\
                 \t\t\t}}); err != nil {{\n\t\t\t\treturn nil, err\n\t\t\t}}"
            );
        } else {
            let _ = writeln!(
                out,
                "\t\t\tif err := argv.CheckRelationshipsWithValuesAndRequirements(Meta, instanceScope, func(k uint64) argv.Source {{\n\
                 \t\t\t\tswitch k {{\n\t\t\t\tcase {key_list}:\n\t\t\t\t\treturn clauseSources[k]\n\t\t\t\tdefault:\n\t\t\t\t\treturn sources[k]\n\t\t\t\t}}\n\
                 \t\t\t}}, nil, func(k uint64) bool {{\n\
                 \t\t\t\tswitch k {{\n\t\t\t\tcase {key_list}:\n\t\t\t\t\treturn true\n\t\t\t\tdefault:\n\t\t\t\t\treturn requirements[k]\n\t\t\t\t}}\n\
                 \t\t\t}}); err != nil {{\n\t\t\t\treturn nil, err\n\t\t\t}}"
            );
        }
        let _ = writeln!(out, "\t\t\titem := {}{{}}", fields.type_name);
        for (arg, named) in &e.clause_args {
            let field = &fields.args[&named.key];
            let assign = if arg.var {
                format!("item.{field} = append(item.{field}, values...)")
            } else {
                format!("item.{field} = values[len(values)-1]")
            };
            let _ = writeln!(
                out,
                "\t\t\tif values := instance[{}]; len(values) > 0 {{\n\t\t\t\t{assign}\n\t\t\t}}",
                named.key
            );
        }
        let _ = writeln!(
            out,
            "\t\t\t{owner}.{} = append({owner}.{}, item)\n\t\t}}\n\t}}",
            fields.field, fields.field
        );
    }
}

/// The cases that put an `env` or `default` value into its field.
fn fallback_cases(out: &mut String, commands: &[Emitted], assigned: &Fields) {
    for e in commands {
        let owner = owner_of(e);
        for (flag, named) in &e.flags {
            let field = &assigned[&named.key];
            let assign = match flag_type(flag) {
                // A value-less flag has nowhere to put text, so the variable is
                // read as a yes or a no — by usage-lib's allow-list, which is
                // narrower than Go's own spellings on purpose.
                "bool" => format!(
                    "\t\t\t\tif source == argv.FromEnv {{\n\
                     \t\t\t\t\t{owner}.{field} = argv.EnvTruth(values[0])\n\
                     \t\t\t\t}} else {{\n\t\t\t\t\t{owner}.{field} = values[0] == \"true\"\n\t\t\t\t}}"
                ),
                "[]string" => {
                    format!("\t\t\t\t{owner}.{field} = append({owner}.{field}, values...)")
                }
                // A count is occurrences, which nothing but the command line has.
                "int" => continue,
                _ => format!("\t\t\t\t{owner}.{field} = values[len(values)-1]"),
            };
            let _ = writeln!(out, "\t\t\tcase {}:\n{assign}", named.key);
        }
        for (arg, named) in &e.args {
            let field = &assigned[&named.key];
            let assign = if arg.var {
                format!("\t\t\t\t{owner}.{field} = append({owner}.{field}, values...)")
            } else {
                format!("\t\t\t\t{owner}.{field} = values[len(values)-1]")
            };
            let _ = writeln!(out, "\t\t\tcase {}:\n{assign}", named.key);
        }
    }
}

/// Where a command's own entries are assigned.
fn owner_of(e: &Emitted) -> String {
    if e.root {
        "out".to_string()
    } else {
        format!("{}V", e.named.var)
    }
}

/// The index of the command that declares this one as a subcommand.
fn parent_of(commands: &[Emitted], at: usize) -> Option<usize> {
    let path = &commands[at].cmd.full_cmd;
    if path.len() <= 1 {
        return Some(0);
    }
    commands
        .iter()
        .position(|e| e.cmd.full_cmd[..] == path[..path.len() - 1])
}

fn name(e: &Emitted) -> String {
    if e.root {
        return "Cli".to_string();
    }
    format!("{}Cmd", &e.named.key["Cmd".len()..])
}

fn flag_type(flag: &SpecFlag) -> &'static str {
    match () {
        _ if flag.count => "int",
        _ if flag.arg.is_none() => "bool",
        _ if flag.var || flag.arg.as_ref().is_some_and(|a| a.var) => "[]string",
        _ => "string",
    }
}

fn arg_type(arg: &SpecArg) -> &'static str {
    if arg.var {
        "[]string"
    } else {
        "string"
    }
}

fn flag_assign(flag: &SpecFlag, owner: &str, field: &str) -> String {
    match flag_type(flag) {
        // A count is the number of occurrences, which is what the parser reports
        // one event at a time.
        "int" => format!("\t\t\t\t{owner}.{field}++"),
        "bool" if flag.bool_value => format!(
            "\t\t\t\tif ev.HasValue {{\n\t\t\t\t\t{owner}.{field} = (ev.Value == \"true\") != ev.Negated\n\t\t\t\t}} else {{\n\t\t\t\t\t{owner}.{field} = !ev.Negated\n\t\t\t\t}}"
        ),
        "bool" => format!("\t\t\t\t{owner}.{field} = !ev.Negated"),
        "[]string" => format!(
            "\t\t\t\tif ev.HasValue {{\n\t\t\t\t\t{owner}.{field} = append({owner}.{field}, argv.SplitValue(ev.Value, ev.Flag.Delimiter, true)...)\n\t\t\t\t}}"
        ),
        _ => format!("\t\t\t\t{owner}.{field} = ev.Value"),
    }
}