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
//! Non-graphical object serialization for DWG records.
//!
//! Handles dictionaries, layouts, plot-settings, XRecords, groups,
//! mline styles, image definitions, etc.
//!
//! Each writer:
//! 1. Calls `write_common_non_entity_data()` (type + handle + reactors)
//! 2. Writes type-specific fields
//! 3. Calls `register_object()` (CRC, output, handle map)
//!
//! Ported from ACadSharp `DwgObjectWriter.Objects.cs`.
use crate::io::dwg::dwg_reference_type::DwgReferenceType;
use crate::objects::*;
use crate::types::{DxfVersion, Handle};
use super::common;
use super::DwgObjectWriter;
/// Value type of an XRECORD/xdata resbuf item, keyed by its group code.
/// Mirrors libredwg `dwg_resbuf_value_type`. Only `Str` is version-specific
/// (code page pre-R2007, UTF-16 since); every other type is a fixed byte run.
#[derive(PartialEq)]
enum XdVt {
Str,
Real,
Int16,
Int32,
Int64,
Int8,
Point3d,
Binary,
Handle,
Invalid,
}
fn xdata_value_type(gc: i16) -> XdVt {
use XdVt::*;
match gc {
g if g < 0 => Handle,
0..=4 => Str,
5 => Handle,
6..=9 => Str,
10..=37 => Point3d,
38..=59 => Real,
60..=79 => Int16,
80..=99 => Int32,
100..=102 => Str,
105 => Handle,
110..=139 => Point3d,
140..=149 => Real,
150..=169 => Int64,
170..=179 => Int16,
210..=269 => Point3d,
270..=279 => Int16,
280..=289 => Int8,
290..=299 => Int8, // bool, one byte
300..=309 => Str,
310..=319 => Binary,
320..=369 => Handle, // 320-329 handle, 330-369 objectid (8 bytes)
370..=389 => Int16,
390..=399 => Handle,
400..=409 => Int16,
410..=419 => Str,
420..=429 => Int32,
430..=439 => Str,
440..=459 => Int32,
460..=469 => Real,
470..=479 => Str,
999 => Str,
1004 => Binary,
1000..=1009 => Str,
1010..=1039 => Point3d,
1040..=1042 => Real,
1043..=1069 => Point3d,
1070 => Int16,
1071 => Int32,
_ => Invalid,
}
}
/// Re-encode an XRECORD's xdata byte blob between the code-page (pre-R2007) and
/// UTF-16 (R2007+) string encodings, copying every non-string item verbatim.
///
/// XRECORD framing is already written version-correctly by the normal object
/// path; only the inline strings inside the xdata are version-specific. Without
/// this a cross-version save would emit the source version's strings and the
/// reader would mis-parse them ("Invalid xdata type"). Items are byte-aligned
/// (every value is a byte multiple). Code-page strings are treated as Latin-1,
/// which is exact for the ASCII keys/app names XRECORDs carry.
fn transcode_xrecord_xdata(raw: &[u8], src_unicode: bool, tgt_unicode: bool) -> Vec<u8> {
if src_unicode == tgt_unicode {
return raw.to_vec();
}
let rd_u16 = |b: &[u8], i: usize| (b[i] as u16) | ((b[i + 1] as u16) << 8);
let mut out = Vec::with_capacity(raw.len() + raw.len() / 2);
let mut p = 0usize;
while p + 2 <= raw.len() {
let gc = rd_u16(raw, p) as i16;
let vt = xdata_value_type(gc);
if vt == XdVt::Invalid {
break;
}
out.extend_from_slice(&raw[p..p + 2]); // group code
p += 2;
// Fixed-size values: copy the exact byte run verbatim.
let fixed = match vt {
XdVt::Real | XdVt::Int64 | XdVt::Handle => Some(8usize),
XdVt::Point3d => Some(24),
XdVt::Int32 => Some(4),
XdVt::Int16 => Some(2),
XdVt::Int8 => Some(1),
_ => None,
};
if let Some(n) = fixed {
if p + n > raw.len() {
break;
}
out.extend_from_slice(&raw[p..p + n]);
p += n;
continue;
}
if vt == XdVt::Binary {
if p >= raw.len() {
break;
}
let size = raw[p] as usize;
if p + 1 + size > raw.len() {
break;
}
out.extend_from_slice(&raw[p..p + 1 + size]);
p += 1 + size;
continue;
}
// Str: decode source format, re-encode target format.
if p + 2 > raw.len() {
break;
}
let len = rd_u16(raw, p) as usize;
p += 2;
let text: String = if src_unicode {
if p + len * 2 > raw.len() {
break;
}
let units: Vec<u16> = (0..len).map(|i| rd_u16(raw, p + i * 2)).collect();
p += len * 2;
String::from_utf16_lossy(&units)
} else {
// [u8 codepage][len bytes]
if p + 1 + len > raw.len() {
break;
}
p += 1; // codepage byte (treat bytes as Latin-1)
let s: String = raw[p..p + len].iter().map(|&b| b as char).collect();
p += len;
s
};
if tgt_unicode {
let utf16: Vec<u16> = text.encode_utf16().collect();
out.extend_from_slice(&(utf16.len() as u16).to_le_bytes());
for u in utf16 {
out.extend_from_slice(&u.to_le_bytes());
}
} else {
let bytes: Vec<u8> = text.chars().map(|c| c as u8).collect();
out.extend_from_slice(&(bytes.len() as u16).to_le_bytes());
out.push(30); // ANSI_1252 code page
out.extend_from_slice(&bytes);
}
}
out
}
/// Flatten a [`Matrix4`](crate::types::Matrix4) into 12 doubles holding its 3×4
/// part in row-major order (3 rows of 4); the bottom row is dropped. DWG stores
/// the spatial-filter transforms row-major.
fn matrix_to_row_major(m: &crate::types::Matrix4) -> [f64; 12] {
let mut out = [0.0; 12];
let mut i = 0;
for row in 0..3 {
for col in 0..4 {
out[i] = m.m[row][col];
i += 1;
}
}
out
}
impl<'a> DwgObjectWriter<'a> {
// ── Object dispatch ─────────────────────────────────────────────
/// Write a single non-graphical object record.
pub(super) fn write_object(&mut self, obj: &ObjectType) {
match obj {
ObjectType::Dictionary(d) => self.write_dictionary(d),
ObjectType::Layout(l) => self.write_layout(l),
ObjectType::XRecord(x) => self.write_xrecord(x),
ObjectType::Group(g) => self.write_group(g),
ObjectType::MLineStyle(m) => self.write_mlinestyle(m),
ObjectType::MultiLeaderStyle(m) => self.write_multileader_style(m),
ObjectType::ImageDefinition(d) => self.write_image_definition(d),
ObjectType::UnderlayDefinition(d) => self.write_underlay_definition(d),
ObjectType::ImageDefinitionReactor(r) => self.write_image_definition_reactor(r),
ObjectType::PlotSettings(p) => self.write_plot_settings_obj(p),
ObjectType::Scale(s) => self.write_scale(s),
ObjectType::SortEntitiesTable(s) => self.write_sort_entities_table(s),
ObjectType::DictionaryVariable(d) => self.write_dictionary_variable(d),
ObjectType::RasterVariables(r) => self.write_raster_variables(r),
ObjectType::DictionaryWithDefault(d) => self.write_dictionary_with_default(d),
ObjectType::PlaceHolder(p) => self.write_placeholder(p),
ObjectType::BookColor(b) => self.write_book_color(b),
ObjectType::WipeoutVariables(w) => self.write_wipeout_variables(w),
ObjectType::SpatialFilter(s) => self.write_spatial_filter(s),
// Stub / unsupported objects — skip
ObjectType::GeoData(_)
| ObjectType::VisualStyle(_)
| ObjectType::Material(_)
| ObjectType::TableStyle(_) => {}
ObjectType::Unknown { handle, raw_dwg_data, raw_dwg_handle_bits, raw_dwg_version, .. } => {
if let Some(ref raw) = raw_dwg_data {
if self.raw_passthrough_compatible(*raw_dwg_version) {
self.register_raw_object(*handle, raw, *raw_dwg_handle_bits);
}
}
}
}
}
// ── Helpers ──────────────────────────────────────────────────────
/// Whether verbatim `raw_dwg_data` from `raw_dwg_version` can be re-emitted
/// to the current target. Raw bytes encode the object using the source
/// version's object-type encoding, stream layout and text encoding, which
/// differ across the R2004/R2007 and R2007/R2010 boundaries and cannot be
/// reframed without parsing the (unsupported) object — so passthrough is
/// only valid within the same encoding family. `None` (e.g. DXF) is treated
/// as compatible. Incompatible objects are dropped to keep the file valid.
pub(super) fn raw_passthrough_compatible(&self, raw_dwg_version: Option<DxfVersion>) -> bool {
match raw_dwg_version {
None => true,
Some(src) => {
let tgt = self.dxf_version;
(src >= DxfVersion::AC1021) == (tgt >= DxfVersion::AC1021)
&& (src >= DxfVersion::AC1024) == (tgt >= DxfVersion::AC1024)
}
}
}
/// Returns `true` when the object at `handle` will actually be
/// serialized by `write_object`. Entries pointing to un-writable
/// objects (VisualStyle, Material, TableStyle, etc.) must be
/// excluded from dictionary records so the DWG doesn't contain
/// dangling handle references.
pub(super) fn is_writable_object(&self, handle: &Handle) -> bool {
match self.document.objects.get(handle) {
None => false,
Some(obj) => match obj {
ObjectType::GeoData(_)
| ObjectType::VisualStyle(_)
| ObjectType::Material(_)
| ObjectType::TableStyle(_) => false,
ObjectType::Unknown { type_name, raw_dwg_data, raw_dwg_version, .. } => {
// Exclude types that would also be excluded if parsed into proper variants
if type_name.starts_with("DWG_OBJ_106") // TABLESTYLE
|| type_name.starts_with("DWG_OBJ_105") // TABLECONTENT
{
return false;
}
// Exclude raw objects dropped on incompatible cross-version save.
raw_dwg_data.is_some() && self.raw_passthrough_compatible(*raw_dwg_version)
}
_ => true,
},
}
}
// ── Dictionary ──────────────────────────────────────────────────
fn write_dictionary(&mut self, dict: &Dictionary) {
// For pre-R2000, filter out R2000+-only dictionary entries
// (PLOTSTYLENAME, LAYOUT, PLOTSETTINGS, MATERIAL, COLOR, VISUALSTYLE)
let entries: Vec<&(String, Handle)> = if self.version.r2000_plus() {
dict.entries.iter()
.filter(|(_, h)| !h.is_null() && self.is_writable_object(h))
.collect()
} else {
dict.entries.iter().filter(|(name, h)| {
!matches!(name.as_str(),
"ACAD_PLOTSTYLENAME" | "ACAD_LAYOUT" | "ACAD_PLOTSETTINGS" |
"ACAD_MATERIAL" | "ACAD_COLOR" | "ACAD_VISUALSTYLE"
) && !h.is_null() && self.is_writable_object(h)
}).collect()
};
self.write_common_non_entity_data(
common::OBJ_DICTIONARY,
dict.handle,
dict.owner,
&dict.reactors,
&dict.xdictionary_handle,
);
// Number of entries (BL)
self.writer.write_bit_long(entries.len() as i32);
// R14 Only: Unknown byte (always 0)
if self.dxf_version == DxfVersion::AC1014 {
self.writer.write_byte(0);
}
// R2000+: Cloning flag (BS 281) + Hard-owner flag (RC)
if self.version.r2000_plus() {
self.writer.write_bit_short(dict.duplicate_cloning as i16);
self.writer.write_byte(if dict.hard_owner { 1 } else { 0 });
}
// Entry names + handles
for (name, handle) in &entries {
self.writer.write_variable_text(name);
// Dictionary item handles ALWAYS use reference code 2 (soft owner),
// regardless of the hard-owner flag. The hard/soft distinction is
// carried only by the is_hardowner byte (and the DXF 350/360 group),
// NOT the DWG handle code. Writing code 3 here makes AutoCAD reject
// every entry (eWrongObjectType) and discard the whole dictionary.
// (libredwg dwg.spec: HANDLE_VECTOR_N(itemhandles, numitems, 2, 0).)
self.writer
.write_handle(DwgReferenceType::SoftOwnership, handle.value());
// Enqueue referenced objects
if !handle.is_null() {
self.object_queue.push_back(*handle);
}
}
self.register_object(dict.handle);
}
// ── Dictionary with default ─────────────────────────────────────
fn write_dictionary_with_default(&mut self, dict: &DictionaryWithDefault) {
// Pre-R2000: ACDBDICTIONARYWDFLT class doesn't exist, so fall back
// to writing as a regular Dictionary (skip the default_handle field).
if !self.version.r2000_plus() {
let plain = Dictionary {
handle: dict.handle,
owner: dict.owner,
hard_owner: dict.hard_owner,
duplicate_cloning: dict.duplicate_cloning,
entries: dict.entries.clone(),
reactors: vec![],
xdictionary_handle: None,
};
self.write_dictionary(&plain);
return;
}
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("ACDBDICTIONARYWDFLT", common::OBJ_DICTIONARYWDFLT);
self.write_common_non_entity_data(
type_code,
dict.handle,
dict.owner,
&[],
&None,
);
// Filter out entries referencing un-writable objects
let entries: Vec<&(String, Handle)> = dict.entries.iter()
.filter(|(_, h)| h.is_null() || self.is_writable_object(h))
.collect();
// Same as dictionary
self.writer.write_bit_long(entries.len() as i32);
// R2000+: Cloning flag (BS) + Hard-owner flag (RC)
self.writer.write_bit_short(dict.duplicate_cloning as i16);
self.writer.write_byte(if dict.hard_owner { 1 } else { 0 });
for (name, handle) in &entries {
self.writer.write_variable_text(name);
// Dictionary item handles always use reference code 2 (see
// write_dictionary) — never code 3, which AutoCAD rejects.
self.writer
.write_handle(DwgReferenceType::SoftOwnership, handle.value());
if !handle.is_null() {
self.object_queue.push_back(*handle);
}
}
// Default entry handle
self.writer
.write_handle(DwgReferenceType::HardPointer, dict.default_handle.value());
self.register_object(dict.handle);
}
// ── Dictionary Variable ─────────────────────────────────────────
fn write_dictionary_variable(&mut self, dv: &DictionaryVariable) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("DICTIONARYVAR", common::OBJ_DICTIONARYVAR);
self.write_common_non_entity_data(
type_code,
dv.handle,
dv.owner_handle,
&[],
&None,
);
self.writer.write_byte(0); // object schema number
self.writer.write_variable_text(&dv.value);
self.register_object(dv.handle);
}
// ── Layout (extends PlotSettings) ───────────────────────────────
//
// Field order must match C# DwgObjectWriter.Objects.cs writeLayout()
// exactly. Layout extends PlotSettings, so PlotSettings fields come
// first, then Layout-specific fields.
fn write_layout(&mut self, layout: &Layout) {
// For pre-R2004, LAYOUT is an UNLISTED type — must use the DXF
// class number instead of the fixed type code 82.
let type_code = if self.version.r2004_pre() {
self.document
.classes
.get_by_name("LAYOUT")
.map(|c| c.class_number)
.unwrap_or(common::OBJ_LAYOUT)
} else {
common::OBJ_LAYOUT
};
self.write_common_non_entity_data(
type_code,
layout.handle,
layout.owner,
&layout.reactors,
&layout.xdictionary_handle,
);
// ── PlotSettings preamble ──
// ModelType flag (bit 0x400) must be set for model space layouts
let plot_flags: i16 = if layout.name == "Model" { 0x400 } else { 0 };
self.write_plot_settings_data(plot_flags, layout);
// ── Layout-specific data ──
// Layout name (TV)
self.writer.write_variable_text(&layout.name);
// Tab order (BL 71)
self.writer.write_bit_long(layout.tab_order as i32);
// Layout flags (BS 70)
self.writer.write_bit_short(layout.flags);
// UCS origin (3BD 13) — layout UCS origin
self.writer
.write_3bit_double(crate::types::Vector3::ZERO);
// Min limits (2RD 10)
self.writer.write_raw_double(layout.min_limits.0);
self.writer.write_raw_double(layout.min_limits.1);
// Max limits (2RD 11)
self.writer.write_raw_double(layout.max_limits.0);
self.writer.write_raw_double(layout.max_limits.1);
// Insertion base (3BD 12)
self.writer
.write_3bit_double(crate::types::Vector3::new(
layout.insertion_base.0,
layout.insertion_base.1,
layout.insertion_base.2,
));
// X axis direction (3BD)
self.writer
.write_3bit_double(crate::types::Vector3::UNIT_X);
// Y axis direction (3BD)
self.writer
.write_3bit_double(crate::types::Vector3::UNIT_Y);
// Elevation (BD)
self.writer.write_bit_double(0.0);
// UCS orthographic type (BS)
self.writer.write_bit_short(0);
// Min extents (3BD)
self.writer
.write_3bit_double(crate::types::Vector3::new(
layout.min_extents.0,
layout.min_extents.1,
layout.min_extents.2,
));
// Max extents (3BD)
self.writer
.write_3bit_double(crate::types::Vector3::new(
layout.max_extents.0,
layout.max_extents.1,
layout.max_extents.2,
));
// R2004+: Viewport count (BL)
if self.version.r2004_plus() {
self.writer.write_bit_long(0); // no viewports
}
// ── Handle references ──
// 330 Associated block record (soft pointer)
self.writer
.write_handle(DwgReferenceType::SoftPointer, layout.block_record.value());
// 331 Last active viewport (soft pointer)
self.writer
.write_handle(DwgReferenceType::SoftPointer, layout.viewport.value());
// UCS handles — ortho type is 0 (None), so:
// 346 base UCS handle (hard pointer) — null
self.writer
.write_handle(DwgReferenceType::HardPointer, 0);
// 345 named UCS handle (hard pointer) — null
self.writer
.write_handle(DwgReferenceType::HardPointer, 0);
// R2004+: Viewport handles (repeated count times — 0 for us)
// (nothing to write since viewport count is 0)
self.register_object(layout.handle);
}
/// Write the PlotSettings portion of a Layout record.
///
/// Field order must match C# DwgObjectWriter.Objects.cs writePlotSettings()
/// exactly. Uses simplified/default values.
fn write_plot_settings_data(&mut self, plot_flags: i16, layout: &crate::objects::Layout) {
// Fall back to A4 landscape when the layout carries no paper size
// (e.g. freshly created layouts that never read a PlotSettings block).
let (paper_width, paper_height) =
if layout.paper_width > 0.0 && layout.paper_height > 0.0 {
(layout.paper_width, layout.paper_height)
} else {
(297.0, 210.0)
};
// Page setup name (TV 1)
self.writer.write_variable_text(&layout.plot_page_name);
// Printer / Config (TV 2)
self.writer.write_variable_text(&layout.plot_printer_name);
// Plot layout flags (BS 70)
self.writer.write_bit_short(plot_flags);
// Margins (BD: left, bottom, right, top)
self.writer.write_bit_double(layout.plot_margin_left);
self.writer.write_bit_double(layout.plot_margin_bottom);
self.writer.write_bit_double(layout.plot_margin_right);
self.writer.write_bit_double(layout.plot_margin_top);
// Paper width (BD 44), height (BD 45)
self.writer.write_bit_double(paper_width);
self.writer.write_bit_double(paper_height);
// Paper size (TV 4)
self.writer.write_variable_text(&layout.paper_size);
// Plot origin (2BD 46,47)
self.writer.write_bit_double(layout.plot_origin_x);
self.writer.write_bit_double(layout.plot_origin_y);
// Paper units (BS 72), Plot rotation (BS 73), Plot type (BS 74)
self.writer.write_bit_short(layout.plot_paper_units);
self.writer.write_bit_short(layout.plot_rotation);
self.writer.write_bit_short(layout.plot_type);
// Plot window (2BD min, 2BD max)
self.writer.write_bit_double(layout.plot_window_min_x);
self.writer.write_bit_double(layout.plot_window_min_y);
self.writer.write_bit_double(layout.plot_window_max_x);
self.writer.write_bit_double(layout.plot_window_max_y);
// R13-R2000 only: Plot view name (TV 6)
if self.version.r13_15_only() {
self.writer.write_variable_text(&layout.plot_view_name);
}
// Real world units / numerator (BD 142)
let num = if layout.plot_scale_numerator != 0.0 { layout.plot_scale_numerator } else { 1.0 };
let den = if layout.plot_scale_denominator != 0.0 { layout.plot_scale_denominator } else { 1.0 };
self.writer.write_bit_double(num);
// Drawing units / denominator (BD 143)
self.writer.write_bit_double(den);
// Current style sheet (TV 7)
self.writer.write_variable_text(&layout.plot_style_sheet);
// Scale type (BS 75)
self.writer.write_bit_short(layout.plot_scale_type);
// Scale factor (BD 147) — standard scale value
let factor = if layout.plot_scale_factor != 0.0 { layout.plot_scale_factor } else { 1.0 };
self.writer.write_bit_double(factor);
// Paper image origin (2BD 148,149)
self.writer.write_bit_double(layout.paper_image_origin_x);
self.writer.write_bit_double(layout.paper_image_origin_y);
// R2004+: shade plot fields
if self.version.r2004_plus() {
self.writer.write_bit_short(layout.shade_plot_mode);
self.writer.write_bit_short(layout.shade_plot_resolution);
let dpi = if layout.shade_plot_dpi != 0 { layout.shade_plot_dpi } else { 300 };
self.writer.write_bit_short(dpi);
// Plot view handle (hard pointer)
self.writer
.write_handle(DwgReferenceType::HardPointer, 0);
}
// R2007+: visual style handle
if self.version.r2007_plus() {
self.writer
.write_handle(DwgReferenceType::SoftPointer, 0);
}
}
/// Write a standalone PlotSettings object.
fn write_plot_settings_obj(&mut self, ps: &PlotSettings) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("PLOTSETTINGS", common::OBJ_PLOTSETTINGS);
self.write_common_non_entity_data(
type_code,
ps.handle,
ps.owner,
&[],
&None,
);
// Field order must match C# writePlotSettings() exactly
// Page setup name (TV 1)
self.writer.write_variable_text(&ps.page_name);
// Printer / Config (TV 2)
self.writer.write_variable_text(&ps.printer_name);
// Plot layout flags (BS 70)
self.writer.write_bit_short(0);
// Margins (BD: left, bottom, right, top)
self.writer.write_bit_double(ps.margins.left);
self.writer.write_bit_double(ps.margins.bottom);
self.writer.write_bit_double(ps.margins.right);
self.writer.write_bit_double(ps.margins.top);
// Paper width (BD 44), height (BD 45)
self.writer.write_bit_double(ps.paper_width);
self.writer.write_bit_double(ps.paper_height);
// Paper size (TV 4)
self.writer.write_variable_text(&ps.paper_size);
// Plot origin (2BD 46,47)
self.writer.write_bit_double(ps.origin_x);
self.writer.write_bit_double(ps.origin_y);
// Paper units (BS 72), Plot rotation (BS 73), Plot type (BS 74)
self.writer.write_bit_short(ps.paper_units as i16);
self.writer.write_bit_short(ps.rotation as i16);
self.writer.write_bit_short(ps.plot_type as i16);
// Plot window (2BD min, 2BD max)
self.writer.write_bit_double(ps.plot_window.lower_left_x);
self.writer.write_bit_double(ps.plot_window.lower_left_y);
self.writer.write_bit_double(ps.plot_window.upper_right_x);
self.writer.write_bit_double(ps.plot_window.upper_right_y);
// R13-R2000 only: Plot view name (TV 6)
if self.version.r13_15_only() {
self.writer.write_variable_text(&ps.plot_view_name);
}
// Real world units / numerator (BD 142)
self.writer.write_bit_double(ps.scale_numerator);
// Drawing units / denominator (BD 143)
self.writer.write_bit_double(ps.scale_denominator);
// Current style sheet (TV 7)
self.writer.write_variable_text(&ps.current_style_sheet);
// Scale type (BS 75)
self.writer.write_bit_short(ps.scale_type as i16);
// Scale factor (BD 147)
self.writer.write_bit_double(1.0);
// Paper image origin (2BD 148,149)
self.writer.write_bit_double(0.0);
self.writer.write_bit_double(0.0);
// R2004+: shade plot fields
if self.version.r2004_plus() {
self.writer.write_bit_short(ps.shade_plot_mode as i16);
self.writer
.write_bit_short(ps.shade_plot_resolution as i16);
self.writer.write_bit_short(ps.shade_plot_dpi);
// Plot view handle (hard pointer)
self.writer
.write_handle(DwgReferenceType::HardPointer, 0);
}
// R2007+: visual style handle
if self.version.r2007_plus() {
self.writer
.write_handle(DwgReferenceType::SoftPointer, 0);
}
self.register_object(ps.handle);
}
// ── Group ───────────────────────────────────────────────────────
fn write_group(&mut self, group: &Group) {
self.write_common_non_entity_data(
common::OBJ_GROUP,
group.handle,
group.owner,
&[],
&None,
);
self.writer.write_variable_text(&group.description);
self.writer.write_bit_short(1); // unnamed flag (0=named)
self.writer
.write_bit_short(if group.selectable { 1 } else { 0 });
// Entity handles
self.writer
.write_bit_long(group.entities.len() as i32);
for h in &group.entities {
self.writer
.write_handle(DwgReferenceType::HardPointer, h.value());
}
self.register_object(group.handle);
}
// ── MLineStyle ──────────────────────────────────────────────────
fn write_mlinestyle(&mut self, style: &MLineStyle) {
self.write_common_non_entity_data(
common::OBJ_MLINESTYLE,
style.handle,
style.owner,
&[],
&None,
);
self.writer.write_variable_text(&style.name);
self.writer.write_variable_text(&style.description);
// Flags — DWG binary format swaps some pairs vs the DXF enum:
// DWG bit 1 = DisplayJoints, bit 2 = FillOn
// (DXF enum: FillOn=1, DisplayJoints=2)
// DWG: StartRound=0x20, StartInner=0x40
// (DXF: StartInner=0x20, StartRound=0x40)
// DWG: EndRound=0x200, EndInner=0x400
// (DXF: EndInner=0x200, EndRound=0x400)
let mut flags: i16 = 0;
if style.flags.display_joints { flags |= 1; }
if style.flags.fill_on { flags |= 2; }
if style.flags.start_square_cap { flags |= 16; }
if style.flags.start_round_cap { flags |= 0x20; }
if style.flags.start_inner_arcs_cap { flags |= 0x40; }
if style.flags.end_square_cap { flags |= 0x100; }
if style.flags.end_round_cap { flags |= 0x200; }
if style.flags.end_inner_arcs_cap { flags |= 0x400; }
self.writer.write_bit_short(flags);
self.writer.write_cm_color(&style.fill_color);
self.writer.write_bit_double(style.start_angle);
self.writer.write_bit_double(style.end_angle);
// Elements
self.writer
.write_byte(style.elements.len() as u8);
for elem in &style.elements {
self.writer.write_bit_double(elem.offset);
self.writer.write_cm_color(&elem.color);
if self.version.r2018_plus(self.dxf_version) {
// R2018+: Line type handle (hard pointer)
let lt_handle = self
.document
.line_types
.get(&elem.linetype)
.map(|lt| lt.handle)
.unwrap_or(Handle::NULL);
self.writer
.write_handle(DwgReferenceType::HardPointer, lt_handle.value());
} else {
// Before R2018: Ltindex BS (linetype index, 0 = BYLAYER)
self.writer.write_bit_short(0);
}
}
self.register_object(style.handle);
}
// ── MultiLeaderStyle ────────────────────────────────────────────
fn write_multileader_style(&mut self, style: &MultiLeaderStyle) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("MLEADERSTYLE", common::OBJ_MLEADERSTYLE);
self.write_common_non_entity_data(
type_code,
style.handle,
style.owner_handle,
&[],
&None,
);
// R2010+: Version (BS, expected 2)
if self.version.r2010_plus() {
self.writer.write_bit_short(2);
}
// Content type
self.writer
.write_bit_short(style.content_type as i16);
// Draw order
self.writer
.write_bit_short(style.multileader_draw_order as i16);
self.writer
.write_bit_short(style.leader_draw_order as i16);
// Max leader points
self.writer
.write_bit_long(style.max_leader_points);
// Segment angles
self.writer
.write_bit_double(style.first_segment_angle);
self.writer
.write_bit_double(style.second_segment_angle);
// Leader
self.writer
.write_bit_short(style.path_type as i16);
self.writer.write_cm_color(&style.line_color);
let lt = style.line_type_handle.unwrap_or(Handle::NULL);
self.writer
.write_handle(DwgReferenceType::HardPointer, lt.value());
self.writer
.write_bit_long(style.line_weight.as_i16() as i32);
self.writer.write_bit(style.enable_landing);
self.writer.write_bit_double(style.landing_gap);
self.writer.write_bit(style.enable_dogleg);
self.writer
.write_bit_double(style.landing_distance);
self.writer.write_variable_text(&style.description);
// Arrowhead
let ah = style.arrowhead_handle.unwrap_or(Handle::NULL);
self.writer
.write_handle(DwgReferenceType::HardPointer, ah.value());
self.writer.write_bit_double(style.arrowhead_size);
// Default text
self.writer.write_variable_text(&style.default_text);
// Text style
let ts = style.text_style_handle.unwrap_or(Handle::NULL);
self.writer
.write_handle(DwgReferenceType::HardPointer, ts.value());
// Text attachments
self.writer
.write_bit_short(style.text_left_attachment as i16);
self.writer
.write_bit_short(style.text_right_attachment as i16);
self.writer
.write_bit_short(style.text_angle_type as i16);
self.writer
.write_bit_short(style.text_alignment as i16);
self.writer.write_cm_color(&style.text_color);
self.writer.write_bit_double(style.text_height);
self.writer.write_bit(style.text_frame);
self.writer.write_bit(style.text_always_left);
self.writer
.write_bit_double(style.align_space);
// Block
let bc = style.block_content_handle.unwrap_or(Handle::NULL);
self.writer
.write_handle(DwgReferenceType::HardPointer, bc.value());
self.writer
.write_cm_color(&style.block_content_color);
self.writer
.write_bit_double(style.block_content_scale_x);
self.writer
.write_bit_double(style.block_content_scale_y);
self.writer
.write_bit_double(style.block_content_scale_z);
self.writer.write_bit(style.enable_block_scale);
self.writer
.write_bit_double(style.block_content_rotation);
self.writer.write_bit(style.enable_block_rotation);
self.writer
.write_bit_short(style.block_content_connection as i16);
self.writer.write_bit_double(style.scale_factor);
self.writer.write_bit(style.property_changed);
self.writer.write_bit(style.is_annotative);
self.writer
.write_bit_double(style.break_gap_size);
// R2010+ additional fields
if self.version.r2010_plus() {
self.writer
.write_bit_short(style.text_attachment_direction as i16);
self.writer
.write_bit_short(style.text_top_attachment as i16);
self.writer
.write_bit_short(style.text_bottom_attachment as i16);
}
// R2013+ undocumented flag (DXF code 298)
if self.version.r2013_plus(self.dxf_version) {
self.writer.write_bit(style.unknown_flag_298);
}
self.register_object(style.handle);
}
// ── Image Definition ────────────────────────────────────────────
fn write_image_definition(&mut self, def: &ImageDefinition) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("IMAGEDEF", common::OBJ_IMAGEDEF);
self.write_common_non_entity_data(
type_code,
def.handle,
def.owner,
&[],
&None,
);
self.writer.write_bit_long(def.class_version);
self.writer
.write_2raw_double(crate::types::Vector2::new(
def.size_in_pixels.0 as f64,
def.size_in_pixels.1 as f64,
));
self.writer.write_variable_text(&def.file_name);
self.writer
.write_bit(def.is_loaded);
self.writer
.write_byte(def.resolution_unit as u8);
self.writer
.write_2raw_double(crate::types::Vector2::new(
def.pixel_size.0,
def.pixel_size.1,
));
self.register_object(def.handle);
}
// ── Underlay Definition (PDF / DWF / DGN) ───────────────────────
/// Write an underlay definition object (AcDbUnderlayDefinition): the file
/// path and page/sheet name, both variable text, after the common
/// non-entity header.
fn write_underlay_definition(&mut self, def: &UnderlayDefinition) {
use crate::entities::underlay::UnderlayType;
// UNLISTED type — resolve to the registered DXF class number (500+).
let fallback = match def.underlay_type {
UnderlayType::Dwf => common::OBJ_DWFDEFINITION,
UnderlayType::Dgn => common::OBJ_DGNDEFINITION,
UnderlayType::Pdf => common::OBJ_PDFDEFINITION,
};
let type_code = self.class_type_code(def.entity_name(), fallback);
self.write_common_non_entity_data(type_code, def.handle, def.owner_handle, &[], &None);
self.writer.write_variable_text(&def.file_path);
self.writer.write_variable_text(&def.page_name);
self.register_object(def.handle);
}
// ── Image Definition Reactor ────────────────────────────────────
fn write_image_definition_reactor(&mut self, reactor: &ImageDefinitionReactor) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("IMAGEDEF_REACTOR", common::OBJ_IMAGEDEFREACTOR);
self.write_common_non_entity_data(
type_code,
reactor.handle,
reactor.owner,
&[],
&None,
);
self.writer.write_bit_long(0); // class version
// C# reference does NOT write an image_handle here
// (the reader gets this from the reactor's owner relationship)
self.register_object(reactor.handle);
}
// ── Scale ───────────────────────────────────────────────────────
fn write_scale(&mut self, scale: &Scale) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("SCALE", common::OBJ_SCALE);
self.write_common_non_entity_data(
type_code,
scale.handle,
scale.owner_handle,
&[],
&None,
);
self.writer.write_bit_short(0); // unknown BS
self.writer.write_variable_text(&scale.name);
self.writer.write_bit_double(scale.paper_units);
self.writer.write_bit_double(scale.drawing_units);
self.writer.write_bit(scale.is_unit_scale);
self.register_object(scale.handle);
}
// ── Sort Entities Table ─────────────────────────────────────────
fn write_sort_entities_table(&mut self, table: &SortEntitiesTable) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("SORTENTSTABLE", common::OBJ_SORTENTSTABLE);
self.write_common_non_entity_data(
type_code,
table.handle,
table.owner_handle,
&[],
&None,
);
let entries: Vec<_> = table.entries().collect();
self.writer.write_bit_long(entries.len() as i32);
// Sort handles are stored inline in the DATA section (one per entry);
// the owner block and the sorted entity handles follow in the handle
// stream (owner first, then one per entry). Mirrors `read_sort_entities_
// table`. (#146)
for entry in &entries {
// Sort handles are sort-order keys, NOT object references — they use
// reference code 0 (Undefined/absolute), per the ODA spec
// (FIELD_HANDLE(sort_ents, 0, 5)). Writing them as a resolvable
// pointer makes AutoCAD's audit dereference them and mark the
// SORTENTS object ePermanentlyErased when a key has no live object.
self.writer
.write_main_handle(DwgReferenceType::Undefined, entry.sort_handle.value());
}
// block_owner is a soft pointer (code 4), not hard — matches the ODA
// spec FIELD_HANDLE(block_owner, 4, 0); a hard ref here makes AutoCAD
// reject the table (eWrongObjectType).
self.writer
.write_handle(DwgReferenceType::SoftPointer, table.block_owner_handle.value());
for entry in &entries {
self.writer
.write_handle(DwgReferenceType::SoftPointer, entry.entity_handle.value());
}
self.register_object(table.handle);
}
// ── XRecord ─────────────────────────────────────────────────────
fn write_xrecord(&mut self, xrec: &XRecord) {
self.write_common_non_entity_data(
common::OBJ_XRECORD,
xrec.handle,
xrec.owner,
&[],
&None,
);
// Write xdata bytes first (per spec: data before cloning flags). The
// blob is captured verbatim from the source version; when saving to a
// different string-encoding family (code page <-> UTF-16) re-encode the
// inline strings so the xdata stays valid instead of being dropped.
let xdata = if xrec.raw_data.is_empty() {
Vec::new()
} else {
let tgt_unicode = self.dxf_version >= DxfVersion::AC1021;
match self.document.dwg_source_version {
Some(src) if (src >= DxfVersion::AC1021) != tgt_unicode => {
transcode_xrecord_xdata(&xrec.raw_data, src >= DxfVersion::AC1021, tgt_unicode)
}
_ => xrec.raw_data.clone(),
}
};
if !xdata.is_empty() {
self.writer.write_bit_long(xdata.len() as i32);
for &b in &xdata {
self.writer.write_byte(b);
}
} else {
self.writer.write_bit_long(0);
}
// R2000+: Cloning flags (valid range 0..5; enum already constrains to valid values)
self.writer.write_bit_short(xrec.cloning_flags.to_value());
self.register_object(xrec.handle);
}
// ── Raster Variables ────────────────────────────────────────────
fn write_raster_variables(&mut self, rv: &RasterVariables) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("RASTERVARIABLES", common::OBJ_RASTERVARIABLES);
self.write_common_non_entity_data(
type_code,
rv.handle,
rv.owner,
&[],
&None,
);
self.writer.write_bit_long(rv.class_version);
self.writer.write_bit_short(rv.display_image_frame);
self.writer.write_bit_short(rv.image_quality);
self.writer.write_bit_short(rv.units);
self.register_object(rv.handle);
}
// ── Spatial Filter (XCLIP clip boundary) ────────────────────────
fn write_spatial_filter(&mut self, sf: &SpatialFilter) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("SPATIAL_FILTER", common::OBJ_SPATIALFILTER);
self.write_common_non_entity_data(
type_code,
sf.handle,
sf.owner,
&[],
&None,
);
self.writer.write_bit_short(sf.boundary_points.len() as i16);
for p in &sf.boundary_points {
self.writer.write_2raw_double(*p);
}
self.writer.write_3bit_double(sf.normal);
self.writer.write_3bit_double(sf.origin);
self.writer.write_bit_short(sf.display_enabled as i16);
self.writer.write_bit_short(sf.front_clip.is_some() as i16);
if let Some(d) = sf.front_clip {
self.writer.write_bit_double(d);
}
self.writer.write_bit_short(sf.back_clip.is_some() as i16);
if let Some(d) = sf.back_clip {
self.writer.write_bit_double(d);
}
for v in matrix_to_row_major(&sf.inverse_block_transform) {
self.writer.write_bit_double(v);
}
for v in matrix_to_row_major(&sf.clip_bound_transform) {
self.writer.write_bit_double(v);
}
self.register_object(sf.handle);
}
// ── PlaceHolder ─────────────────────────────────────────────────
fn write_placeholder(&mut self, ph: &PlaceHolder) {
self.write_common_non_entity_data(
common::OBJ_PLACEHOLDER,
ph.handle,
ph.owner,
&[],
&None,
);
self.register_object(ph.handle);
}
// ── BookColor ───────────────────────────────────────────────────
fn write_book_color(&mut self, bc: &BookColor) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("DBCOLOR", common::OBJ_DBCOLOR);
self.write_common_non_entity_data(
type_code,
bc.handle,
bc.owner,
&[],
&None,
);
self.writer.write_variable_text(&bc.color_name);
self.writer.write_variable_text(&bc.book_name);
self.register_object(bc.handle);
}
// ── Wipeout Variables ───────────────────────────────────────────
fn write_wipeout_variables(&mut self, wv: &WipeoutVariables) {
// UNLISTED type — always use DXF class number (500+)
let type_code = self.class_type_code("WIPEOUTVARIABLES", common::OBJ_WIPEOUTVARIABLES);
self.write_common_non_entity_data(
type_code,
wv.handle,
wv.owner,
&[],
&None,
);
self.writer.write_bit_short(wv.display_frame);
self.register_object(wv.handle);
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::document::CadDocument;
#[test]
fn write_empty_dictionary() {
let doc = CadDocument::new();
let mut writer = DwgObjectWriter::new(&doc).unwrap();
let dict = Dictionary::default();
writer.write_dictionary(&dict);
assert!(!writer.output.is_empty());
}
#[test]
fn write_dictionary_with_entries() {
let doc = CadDocument::new();
let mut writer = DwgObjectWriter::new(&doc).unwrap();
let mut dict = Dictionary::new();
dict.handle = Handle::new(0x10);
dict.add_entry("TestEntry".to_string(), Handle::new(0x20));
writer.write_dictionary(&dict);
assert!(!writer.output.is_empty());
// Should have enqueued the child handle
assert!(writer.object_queue.contains(&Handle::new(0x20)));
}
}