bl4-ncs 0.8.4

NCS (Nexus Config Store) parser for Borderlands 4
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
//! Table data decode loop
//!
//! Implements the NCS table data decode algorithm: tables → records → entries.

use crate::bit_reader::{bit_width, BitRead, BitReader};
use crate::document::{DepEntry, Document, Entry, Record, Table, Tag, Value};
use crate::parse::remap::FixedWidthIntArray;
use std::collections::HashMap;

enum NodeKind {
    Null,
    Leaf,
    Array,
    Map,
}

impl NodeKind {
    fn from_bits(bits: u32) -> Self {
        match bits & 3 {
            0 => Self::Null,
            1 => Self::Leaf,
            2 => Self::Array,
            3 => Self::Map,
            _ => unreachable!(),
        }
    }
}

struct NodeType {
    kind: NodeKind,
    carries_key: bool,
}

impl NodeType {
    fn from_flags(flags: u32) -> Self {
        let kind = NodeKind::from_bits(flags);
        let carries_key = matches!(kind, NodeKind::Map) || (flags & 0x80) != 0;
        Self { kind, carries_key }
    }
}

/// All string tables and precomputed bit widths needed during decoding
struct DecodeContext<'a> {
    value_strings: &'a [String],
    value_kinds: &'a [String],
    key_strings: &'a [String],
    header_index_bits: u8,
    value_index_bits: u8,
    value_kind_bits: u8,
    key_index_bits: u8,
    type_index_bits: u8,
    node_types: Vec<NodeType>,
}

/// Per-table remap and dependency state
struct TableContext<'a> {
    pair_remap: Option<&'a FixedWidthIntArray>,
    value_remap: Option<&'a FixedWidthIntArray>,
    dep_names: Vec<String>,
    dep_index_bits: u8,
}

/// Resolve a remap: use the remap's bit width if active, otherwise the default
fn remap_index(remap: Option<&FixedWidthIntArray>, raw: u32, default_bits: u8) -> (u8, u32) {
    match remap {
        Some(r) if r.is_active() => (r.index_bit_width, r.remap(raw).unwrap_or(raw)),
        _ => (default_bits, raw),
    }
}

/// Read a key string using the pair_vec remap
fn read_pair_vec_string(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    remap: Option<&FixedWidthIntArray>,
) -> Option<String> {
    let (bits, _) = remap_index(remap, 0, ctx.key_index_bits);
    let raw_index = reader.read_bits(bits)?;
    let (_, mapped) = remap_index(remap, raw_index, ctx.key_index_bits);

    if (mapped as usize) < ctx.key_strings.len() {
        Some(ctx.key_strings[mapped as usize].clone())
    } else {
        Some(format!("<key:{}>", mapped))
    }
}

/// Read a leaf value string using the value_string remap + kind
fn read_value(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    value_remap: Option<&FixedWidthIntArray>,
) -> Option<String> {
    let (bits, _) = remap_index(value_remap, 0, ctx.value_index_bits);
    let raw_index = reader.read_bits(bits)?;
    let kind_index = reader.read_bits(ctx.value_kind_bits)? as usize;
    let (_, mapped) = remap_index(value_remap, raw_index, ctx.value_index_bits);
    let value_index = mapped as usize;

    let value = ctx
        .value_strings
        .get(value_index)
        .cloned()
        .unwrap_or_default();

    let type_name = ctx
        .value_kinds
        .get(kind_index)
        .map(|s| s.as_str())
        .unwrap_or("");

    if type_name.is_empty() {
        Some(value)
    } else {
        Some(format!("{}'{}'", type_name, value))
    }
}

/// Decode a node recursively based on type flags
fn decode_node(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
) -> Option<Value> {
    let type_index = reader.read_bits(ctx.type_index_bits)? as usize;
    let node_type = ctx.node_types.get(type_index).unwrap_or(&NodeType {
        kind: NodeKind::Null,
        carries_key: false,
    });

    let self_key = if node_type.carries_key {
        read_pair_vec_string(reader, ctx, tctx.pair_remap)?
    } else {
        String::new()
    };

    let value = decode_node_value(reader, ctx, tctx, record_end_bit, &node_type.kind)?;
    wrap_with_self_key(self_key, value)
}

/// Decode the value portion of a node based on kind
fn decode_node_value(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
    kind: &NodeKind,
) -> Option<Value> {
    match kind {
        NodeKind::Null => Some(Value::Null),
        NodeKind::Leaf => Some(Value::Leaf(read_value(reader, ctx, tctx.value_remap)?)),
        NodeKind::Array => {
            let mut arr = Vec::new();
            while reader.position() < record_end_bit {
                if !reader.read_bit()? {
                    break;
                }
                arr.push(decode_node(reader, ctx, tctx, record_end_bit)?);
            }
            Some(Value::Array(arr))
        }
        NodeKind::Map => {
            let mut map = HashMap::new();
            while reader.position() < record_end_bit {
                if !reader.read_bit()? {
                    break;
                }
                let k = read_pair_vec_string(reader, ctx, tctx.pair_remap)?;
                let v = decode_node(reader, ctx, tctx, record_end_bit)?;
                map.insert(k, v);
            }
            Some(Value::Map(map))
        }
    }
}

/// Wrap a value with a self_key if present and non-trivial
fn wrap_with_self_key(self_key: String, value: Value) -> Option<Value> {
    if !self_key.is_empty() && !self_key.eq_ignore_ascii_case("none") {
        let mut wrapper = HashMap::new();
        wrapper.insert(self_key, value);
        Some(Value::Map(wrapper))
    } else {
        Some(value)
    }
}

/// Read a packed name list (used by tags d/e/f)
fn read_packed_name_list(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    pair_remap: Option<&FixedWidthIntArray>,
) -> Option<Vec<String>> {
    let mut list = Vec::new();
    for _ in 0..4096 {
        let s = read_pair_vec_string(reader, ctx, pair_remap)?;
        if s.is_empty() || s.eq_ignore_ascii_case("none") {
            break;
        }
        list.push(s);
    }
    Some(list)
}

/// Read an entry or dep_entry value based on a 2-bit opcode
fn decode_op_value(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
    op: u32,
) -> Option<Value> {
    match op {
        1 => Some(Value::Null),
        2 => decode_node(reader, ctx, tctx, record_end_bit),
        3 => {
            let ref_str = read_pair_vec_string(reader, ctx, tctx.pair_remap)?;
            Some(Value::Ref { r#ref: ref_str })
        }
        _ => Some(Value::Null),
    }
}

/// Parse record tags until 'z' marker, capturing metadata
fn parse_tags(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
) -> Vec<Tag> {
    let mut tags = Vec::new();

    while reader.position() + 8 <= record_end_bit {
        let Some(tag_byte) = reader.read_bits(8) else {
            break;
        };
        let tag_byte = tag_byte as u8;
        if tag_byte == b'z' {
            break;
        }

        let tag = match tag_byte {
            b'a' => {
                read_pair_vec_string(reader, ctx, tctx.pair_remap).map(|pair| Tag::KeyName { pair })
            }
            b'b' => reader.read_bits(32).map(|value| Tag::U32 { value }),
            b'c' => reader.read_bits(32).map(|u32_value| {
                let f32_value = f32::from_bits(u32_value);
                Tag::F32 {
                    u32_value,
                    f32_value,
                }
            }),
            b'd' => read_packed_name_list(reader, ctx, tctx.pair_remap)
                .map(|list| Tag::NameListD { list }),
            b'e' => read_packed_name_list(reader, ctx, tctx.pair_remap)
                .map(|list| Tag::NameListE { list }),
            b'f' => read_packed_name_list(reader, ctx, tctx.pair_remap)
                .map(|list| Tag::NameListF { list }),
            b'p' => decode_node(reader, ctx, tctx, record_end_bit)
                .map(|variant| Tag::Variant { variant }),
            _ => break,
        };

        match tag {
            Some(t) => tags.push(t),
            None => break,
        }
    }

    tags
}

/// Parse entries from a record's entry section
fn parse_entries(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
) -> Vec<Entry> {
    let mut entries = Vec::new();

    while reader.position() + 2 <= record_end_bit {
        let Some(op) = reader.read_bits(2) else {
            break;
        };
        if op == 0 {
            break;
        }

        let Some(key) = read_pair_vec_string(reader, ctx, tctx.pair_remap) else {
            break;
        };
        let Some(value) = decode_op_value(reader, ctx, tctx, record_end_bit, op) else {
            break;
        };

        let dep_entries = parse_dep_entries(reader, ctx, tctx, record_end_bit);

        entries.push(Entry {
            key,
            value,
            dep_entries,
        });
    }

    entries
}

/// Parse dependency entries following a main entry
fn parse_dep_entries(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
    record_end_bit: usize,
) -> Vec<DepEntry> {
    if tctx.dep_names.is_empty() {
        return Vec::new();
    }

    let mut dep_entries = Vec::new();

    while reader.position() + 2 <= record_end_bit {
        let Some(dep_op) = reader.read_bits(2) else {
            break;
        };
        if dep_op == 0 {
            break;
        }

        let Some(dep_key) = read_pair_vec_string(reader, ctx, tctx.pair_remap) else {
            break;
        };
        let dep_index = if tctx.dep_index_bits > 0 {
            reader.read_bits(tctx.dep_index_bits).unwrap_or(0)
        } else {
            0
        };

        let dep_table_name = tctx
            .dep_names
            .get(dep_index as usize)
            .cloned()
            .unwrap_or_default();

        let Some(dep_value) = decode_op_value(reader, ctx, tctx, record_end_bit, dep_op) else {
            break;
        };

        dep_entries.push(DepEntry {
            dep_table_name,
            dep_index,
            key: dep_key,
            value: dep_value,
        });
    }

    dep_entries
}

/// Parse all records from a table's record section
fn parse_records(
    reader: &mut impl BitRead,
    ctx: &DecodeContext,
    tctx: &TableContext,
) -> Vec<Record> {
    let mut records = Vec::new();

    loop {
        reader.align_byte();
        if !reader.has_bits(32) {
            break;
        }

        let record_start = reader.position();
        let Some(record_len_bytes) = reader.read_bits(32) else {
            break;
        };
        if record_len_bytes == 0 {
            if reader.has_bits(8) {
                reader.read_bits(8);
            }
            break;
        }

        let record_end_bit = (record_start + record_len_bytes as usize * 8) & !7;
        if record_end_bit > reader.total_bits() {
            break;
        }

        let tags = parse_tags(reader, ctx, tctx, record_end_bit);
        let entries = parse_entries(reader, ctx, tctx, record_end_bit);

        if reader.position() < record_end_bit {
            reader.seek(record_end_bit);
        }

        records.push(Record { tags, entries });
    }

    records
}

/// Input configuration for the decode loop
pub struct DecodeInput<'a> {
    pub data: &'a [u8],
    pub header_strings: &'a [String],
    pub value_strings: &'a [String],
    pub value_strings_declared: u32,
    pub value_kinds: &'a [String],
    pub value_kinds_declared: u32,
    pub key_strings: &'a [String],
    pub key_strings_declared: u32,
    pub row_flags: &'a [u32],
    pub binary_offset: usize,
}

/// Decode all table data from the binary section
pub fn decode_table_data(input: &DecodeInput) -> Option<Document> {
    if input.binary_offset >= input.data.len() {
        return None;
    }

    let binary_data = &input.data[input.binary_offset..];
    let mut reader = BitReader::new(binary_data);
    decode_tables(&mut reader, input)
}

fn build_context<'a>(input: &'a DecodeInput<'a>) -> DecodeContext<'a> {
    let node_types = input
        .row_flags
        .iter()
        .map(|&f| NodeType::from_flags(f))
        .collect();
    DecodeContext {
        value_strings: input.value_strings,
        value_kinds: input.value_kinds,
        key_strings: input.key_strings,
        header_index_bits: bit_width(input.header_strings.len() as u32),
        value_index_bits: bit_width(input.value_strings_declared.max(1)),
        value_kind_bits: bit_width(input.value_kinds_declared.max(1)),
        key_index_bits: bit_width(input.key_strings_declared.max(1)),
        type_index_bits: bit_width(input.row_flags.len() as u32),
        node_types,
    }
}

/// Decode all table data from any BitRead source
pub fn decode_tables(reader: &mut impl BitRead, input: &DecodeInput) -> Option<Document> {
    let ctx = build_context(input);
    let table_id_bits = ctx.header_index_bits;
    let mut tables = HashMap::new();

    while reader.has_bits(table_id_bits as usize) {
        let table_id = reader.read_bits(table_id_bits)?;
        if table_id == 0 {
            break;
        }

        let table_name = input.header_strings.get(table_id as usize)?.clone();

        let (dep_names, dep_count) = read_table_deps(reader, table_id_bits, input.header_strings);

        let remap_a = FixedWidthIntArray::read(reader)?;
        let remap_b = FixedWidthIntArray::read(reader)?;

        let tctx = TableContext {
            pair_remap: if remap_a.is_active() {
                Some(&remap_a)
            } else {
                None
            },
            value_remap: if remap_b.is_active() {
                Some(&remap_b)
            } else {
                None
            },
            dep_index_bits: if dep_count > 0 {
                bit_width(dep_count as u32)
            } else {
                0
            },
            dep_names,
        };

        reader.align_byte();

        let records = parse_records(reader, &ctx, &tctx);

        tables.insert(
            table_name.clone(),
            Table {
                name: table_name,
                deps: tctx.dep_names,
                records,
            },
        );
    }

    Some(Document { tables })
}

/// Read dependency table IDs until a 0-terminator
fn read_table_deps(
    reader: &mut impl BitRead,
    table_id_bits: u8,
    header_strings: &[String],
) -> (Vec<String>, usize) {
    let mut dep_names = Vec::new();
    let mut count = 0;

    loop {
        if !reader.has_bits(table_id_bits as usize) {
            break;
        }
        let dep_id = match reader.read_bits(table_id_bits) {
            Some(0) | None => break,
            Some(id) => id,
        };
        count += 1;
        if let Some(name) = header_strings.get(dep_id as usize) {
            dep_names.push(name.clone());
        }
    }

    (dep_names, count)
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_decode_context<'a>(
        key_strings: &'a [String],
        value_strings: &'a [String],
        value_kinds: &'a [String],
        row_flags: &'a [u32],
    ) -> DecodeContext<'a> {
        let node_types = row_flags.iter().map(|&f| NodeType::from_flags(f)).collect();
        DecodeContext {
            value_strings,
            value_kinds,
            key_strings,
            header_index_bits: 1,
            value_index_bits: bit_width(value_strings.len().max(1) as u32),
            value_kind_bits: bit_width(value_kinds.len().max(1) as u32),
            key_index_bits: bit_width(key_strings.len().max(1) as u32),
            type_index_bits: bit_width(row_flags.len() as u32),
            node_types,
        }
    }

    fn make_table_context() -> TableContext<'static> {
        TableContext {
            pair_remap: None,
            value_remap: None,
            dep_names: Vec::new(),
            dep_index_bits: 0,
        }
    }

    #[test]
    fn test_decode_empty_binary() {
        let data = vec![0u8; 4];
        let header_strings = vec!["test".to_string()];
        let row_flags = vec![0u32];

        let result = decode_table_data(&DecodeInput {
            data: &data,
            header_strings: &header_strings,
            value_strings: &[],
            value_strings_declared: 0,
            value_kinds: &[],
            value_kinds_declared: 0,
            key_strings: &[],
            key_strings_declared: 0,
            row_flags: &row_flags,
            binary_offset: 0,
        });

        let doc = result.unwrap();
        assert!(doc.tables.is_empty());
    }

    #[test]
    fn test_parse_tags_empty_z_terminator() {
        let data = [b'z'];
        let mut reader = BitReader::new(&data);
        let key_strings = vec!["none".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);
        assert!(tags.is_empty());
    }

    #[test]
    fn test_parse_tags_tag_a_key_name() {
        let key_strings: Vec<String> = vec!["none".to_string(), "test_key".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        // Tag 'a' (0x61), then key index 1 (1 bit since 2 keys), then 'z' (0x7A)
        // key_index_bits = bit_width(2) = 1
        // byte 0: 0x61 = 'a'
        // bit 8: key index = 1 (1 bit)
        // We need to pack: 8 bits of 'a', 1 bit of index=1, then 8 bits of 'z'
        // 0x61 = 0110_0001, then 1, then 0x7A = 0111_1010
        // byte 0: 0110_0001 = 0x61
        // byte 1: 1_0111_101 = 0xBD
        // byte 2: 0_0000000 = 0x00
        // Wait, BitReader reads MSB first. Let me reconsider.
        // bit_width(2) = 1, so key index 1 is read as 1 bit.
        // Actually BitReader reads bits MSB-first from bytes.
        // Byte 0 bits: [7,6,5,4,3,2,1,0] = 0,1,1,0,0,0,0,1 for 0x61
        // read_bits(8) reads bits 7..0 -> 0x61 = 'a' ✓
        // Then read_bits(1) reads bit 7 of byte 1
        // For index 1, we need that bit to be 1.
        // Then read_bits(8) for 'z' = 0x7A = 0111_1010
        // Byte 1: bit7=1, then bits6..0 = 0111101 (first 7 bits of 'z')
        // Byte 2: bit7=0 (last bit of 'z'), rest don't matter
        // Byte 1 = 1_0111101 = 0xBD
        // Byte 2 = 0_0000000 = 0x00
        let data = [0x61, 0xBD, 0x00];
        let mut reader = BitReader::new(&data);
        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);

        assert_eq!(tags.len(), 1);
        match &tags[0] {
            Tag::KeyName { pair } => assert_eq!(pair, "test_key"),
            other => panic!("Expected Tag::KeyName, got {:?}", other),
        }
    }

    #[test]
    fn test_parse_tags_tag_b_u32() {
        let key_strings = vec!["none".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        // Tag 'b' (0x62) + 32 bits of value 42 in LE (BitReader is LSB-first) + tag 'z' (0x7A)
        let data = [0x62, 0x2A, 0x00, 0x00, 0x00, 0x7A];
        let mut reader = BitReader::new(&data);
        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);

        assert_eq!(tags.len(), 1);
        match &tags[0] {
            Tag::U32 { value } => assert_eq!(*value, 42),
            other => panic!("Expected Tag::U32, got {:?}", other),
        }
    }

    #[test]
    fn test_parse_tags_tag_c_f32() {
        let key_strings = vec!["none".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        // Tag 'c' (0x63) + 32 bits of 1.0f (0x3F800000) in LE + tag 'z'
        // BitReader is LSB-first, so 0x3F800000 → bytes [0x00, 0x00, 0x80, 0x3F]
        let data = [0x63, 0x00, 0x00, 0x80, 0x3F, 0x7A];
        let mut reader = BitReader::new(&data);
        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);

        assert_eq!(tags.len(), 1);
        match &tags[0] {
            Tag::F32 {
                u32_value,
                f32_value,
            } => {
                assert_eq!(*u32_value, 0x3F800000);
                assert!((f32_value - 1.0).abs() < f32::EPSILON);
            }
            other => panic!("Expected Tag::F32, got {:?}", other),
        }
    }

    #[test]
    fn test_parse_tags_multiple() {
        let key_strings = vec!["none".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        // Two 'b' tags then 'z', values in LE (BitReader is LSB-first)
        let data = [
            0x62, 0x01, 0x00, 0x00, 0x00, 0x62, 0x02, 0x00, 0x00, 0x00, 0x7A,
        ];
        let mut reader = BitReader::new(&data);
        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);

        assert_eq!(tags.len(), 2);
        match (&tags[0], &tags[1]) {
            (Tag::U32 { value: v1 }, Tag::U32 { value: v2 }) => {
                assert_eq!(*v1, 1);
                assert_eq!(*v2, 2);
            }
            other => panic!("Expected two Tag::U32, got {:?}", other),
        }
    }

    #[test]
    fn test_parse_tags_unknown_tag_breaks() {
        let key_strings = vec!["none".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);
        let tctx = make_table_context();

        // Unknown tag 0xFF should cause break, returning empty
        let data = [0xFF];
        let mut reader = BitReader::new(&data);
        let tags = parse_tags(&mut reader, &ctx, &tctx, data.len() * 8);
        assert!(tags.is_empty());
    }

    #[test]
    fn test_read_packed_name_list_terminated_by_none() {
        // key_strings: [0]="none", [1]="foo", [2]="bar"
        // key_index_bits = bit_width(3) = 2
        // Read index 1 ("foo"), index 2 ("bar"), index 0 ("none" → terminator)
        let key_strings: Vec<String> =
            vec!["none".to_string(), "foo".to_string(), "bar".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);

        // BitReader is LSB-first: 2-bit indices packed from bit 0 upward
        // index 1 = 0b01 at bits[0..2], index 2 = 0b10 at bits[2..4], index 0 = 0b00 at bits[4..6]
        // byte = (1 << 0) | (2 << 2) | (0 << 4) = 0x09
        let data = [0x09];
        let mut reader = BitReader::new(&data);
        let list = read_packed_name_list(&mut reader, &ctx, None).unwrap();

        assert_eq!(list, vec!["foo", "bar"]);
    }

    #[test]
    fn test_read_packed_name_list_empty() {
        let key_strings: Vec<String> = vec!["none".to_string(), "test".to_string()];
        let row_flags = vec![0u32];
        let ctx = make_decode_context(&key_strings, &[], &[], &row_flags);

        // 1-bit index: 0 (none → terminator immediately)
        let data = [0x00];
        let mut reader = BitReader::new(&data);
        let list = read_packed_name_list(&mut reader, &ctx, None).unwrap();

        assert!(list.is_empty());
    }

    #[test]
    fn test_read_table_deps() {
        let header_strings = vec![
            "unused".to_string(),
            "inv".to_string(),
            "inv_comp".to_string(),
            "firmware".to_string(),
        ];

        // table_id_bits = 2, BitReader is LSB-first
        // deps: 2 ("inv_comp"), 3 ("firmware"), 0 (terminator)
        // byte = (2 << 0) | (3 << 2) | (0 << 4) = 0x0E
        let data = [0x0E];
        let mut reader = BitReader::new(&data);

        let (dep_names, count) = read_table_deps(&mut reader, 2, &header_strings);

        assert_eq!(count, 2);
        assert_eq!(dep_names, vec!["inv_comp", "firmware"]);
    }

    #[test]
    fn test_read_table_deps_empty() {
        let header_strings = vec!["unused".to_string(), "inv".to_string()];

        // 1-bit index: 0 (terminator immediately)
        let data = [0x00];
        let mut reader = BitReader::new(&data);

        let (dep_names, count) = read_table_deps(&mut reader, 1, &header_strings);

        assert_eq!(count, 0);
        assert!(dep_names.is_empty());
    }

    #[test]
    fn test_wrap_with_self_key_nonempty() {
        let value = Value::Leaf("hello".to_string());
        let result = wrap_with_self_key("my_key".to_string(), value).unwrap();

        match result {
            Value::Map(map) => {
                assert_eq!(map.len(), 1);
                assert!(map.contains_key("my_key"));
            }
            other => panic!("Expected Map, got {:?}", other),
        }
    }

    #[test]
    fn test_wrap_with_self_key_empty() {
        let value = Value::Leaf("hello".to_string());
        let result = wrap_with_self_key(String::new(), value.clone()).unwrap();
        match result {
            Value::Leaf(s) => assert_eq!(s, "hello"),
            other => panic!("Expected Leaf, got {:?}", other),
        }
    }

    #[test]
    fn test_wrap_with_self_key_none() {
        let value = Value::Leaf("hello".to_string());
        let result = wrap_with_self_key("None".to_string(), value).unwrap();
        match result {
            Value::Leaf(s) => assert_eq!(s, "hello"),
            other => panic!("Expected Leaf (none key skipped), got {:?}", other),
        }
    }

    #[test]
    fn test_remap_index_no_remap() {
        let (bits, mapped) = remap_index(None, 5, 8);
        assert_eq!(bits, 8);
        assert_eq!(mapped, 5);
    }
}