brink-ir 0.0.16

Intermediate representations for inkle's ink narrative scripting language
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
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
//! Semantic token classification — core moved from `brink-ide` (#3064
//! B4) so `brink-db`'s per-segment queries can call it; `brink-ide`
//! keeps the `AnalysisResult`-taking wrappers and re-exports this
//! module's types from its old paths.

use std::collections::BTreeMap;

use crate::SymbolKind;
use brink_syntax::{SyntaxKind, SyntaxNode};
use rowan::TextRange;

use crate::hir::projection::range_key;
use crate::line_index::LineIndex;

// ── Token type names (indices into this array) ──────────────────────

/// Token type names for the semantic token legend.
pub fn token_type_names() -> &'static [&'static str] {
    &[
        "namespace",  // 0  knots
        "function",   // 1  stitches, externals
        "variable",   // 2  variables
        "string",     // 3  string content
        "number",     // 4  numeric literals
        "keyword",    // 5  VAR, CONST, LIST, INCLUDE, etc.
        "operator",   // 6  ->, <-, ~, etc.
        "comment",    // 7  // and /* */
        "enum",       // 8  list names
        "enumMember", // 9  list items
        "parameter",  // 10 function/knot params
        "decorator",  // 11 tags (#)
        "label",      // 12 labels, gather names
        "struct",     // 13 STRUCT declarations (TM-4b)
        "property",   // 14 struct-field segments of a dotted field access
    ]
}

/// Token modifier names for the semantic token legend.
pub fn token_modifier_names() -> &'static [&'static str] {
    &[
        "declaration", // 1 << 0
        "definition",  // 1 << 1
        "readonly",    // 1 << 2
        "deprecated",  // 1 << 3 (future use)
    ]
}

// ── Token type indices ─────────────────────────────────────────────

pub const TT_NAMESPACE: u32 = 0;
pub const TT_FUNCTION: u32 = 1;
pub const TT_VARIABLE: u32 = 2;
pub const TT_STRING: u32 = 3;
pub const TT_NUMBER: u32 = 4;
pub const TT_KEYWORD: u32 = 5;
pub const TT_OPERATOR: u32 = 6;
pub const TT_COMMENT: u32 = 7;
pub const TT_ENUM: u32 = 8;
pub const TT_ENUM_MEMBER: u32 = 9;
pub const TT_PARAMETER: u32 = 10;
pub const TT_DECORATOR: u32 = 11;
pub const TT_LABEL: u32 = 12;
pub const TT_STRUCT: u32 = 13;
pub const TT_PROPERTY: u32 = 14;

// ── Modifier bitmasks ──────────────────────────────────────────────

pub const MOD_DECLARATION: u32 = 1 << 0;
pub const MOD_READONLY: u32 = 1 << 2;

// ── Raw token (absolute position) ──────────────────────────────────

/// A semantic token with absolute line/column position.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RawToken {
    pub line: u32,
    pub start_char: u32,
    pub length: u32,
    pub token_type: u32,
    pub modifiers: u32,
}

/// A delta-encoded semantic token.
#[derive(Debug, Clone)]
pub struct DeltaToken {
    pub delta_line: u32,
    pub delta_start: u32,
    pub length: u32,
    pub token_type: u32,
    pub token_modifiers: u32,
}

// ── Classification result ──────────────────────────────────────────

pub struct Classification {
    pub token_type: u32,
    pub modifiers: u32,
}

// ── Token classification ───────────────────────────────────────────

pub fn classify_token(
    token: &brink_syntax::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Option<Classification> {
    let kind = token.kind();

    // Skip tokens we never highlight
    if matches!(
        kind,
        SyntaxKind::WHITESPACE
            | SyntaxKind::NEWLINE
            | SyntaxKind::EOF
            | SyntaxKind::ERROR_TOKEN
            | SyntaxKind::L_PAREN
            | SyntaxKind::R_PAREN
            | SyntaxKind::L_BRACE
            | SyntaxKind::R_BRACE
            | SyntaxKind::L_BRACKET
            | SyntaxKind::R_BRACKET
            | SyntaxKind::COMMA
            | SyntaxKind::DOT
            | SyntaxKind::COLON
            | SyntaxKind::PIPE
            | SyntaxKind::BACKSLASH
            | SyntaxKind::DOLLAR
    ) {
        return None;
    }

    // A leaf whose direct parent is `TEXT` is literal prose, whatever kind
    // the shared lexer tagged it as. `text_content` (`parser/content.rs`)
    // bumps every non-structural token straight into a flat `TEXT` node —
    // no wrapping `IDENTIFIER`/`PATH`/etc — and `{expr}` interpolation
    // always breaks the run and lowers as a *sibling* node before
    // `text_content` starts (`mixed_content`'s `L_BRACE` dispatch), so a
    // `TEXT` child is never anything else. #275 first carved this out for
    // keyword lexemes alone (the word "and" in "cats and dogs"); #2293
    // generalizes it to every kind — a hyphen in "well-known", a stray
    // quote mark in dialogue, a plain word — none of it is code, so none
    // of it gets a token. Mirrors the native classifier's
    // `is_prose_run_container` carve-out below, which the same review
    // thread (#2280/#2286) already established for `.brink` files.
    if token.parent().is_some_and(|p| p.kind() == SyntaxKind::TEXT) {
        return None;
    }

    // Direct mappings by SyntaxKind
    if kind == SyntaxKind::LINE_COMMENT || kind == SyntaxKind::BLOCK_COMMENT {
        return Some(Classification {
            token_type: TT_COMMENT,
            modifiers: 0,
        });
    }

    if kind.is_keyword() {
        return Some(Classification {
            token_type: TT_KEYWORD,
            modifiers: 0,
        });
    }

    if kind == SyntaxKind::INTEGER || kind == SyntaxKind::FLOAT {
        return Some(Classification {
            token_type: TT_NUMBER,
            modifiers: 0,
        });
    }

    if matches!(
        kind,
        SyntaxKind::STRING_TEXT | SyntaxKind::STRING_ESCAPE | SyntaxKind::QUOTE
    ) {
        return Some(Classification {
            token_type: TT_STRING,
            modifiers: 0,
        });
    }

    if matches!(
        kind,
        SyntaxKind::DIVERT
            | SyntaxKind::THREAD
            | SyntaxKind::TUNNEL_ONWARDS
            | SyntaxKind::GLUE
            | SyntaxKind::TILDE
            | SyntaxKind::EQ
            | SyntaxKind::EQ_EQ
            | SyntaxKind::BANG_EQ
            | SyntaxKind::LT
            | SyntaxKind::GT
            | SyntaxKind::LT_EQ
            | SyntaxKind::GT_EQ
            | SyntaxKind::PLUS
            | SyntaxKind::MINUS
            | SyntaxKind::STAR
            | SyntaxKind::SLASH
            | SyntaxKind::PERCENT
            | SyntaxKind::CARET
            | SyntaxKind::BANG
            | SyntaxKind::QUESTION
            | SyntaxKind::BANG_QUESTION
            | SyntaxKind::AMP
            | SyntaxKind::AMP_AMP
            | SyntaxKind::PLUS_EQ
            | SyntaxKind::MINUS_EQ
    ) {
        return Some(Classification {
            token_type: TT_OPERATOR,
            modifiers: 0,
        });
    }

    if kind == SyntaxKind::HASH {
        return Some(Classification {
            token_type: TT_DECORATOR,
            modifiers: 0,
        });
    }

    // IDENT classification — context-dependent
    if kind == SyntaxKind::IDENT {
        return classify_ident(token, resolution_index);
    }

    None
}

fn classify_ident(
    token: &brink_syntax::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Option<Classification> {
    let parent = token.parent()?;
    let parent_kind = parent.kind();

    // IDENT directly in LIST_MEMBER_ON / LIST_MEMBER_OFF (no intermediate IDENTIFIER)
    if parent_kind == SyntaxKind::LIST_MEMBER_ON || parent_kind == SyntaxKind::LIST_MEMBER_OFF {
        return Some(Classification {
            token_type: TT_ENUM_MEMBER,
            modifiers: MOD_DECLARATION,
        });
    }

    // IDENT inside IDENTIFIER node — check grandparent
    if parent_kind == SyntaxKind::IDENTIFIER
        && let Some(grandparent) = parent.parent()
    {
        let gp_kind = grandparent.kind();
        return match gp_kind {
            SyntaxKind::KNOT_HEADER => Some(Classification {
                token_type: TT_NAMESPACE,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::STITCH_HEADER | SyntaxKind::EXTERNAL_DECL => Some(Classification {
                token_type: TT_FUNCTION,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::KNOT_PARAM_DECL => Some(Classification {
                token_type: TT_PARAMETER,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::LABEL => Some(Classification {
                token_type: TT_LABEL,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::VAR_DECL | SyntaxKind::TEMP_DECL => Some(Classification {
                token_type: TT_VARIABLE,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::CONST_DECL => Some(Classification {
                token_type: TT_VARIABLE,
                modifiers: MOD_DECLARATION | MOD_READONLY,
            }),
            SyntaxKind::LIST_DECL => Some(Classification {
                token_type: TT_ENUM,
                modifiers: MOD_DECLARATION,
            }),
            SyntaxKind::FUNCTION_CALL => Some(Classification {
                token_type: TT_FUNCTION,
                modifiers: 0,
            }),
            // PATH or other contexts — try resolution index
            _ => Some(classify_ident_by_resolution(token, resolution_index)),
        };
    }

    // Fallback: try resolution index
    Some(classify_ident_by_resolution(token, resolution_index))
}

fn classify_ident_by_resolution(
    token: &brink_syntax::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Classification {
    // Try the token's own range first
    if let Some(&sym_kind) = resolution_index.get(&range_key(token.text_range())) {
        return symbol_kind_to_classification(sym_kind);
    }

    // Try the parent IDENTIFIER node range (resolutions may use the node range)
    let Some(parent) = token.parent() else {
        return GENERIC_VARIABLE;
    };
    if parent.kind() == SyntaxKind::IDENTIFIER
        && let Some(&sym_kind) = resolution_index.get(&range_key(parent.text_range()))
    {
        return symbol_kind_to_classification(sym_kind);
    }

    // Try the enclosing PATH node's range. A dotted reference's resolution is
    // recorded against the *whole* path (`brink_ir::ResolvedRef::range`'s
    // load-bearing whole-path contract, pinned by #1561), so this is the only
    // range a segment of `p.x.y` / `Colors.Red` can be looked up by. The
    // segment tokens sit directly under `PATH` in some shapes and inside an
    // `IDENTIFIER` wrapper in others, so both are accepted.
    let path = if parent.kind() == SyntaxKind::PATH {
        Some(parent.clone())
    } else if parent.kind() == SyntaxKind::IDENTIFIER {
        parent.parent().filter(|gp| gp.kind() == SyntaxKind::PATH)
    } else {
        None
    };
    if let Some(path) = path
        && let Some(&sym_kind) = resolution_index.get(&range_key(path.text_range()))
    {
        return classify_path_segment(&path, token, sym_kind);
    }

    GENERIC_VARIABLE
}

/// The classification for an identifier no resolution accounts for.
const GENERIC_VARIABLE: Classification = Classification {
    token_type: TT_VARIABLE,
    modifiers: 0,
};

/// Classify one segment of a dotted `PATH` whose *whole* range carries the
/// resolution `sym_kind` (issue #1571).
///
/// Only ONE segment of such a path actually names the resolved symbol —
/// handing `sym_kind`'s colour to all of them rendered `p.x.y` as a single
/// flat `variable` run. Which segment it is depends on the kind, exactly as
/// it does for `rename`'s range narrowing (`ufcs_hover`'s
/// `field_access_head_range_at_path` vs `qualified_tail_range_at_path`):
///
/// - a **value** (`Variable`/`Constant`/`Param`/`Temp`) is named by the
///   *head* — `p` in `p.x.y` (`resolve::lookup_variable` step 11) — and the
///   trailing segments are struct field names, so they get `property`;
/// - a **stitch**, **list item** or **label** is named by the *tail* —
///   `market` in `hub.market`, `Red` in `Colors.Red` — and the leading
///   segments are qualifiers this pass cannot resolve on their own, so they
///   keep the unresolved-identifier fallback;
/// - every other kind resolves from a single-segment path, where head and
///   tail are the same token.
fn classify_path_segment(
    path: &SyntaxNode,
    token: &brink_syntax::SyntaxToken,
    sym_kind: SymbolKind,
) -> Classification {
    let named_by_tail = matches!(
        sym_kind,
        SymbolKind::Stitch | SymbolKind::ListItem | SymbolKind::Label
    );
    let segments: Vec<TextRange> = path
        .descendants_with_tokens()
        .filter_map(rowan::NodeOrToken::into_token)
        .filter(|t| t.kind() == SyntaxKind::IDENT)
        .map(|t| t.text_range())
        .collect();
    let naming = if named_by_tail {
        segments.last()
    } else {
        segments.first()
    };
    if naming == Some(&token.text_range()) {
        return symbol_kind_to_classification(sym_kind);
    }
    if named_by_tail {
        return GENERIC_VARIABLE;
    }
    Classification {
        token_type: TT_PROPERTY,
        modifiers: 0,
    }
}

fn symbol_kind_to_classification(kind: SymbolKind) -> Classification {
    match kind {
        SymbolKind::Knot => Classification {
            token_type: TT_NAMESPACE,
            modifiers: 0,
        },
        SymbolKind::Stitch | SymbolKind::External => Classification {
            token_type: TT_FUNCTION,
            modifiers: 0,
        },
        SymbolKind::Variable | SymbolKind::Temp => Classification {
            token_type: TT_VARIABLE,
            modifiers: 0,
        },
        SymbolKind::Constant => Classification {
            token_type: TT_VARIABLE,
            modifiers: MOD_READONLY,
        },
        SymbolKind::List => Classification {
            token_type: TT_ENUM,
            modifiers: 0,
        },
        SymbolKind::ListItem => Classification {
            token_type: TT_ENUM_MEMBER,
            modifiers: 0,
        },
        SymbolKind::Label => Classification {
            token_type: TT_LABEL,
            modifiers: 0,
        },
        SymbolKind::Param => Classification {
            token_type: TT_PARAMETER,
            modifiers: 0,
        },
        SymbolKind::Struct => Classification {
            token_type: TT_STRUCT,
            modifiers: 0,
        },
    }
}

// ── Native (`.brink`) token classification (issue #2280) ───────────
//
// `brink_syntax_native::SyntaxKind` is a peer enum with its own discriminant
// space (NF-1 ruling) — a native file's tokens are never `brink_syntax`
// values, so they need their own classifier rather than an extra arm on
// [`classify_token`]. `symbol_kind_to_classification`/`GENERIC_VARIABLE`
// above are frontend-agnostic (they dispatch on `brink_ir::SymbolKind`, not
// on either `SyntaxKind`), so both classifiers share them.

/// Node kinds whose parser raw-bumps arbitrary source text into one CST
/// node, regardless of what the shared lexer tagged each byte as: `TEXT`
/// (`content::text_run_until`), `CUE_NAME` (`element::cue_name`), `TAG`
/// (`content::tag`), and `SCENE_TITLE` (`element::scene_title`). A leaf
/// whose direct parent is one of these is literal prose — a keyword
/// lexeme, a `-`, or a digit run inside one of them is text, never a
/// keyword/operator/number (review finding on #2280/#2286: the original
/// "absorbed into prose" carve-out only checked `TEXT`, missing the three
/// other raw-bump runs the native grammar introduced).
fn is_prose_run_container(kind: brink_syntax_native::SyntaxKind) -> bool {
    use brink_syntax_native::SyntaxKind as NK;
    matches!(kind, NK::TEXT | NK::CUE_NAME | NK::TAG | NK::SCENE_TITLE)
}

pub fn classify_native_token(
    token: &brink_syntax_native::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Option<Classification> {
    use brink_syntax_native::SyntaxKind as NK;
    let kind = token.kind();

    // A leaf directly under a string-shaped literal — colour the whole
    // literal uniformly, however the shared lexer tagged this particular
    // byte. `lexer::lex_string_token` always emits `[`/`]`/`<>` as their own
    // punctuation kind even in string mode ("so the parser can find
    // choice-bracket boundaries... regardless of context, mirroring ink"),
    // so a plain string/attribute value with no such structural meaning
    // still gets these as literal children — e.g. a regex character class
    // `[A-Z]` inside a quoted string. Checked before anything else so it
    // wins over the "tokens we never highlight" skip list below (`[`/`]`
    // would otherwise vanish instead of reading as string content).
    // `SPAN_ATTR_VALUE` shares the same STRING_TEXT/STRING_ESCAPE/QUOTE
    // token shape (deliberately with no INTERPOLATION arm, so this is safe
    // unconditionally). `STRING_LIT`'s own INTERPOLATION child (`{expr}`)
    // is a distinct node one level down — its own descendants have a
    // different immediate parent, so they fall through and classify
    // normally as an expression, not as string text.
    if token
        .parent()
        .is_some_and(|p| matches!(p.kind(), NK::STRING_LIT | NK::SPAN_ATTR_VALUE))
    {
        return Some(Classification {
            token_type: TT_STRING,
            modifiers: 0,
        });
    }

    // Skip tokens we never highlight (mirrors `classify_token`'s ink list).
    if matches!(
        kind,
        NK::WHITESPACE
            | NK::NEWLINE
            | NK::EOF
            | NK::ERROR_TOKEN
            | NK::L_PAREN
            | NK::R_PAREN
            | NK::L_BRACE
            | NK::R_BRACE
            | NK::L_BRACKET
            | NK::R_BRACKET
            | NK::COMMA
            | NK::DOT
            | NK::COLON
            | NK::COLON_COLON
            | NK::SEMICOLON
            | NK::PIPE
            | NK::BACKSLASH
    ) {
        return None;
    }

    if matches!(
        kind,
        NK::LINE_COMMENT | NK::BLOCK_COMMENT | NK::DOC_COMMENT_OUTER | NK::DOC_COMMENT_INNER
    ) {
        return Some(Classification {
            token_type: TT_COMMENT,
            modifiers: 0,
        });
    }

    if kind.is_keyword() {
        // Native hard-reserves keywords everywhere at the lexer (Finding #1,
        // `syntax_kind.rs`'s keyword-section doc) — unlike ink, a prose word
        // that happens to spell a keyword (`or`, `if`, ...) still lexes as
        // that keyword token. The *parser* is what decides a run is prose,
        // folding such tokens into a `TEXT` node exactly as it does the
        // `@`/`AT` sigil (`SyntaxKind::AT`'s doc) — so the same "absorbed
        // into TEXT" guard ink's `classify_token` uses for #275 applies here
        // too, just for a different reason. Extended to every raw-bump run,
        // not only `TEXT` — `@THE END:`'s `CUE_NAME` lexes `END` as
        // `KW_END`, and a `#if only` tag lexes `if` as `KW_IF`; both are a
        // character name / tag text, not a keyword (review finding on
        // #2280/#2286).
        if token
            .parent()
            .is_some_and(|p| is_prose_run_container(p.kind()))
        {
            return None;
        }
        return Some(Classification {
            token_type: TT_KEYWORD,
            modifiers: 0,
        });
    }

    if kind == NK::AT {
        // The bare `@` sigil only means something when it opens a cue
        // (`SyntaxKind::AT`'s doc: "anywhere else... it folds into plain
        // TEXT"). A detached `@ 5pm` in prose sits directly under `TEXT`,
        // same shape as the keyword carve-out above — check the same way.
        return token
            .parent()
            .filter(|p| matches!(p.kind(), NK::CUE | NK::COMPACT_CUE))
            .map(|_| Classification {
                token_type: TT_DECORATOR,
                modifiers: 0,
            });
    }

    if kind == NK::IDENT {
        return classify_native_ident(token, resolution_index);
    }

    // Any other punctuation inside a raw-bump prose container is literal
    // text — never an operator, a divert, or a number.
    // `classify_native_fixed_kind` below has no parent access at all, so it
    // cannot tell these apart from a real token of the same kind on its
    // own; check parent-awareness here first. Originally scoped to just
    // `MINUS | INTEGER | FLOAT` (`INT. HALL - DAY`'s `-`, `@JEAN-LUC`'s `-`;
    // review finding on #2280/#2286, the same hole as the keyword
    // carve-out above). #2293 widens it to every kind reaching this point:
    // `text_run_until`'s stop set doesn't exclude `!`/`?`/`=`/etc, so
    // "Wait! Really?" inside `TEXT` still hit the operator arm below, and
    // `tag()`'s raw-bump loop is even less restrictive — it doesn't stop on
    // `DIVERT`/`GLUE` either, so a `#tag -> text` tag body could still
    // paint `->` as an operator.
    //
    // `HASH`/`AT_L_BRACKET` are exempted: `tag()` (`content.rs`) makes
    // `HASH` a *direct child of `TAG`* — the same node this guard treats as
    // a prose container — so the sigil itself would otherwise be swallowed
    // as prose and never reach `classify_native_fixed_kind`'s decorator arm
    // below (review finding on #2293: the widened guard regressed every
    // tag's own `#`/`@[` sigil colour, which #2280/#2286 had established).
    // The sigil is structure, not prose — only the *text after* it is.
    if !matches!(kind, NK::HASH | NK::AT_L_BRACKET)
        && token
            .parent()
            .is_some_and(|p| is_prose_run_container(p.kind()))
    {
        return None;
    }

    classify_native_fixed_kind(kind)
}

/// The context-free half of [`classify_native_token`] — every `SyntaxKind`
/// whose colour never depends on where the token sits in the tree. Split out
/// only to keep each function under the pedantic line-count lint; there is
/// no semantic reason these couldn't be one big `match`.
fn classify_native_fixed_kind(kind: brink_syntax_native::SyntaxKind) -> Option<Classification> {
    use brink_syntax_native::SyntaxKind as NK;

    if matches!(kind, NK::INTEGER | NK::FLOAT) {
        return Some(Classification {
            token_type: TT_NUMBER,
            modifiers: 0,
        });
    }

    if matches!(kind, NK::STRING_TEXT | NK::STRING_ESCAPE | NK::QUOTE) {
        return Some(Classification {
            token_type: TT_STRING,
            modifiers: 0,
        });
    }

    if matches!(
        kind,
        NK::DIVERT
            | NK::THREAD
            | NK::GLUE
            | NK::TILDE
            | NK::EQ
            | NK::EQ_EQ
            | NK::BANG_EQ
            | NK::LT
            | NK::GT
            | NK::LT_EQ
            | NK::GT_EQ
            | NK::PLUS
            | NK::MINUS
            | NK::STAR
            | NK::SLASH
            | NK::PERCENT
            | NK::CARET
            | NK::BANG
            | NK::QUESTION
            | NK::AMP
            | NK::AMP_AMP
            | NK::PLUS_EQ
            | NK::MINUS_EQ
            | NK::STAR_EQ
            | NK::SLASH_EQ
            | NK::FAT_ARROW
    ) {
        return Some(Classification {
            token_type: TT_OPERATOR,
            modifiers: 0,
        });
    }

    if kind == NK::HASH || kind == NK::AT_L_BRACKET {
        return Some(Classification {
            token_type: TT_DECORATOR,
            modifiers: 0,
        });
    }

    None
}

fn classify_native_ident(
    token: &brink_syntax_native::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Option<Classification> {
    use brink_syntax_native::SyntaxKind as NK;
    let parent = token.parent()?;

    match parent.kind() {
        NK::STRUCT_DECL => Some(Classification {
            token_type: TT_STRUCT,
            modifiers: MOD_DECLARATION,
        }),
        NK::FLOW_DECL | NK::MODULE_DECL => Some(Classification {
            token_type: TT_NAMESPACE,
            modifiers: MOD_DECLARATION,
        }),
        // `SCENE_SLUG` shares this arm deliberately: `[slug]` on a scene
        // heading names the stitch the heading declares (`element::
        // scene_stitch`'s doc: "a heading declares a stitch"), so it is the
        // same classification as any other stitch header (review finding on
        // #2280/#2286). Kept folded in rather than as its own identical arm —
        // clippy's `match_same_arms` denies the duplicate.
        NK::FN_DECL | NK::EXTERN_DECL | NK::SCENE_SLUG => Some(Classification {
            token_type: TT_FUNCTION,
            modifiers: MOD_DECLARATION,
        }),
        NK::PARAM => Some(Classification {
            token_type: TT_PARAMETER,
            modifiers: MOD_DECLARATION,
        }),
        NK::VAR_DECL | NK::LET_STMT => Some(Classification {
            token_type: TT_VARIABLE,
            modifiers: MOD_DECLARATION,
        }),
        NK::CONST_DECL => Some(Classification {
            token_type: TT_VARIABLE,
            modifiers: MOD_DECLARATION | MOD_READONLY,
        }),
        NK::FLAGS_DECL => Some(Classification {
            token_type: TT_ENUM,
            modifiers: MOD_DECLARATION,
        }),
        NK::FLAGS_MEMBER => Some(Classification {
            token_type: TT_ENUM_MEMBER,
            modifiers: MOD_DECLARATION,
        }),
        NK::STRUCT_FIELD => Some(Classification {
            token_type: TT_PROPERTY,
            modifiers: MOD_DECLARATION,
        }),
        // `LABEL`: `(name)` — a choice/gather label. `CUE_NAME`: the name
        // inside an `@NAME`/`@NAME:` block cue — both are named markers, so
        // they share `label`.
        NK::LABEL | NK::CUE_NAME => Some(Classification {
            token_type: TT_LABEL,
            modifiers: MOD_DECLARATION,
        }),
        // A type reference — the fixed-set built-ins (`int`, `string`, ...)
        // have no resolvable symbol at all, and a user `struct` name here is
        // a *use*, not the declaration `STRUCT_DECL` matches above — reuse
        // `struct`, the legend's closest entry to "type" (issue #2280's
        // table: "string -> type", and no dedicated `type` token exists).
        NK::TYPE_NAME | NK::TYPE_GENERIC => Some(Classification {
            token_type: TT_STRUCT,
            modifiers: 0,
        }),
        // `!name rest…` self-announcing dispatch sigil.
        NK::DISPATCH_NAME => Some(Classification {
            token_type: TT_FUNCTION,
            modifiers: 0,
        }),
        // `@[name(...)]` — the annotation's own name.
        NK::ANNOTATION_LINE => Some(Classification {
            token_type: TT_DECORATOR,
            modifiers: 0,
        }),
        // `@[...(arg, name = value, ...)]` — one argument's name.
        NK::ANNOTATION_ARG => Some(Classification {
            token_type: TT_PARAMETER,
            modifiers: 0,
        }),
        // `INT. TITLE - DAY` — the heading's display name. Narrative text,
        // not a symbol reference; without this arm every word fell through
        // to the resolution fallback below and rendered as a plain
        // `variable` — precisely #2280's own worked example (review finding
        // on #2280/#2286). `TEXT`/`TAG` are the same story for plain
        // dialogue/narration and `#tag` text: #2286 only closed this gap for
        // `SCENE_TITLE`, so a run-of-the-mill prose word (or a tag's own
        // text) still fell through to `variable` — the exact remainder
        // issue #2293 flagged, now folded into the same arm.
        NK::TEXT | NK::TAG | NK::SCENE_TITLE => None,
        // `PATH`/other contexts — try the resolution index.
        _ => Some(classify_native_ident_by_resolution(token, resolution_index)),
    }
}

fn classify_native_ident_by_resolution(
    token: &brink_syntax_native::SyntaxToken,
    resolution_index: &BTreeMap<(u32, u32), SymbolKind>,
) -> Classification {
    use brink_syntax_native::SyntaxKind as NK;

    // Try the token's own range first.
    if let Some(&sym_kind) = resolution_index.get(&range_key(token.text_range())) {
        return symbol_kind_to_classification(sym_kind);
    }

    // Try the immediate `PATH_SEGMENT` wrapper's range — native wraps every
    // path segment (even a single-segment path) in its own `PATH_SEGMENT`
    // node directly around the `IDENT` (no ink-style extra `IDENTIFIER`
    // indirection).
    let Some(parent) = token.parent() else {
        return GENERIC_VARIABLE;
    };
    if parent.kind() == NK::PATH_SEGMENT
        && let Some(&sym_kind) = resolution_index.get(&range_key(parent.text_range()))
    {
        return symbol_kind_to_classification(sym_kind);
    }

    // Try the enclosing `PATH` node's range — a dotted reference's
    // resolution is recorded against the *whole* path
    // (`brink_ir::ResolvedRef::range`'s frontend-agnostic, load-bearing
    // whole-path contract, pinned by #1561 for ink and confirmed to hold
    // identically for native by this issue's own decode probe).
    let path = if parent.kind() == NK::PATH {
        Some(parent.clone())
    } else if parent.kind() == NK::PATH_SEGMENT {
        parent.parent().filter(|gp| gp.kind() == NK::PATH)
    } else {
        None
    };
    if let Some(path) = path
        && let Some(&sym_kind) = resolution_index.get(&range_key(path.text_range()))
    {
        return classify_native_path_segment(&path, token, sym_kind);
    }

    GENERIC_VARIABLE
}

/// The native sibling of [`classify_path_segment`] — same "only one segment
/// actually names the resolved symbol" logic, over native's `PATH`/
/// `PATH_SEGMENT`/`IDENT` shape instead of ink's `PATH`/`IDENTIFIER`/`IDENT`.
fn classify_native_path_segment(
    path: &brink_syntax_native::SyntaxNode,
    token: &brink_syntax_native::SyntaxToken,
    sym_kind: SymbolKind,
) -> Classification {
    let named_by_tail = matches!(
        sym_kind,
        SymbolKind::Stitch | SymbolKind::ListItem | SymbolKind::Label
    );
    let segments: Vec<TextRange> = path
        .descendants_with_tokens()
        .filter_map(rowan::NodeOrToken::into_token)
        .filter(|t| t.kind() == brink_syntax_native::SyntaxKind::IDENT)
        .map(|t| t.text_range())
        .collect();
    let naming = if named_by_tail {
        segments.last()
    } else {
        segments.first()
    };
    if naming == Some(&token.text_range()) {
        return symbol_kind_to_classification(sym_kind);
    }
    if named_by_tail {
        return GENERIC_VARIABLE;
    }
    Classification {
        token_type: TT_PROPERTY,
        modifiers: 0,
    }
}

// ── Multi-line splitting ───────────────────────────────────────────

/// Generic over the rowan `Language` so both the ink (`brink_syntax`) and
/// native (`brink_syntax_native`) frontends share one line-splitting
/// implementation — the two `SyntaxKind` enums differ, but `text()`/
/// `text_range()` are plain `rowan::SyntaxToken<L>` methods.
pub fn emit_token<L: rowan::Language>(
    token: &rowan::SyntaxToken<L>,
    classification: &Classification,
    idx: &LineIndex,
    out: &mut Vec<RawToken>,
) {
    let text = token.text();
    let start_offset = token.text_range().start();

    // Fast path: single-line token
    if !text.contains('\n') {
        let (line, start_char) = idx.line_col(start_offset);
        let length = utf16_len(text);
        out.push(RawToken {
            line,
            start_char,
            length,
            token_type: classification.token_type,
            modifiers: classification.modifiers,
        });
        return;
    }

    // Multi-line: split by newlines
    let segments: Vec<&str> = text.split('\n').collect();
    let num_segments = segments.len();
    let mut byte_offset = u32::from(start_offset);
    for (i, segment) in segments.iter().enumerate() {
        if segment.is_empty() && i > 0 {
            // Empty line segment after split — skip but advance offset
            byte_offset += 1; // for the \n
            continue;
        }
        let (line, start_char) = idx.line_col(rowan::TextSize::from(byte_offset));
        let length = utf16_len(segment);
        if length > 0 {
            out.push(RawToken {
                line,
                start_char,
                length,
                token_type: classification.token_type,
                modifiers: classification.modifiers,
            });
        }
        // Advance past this segment + the \n separator
        byte_offset += u32::try_from(segment.len()).unwrap_or(u32::MAX);
        if i < num_segments - 1 {
            byte_offset += 1; // \n
        }
    }
}

fn utf16_len(s: &str) -> u32 {
    s.chars()
        .map(|c| u32::try_from(c.len_utf16()).unwrap_or(1))
        .sum()
}

// ── Delta encoding ─────────────────────────────────────────────────

/// Delta-encode raw tokens into relative positions.
pub fn delta_encode(raw_tokens: &[RawToken]) -> Vec<DeltaToken> {
    let mut result = Vec::with_capacity(raw_tokens.len());
    let mut prev_line = 0u32;
    let mut prev_start = 0u32;

    for tok in raw_tokens {
        let delta_line = tok.line - prev_line;
        let delta_start = if delta_line == 0 {
            tok.start_char - prev_start
        } else {
            tok.start_char
        };

        result.push(DeltaToken {
            delta_line,
            delta_start,
            length: tok.length,
            token_type: tok.token_type,
            token_modifiers: tok.modifiers,
        });

        prev_line = tok.line;
        prev_start = tok.start_char;
    }

    result
}

// ── Public API ─────────────────────────────────────────────────────

/// Walk one ink CST emitting classified tokens against a range-keyed
/// resolution-kind map (#3064 B4). The map's keys are `(start, end)`
/// tuples in the SAME coordinate space as `root`/`source` — whole-file
/// callers pass absolute keys, per-segment callers fragment-relative
/// ones. Positions in the returned tokens are line/column within
/// `source`.
#[must_use]
pub fn tokens_with_kinds(
    source: &str,
    root: &brink_syntax::SyntaxNode,
    kinds: &BTreeMap<(u32, u32), SymbolKind>,
) -> Vec<RawToken> {
    let idx = LineIndex::new(source);
    let mut raw_tokens = Vec::new();
    for element in root.descendants_with_tokens() {
        let token = match element {
            rowan::NodeOrToken::Token(t) => t,
            rowan::NodeOrToken::Node(_) => continue,
        };
        if let Some(classification) = classify_token(&token, kinds) {
            emit_token(&token, &classification, &idx, &mut raw_tokens);
        }
    }
    raw_tokens
}

/// The native sibling of [`tokens_with_kinds`].
#[must_use]
pub fn tokens_with_kinds_native(
    source: &str,
    root: &brink_syntax_native::SyntaxNode,
    kinds: &BTreeMap<(u32, u32), SymbolKind>,
) -> Vec<RawToken> {
    let idx = LineIndex::new(source);
    let mut raw_tokens = Vec::new();
    for element in root.descendants_with_tokens() {
        let token = match element {
            rowan::NodeOrToken::Token(t) => t,
            rowan::NodeOrToken::Node(_) => continue,
        };
        if let Some(classification) = classify_native_token(&token, kinds) {
            emit_token(&token, &classification, &idx, &mut raw_tokens);
        }
    }
    raw_tokens
}