jomini 0.34.1

Low level, performance oriented parser for save and game files from EU4, CK3, HOI4, Vic3, Imperator, and other PDS titles
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
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
use super::fnv::FnvBuildHasher;
use crate::{
    DeserializeError, DeserializeErrorKind, Encoding, Scalar, TextTape, TextToken, text::Operator,
};
use std::{
    borrow::Cow,
    collections::{HashMap, hash_map::Entry},
};

pub type KeyValue<'data, 'tokens, E> = (
    ScalarReader<'data, E>,
    Option<Operator>,
    ValueReader<'data, 'tokens, E>,
);

pub type KeyValues<'data, 'tokens, E> = (ScalarReader<'data, E>, GroupEntry<'data, 'tokens, E>);

/// Calculate what index the next value is. This assumes that a header + value
/// are two separate values
#[inline]
fn next_idx_header(tokens: &[TextToken], idx: usize) -> usize {
    match tokens[idx] {
        TextToken::Array { end, .. } | TextToken::Object { end, .. } => end + 1,
        TextToken::Operator(_) | TextToken::MixedContainer => idx + 2,
        _ => idx + 1,
    }
}

/// Calculate what index the next value is. This assumes that a header + value
/// is one value
#[inline]
fn next_idx(tokens: &[TextToken], idx: usize) -> usize {
    match tokens[idx] {
        TextToken::Array { end, .. } | TextToken::Object { end, .. } => end + 1,
        TextToken::Operator(_) => next_idx(tokens, idx + 1),
        TextToken::Header(_) => next_idx_header(tokens, idx + 1),
        _ => idx + 1,
    }
}

#[inline]
fn next_idx_values(tokens: &[TextToken], idx: usize) -> usize {
    match tokens[idx] {
        TextToken::Array { end, .. } | TextToken::Object { end, .. } => end + 1,
        _ => idx + 1,
    }
}

#[inline]
fn fields_len(tokens: &[TextToken], start_ind: usize, end_ind: usize) -> usize {
    let mut ind = start_ind;
    let mut count = 0;
    while ind < end_ind {
        let key_ind = ind;
        if tokens[key_ind] == TextToken::MixedContainer {
            return count;
        }

        let value_ind = match tokens[key_ind + 1] {
            TextToken::Operator(_) => key_ind + 2,
            _ => key_ind + 1,
        };
        ind = next_idx(tokens, value_ind);
        count += 1;
    }

    count
}

#[inline]
pub fn values_len(tokens: &[TextToken], start_ind: usize, end_ind: usize) -> usize {
    let mut count = 0;
    let mut ind = start_ind;
    while ind < end_ind {
        ind = next_idx_values(tokens, ind);
        count += 1;
    }

    count
}

type OpValue<'data, 'tokens, E> = (Option<Operator>, ValueReader<'data, 'tokens, E>);

/// Iterator over values grouped by duplicate keys
///
/// See [FieldGroupsIter](crate::text::FieldGroupsIter) for a worked example
pub struct GroupEntryIter<'data, 'tokens, 'parent, E> {
    index: usize,
    parent: &'parent GroupEntry<'data, 'tokens, E>,
}

impl<'data, 'tokens, E> Iterator for GroupEntryIter<'data, 'tokens, '_, E>
where
    E: Clone,
{
    type Item = (Option<Operator>, ValueReader<'data, 'tokens, E>);

    fn next(&mut self) -> Option<Self::Item> {
        match &self.parent {
            GroupEntry::One((op, val)) => {
                if self.index == 0 {
                    self.index += 1;
                    Some((*op, (*val).clone()))
                } else {
                    None
                }
            }
            GroupEntry::Multiple(entries) => {
                let result = entries.get(self.index);
                self.index += 1;
                result.map(|(op, val)| (*op, (*val).clone()))
            }
        }
    }
}

/// Represents a group of values for duplicate keys
///
/// May contain one or many values
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"name=a core=b core=c")?;
/// let reader = tape.windows1252_reader();
/// let mut fields = reader.field_groups();
/// let first_group = fields.next();
/// let first_key = first_group.as_ref().map(|(key, _)| key.read_str());
/// assert_eq!(first_key.as_deref(), Some("name"));
/// let first_values_len = first_group.as_ref().map(|(_, group)| group.len());
/// assert_eq!(first_values_len, Some(1));
/// let first_values = first_group.map(|(_, group)| {
///     group.values()
///         .filter_map(|(_op, val)| val.read_string().ok())
///         .collect()
/// });
/// assert_eq!(first_values, Some(vec![String::from("a")]));
///
/// let second_group = fields.next();
/// let second_key = second_group.as_ref().map(|(key, _)| key.read_str());
/// assert_eq!(second_key.as_deref(), Some("core"));
/// let second_values = second_group.as_ref().map(|(_, group)| group.len());
/// assert_eq!(second_values, Some(2));
/// let second_values = second_group.map(|(_, group)| {
///     group.values()
///         .filter_map(|(_op, val)| val.read_string().ok())
///         .collect()
/// });
/// assert_eq!(second_values, Some(vec![String::from("b"), String::from("c")]));
/// # Ok(())
/// # }
/// ```
pub enum GroupEntry<'data, 'tokens, E> {
    /// Represents that the group is composed of only one value
    ///
    /// Most fields should only occur once, so this variant is optimized to
    /// not require a memory allocation (unlike the `Multiple` variant).
    One(OpValue<'data, 'tokens, E>),

    /// Represents that the group is composed of several values
    Multiple(Vec<OpValue<'data, 'tokens, E>>),
}

impl<'data, 'tokens, E> GroupEntry<'data, 'tokens, E> {
    /// Returns an iterator that includes all the values
    pub fn values<'parent>(&'parent self) -> GroupEntryIter<'data, 'tokens, 'parent, E> {
        GroupEntryIter {
            index: 0,
            parent: self,
        }
    }

    /// A group can never be empty so this returns false
    pub fn is_empty(&self) -> bool {
        false
    }

    /// Returns the number of values in the group
    pub fn len(&self) -> usize {
        match &self {
            GroupEntry::One(_) => 1,
            GroupEntry::Multiple(x) => x.len(),
        }
    }
}

/// All possible text reader variants
#[derive(Debug, Clone)]
pub enum Reader<'data, 'tokens, E> {
    /// object reader
    Object(ObjectReader<'data, 'tokens, E>),

    /// array reader
    Array(ArrayReader<'data, 'tokens, E>),

    /// scalar reader
    Scalar(ScalarReader<'data, E>),

    /// value reader
    Value(ValueReader<'data, 'tokens, E>),
}

impl<'data, E> Reader<'data, '_, E>
where
    E: Encoding + Clone,
{
    /// Interpret value as a string
    #[inline]
    pub fn read_str(&self) -> Result<Cow<'data, str>, DeserializeError> {
        match &self {
            Reader::Scalar(x) => Ok(x.read_str()),
            Reader::Value(x) => x.read_str(),
            _ => Err(DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not a scalar")),
            }),
        }
    }

    /// Interpret value as a string
    #[inline]
    pub fn read_string(&self) -> Result<String, DeserializeError> {
        match &self {
            Reader::Scalar(x) => Ok(x.read_string()),
            Reader::Value(x) => x.read_string(),
            _ => Err(DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not a scalar")),
            }),
        }
    }

    /// Interpret value as a scalar
    #[inline]
    pub fn read_scalar(&self) -> Result<Scalar<'data>, DeserializeError> {
        match &self {
            Reader::Scalar(x) => Ok(x.read_scalar()),
            Reader::Value(x) => x.read_scalar(),
            _ => Err(DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not a scalar")),
            }),
        }
    }
}

/// Iterator over fields of an object grouped by key
///
/// Since objects can have duplicated keys across fields, this iterator
/// consolidates them such that all values with the same key are grouped
/// together in the order that they appear in the object. Key order is
/// also equivalent, except that already seen keys will be skipped, as
/// those values have already been seen in an earlier group.
///
/// The process of grouping values together is more expensive than simply
/// iterating the keys in order, so when possible prefer
/// [`ObjectReader::fields()`](crate::text::ObjectReader::fields) over
/// [`ObjectReader::field_groups()`](crate::text::ObjectReader::field_groups).
///
/// These groups can be easily iterated:
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"name=a core=b core=c")?;
/// let reader = tape.windows1252_reader();
/// for (key, group) in reader.field_groups() {
///     match key.read_str().as_ref() {
///         "name" => assert_eq!(group.len(), 1),
///         "core" => assert_eq!(group.len(), 2),
///         x => panic!("unexpected key: {}", x),
///     }
/// }
/// # Ok(())
/// # }
/// ```
///
/// And picked apart:
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"name=a core=b core=c")?;
/// let reader = tape.windows1252_reader();
/// let mut fields = reader.field_groups();
/// let first_group = fields.next();
/// let first_key = first_group.as_ref().map(|(key, _)| key.read_str());
/// assert_eq!(first_key.as_deref(), Some("name"));
/// let first_values_len = first_group.as_ref().map(|(_, group)| group.len());
/// assert_eq!(first_values_len, Some(1));
/// let first_values = first_group.map(|(_, group)| {
///     group.values()
///         .filter_map(|(_op, val)| val.read_string().ok())
///         .collect()
/// });
/// assert_eq!(first_values, Some(vec![String::from("a")]));
///
/// let second_group = fields.next();
/// let second_key = second_group.as_ref().map(|(key, _)| key.read_str());
/// assert_eq!(second_key.as_deref(), Some("core"));
/// let second_values = second_group.as_ref().map(|(_, group)| group.len());
/// assert_eq!(second_values, Some(2));
/// let second_values = second_group.map(|(_, group)| {
///     group.values()
///         .filter_map(|(_op, val)| val.read_string().ok())
///         .collect()
/// });
/// assert_eq!(second_values, Some(vec![String::from("b"), String::from("c")]));
/// # Ok(())
/// # }
/// ```
pub struct FieldGroupsIter<'data, 'tokens, E> {
    key_indices: HashMap<&'data [u8], Vec<OpValue<'data, 'tokens, E>>, FnvBuildHasher>,
    fields: FieldsIter<'data, 'tokens, E>,
}

impl<'data, 'tokens, E> FieldGroupsIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    fn new(reader: &ObjectReader<'data, 'tokens, E>) -> Self {
        // Using the fnv hasher improved throughput of the eu4 json benchmark
        // by over 15%.
        let mut key_indices =
            HashMap::with_capacity_and_hasher(reader.fields_len(), FnvBuildHasher::default());
        for (key, op, val) in reader.fields() {
            let entry = key_indices.entry(key.read_scalar().as_bytes());

            match entry {
                Entry::Vacant(x) => {
                    x.insert(Vec::with_capacity(0));
                }
                Entry::Occupied(mut x) => {
                    x.get_mut().push((op, val));
                }
            }
        }

        let fields = reader.fields();

        FieldGroupsIter {
            key_indices,
            fields,
        }
    }

    /// See [the other `remainder` documentation](crate::text::FieldsIter::remainder)
    pub fn remainder(&self) -> ArrayReader<'data, 'tokens, E> {
        self.fields.remainder()
    }
}

impl<'data, 'tokens, E> Iterator for FieldGroupsIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    type Item = KeyValues<'data, 'tokens, E>;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            let (key, op, value) = self.fields.next()?;

            if let Some((_key, mut entries)) =
                self.key_indices.remove_entry(key.read_scalar().as_bytes())
            {
                if entries.is_empty() {
                    return Some((key, GroupEntry::One((op, value))));
                } else {
                    entries.insert(0, (op, value));
                    return Some((key, GroupEntry::Multiple(entries)));
                }
            }
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        (self.key_indices.len(), None)
    }
}

/// Iterator over fields of an object in the order that they appear
///
/// Since objects can have duplicated keys across fields, this iterator
/// may yield items that have duplicate keys.
///
/// Fields can be easily iterated:
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"name=a core=b core=c")?;
/// let reader = tape.windows1252_reader();
/// let (names, cores) = reader
///     .fields()
///     .fold((0, 0), |(names, cores), (key, _op, _value)| {
///         match key.read_str().as_ref() {
///             "name" => (names + 1, cores),
///             "core" => (names, cores + 1),
///             x => panic!("unexpected key: {}", x),
///         }
///     });
/// assert_eq!((1, 2), (names, cores));
/// # Ok(())
/// # }
/// ```
///
/// And picked apart:
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"name=a core=b core=c")?;
/// let reader = tape.windows1252_reader();
/// let mut fields = reader.fields();
/// let (first_key, _op, first_val) = fields.next().unwrap();
/// assert_eq!(first_key.read_str(), "name");
/// assert_eq!(first_val.read_str().ok().as_deref(), Some("a"));
/// # Ok(())
/// # }
/// ```
pub struct FieldsIter<'data, 'tokens, E> {
    start_ind: usize,
    token_ind: usize,
    end_ind: usize,
    tokens: &'tokens [TextToken<'data>],
    encoding: E,
}

impl<'data, 'tokens, E> FieldsIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    fn new(reader: &ObjectReader<'data, 'tokens, E>) -> Self {
        FieldsIter {
            start_ind: reader.start_ind.saturating_sub(1),
            token_ind: reader.start_ind,
            end_ind: reader.end_ind,
            tokens: reader.tokens,
            encoding: reader.encoding.clone(),
        }
    }

    /// Returns the remaining values from an object if the container is an
    /// object that transitions into an array.
    pub fn remainder(&self) -> ArrayReader<'data, 'tokens, E> {
        let start = self
            .tokens
            .get(self.token_ind)
            .map(|x| match x {
                TextToken::MixedContainer => self.token_ind + 1,
                TextToken::End(y) => {
                    if let Some(TextToken::Array { .. }) = self.tokens.get(*y) {
                        *y + 1
                    } else {
                        self.token_ind
                    }
                }
                _ => self.token_ind,
            })
            .unwrap_or(self.end_ind);

        ArrayReader {
            start_ind: start,
            end_ind: self.end_ind,
            encoding: self.encoding.clone(),
            tokens: self.tokens,
        }
    }
}

impl<'data, 'tokens, E> Iterator for FieldsIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    type Item = KeyValue<'data, 'tokens, E>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.token_ind >= self.end_ind {
            return None;
        }

        let key_ind = self.token_ind;
        let token = self.tokens[key_ind].clone();
        let key_scalar = match token {
            TextToken::Quoted(x)
            | TextToken::Unquoted(x)
            | TextToken::Parameter(x)
            | TextToken::UndefinedParameter(x) => x,
            TextToken::MixedContainer => {
                return None;
            }
            _ => {
                // this is a broken invariant, so we safely recover by saying the object
                // has no more fields
                debug_assert!(false, "All keys should be scalars, not {:?}", &token);
                return None;
            }
        };

        let key_reader = ScalarReader {
            scalar: key_scalar,
            token,
            encoding: self.encoding.clone(),
        };

        let (op, value_ind) = match self.tokens[key_ind + 1] {
            TextToken::Operator(x) => (Some(x), key_ind + 2),
            _ => (None, key_ind + 1),
        };

        let value_reader = ValueReader {
            parent_ind: self.start_ind,
            value_ind,
            tokens: self.tokens,
            encoding: self.encoding.clone(),
        };
        self.token_ind = next_idx(self.tokens, value_ind);
        Some((key_reader, op, value_reader))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let len = fields_len(self.tokens, self.token_ind, self.end_ind);
        (len, None)
    }
}

/// A reader for objects
#[derive(Debug, Clone)]
pub struct ObjectReader<'data, 'tokens, E> {
    start_ind: usize,
    end_ind: usize,
    tokens: &'tokens [TextToken<'data>],
    encoding: E,
}

impl<'data, 'tokens, E> ObjectReader<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    /// Create a new object reader from parsed data with encoded strings
    pub fn new(tape: &'tokens TextTape<'data>, encoding: E) -> Self {
        let tokens = tape.tokens();
        ObjectReader {
            tokens,
            end_ind: tokens.len(),
            start_ind: 0,
            encoding,
        }
    }

    /// Create a new object reader directly from a token slice
    pub fn from_tokens(tokens: &'tokens [TextToken<'data>], encoding: E) -> Self {
        ObjectReader {
            tokens,
            end_ind: tokens.len(),
            start_ind: 0,
            encoding,
        }
    }

    /// Return the number of tokens contained within the object
    ///
    /// ```
    /// use jomini::TextTape;
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let tape = TextTape::from_slice(b"obj={1} foo=bar")?;
    /// let reader = tape.windows1252_reader();
    /// assert_eq!(reader.tokens_len(), 6);
    /// # Ok(())
    /// # }
    /// ```
    pub fn tokens_len(&self) -> usize {
        self.end_ind - self.start_ind
    }

    /// Deserialize from the object reader
    ///
    /// ```
    /// use jomini::TextTape;
    /// use serde::Deserialize;
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// #[derive(Debug, Clone, Deserialize, PartialEq)]
    /// pub struct Obj {
    ///   foo: String,
    /// }
    ///
    /// let tape = TextTape::from_slice(b"obj={foo=bar}")?;
    /// let reader = tape.windows1252_reader();
    /// let mut fields = reader.fields();
    /// let (_, _, obj_value) = fields.next().unwrap();
    /// let obj_reader = obj_value.read_object().unwrap();
    /// let result: Obj = obj_reader.deserialize().unwrap();
    /// assert_eq!(result, Obj { foo: "bar".to_string() });
    /// # Ok(())
    /// # }
    /// ```
    #[cfg(feature = "serde")]
    pub fn deserialize<T>(&self) -> Result<T, crate::Error>
    where
        T: serde::Deserialize<'data>,
    {
        T::deserialize(&crate::TextDeserializer::from_reader(self))
    }

    /// Return the number of key value pairs that the object contains.
    pub fn fields_len(&self) -> usize {
        fields_len(self.tokens, self.start_ind, self.end_ind)
    }

    /// Iterator over fields as they appear in the object
    ///
    /// See [FieldsIter](crate::text::FieldsIter) for a worked example
    #[inline]
    pub fn fields(&self) -> FieldsIter<'data, 'tokens, E> {
        FieldsIter::new(self)
    }

    /// Iterator over fields that are grouped by key
    ///
    /// See [FieldGroupsIter](crate::text::FieldGroupsIter) for a worked example
    #[inline]
    pub fn field_groups(&self) -> FieldGroupsIter<'data, 'tokens, E> {
        FieldGroupsIter::new(self)
    }
}

/// A text reader that wraps an underlying scalar value
#[derive(Debug, Clone)]
pub struct ScalarReader<'data, E> {
    scalar: Scalar<'data>,
    token: TextToken<'data>,
    encoding: E,
}

impl<'data, E> ScalarReader<'data, E>
where
    E: Encoding,
{
    /// Decode the data with a given string encoding
    #[inline]
    pub fn read_str(&self) -> Cow<'data, str> {
        self.encoding.decode(self.scalar.as_bytes())
    }

    /// Decode the data with a given string encoding
    #[inline]
    pub fn read_string(&self) -> String {
        self.encoding.decode(self.scalar.as_bytes()).into_owned()
    }

    /// Return the underlying scalar
    #[inline]
    pub fn read_scalar(&self) -> Scalar<'data> {
        self.scalar
    }

    /// Return the token that the reader is abstracting
    #[inline]
    pub fn token(&self) -> &TextToken<'data> {
        &self.token
    }
}

/// A text reader for a text value
#[derive(Debug, Clone)]
pub struct ValueReader<'data, 'tokens, E> {
    parent_ind: usize,
    value_ind: usize,
    tokens: &'tokens [TextToken<'data>],
    encoding: E,
}

impl<'data, E> ValueReader<'data, '_, E> {
    /// Return the token that the reader is abstracting
    #[inline]
    pub fn token(&self) -> &TextToken<'data> {
        &self.tokens[self.value_ind]
    }

    #[cfg(feature = "serde")]
    pub(crate) fn next(&mut self) -> Option<&TextToken<'data>> {
        self.value_ind += 1;
        self.tokens.get(self.value_ind)
    }
}

impl<E> Encoding for ValueReader<'_, '_, E>
where
    E: Encoding,
{
    #[inline]
    fn decode<'a>(&self, data: &'a [u8]) -> Cow<'a, str> {
        self.encoding.decode(data)
    }
}

impl<'data, 'tokens, E> ValueReader<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    fn raw_str(&self) -> Option<Cow<'data, str>> {
        match self.tokens[self.value_ind] {
            TextToken::Header(s)
            | TextToken::Unquoted(s)
            | TextToken::Quoted(s)
            | TextToken::Parameter(s)
            | TextToken::UndefinedParameter(s) => Some(self.encoding.decode(s.as_bytes())),
            TextToken::Operator(s) => Some(Cow::Borrowed(s.symbol())),
            _ => None,
        }
    }

    /// Interpret the current value as string
    #[inline]
    pub fn read_str(&self) -> Result<Cow<'data, str>, DeserializeError> {
        self.raw_str().ok_or_else(|| DeserializeError {
            kind: DeserializeErrorKind::Unsupported(String::from("not a string")),
        })
    }

    /// Interpret the current value as string
    #[inline]
    pub fn read_string(&self) -> Result<String, DeserializeError> {
        self.raw_str()
            .map(String::from)
            .ok_or_else(|| DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not a string")),
            })
    }

    /// Interpret the current value as a scalar
    #[inline]
    pub fn read_scalar(&self) -> Result<Scalar<'data>, DeserializeError> {
        self.tokens[self.value_ind]
            .as_scalar()
            .ok_or_else(|| DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not a scalar")),
            })
    }

    /// Interpret the current value as an object
    #[inline]
    pub fn read_object(&self) -> Result<ObjectReader<'data, 'tokens, E>, DeserializeError> {
        match self.tokens[self.value_ind] {
            TextToken::Object { end, .. } => Ok(ObjectReader {
                tokens: self.tokens,
                start_ind: self.value_ind + 1,
                end_ind: end,
                encoding: self.encoding.clone(),
            }),

            TextToken::Array { end, .. } => Ok(ObjectReader {
                tokens: self.tokens,
                start_ind: end,
                end_ind: end,
                encoding: self.encoding.clone(),
            }),

            TextToken::MixedContainer => Ok(ObjectReader {
                tokens: self.tokens,
                start_ind: self.value_ind + 1,
                end_ind: match self.tokens[self.parent_ind] {
                    TextToken::Array { end, .. } | TextToken::Object { end, .. } => end,
                    _ => self.tokens.len(),
                },
                encoding: self.encoding.clone(),
            }),

            _ => Err(DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not an object")),
            }),
        }
    }

    /// Interpret the current value as an array
    #[inline]
    pub fn read_array(&self) -> Result<ArrayReader<'data, 'tokens, E>, DeserializeError> {
        match self.tokens[self.value_ind] {
            TextToken::Object { end, mixed: true } => {
                let mut start_ind = self.value_ind + 1;
                while self.tokens.get(start_ind) != Some(&TextToken::MixedContainer) {
                    start_ind = next_idx(self.tokens, start_ind);
                }

                Ok(ArrayReader {
                    tokens: self.tokens,
                    start_ind: start_ind + 1,
                    end_ind: end,
                    encoding: self.encoding.clone(),
                })
            }
            TextToken::Array { end, .. } | TextToken::Object { end, .. } => Ok(ArrayReader {
                tokens: self.tokens,
                start_ind: self.value_ind + 1,
                end_ind: end,
                encoding: self.encoding.clone(),
            }),

            // A header can be seen as a two element array
            TextToken::Header(_) => Ok(ArrayReader {
                tokens: self.tokens,
                start_ind: self.value_ind,
                end_ind: next_idx(self.tokens, self.value_ind + 1),
                encoding: self.encoding.clone(),
            }),

            _ => Err(DeserializeError {
                kind: DeserializeErrorKind::Unsupported(String::from("not an array")),
            }),
        }
    }

    /// Return the number of tokens the value encompases
    ///
    /// ```
    /// use jomini::TextTape;
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let tape = TextTape::from_slice(b"obj={1 {foo=bar} 3}")?;
    /// let reader = tape.windows1252_reader();
    /// let mut fields = reader.fields();
    /// let (_, _, first_value) = fields.next().unwrap();
    /// assert_eq!(first_value.tokens_len(), 6);
    /// # Ok(())
    /// # }
    /// ```
    #[inline]
    pub fn tokens_len(&self) -> usize {
        match self.tokens[self.value_ind] {
            TextToken::Array { end, .. } | TextToken::Object { end, .. } => {
                end - self.value_ind - 1
            }
            _ => 1,
        }
    }
}

/// An iterator over the values of an array
///
/// ```
/// use jomini::TextTape;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let tape = TextTape::from_slice(b"cores={a b}")?;
/// let reader = tape.windows1252_reader();
///
/// let mut all_cores = Vec::new();
/// for (key, _op, value) in reader.fields() {
///     assert_eq!(key.read_str(), "cores");
///     let cores = value.read_array()?;
///     assert_eq!(cores.len(), 2);
///     for value in cores.values() {
///         all_cores.push(value.read_string()?);
///     }
/// }
/// assert_eq!(all_cores, vec![String::from("a"), String::from("b")]);
/// # Ok(())
/// # }
/// ```
pub struct ValuesIter<'data, 'tokens, E> {
    start_ind: usize,
    token_ind: usize,
    end_ind: usize,
    tokens: &'tokens [TextToken<'data>],
    encoding: E,
}

impl<'data, 'tokens, E> ValuesIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    fn new(reader: &ArrayReader<'data, 'tokens, E>) -> Self {
        ValuesIter {
            start_ind: reader.start_ind.saturating_sub(1),
            token_ind: reader.start_ind,
            end_ind: reader.end_ind,
            tokens: reader.tokens,
            encoding: reader.encoding.clone(),
        }
    }
}

impl<'data, 'tokens, E> Iterator for ValuesIter<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    type Item = ValueReader<'data, 'tokens, E>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.token_ind < self.end_ind {
            let value_ind = self.token_ind;
            self.token_ind = next_idx_values(self.tokens, self.token_ind);
            Some(ValueReader {
                parent_ind: self.start_ind,
                value_ind,
                tokens: self.tokens,
                encoding: self.encoding.clone(),
            })
        } else {
            None
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let len = values_len(self.tokens, self.token_ind, self.end_ind);
        (len, Some(len))
    }
}

/// A text reader for sequences of values
#[derive(Debug, Clone)]
pub struct ArrayReader<'data, 'tokens, E> {
    start_ind: usize,
    end_ind: usize,
    tokens: &'tokens [TextToken<'data>],
    encoding: E,
}

impl<'data, 'tokens, E> ArrayReader<'data, 'tokens, E>
where
    E: Encoding + Clone,
{
    /// Iterator over values of an array
    ///
    /// See [ValuesIter](crate::text::ValuesIter) for a worked example
    #[inline]
    pub fn values(&self) -> ValuesIter<'data, 'tokens, E> {
        ValuesIter::new(self)
    }

    /// Returns if the array is empty
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Return the number of values in the array
    #[inline]
    pub fn len(&self) -> usize {
        values_len(self.tokens, self.start_ind, self.end_ind)
    }

    /// Return the number of tokens contained within the object
    ///
    /// ```
    /// use jomini::TextTape;
    ///
    /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let tape = TextTape::from_slice(b"obj={1 {foo=bar} 3}")?;
    /// let reader = tape.windows1252_reader();
    /// let mut fields = reader.fields();
    /// let (_, _, first_value) = fields.next().unwrap();
    /// let array = first_value.read_array()?;
    /// assert_eq!(array.tokens_len(), 6);
    /// # Ok(())
    /// # }
    /// ```
    #[inline]
    pub fn tokens_len(&self) -> usize {
        self.end_ind - self.start_ind
    }
}

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

    fn read_value<E>(value: ValueReader<E>)
    where
        E: crate::Encoding + Clone,
    {
        match value.token() {
            TextToken::Object { .. } => {
                iterate_object(value.read_object().unwrap());
                iterate_array(value.read_array().unwrap());
            }
            TextToken::Array { .. } => {
                iterate_object(value.read_object().unwrap());
                iterate_array(value.read_array().unwrap());
            }
            TextToken::End(_) => panic!("end!?"),
            TextToken::Operator(_) => {}
            TextToken::MixedContainer => {}
            TextToken::Unquoted(_)
            | TextToken::Quoted(_)
            | TextToken::Header(_)
            | TextToken::Parameter(_)
            | TextToken::UndefinedParameter(_) => {
                let _ = value.read_str().unwrap();
            }
        }
    }

    fn iterate_array<E>(reader: ArrayReader<E>)
    where
        E: crate::Encoding + Clone,
    {
        for value in reader.values() {
            read_value(value);
        }
    }

    fn iterate_object<E>(reader: ObjectReader<E>)
    where
        E: crate::Encoding + Clone,
    {
        for (_key, group) in reader.field_groups() {
            for (_op, value) in group.values() {
                read_value(value);
            }
        }

        let mut fields = reader.fields();
        for (key, _op, value) in fields.by_ref() {
            let _ = key.read_str();
            read_value(value);
        }
    }

    #[test]
    fn simple_text_reader_text() {
        let data = b"foo=bar";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        assert_eq!(reader.fields_len(), 1);

        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_string(), String::from("foo"));
        assert_eq!(value.read_string().unwrap(), String::from("bar"));

        assert!(iter.next().is_none());
    }

    #[test]
    fn simple_text_reader_obj() {
        let data = b"foo={bar=qux}";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_string(), String::from("foo"));

        let nested = value.read_object().unwrap();
        let mut nested_iter = nested.fields();
        let (key2, _op, value2) = nested_iter.next().unwrap();
        assert_eq!(key2.read_string(), String::from("bar"));
        assert_eq!(value2.read_string().unwrap(), String::from("qux"));
        assert!(nested_iter.next().is_none());
        assert!(iter.next().is_none());
    }

    #[test]
    fn simple_text_reader_array() {
        let data = b"foo={bar qux}";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_string(), String::from("foo"));

        let nested = value.read_array().unwrap();
        let mut values = nested.values();
        assert_eq!(nested.len(), 2);
        let value1 = values.next().unwrap().read_string().unwrap();
        let value2 = values.next().unwrap().read_string().unwrap();

        assert!(values.next().is_none());
        assert_eq!(value1, String::from("bar"));
        assert_eq!(value2, String::from("qux"));
    }

    #[test]
    fn text_reader_read_fields() {
        let data = b"name=aaa name=bbb core=123 core=456 name=ccc name=ddd";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut field_groups = reader.field_groups();
        let (key, values) = field_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));

        let values = values.values().collect::<Vec<_>>();
        assert_eq!(values.len(), 4);
        assert_eq!(values[0].1.read_string().unwrap(), String::from("aaa"));
        assert_eq!(values[1].1.read_string().unwrap(), String::from("bbb"));
        assert_eq!(values[2].1.read_string().unwrap(), String::from("ccc"));
        assert_eq!(values[3].1.read_string().unwrap(), String::from("ddd"));

        let (key, values) = field_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("core"));

        let values = values.values().collect::<Vec<_>>();
        assert_eq!(values.len(), 2);
        assert_eq!(values[0].1.read_string().unwrap(), String::from("123"));
        assert_eq!(values[1].1.read_string().unwrap(), String::from("456"));
    }

    #[test]
    fn text_reader_read_fields_nested() {
        let data =
            b"army={name=aaa unit={name=bbb} unit={name=ccc}} army={name=ddd unit={name=eee}}";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut field_groups = reader.field_groups();

        let (key, army_values) = field_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("army"));
        assert_eq!(army_values.len(), 2);

        let army_values = army_values.values().collect::<Vec<_>>();
        let aaa = army_values[0].1.read_object().unwrap();
        let mut aaa_groups = aaa.field_groups();
        assert_eq!(aaa.fields_len(), 3);

        let (key, values) = aaa_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));
        assert_eq!(values.len(), 1);
        assert_eq!(
            values.values().next().unwrap().1.read_string().unwrap(),
            String::from("aaa")
        );

        let (key, values) = aaa_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("unit"));
        assert_eq!(values.len(), 2);

        let bbb = values.values().next().unwrap().1.read_object().unwrap();
        let mut bbb_fields = bbb.fields();
        let (key, _, value) = bbb_fields.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));
        assert_eq!(value.read_string().unwrap(), String::from("bbb"));

        let ccc = values.values().nth(1).unwrap().1.read_object().unwrap();
        let mut ccc_fields = ccc.fields();
        let (key, _, value) = ccc_fields.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));
        assert_eq!(value.read_string().unwrap(), String::from("ccc"));

        let ddd = army_values[1].1.read_object().unwrap();
        assert_eq!(ddd.fields_len(), 2);

        let mut ddd_groups = ddd.field_groups();
        let (key, values) = ddd_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));
        assert_eq!(values.len(), 1);
        assert_eq!(
            values.values().next().unwrap().1.read_string().unwrap(),
            String::from("ddd")
        );

        let (key, values) = ddd_groups.next().unwrap();
        assert_eq!(key.read_string(), String::from("unit"));
        assert_eq!(values.len(), 1);

        let eee = values.values().next().unwrap().1.read_object().unwrap();
        let mut eee_fields = eee.fields();
        let (key, _, value) = eee_fields.next().unwrap();
        assert_eq!(key.read_string(), String::from("name"));
        assert_eq!(value.read_string().unwrap(), String::from("eee"));
    }

    #[test]
    fn text_reader_read_fields_consume() {
        let data = b"name=aaa name=bbb core=123 name=ccc name=ddd";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut count = 0;
        for (_key, entries) in reader.field_groups() {
            for (_op, value) in entries.values() {
                count += value.read_scalar().map(|_| 1).unwrap_or(0);
            }
        }

        assert_eq!(count, 5);
    }

    #[test]
    fn text_reader_mixed_object_1() {
        let data = b"levels={10 0=1 0=2}";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        assert_eq!(reader.fields_len(), 1);
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_string(), String::from("levels"));

        let nested = value.read_array().unwrap();
        assert_eq!(nested.len(), 8);

        assert_eq!(
            nested.values().nth(3).unwrap().token(),
            &TextToken::Operator(Operator::Equal)
        );
        assert_eq!(
            nested.values().nth(6).unwrap().token(),
            &TextToken::Operator(Operator::Equal)
        );

        let values = nested
            .values()
            .filter(|x| x.token() != &TextToken::MixedContainer)
            .map(|x| x.read_string().unwrap())
            .collect::<Vec<_>>();

        assert_eq!(
            values.as_slice(),
            &[
                String::from("10"),
                String::from("0"),
                String::from("="),
                String::from("1"),
                String::from("0"),
                String::from("="),
                String::from("2"),
            ]
        );
    }

    #[test]
    fn text_reader_mixed_object_2() {
        let data = br#"brittany_area = { #5
            color = { 118  99  151 }
            169 170 171 172 4384
        }"#;

        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_str(), "brittany_area");

        let mut keys = vec![];
        let brittany = value.read_object().unwrap();
        let mut fields = brittany.fields();
        for (key, _op, _value) in fields.by_ref() {
            keys.push(key.read_str())
        }

        assert_eq!(keys, vec![String::from("color")]);
        let trailer = fields.remainder();
        assert_eq!(trailer.len(), 5);
        assert_eq!(trailer.values().next().unwrap().read_str().unwrap(), "169");

        let nested = value.read_array().unwrap();
        assert_eq!(nested.len(), 5);

        let mut values = nested.values();
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"169"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"170"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"171"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"172"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"4384"))
        );
        assert!(values.next().is_none());
    }

    #[test]
    fn text_reader_mixed_object_3() {
        let data = br#"brittany_area = { #5
            color = { 118  99  151 }
            color = { 118  99  151 }
            169 170 171 172 4384
        }"#;

        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let (_key, _op, brittany) = reader.fields().next().unwrap();
        let brittany_reader = brittany.read_object().unwrap();

        let mut fields = brittany_reader.fields();
        let (lower_bound, upper_bound) = fields.size_hint();
        assert_eq!(lower_bound, brittany_reader.fields_len());
        assert_eq!(lower_bound, 2);
        assert!(upper_bound.is_none() || upper_bound == Some(7));

        let _ = fields.next();
        let (lower_bound, upper_bound) = fields.size_hint();
        assert_eq!(lower_bound, 1);
        assert!(upper_bound.is_none() || upper_bound == Some(6));

        let mut groups = brittany_reader.field_groups();
        let (lower_bound, upper_bound) = groups.size_hint();
        assert_eq!(lower_bound, 1);
        assert!(upper_bound.is_none() || upper_bound == Some(6));

        let _ = groups.next();
        let (lower_bound, upper_bound) = groups.size_hint();
        assert_eq!(lower_bound, 0);
        assert!(upper_bound.is_none() || upper_bound == Some(5));
    }

    #[test]
    fn text_reader_mixed_object_4() {
        let data = br#"levels={a=b 10 c=d 20}"#;

        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        assert_eq!(reader.fields_len(), 1);
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_string(), String::from("levels"));

        let nested = value.read_array().unwrap();
        assert_eq!(nested.len(), 5);

        let mut values = nested.values();
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"10"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"c"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Operator(Operator::Equal)
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"d"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"20"))
        );
        assert!(values.next().is_none());
    }

    #[test]
    fn text_reader_mixed_object_5() {
        let data = br#"brittany_area = { #5
            color = { 118  99  151 }
            169 170 171 172 4384
        }"#;

        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_str(), "brittany_area");

        let brittany = value.read_object().unwrap();
        let mut field_groups = brittany.field_groups();
        field_groups.next().unwrap();
        assert!(field_groups.next().is_none());

        let trailer = field_groups.remainder();

        let mut values = trailer.values();
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"169"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"170"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"171"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"172"))
        );
        assert_eq!(
            values.next().unwrap().token(),
            &TextToken::Unquoted(Scalar::new(b"4384"))
        );
        assert!(values.next().is_none());
    }

    #[test]
    fn test_issue_168() {
        let data = br#"has_leviathans = {
            optimize_memory
            host_has_dlc = "Leviathans Story Pack"
        }"#;

        let tt = TextTape::from_slice(data).unwrap();

        let mut fields = tt.utf8_reader().fields();
        let (key, op, val) = fields.next().unwrap();
        assert_eq!(key.read_str(), "has_leviathans");
        assert_eq!(op, None);

        let object = match val.token() {
            TextToken::Object { .. } => val.read_object().unwrap(),
            TextToken::Array { .. } => {
                let mut values = val.read_array().unwrap().values();
                loop {
                    let Some(val) = values.next() else {
                        panic!("end of the line");
                    };

                    if val.token() == &TextToken::MixedContainer {
                        break val.read_object().unwrap();
                    }
                }
            }
            _ => panic!("expected object"),
        };

        {
            let mut fields = object.fields();

            let (key, op, val) = fields.next().unwrap();
            assert_eq!(key.read_str(), "host_has_dlc");
            assert_eq!(op, Some(Operator::Equal));
            assert_eq!(val.read_str().unwrap(), "Leviathans Story Pack");

            assert!(fields.next().is_none());
        }

        assert!(fields.next().is_none());
    }

    #[test]
    fn test_object_template_basic_dom_reader() {
        let data = br"obj={ { a = b }={ 1 2 3 } }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut fields = reader.fields();
        let (key, _op, value) = fields.next().unwrap();
        assert_eq!(key.read_str(), "obj");

        // Object templates are parsed as arrays with template-value pairs
        let array = value.read_array().unwrap();
        assert_eq!(array.len(), 2);

        let mut values = array.values();

        // First value should be the template object { a = b }
        let template = values.next().unwrap();
        let template_obj = template.read_object().unwrap();
        let mut template_fields = template_obj.fields();
        let (template_key, _op, template_value) = template_fields.next().unwrap();
        assert_eq!(template_key.read_str(), "a");
        assert_eq!(template_value.read_str().unwrap(), "b");
        assert!(template_fields.next().is_none());

        // Second value should be the values array { 1 2 3 }
        let values_array = values.next().unwrap();
        let values_arr = values_array.read_array().unwrap();
        assert_eq!(values_arr.len(), 3);
        let mut arr_values = values_arr.values();
        assert_eq!(arr_values.next().unwrap().read_str().unwrap(), "1");
        assert_eq!(arr_values.next().unwrap().read_str().unwrap(), "2");
        assert_eq!(arr_values.next().unwrap().read_str().unwrap(), "3");
        assert!(arr_values.next().is_none());
        assert!(values.next().is_none());
    }

    #[test]
    fn test_object_template_single_key_dom_reader() {
        let data = br"obj={ { foo }={ 1000 } }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut fields = reader.fields();
        let (key, _op, value) = fields.next().unwrap();
        assert_eq!(key.read_str(), "obj");

        let array = value.read_array().unwrap();
        assert_eq!(array.len(), 2);

        let mut values = array.values();

        // First value should be the template array { foo }
        let template = values.next().unwrap();
        let template_arr = template.read_array().unwrap();
        assert_eq!(template_arr.len(), 1);
        let mut template_values = template_arr.values();
        assert_eq!(template_values.next().unwrap().read_str().unwrap(), "foo");
        assert!(template_values.next().is_none());

        // Second value should be the values array { 1000 }
        let values_array = values.next().unwrap();
        let values_arr = values_array.read_array().unwrap();
        assert_eq!(values_arr.len(), 1);
        let mut arr_values = values_arr.values();
        assert_eq!(arr_values.next().unwrap().read_str().unwrap(), "1000");
        assert!(arr_values.next().is_none());
        assert!(values.next().is_none());
    }

    #[test]
    fn test_object_template_scalar_value_dom_reader() {
        let data = br"obj={ { a=b }=16 }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut fields = reader.fields();
        let (key, _op, value) = fields.next().unwrap();
        assert_eq!(key.read_str(), "obj");

        let array = value.read_array().unwrap();
        assert_eq!(array.len(), 2);

        let mut values = array.values();

        // First value should be the template object { a = b }
        let template = values.next().unwrap();
        let template_obj = template.read_object().unwrap();
        let mut template_fields = template_obj.fields();
        let (template_key, _op, template_value) = template_fields.next().unwrap();
        assert_eq!(template_key.read_str(), "a");
        assert_eq!(template_value.read_str().unwrap(), "b");
        assert!(template_fields.next().is_none());

        // Second value should be the scalar 16
        let scalar_value = values.next().unwrap();
        assert_eq!(scalar_value.read_str().unwrap(), "16");
        assert!(values.next().is_none());
    }

    #[test]
    fn test_object_template_multiple_pairs_dom_reader() {
        let data = br"obj={ { 31=16 }=16 { 32=17 }=18 }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut fields = reader.fields();
        let (key, _op, value) = fields.next().unwrap();
        assert_eq!(key.read_str(), "obj");

        let array = value.read_array().unwrap();
        assert_eq!(array.len(), 4); // 2 template-value pairs = 4 elements

        let mut values = array.values();

        // First template-value pair
        let template1 = values.next().unwrap();
        let template1_obj = template1.read_object().unwrap();
        let mut template1_fields = template1_obj.fields();
        let (key1, _op, val1) = template1_fields.next().unwrap();
        assert_eq!(key1.read_str(), "31");
        assert_eq!(val1.read_str().unwrap(), "16");
        assert!(template1_fields.next().is_none());

        let value1 = values.next().unwrap();
        assert_eq!(value1.read_str().unwrap(), "16");

        // Second template-value pair
        let template2 = values.next().unwrap();
        let template2_obj = template2.read_object().unwrap();
        let mut template2_fields = template2_obj.fields();
        let (key2, _op, val2) = template2_fields.next().unwrap();
        assert_eq!(key2.read_str(), "32");
        assert_eq!(val2.read_str().unwrap(), "17");
        assert!(template2_fields.next().is_none());

        let value2 = values.next().unwrap();
        assert_eq!(value2.read_str().unwrap(), "18");
        assert!(values.next().is_none());
    }

    #[test]
    fn test_object_template_complex_dom_reader() {
        let data =
            br"config={ { debug=yes logging=verbose }={ output_file=debug.log level=trace } }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();

        let mut fields = reader.fields();
        let (key, _op, value) = fields.next().unwrap();
        assert_eq!(key.read_str(), "config");

        let array = value.read_array().unwrap();
        assert_eq!(array.len(), 2);

        let mut values = array.values();

        // First value should be the template object with multiple fields
        let template = values.next().unwrap();
        let template_obj = template.read_object().unwrap();
        assert_eq!(template_obj.fields_len(), 2);

        let mut template_groups = template_obj.field_groups();
        let (debug_key, debug_group) = template_groups.next().unwrap();
        assert_eq!(debug_key.read_str(), "debug");
        let debug_values: Vec<_> = debug_group.values().collect();
        assert_eq!(debug_values.len(), 1);
        assert_eq!(debug_values[0].1.read_str().unwrap(), "yes");

        let (logging_key, logging_group) = template_groups.next().unwrap();
        assert_eq!(logging_key.read_str(), "logging");
        let logging_values: Vec<_> = logging_group.values().collect();
        assert_eq!(logging_values.len(), 1);
        assert_eq!(logging_values[0].1.read_str().unwrap(), "verbose");
        assert!(template_groups.next().is_none());

        // Second value should be the values object
        let values_obj = values.next().unwrap();
        let values_object = values_obj.read_object().unwrap();
        assert_eq!(values_object.fields_len(), 2);

        let mut values_groups = values_object.field_groups();
        let (output_key, output_group) = values_groups.next().unwrap();
        assert_eq!(output_key.read_str(), "output_file");
        let output_values: Vec<_> = output_group.values().collect();
        assert_eq!(output_values.len(), 1);
        assert_eq!(output_values[0].1.read_str().unwrap(), "debug.log");

        let (level_key, level_group) = values_groups.next().unwrap();
        assert_eq!(level_key.read_str(), "level");
        let level_values: Vec<_> = level_group.values().collect();
        assert_eq!(level_values.len(), 1);
        assert_eq!(level_values[0].1.read_str().unwrap(), "trace");
        assert!(values_groups.next().is_none());
        assert!(values.next().is_none());
    }

    #[test]
    fn text_reader_empty_container() {
        let data = b"active_idea_groups={ }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_str(), "active_idea_groups");

        let empty_array = value.read_array().unwrap();
        assert_eq!(0, empty_array.len());
        assert!(empty_array.values().next().is_none());

        let empty_object = value.read_object().unwrap();
        let mut empty_object_iter = empty_object.fields();
        assert_eq!(0, empty_object.fields_len());
        assert!(empty_object_iter.next().is_none());
    }

    #[test]
    fn text_reader_header() {
        let data = b"color = rgb { 10 20 30 }";
        let tape = TextTape::from_slice(data).unwrap();
        let reader = tape.windows1252_reader();
        let mut iter = reader.fields();
        let (key, _op, value) = iter.next().unwrap();
        assert_eq!(key.read_str(), "color");

        let header_array = value.read_array().unwrap();
        let mut values = header_array.values();
        let rgb = values.next().unwrap();
        assert_eq!(rgb.read_str().unwrap(), "rgb");

        let vals = values.next().unwrap();
        let s = vals.read_array().unwrap();
        let svals = s.values();

        let colors = svals
            .map(|x| x.read_scalar().unwrap())
            .map(|x| x.to_u64().unwrap())
            .collect::<Vec<u64>>();

        assert_eq!(colors, vec![10, 20, 30]);
    }

    #[test]
    fn reader_crash1() {
        let data = b"a=r{}";
        let tape = TextTape::from_slice(data).unwrap();
        iterate_object(tape.windows1252_reader());
    }

    #[test]
    fn text_reader_object_fields() {
        let data = b"a{b=}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_object_fields_op2() {
        let data = b"a{}b>{}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_object_fields_dupe() {
        let data = b"a{b=c d=E d}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_object_fields_header() {
        let data = b"a{}b>r{}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_object_fields_dupe2() {
        let data = b"a{b=c d b}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_regression() {
        let data = b"a={b{}=2}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_regression2() {
        let data = b"r={c=d=@{y=u}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }

    #[test]
    fn text_reader_regression3() {
        let data = b"a={{t c=d = b}}";
        if let Ok(tape) = TextTape::from_slice(data) {
            let reader = tape.windows1252_reader();
            iterate_object(reader);
        }
    }
}