cadkit-dgn 0.5.3

Clean-room DGN V7 and V8 reader and seed-based DGN V8 writer.
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
//! V8 element bodies -> [`Element`].
//!
//! Offsets are from the element start (after the 4-byte page record prefix). The standard
//! graphic header occupies `0x00..0x68`; see `docs/dgn/FORMAT_NOTES.md` for every table.

use cadkit_core::Limits;
use encoding_rs::Encoding;

use crate::le;
use crate::native::element::{
    CellData, Element, ElementData, ElementHeader, LevelData, Rotation, TagData, TagDef,
    TagSetData, TagValue, TextData, TextNodeData, UorPoint,
};
use crate::native::linkage::{self, LinkageData};
use crate::native::v8::RawElement;
use crate::text::{self, TextDecoder};

const HEADER_LEN: usize = 0x68;
const FLAG_3D: u32 = 0x0800;
/// Property bit `0x1000` (meaning not established). A MicroStation text carrying it stores
/// a range that is not its text box (private corpus: 101 of 102 such ranges are the square
/// origin ± stored length), so the range cannot give its length.
const PROP_0X1000: u32 = 0x1000;
/// Attribute offset in words of a 240-byte level entry, the layout whose symbology fields
/// are located (FORMAT_NOTES, "Level entry symbology").
const LEVEL_ENTRY_240_WORDS: u32 = 120;
/// Text size multipliers are stored in 1/1000 of 6 UOR (GDAL dgnlib, ezdgn).
const TEXT_MULT_TO_UOR: f64 = 6.0 / 1000.0;
/// Dependency application ids observed on tag elements.
pub(crate) const DEP_TAG_SET: u16 = 0x2717;
pub(crate) const DEP_TAG_TARGET: u16 = 0x2710;
/// Table numbers (the level slot of type 95/96 elements).
pub(crate) const TABLE_LEVELS: u32 = 1;
pub(crate) const TABLE_FONTS: u32 = 2;

/// Element types without the standard 0x68-byte display header.
fn has_display_header(t: u16) -> bool {
    !matches!(t, 0 | 1 | 5 | 8 | 9 | 10 | 39 | 57 | 63 | 66 | 90..=93 | 95..=99)
}

/// Decodes a raw V8 element. Never fails: undecodable bodies become
/// [`ElementData::Unknown`] with `problem` set.
pub fn decode(raw: &RawElement, enc: &'static Encoding, limits: &Limits) -> Element {
    decode_with(raw, TextDecoder::Whatwg(enc), limits)
}

pub(crate) fn decode_with(raw: &RawElement, enc: TextDecoder, limits: &Limits) -> Element {
    let b = &raw.bytes;
    let t = raw.type_code();
    let display = has_display_header(t) && b.len() >= HEADER_LEN;
    let properties = if display {
        le::u32_at(b, 0x28).unwrap_or(0)
    } else {
        0
    };
    // The second range triple is the extent (high - low) for every graphic type, not
    // an absolute corner: MicroStation and ODA files agree on this (FORMAT_NOTES,
    // "Element range").
    let range = if display {
        let r = |o: usize| le::i64_at(b, o).map(|v| v as f64).unwrap_or(0.0);
        let low = [r(0x38), r(0x40), r(0x48)];
        let span = [r(0x50), r(0x58), r(0x60)];
        Some([low, [low[0] + span[0], low[1] + span[1], low[2] + span[2]]])
    } else {
        None
    };
    let header = ElementHeader {
        type_code: t,
        level: le::u32_at(b, 0x0c).unwrap_or(0),
        id: le::u64_at(b, 0x10),
        complex_header: raw.is_complex_header(),
        complex_component: raw.is_complex_component(),
        deleted: false,
        is_3d: properties & FLAG_3D != 0,
        has_display_header: display,
        graphic_group: if display {
            le::u32_at(b, 0x20).unwrap_or(0)
        } else {
            0
        },
        properties,
        style: if display {
            le::u32_at(b, 0x2c).unwrap_or(0)
        } else {
            0
        },
        weight: if display {
            le::u32_at(b, 0x30).unwrap_or(0)
        } else {
            0
        },
        color: if display {
            le::u32_at(b, 0x34).unwrap_or(0)
        } else {
            0
        },
        range,
        type_flags: (raw.type_word >> 16) as u16,
        modified_ms: le::f64_at(b, 0x18),
    };
    let attr = raw.attribute_offset();
    let linkages = linkage::parse(raw.attributes(), attr, true, enc);
    // Text carries its own code page linkage (observed 1252); prefer it for 8-bit text.
    let text_enc = linkages
        .iter()
        .find_map(|l| match l.data {
            LinkageData::CodePage(cp) => {
                u16::try_from(cp).ok().and_then(text::encoding_for_codepage)
            }
            _ => None,
        })
        .unwrap_or(enc);
    let d = Decoder {
        b: raw.primary(),
        whole: b,
        is_3d: header.is_3d,
        limits,
        enc: text_enc,
    };
    let result = match t {
        2 => d.cell().map(ElementData::Cell),
        3 => d.line(),
        4 => d.points(2).map(|points| ElementData::LineString { points }),
        // Type 5 is "group data"; only the one in level slot 1 is a color table (as in V7).
        5 if header.level == 1 => d.color_table(),
        6 => d.points(2).map(|points| ElementData::Shape { points }),
        7 => d.text_node().map(ElementData::TextNode),
        11 => d.points(2).map(|points| ElementData::Curve { points }),
        12 | 14 | 18 | 19 => le::u32_at(d.b, 0x68)
            .map(|children| ElementData::Complex { children })
            .ok_or_else(short),
        15 => d.ellipse(),
        16 => d.arc(),
        17 => d.text().map(ElementData::Text),
        21 => d
            .points(1)
            .map(|points| ElementData::BSplinePoles { points }),
        22 => d.point_string(),
        26 => Ok(ElementData::BSplineKnots {
            values: d.scalars(),
        }),
        27 => d.bspline_header(),
        28 => Ok(ElementData::BSplineWeights {
            values: d.scalars(),
        }),
        34 => d.cell().map(ElementData::SharedCellDefinition),
        35 => d.cell().map(ElementData::SharedCellInstance),
        37 => d.tag(&linkages).map(ElementData::Tag),
        39 => d.tag_set(&linkages).map(ElementData::TagSet),
        // An attachment written with a relative path stores an empty full path.
        90 => Ok(ElementData::RasterReference {
            file_name: linkage::string(&linkages, 3).filter(|s| !s.is_empty()),
            full_path: linkage::string(&linkages, 0x1f).filter(|s| !s.is_empty()),
        }),
        94 => le::f64s::<16>(d.b, 0x78)
            .map(|matrix| ElementData::RasterFrame {
                matrix,
                corner: le::f64s::<2>(d.b, 0x108),
            })
            .ok_or_else(short),
        95 => d.table_entry(header.level, &linkages),
        96 => Ok(ElementData::TableHeader {
            table: header.level,
            children: le::u32_at(d.b, 0x20).unwrap_or(0),
        }),
        _ if raw.is_complex_header() && display => le::u32_at(d.b, 0x68)
            .map(|children| ElementData::Complex { children })
            .ok_or_else(short),
        _ => Ok(ElementData::Unknown),
    };
    let (mut data, problem) = match result {
        Ok(data) => (data, None),
        Err(p) => (ElementData::Unknown, Some(p)),
    };
    if let ElementData::Text(t) = &mut data
        && t.measured_length.is_none()
        && properties & PROP_0X1000 == 0
    {
        t.measured_length = length_from_range(t, header.range);
    }
    Element {
        header,
        data,
        linkages,
        problem,
    }
}

/// Text length stored at `0x80` of a V8 text element (`element` from the element start);
/// `None` when it is zero (the writer did not measure) or missing.
pub(crate) fn stored_text_length(element: &[u8]) -> Option<f64> {
    le::f64_at(element, 0x80).filter(|v| *v > 0.0)
}

/// Length of an unmeasured text from its range: the x extent of a MicroStation text's range
/// equals its stored `0x80` length (private corpus: 303 of 303 unrotated texts whose range
/// starts at the origin, relative difference at most 1e-3, the range being rounded outwards
/// to whole UOR). Applies, like the V7 rule, only to unrotated text whose range starts at the
/// origin (the lower-left corner); an empty text keeps no length, its range is the empty box
/// rounded outwards to 1 UOR (501 of 501 empty private texts).
fn length_from_range(t: &TextData, range: Option<[UorPoint; 2]>) -> Option<f64> {
    const IDENTITY: [f64; 9] = [1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0];
    let [lo, hi] = range?;
    let unrotated = t
        .rotation
        .matrix()
        .iter()
        .zip(IDENTITY)
        .all(|(a, b)| (a - b).abs() <= 1e-9);
    let [ox, ..] = t.origin;
    let [lx, ..] = lo;
    let [hx, ..] = hi;
    (!t.text.is_empty() && unrotated && (lx - ox).abs() <= 1.0 && hx > lx).then_some(hx - lx)
}

/// Symbology fields of a level entry (type 95, table 1) with a 240-byte fixed part, the only
/// layout of the private corpus (FORMAT_NOTES, "Level entry symbology"). Other layouts (the
/// 104-byte entries of the three public V8 samples) give `None`: their fields are not
/// located.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct LevelSymbology {
    /// `0x48`: color index of the level (strong evidence).
    pub(crate) color: u32,
    /// `0x44`: presumably the level's line weight (weak evidence, kept raw).
    pub(crate) weight_raw: u32,
    /// `0x40`: presumably the level's line style (weak evidence, kept raw).
    pub(crate) style_raw: i32,
}

/// [`LevelSymbology`] of a level entry, `element` from the element start.
pub(crate) fn level_symbology(element: &[u8]) -> Option<LevelSymbology> {
    if le::u32_at(element, 0x08)? != LEVEL_ENTRY_240_WORDS {
        return None;
    }
    Some(LevelSymbology {
        color: le::u32_at(element, 0x48)?,
        weight_raw: le::u32_at(element, 0x44)?,
        style_raw: i32::from_le_bytes(le::array::<4>(element, 0x40)?),
    })
}

fn short() -> String {
    "element body is too short".to_owned()
}

struct Decoder<'a> {
    /// Primary bytes (before the attribute offset).
    b: &'a [u8],
    /// Whole element (some writers place fixed fields past a too-small attribute offset).
    whole: &'a [u8],
    is_3d: bool,
    limits: &'a Limits,
    enc: TextDecoder,
}

type R<T> = std::result::Result<T, String>;

impl Decoder<'_> {
    fn pt(&self, off: usize) -> R<UorPoint> {
        le::point_at(self.b, off, self.is_3d)
            .ok_or_else(|| format!("point at 0x{off:x} missing or not finite"))
    }

    fn f(&self, off: usize) -> R<f64> {
        le::f64_at(self.b, off).ok_or_else(|| format!("value at 0x{off:x} missing or not finite"))
    }

    fn point_size(&self) -> usize {
        if self.is_3d { 24 } else { 16 }
    }

    fn line(&self) -> R<ElementData> {
        let start = self.pt(HEADER_LEN)?;
        let end = self.pt(HEADER_LEN + self.point_size())?;
        Ok(ElementData::Line { start, end })
    }

    /// `u32` count at 0x68, padding, points from 0x70.
    fn points(&self, min: usize) -> R<Vec<UorPoint>> {
        let count = le::u32_at(self.b, HEADER_LEN).ok_or_else(short)? as usize;
        self.check_count(count, min)?;
        let size = self.point_size();
        if count.saturating_mul(size).saturating_add(0x70) > self.b.len() {
            return Err(format!(
                "{count} points do not fit in {} bytes",
                self.b.len()
            ));
        }
        (0..count).map(|i| self.pt(0x70 + i * size)).collect()
    }

    fn check_count(&self, count: usize, min: usize) -> R<()> {
        if count < min {
            return Err(format!("{count} points, at least {min} required"));
        }
        if count as u64 > u64::from(self.limits.max_vertices) {
            return Err(format!("{count} points exceed the vertex limit"));
        }
        Ok(())
    }

    fn point_string(&self) -> R<ElementData> {
        let points = self.points(1)?;
        let base = 0x70 + points.len() * self.point_size();
        let orientations = (0..points.len())
            .map_while(|i| le::f64s::<4>(self.b, base + 32 * i))
            .collect();
        Ok(ElementData::PointString {
            points,
            orientations,
        })
    }

    fn rotation(&self, off: usize) -> R<Rotation> {
        if self.is_3d {
            le::f64s::<4>(self.b, off)
                .map(Rotation::Quaternion)
                .ok_or_else(short)
        } else {
            self.f(off).map(Rotation::Angle)
        }
    }

    fn ellipse(&self) -> R<ElementData> {
        let primary = self.f(0x68)?;
        let secondary = self.f(0x70)?;
        let rotation = self.rotation(0x78)?;
        let center = self.pt(if self.is_3d { 0x98 } else { 0x80 })?;
        Ok(ElementData::Ellipse {
            primary,
            secondary,
            rotation,
            center,
        })
    }

    fn arc(&self) -> R<ElementData> {
        let start = self.f(0x68)?;
        let sweep = self.f(0x70)?;
        let primary = self.f(0x78)?;
        let secondary = self.f(0x80)?;
        let rotation = self.rotation(0x88)?;
        let center = self.pt(if self.is_3d { 0xa8 } else { 0x90 })?;
        Ok(ElementData::Arc {
            start,
            sweep,
            primary,
            secondary,
            rotation,
            center,
        })
    }

    fn text(&self) -> R<TextData> {
        let font = le::u32_at(self.b, 0x68).ok_or_else(short)?;
        let justification = le::u16_at(self.b, 0x6c).ok_or_else(short)?;
        let len = usize::from(le::u16_at(self.b, 0x6e).ok_or_else(short)?);
        let width = self.f(0x70)? * TEXT_MULT_TO_UOR;
        let height = self.f(0x78)? * TEXT_MULT_TO_UOR;
        let rotation = self.rotation(0x90)?;
        let (origin_off, text_off) = if self.is_3d {
            (0xb0, 0xca)
        } else {
            (0x98, 0xaa)
        };
        let origin = self.pt(origin_off)?;
        // The payload is anchored on the fixed layout; elements may be padded after it.
        let raw_text = le::bytes(self.whole, text_off, len)
            .ok_or_else(|| format!("text of {len} bytes at 0x{text_off:x} exceeds the element"))?
            .to_vec();
        let (text, encoding) = text::decode_dgn_string(&raw_text, self.enc);
        // 0x80: text length along the baseline in UOR, written by MicroStation (TreeText:
        // 583.33 for 12 characters of width 50); zero when the writer did not measure.
        let measured_length = stored_text_length(self.b);
        Ok(TextData {
            font,
            justification,
            width,
            height,
            rotation,
            origin,
            text,
            encoding,
            raw_text,
            measured_length,
        })
    }

    fn text_node(&self) -> R<TextNodeData> {
        Ok(TextNodeData {
            children: le::u32_at(self.b, 0x68).ok_or_else(short)?,
            node_number: le::u32_at(self.b, 0x6c).unwrap_or(0),
            font: le::u32_at(self.b, 0x70).unwrap_or(0),
            justification: le::u16_at(self.b, 0x76).unwrap_or(0),
            line_spacing: le::f64_at(self.b, 0x78).unwrap_or(0.0),
            width: le::f64_at(self.b, 0x80).unwrap_or(0.0) * TEXT_MULT_TO_UOR,
            height: le::f64_at(self.b, 0x88).unwrap_or(0.0) * TEXT_MULT_TO_UOR,
            rotation: self.rotation(0x90).unwrap_or(Rotation::None),
            origin: self
                .pt(if self.is_3d { 0xb0 } else { 0x98 })
                .unwrap_or([0.0; 3]),
        })
    }

    /// Cell header (2), shared cell definition (34) and instance (35) share one layout;
    /// the 2D/3D variant is chosen by size because definitions are stored 3D even when
    /// their flag word says 2D (test_dgnv8.dgn).
    fn cell(&self) -> R<CellData> {
        let children = le::u32_at(self.b, 0x68).ok_or_else(short)?;
        let three = if self.b.len() >= 0x100 {
            true
        } else if self.b.len() >= 0xc0 {
            false
        } else {
            return Err(short());
        };
        let (lo, hi, m, o) = if three {
            (0x70, 0x88, 0xa0, 0xe8)
        } else {
            (0x70, 0x80, 0x90, 0xb0)
        };
        let point = |off| le::point_at(self.b, off, three).ok_or_else(short);
        let matrix = if three {
            le::f64s::<9>(self.b, m).ok_or_else(short)?
        } else {
            let [a, b, c, d] = le::f64s::<4>(self.b, m).ok_or_else(short)?;
            [a, b, 0.0, c, d, 0.0, 0.0, 0.0, 1.0]
        };
        Ok(CellData {
            name: None,
            description: None,
            children,
            range: Some([point(lo)?, point(hi)?]),
            matrix,
            origin: point(o)?,
        })
    }

    fn bspline_header(&self) -> R<ElementData> {
        let children = le::u32_at(self.b, 0x68).ok_or_else(short)?;
        let of = le::u8_at(self.b, 0x6c).ok_or_else(short)?;
        let next = le::u8_at(self.b, 0x6d).unwrap_or(0);
        Ok(ElementData::BSplineCurve {
            children,
            order: (of & 0x0f) + 2,
            flags: of & 0xf0,
            curve_type: next,
            // V7 keeps "closed" in bit 0x80 of the order byte. Both V8 sample curves have
            // that bit clear but bit 0 of the next byte set, and the oracle evaluates them
            // as periodic, so either bit closes the curve (FORMAT_NOTES, open question).
            closed: of & 0x80 != 0 || next & 0x01 != 0,
            num_poles: le::u32_at(self.b, 0x70).unwrap_or(0),
            num_knots: le::u32_at(self.b, 0x74).unwrap_or(0),
        })
    }

    /// Knot / weight vectors: doubles after the 0x20-byte identification prefix
    /// (layout unverified, see FORMAT_NOTES).
    fn scalars(&self) -> Vec<f64> {
        let n = self.b.len().saturating_sub(0x20) / 8;
        let n = n.min(self.limits.max_vertices as usize);
        (0..n)
            .map_while(|i| le::f64_at(self.b, 0x20 + 8 * i))
            .collect()
    }

    fn color_table(&self) -> R<ElementData> {
        // Like V7: a u16 screen flag, then 256 RGB triples whose first entry is color 255.
        let rgb = le::bytes(self.b, 0x22, 768).ok_or_else(short)?;
        let mut colors = vec![[0u8; 3]; 256];
        for (i, c) in rgb.as_chunks::<3>().0.iter().enumerate() {
            let slot = if i == 0 { 255 } else { i - 1 };
            if let (Some(dst), [r, g, b]) = (colors.get_mut(slot), c) {
                *dst = [*r, *g, *b];
            }
        }
        Ok(ElementData::ColorTable { colors })
    }

    fn tag(&self, links: &[linkage::Linkage]) -> R<TagData> {
        let value_type = le::u16_at(self.b, 0xd2).ok_or_else(short)?;
        let len = le::u32_at(self.b, 0x138).ok_or_else(short)? as usize;
        let len = len.min(self.limits.max_string_bytes as usize);
        let raw = le::bytes(self.whole, 0x140, len)
            .ok_or_else(|| format!("tag value of {len} bytes exceeds the element"))?;
        Ok(TagData {
            set_id: linkage::dependency_root(links, DEP_TAG_SET),
            set_number: None,
            tag_index: le::u16_at(self.b, 0xd0).unwrap_or(0),
            value_type,
            value: tag_value(value_type, raw, self.enc),
            target: linkage::dependency_root(links, DEP_TAG_TARGET),
            origin: le::f64s::<3>(self.b, 0xa0).unwrap_or([0.0; 3]),
            offset: le::f64s::<3>(self.b, 0xb8).unwrap_or([0.0; 3]),
            size: [
                le::f64_at(self.b, 0xf0).unwrap_or(0.0) * TEXT_MULT_TO_UOR,
                le::f64_at(self.b, 0xf8).unwrap_or(0.0) * TEXT_MULT_TO_UOR,
            ],
            font: le::u32_at(self.b, 0x12c).unwrap_or(0),
            justification: le::u16_at(self.b, 0x130).unwrap_or(0),
            quaternion: le::f64s::<4>(self.b, 0x100).unwrap_or([0.0; 4]),
        })
    }

    /// Tag set definition: magic `teSt` at 0x28, definitions byte length at 0x34,
    /// definitions from 0x3c; set name in string linkage 1.
    fn tag_set(&self, links: &[linkage::Linkage]) -> R<TagSetData> {
        let len = le::u32_at(self.b, 0x34).ok_or_else(short)? as usize;
        let defs = le::bytes(self.b, 0x3c, len.min(self.b.len().saturating_sub(0x3c)))
            .ok_or_else(short)?;
        Ok(TagSetData {
            name: linkage::string(links, 1),
            number: None,
            tags: parse_tag_defs(defs, self.enc),
        })
    }

    fn table_entry(&self, table: u32, links: &[linkage::Linkage]) -> R<ElementData> {
        match table {
            TABLE_LEVELS => Ok(ElementData::Level(LevelData {
                id: le::u32_at(self.b, 0x20).ok_or_else(short)?,
                name: linkage::string(links, 1),
                description: linkage::string(links, 2),
                parent: le::u32_at(self.b, 0x24).unwrap_or(u32::MAX),
                flags: le::u32_at(self.b, 0x28).unwrap_or(0),
            })),
            TABLE_FONTS => {
                let number = le::u32_at(self.b, 0x28).ok_or_else(short)?;
                let n = usize::from(le::u16_at(self.b, 0x2c).unwrap_or(0));
                let name = le::bytes(self.whole, 0x2e, n)
                    .map(text::decode_utf16_name)
                    .unwrap_or_default();
                Ok(ElementData::Font { number, name })
            }
            _ => Ok(ElementData::Unknown),
        }
    }
}

/// Decodes a tag value of `value_type` (1 text, 3 integer, 4 double, other binary).
pub(crate) fn tag_value(value_type: u16, raw: &[u8], enc: TextDecoder) -> TagValue {
    match value_type {
        1 => TagValue::Text(text::decode_dgn_string(raw, enc).0),
        3 => le::array::<4>(raw, 0).map_or_else(
            || TagValue::Binary(raw.to_vec()),
            |a| TagValue::Int(i64::from(i32::from_le_bytes(a))),
        ),
        4 => le::f64_at(raw, 0).map_or_else(|| TagValue::Binary(raw.to_vec()), TagValue::Float),
        _ => TagValue::Binary(raw.to_vec()),
    }
}

/// Tag definitions (V7 type 66 and V8 type 39 share this record list, GDAL dgnlib
/// `DGNParseTagSet`): name, `u16` id, prompt, `u16` type, 5 bytes, default value.
pub(crate) fn parse_tag_defs(b: &[u8], enc: impl Into<TextDecoder>) -> Vec<TagDef> {
    let enc = enc.into();
    let mut out = Vec::new();
    let mut off = 0usize;
    while off < b.len() && out.len() < 4096 {
        let Some((name, o)) = text::dgn_cstr_at(b, off, enc) else {
            break;
        };
        let Some(id) = le::u16_at(b, o) else { break };
        let Some((prompt, o)) = text::dgn_cstr_at(b, o + 2, enc) else {
            break;
        };
        let Some(value_type) = le::u16_at(b, o) else {
            break;
        };
        let Some(flags) = le::array::<5>(b, o + 2) else {
            break;
        };
        let o = o + 2 + 5;
        let (default, next) = match value_type {
            1 => match text::dgn_cstr_at(b, o, enc) {
                Some((s, n)) => (TagValue::Text(s), n),
                None => break,
            },
            3 | 5 => match le::array::<4>(b, o) {
                Some(a) => (TagValue::Int(i64::from(i32::from_le_bytes(a))), o + 4),
                None => break,
            },
            4 => match le::array::<8>(b, o) {
                Some(a) => (TagValue::Float(f64::from_le_bytes(a)), o + 8),
                None => break,
            },
            _ => match le::bytes(b, o, 4) {
                Some(v) => (TagValue::Binary(v.to_vec()), o + 4),
                None => break,
            },
        };
        if name.is_empty() && id == 0 {
            break;
        }
        out.push(TagDef {
            id,
            name,
            prompt,
            value_type,
            default,
            flags,
        });
        off = next;
    }
    out
}

#[cfg(test)]
pub(crate) mod tests {
    use super::*;
    use crate::native::v8::tests::element;

    fn raw(bytes: Vec<u8>) -> RawElement {
        let tw = u32::from_le_bytes([bytes[0], bytes[1], bytes[2], bytes[3]]);
        let words = u32::from_le_bytes([bytes[4], bytes[5], bytes[6], bytes[7]]);
        let attr = u32::from_le_bytes([bytes[8], bytes[9], bytes[10], bytes[11]]);
        RawElement {
            offset: 0,
            prefix: 0,
            type_word: tw,
            words,
            attr_words: attr,
            bytes,
        }
    }

    /// Display header body starting at 0x0c: level, id, color etc.; `flags` at 0x28.
    pub(crate) fn header(level: u32, id: u64, flags: u32, color: u32) -> Vec<u8> {
        let mut h = vec![0u8; HEADER_LEN - 0x0c];
        h[0..4].copy_from_slice(&level.to_le_bytes());
        h[4..12].copy_from_slice(&id.to_le_bytes());
        h[0x28 - 0x0c..0x2c - 0x0c].copy_from_slice(&flags.to_le_bytes());
        h[0x34 - 0x0c..0x38 - 0x0c].copy_from_slice(&color.to_le_bytes());
        h
    }

    pub(crate) fn f64s(v: &[f64]) -> Vec<u8> {
        v.iter().flat_map(|x| x.to_le_bytes()).collect()
    }

    fn lim() -> Limits {
        Limits::default()
    }

    fn enc() -> &'static Encoding {
        encoding_rs::WINDOWS_1252
    }

    #[test]
    fn decodes_line_shape_and_header_fields() {
        let mut body = header(64, 0x25, 0x800, 3);
        body.extend(f64s(&[0.0, 10000.0, 20000.0, 30000.0, 40000.0, 50000.0]));
        let e = decode(&raw(element(3, &body, &[])), enc(), &lim());
        assert_eq!(e.header.level, 64);
        assert_eq!(e.header.id, Some(0x25));
        assert!(e.header.is_3d);
        assert_eq!(e.header.color, 3);
        assert_eq!(
            e.data,
            ElementData::Line {
                start: [0.0, 10000.0, 20000.0],
                end: [30000.0, 40000.0, 50000.0]
            }
        );

        let mut body = header(64, 1, 0x200, 0);
        body.extend(&5u32.to_le_bytes());
        body.extend(&[0u8; 4]);
        body.extend(f64s(&[0., 0., 0., 1., 1., 1., 1., 0., 0., 0.]));
        let e = decode(&raw(element(6, &body, &[])), enc(), &lim());
        let ElementData::Shape { points } = &e.data else {
            panic!("{e:?}")
        };
        assert_eq!(points.len(), 5);
        assert_eq!(points[2], [1.0, 1.0, 0.0]);
    }

    #[test]
    fn vertex_count_is_validated() {
        let mut body = header(1, 1, 0, 0);
        body.extend(&u32::MAX.to_le_bytes());
        body.extend(&[0u8; 4]);
        let e = decode(&raw(element(4, &body, &[])), enc(), &lim());
        assert_eq!(e.data, ElementData::Unknown);
        assert!(e.problem.is_some());
    }

    #[test]
    fn decodes_2d_arc_and_3d_ellipse() {
        let mut body = header(1, 2, 0, 0);
        body.extend(f64s(&[0.1, 3.0, 10.0, 20.0, 0.5, 1.0, 2.0]));
        let e = decode(&raw(element(16, &body, &[])), enc(), &lim());
        assert_eq!(
            e.data,
            ElementData::Arc {
                start: 0.1,
                sweep: 3.0,
                primary: 10.0,
                secondary: 20.0,
                rotation: Rotation::Angle(0.5),
                center: [1.0, 2.0, 0.0]
            }
        );
        let mut body = header(1, 2, 0x800, 0);
        body.extend(f64s(&[1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 10000.0, 20000.0]));
        let e = decode(&raw(element(15, &body, &[])), enc(), &lim());
        assert_eq!(
            e.data,
            ElementData::Ellipse {
                primary: 1.0,
                secondary: 1.0,
                rotation: Rotation::Quaternion([1.0, 0.0, 0.0, 0.0]),
                center: [0.0, 10000.0, 20000.0]
            }
        );
    }

    #[test]
    fn decodes_2d_text_with_marker() {
        let mut body = header(64, 0x28, 0, 0);
        body.extend(&1024u32.to_le_bytes());
        body.extend(&0u16.to_le_bytes());
        body.extend(&10u16.to_le_bytes());
        body.extend(f64s(&[
            1_666_666.666_666_7,
            1_666_666.666_666_7,
            0.0,
            0.0,
            -0.785,
            0.0,
            10000.0,
        ]));
        body.extend(&0u16.to_le_bytes());
        body.extend(&[0xff, 0xfe, 1, 0, b'm', b'y', b'T', 0xe9, b'x', b't']);
        let e = decode(&raw(element(17, &body, &[])), enc(), &lim());
        let ElementData::Text(t) = &e.data else {
            panic!("{e:?}")
        };
        assert_eq!(t.text, "myTéxt");
        assert_eq!(t.font, 1024);
        assert!((t.height - 10_000.0).abs() < 1e-6);
        assert_eq!(t.origin, [0.0, 10000.0, 0.0]);
        assert_eq!(t.rotation, Rotation::Angle(-0.785));
    }

    /// A text element: `flags` at 0x28, range low x / x extent at 0x38 / 0x50, 2D angle
    /// or 3D quaternion at 0x90 (by `rotation.len()`), origin x at 0x98 / 0xB0, stored
    /// length at 0x80.
    fn text_record(
        flags: u32,
        rotation: &[f64],
        low_x: i64,
        span_x: i64,
        stored: f64,
        text: &[u8],
    ) -> RawElement {
        let three = rotation.len() == 4;
        let mut body = header(64, 0x29, flags | if three { FLAG_3D } else { 0 }, 0);
        body[0x38 - 0x0c..0x40 - 0x0c].copy_from_slice(&low_x.to_le_bytes());
        body[0x50 - 0x0c..0x58 - 0x0c].copy_from_slice(&span_x.to_le_bytes());
        body[0x58 - 0x0c..0x60 - 0x0c].copy_from_slice(&500i64.to_le_bytes());
        body.extend(&1024u32.to_le_bytes());
        body.extend(&7u16.to_le_bytes());
        body.extend(&(text.len() as u16).to_le_bytes());
        // Width and height multipliers (UOR = value x 6/1000: 100 and 500), stored length
        // and height.
        body.extend(f64s(&[100_000.0 / 6.0, 500_000.0 / 6.0, stored, 0.0]));
        body.extend(f64s(rotation));
        body.extend(f64s(if three {
            &[2000.0, 3000.0, 0.0]
        } else {
            &[2000.0, 3000.0]
        }));
        body.extend(&0u16.to_le_bytes());
        body.extend(text);
        raw(element(17, &body, &[]))
    }

    fn length_of(raw: &RawElement) -> Option<f64> {
        let ElementData::Text(t) = decode(raw, enc(), &lim()).data else {
            panic!("text")
        };
        t.measured_length
    }

    /// V8 text without a stored length takes it from the range when the range starts at
    /// the (lower-left) origin of an unrotated, non-empty text whose property bit 0x1000 is
    /// clear; otherwise the length stays unknown (estimated by the mapping).
    #[test]
    fn unmeasured_text_length_comes_from_the_range() {
        let half = std::f64::consts::FRAC_PI_8;
        for rotation in [&[0.0][..], &[1.0, 0.0, 0.0, 0.0], &[-1.0, 0.0, 0.0, 0.0]] {
            assert_eq!(
                length_of(&text_record(0, rotation, 2000, 1234, 0.0, b"Text")),
                Some(1234.0)
            );
            // Within one UOR of the origin (ranges are whole UOR).
            assert_eq!(
                length_of(&text_record(0, rotation, 1999, 1234, 0.0, b"Text")),
                Some(1234.0)
            );
        }
        // A stored length wins over the range.
        assert_eq!(
            length_of(&text_record(0, &[0.0], 2000, 1234, 583.5, b"Text")),
            Some(583.5)
        );
        for raw in [
            // Bit 0x1000: the range is not the text box.
            text_record(0x1000, &[0.0], 2000, 1234, 0.0, b"Text"),
            // Rotated (2D angle, 3D quaternion of 45 degrees about Z).
            text_record(0, &[0.5], 2000, 1234, 0.0, b"Text"),
            text_record(
                0,
                &[half.cos(), 0.0, 0.0, half.sin()],
                2000,
                1234,
                0.0,
                b"Text",
            ),
            // The range does not start at the origin.
            text_record(0, &[0.0], 2002, 1234, 0.0, b"Text"),
            // An empty range, and an empty text (its range is the empty box rounded out).
            text_record(0, &[0.0], 2000, 0, 0.0, b"Text"),
            text_record(0, &[0.0], 2000, 1, 0.0, b""),
        ] {
            assert_eq!(length_of(&raw), None);
        }
        assert_eq!(
            stored_text_length(&text_record(0, &[0.0], 2000, 1, 0.0, b"").bytes),
            None
        );
    }

    /// The symbology fields of a 240-byte level entry; other entry sizes give none.
    #[test]
    fn level_symbology_reads_240_byte_entries_only() {
        let mut body = vec![0u8; 0xf0 - 0x0c];
        body[0x20 - 0x0c..0x24 - 0x0c].copy_from_slice(&5u32.to_le_bytes());
        body[0x40 - 0x0c..0x44 - 0x0c].copy_from_slice(&(-435i32).to_le_bytes());
        body[0x44 - 0x0c..0x48 - 0x0c].copy_from_slice(&2u32.to_le_bytes());
        body[0x48 - 0x0c..0x4c - 0x0c].copy_from_slice(&114u32.to_le_bytes());
        body[0x4c - 0x0c..0x50 - 0x0c].copy_from_slice(&114u32.to_le_bytes());
        let entry = element(95, &body, &[]);
        assert_eq!(
            level_symbology(&entry),
            Some(LevelSymbology {
                color: 114,
                weight_raw: 2,
                style_raw: -435
            })
        );
        let short = element(95, &body[..0x68 - 0x0c], &[]);
        assert_eq!(level_symbology(&short), None);
        assert_eq!(level_symbology(&entry[..0x40]), None);
    }

    #[test]
    fn decodes_tag_with_dependencies() {
        let mut body = header(1, 0x6f, 0x1280, 0);
        body.resize(0x140 - 0x0c, 0);
        let put = |b: &mut Vec<u8>, off: usize, v: &[u8]| {
            b[off - 0x0c..off - 0x0c + v.len()].copy_from_slice(v)
        };
        put(&mut body, 0xa0, &f64s(&[5.0, 6.0, 0.0, 0.0, -10.0, 0.0]));
        put(&mut body, 0xd0, &[1, 0, 1, 0]);
        put(&mut body, 0x138, &4u32.to_le_bytes());
        body.extend(b"Oak\0");
        let mut links = vec![0x0b, 0x10, 0xd0, 0x56, 0x17, 0x27, 0, 0, 0, 2, 1, 0];
        links.extend(&0x6e_u64.to_le_bytes());
        links.extend(&[0; 4]);
        let mut d = vec![0x1b, 0x10, 0xd0, 0x56, 0x10, 0x27, 1, 0, 0, 0x0a, 1, 0];
        d.extend(&7u64.to_le_bytes());
        d.extend(&0x6b_u64.to_le_bytes());
        d.resize(56, 0);
        links.extend(d);
        let e = decode(&raw(element(37, &body, &links)), enc(), &lim());
        let ElementData::Tag(t) = &e.data else {
            panic!("{e:?}")
        };
        assert_eq!(t.value, TagValue::Text("Oak".into()));
        assert_eq!(
            (t.set_id, t.target, t.tag_index),
            (Some(0x6e), Some(0x6b), 1)
        );
        assert_eq!(t.origin, [5.0, 6.0, 0.0]);
    }

    #[test]
    fn parses_tag_set_definitions() {
        let mut defs = Vec::new();
        defs.extend(b"Species\0");
        defs.extend(&1u16.to_le_bytes());
        defs.extend(b"Enter value\0");
        defs.extend(&1u16.to_le_bytes());
        defs.extend(&[13, 0, 1, 0, 0]);
        defs.extend(b"Default Value\0");
        defs.extend(b"Count\0");
        defs.extend(&2u16.to_le_bytes());
        defs.extend(b"\0");
        defs.extend(&3u16.to_le_bytes());
        defs.extend(&[0, 0, 3, 0, 0]);
        defs.extend(&7i32.to_le_bytes());
        let d = parse_tag_defs(&defs, enc());
        assert_eq!(d.len(), 2);
        assert_eq!(d[0].name, "Species");
        assert_eq!(d[0].default, TagValue::Text("Default Value".into()));
        assert_eq!(
            (d[1].id, d[1].value_type, d[1].default.clone()),
            (2, 3, TagValue::Int(7))
        );
        // Truncated definitions stop cleanly.
        assert_eq!(parse_tag_defs(&defs[..10], enc()).len(), 0);
    }

    #[test]
    fn decodes_cells_in_both_layouts() {
        let mut body = header(0, 9, 0xc200, 0);
        body.extend(&2u32.to_le_bytes());
        body.extend(&1u32.to_le_bytes());
        body.extend(f64s(&[0., 0., 1., 1., 1., 0., 0., 1., 7., 8.]));
        let e = decode(&raw(element(0x2000_0002, &body, &[])), enc(), &lim());
        let ElementData::Cell(c) = &e.data else {
            panic!("{e:?}")
        };
        assert_eq!(c.children, 2);
        assert_eq!(c.origin, [7.0, 8.0, 0.0]);
        assert_eq!(c.matrix, [1., 0., 0., 0., 1., 0., 0., 0., 1.]);
        assert!(e.header.complex_header);

        let mut body = header(0, 9, 0, 0);
        body.extend(&1u32.to_le_bytes());
        body.extend(&0u32.to_le_bytes());
        body.extend(f64s(&[-1., -1., 0., 1., 1., 0.]));
        body.extend(f64s(&[10000., 0., 0., 0., 10000., 0., 0., 0., 10000.]));
        body.extend(f64s(&[0., 10000., 20000.]));
        let mut name = vec![0x0b, 0x10, 0xd2, 0x56, 1, 0, 0, 0, 3, 0, 0, 0];
        name.extend(b"Abc\0\0\0\0\0\0\0\0\0");
        let e = decode(&raw(element(35, &body, &name)), enc(), &lim());
        let ElementData::SharedCellInstance(c) = &e.data else {
            panic!("{e:?}")
        };
        assert_eq!(c.origin, [0.0, 10000.0, 20000.0]);
        assert_eq!(c.matrix[4], 10000.0);
        assert_eq!(linkage::string(&e.linkages, 1).as_deref(), Some("Abc"));
    }

    #[test]
    fn truncated_bodies_degrade() {
        for t in [
            2u32, 3, 4, 6, 7, 11, 12, 15, 16, 17, 21, 22, 27, 34, 35, 37, 39, 94, 95,
        ] {
            let e = decode(&raw(element(t, &header(1, 1, 0, 0), &[])), enc(), &lim());
            assert_eq!(e.header.type_code as u32, t);
            let _ = e.data;
        }
        let e = decode(&raw(element(3, &[1, 2, 3], &[])), enc(), &lim());
        assert!(!e.header.has_display_header);
    }
}