acadrust 0.6.7

A pure Rust library for reading and writing CAD files in DXF format (ASCII and Binary) and DWG format (Binary).
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
use std::io::Cursor;

use acadrust::entities::acis::primitives::build_box;
use acadrust::entities::solid3d::{AcisData, AcisRevision, Body, Region, Solid3D, Wire};
use acadrust::entities::surface::{Surface, SurfaceKind};
use acadrust::entities::EntityType;
use acadrust::io::dwg::dwg_stream_readers::bit_reader::DwgBitReader;
use acadrust::io::dwg::dwg_stream_readers::merged_reader::DwgMergedReader;
use acadrust::io::dwg::dwg_stream_readers::object_reader::entities::{
    read_acis_entity, read_surface,
};
use acadrust::io::dwg::dwg_stream_writers::bit_writer::DwgBitWriter;
use acadrust::io::dwg::DwgVersion;
use acadrust::types::{Color, DxfVersion, Vector3};
use acadrust::{CadDocument, DwgReadOptions, DwgReader, DwgWriter, SabReader, SabWriter};

const VERSIONS: [DxfVersion; 8] = [
    DxfVersion::AC1012,
    DxfVersion::AC1014,
    DxfVersion::AC1015,
    DxfVersion::AC1018,
    DxfVersion::AC1021,
    DxfVersion::AC1024,
    DxfVersion::AC1027,
    DxfVersion::AC1032,
];

fn sab() -> Vec<u8> {
    SabWriter::write(&build_box([10.0, 20.0, -5.0], 2.0, 3.0, 4.0))
}

// Encode the wire layout independently of DwgObjectWriter, particularly its
// BS color field, including both compact and full-width BS representations.
fn modeler_record(
    dxf_version: DxfVersion,
    bit_offset: i64,
    color: i16,
    full_width_color: bool,
    point_count: i32,
    surface: bool,
) -> (DwgMergedReader, Vec<u8>, i64) {
    modeler_record_with_silhouette(
        dxf_version,
        bit_offset,
        color,
        full_width_color,
        point_count,
        surface,
        None,
    )
}

fn modeler_record_with_silhouette(
    dxf_version: DxfVersion,
    bit_offset: i64,
    color: i16,
    full_width_color: bool,
    point_count: i32,
    surface: bool,
    silhouette_viewport: Option<i64>,
) -> (DwgMergedReader, Vec<u8>, i64) {
    let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
    let mut writer = DwgBitWriter::new(version, dxf_version);
    for _ in 0..bit_offset {
        writer.write_bit(true);
    }
    let geometry = sab();
    if !version.r2013_plus(dxf_version) {
        writer.write_bit(false); // nonempty inline ACIS body
        writer.write_bit(false);
        writer.write_bit_short(2);
        writer.write_bytes(&geometry);
    }
    writer.write_bit(true); // wireframe cache
    writer.write_bit(true); // reference point
    writer.write_3bit_double(Vector3::new(10.0, 20.0, -5.0));
    writer.write_bit_long(2); // isolines
    writer.write_bit(true); // wire list
    writer.write_bit_long(1);
    writer.write_byte(2); // visible edge
    writer.write_bit_long(-1); // selection marker
    if full_width_color {
        writer.write_2bits(0);
        writer.write_raw_short(color);
    } else {
        writer.write_bit_short(color);
    }
    writer.write_bit_long(0x80FA); // ACIS index
    writer.write_bit_long(point_count);
    if point_count == 2 {
        writer.write_3bit_double(Vector3::ZERO);
        writer.write_3bit_double(Vector3::new(10.0, 20.0, -5.0));
    }
    writer.write_bit(false); // wire transform
    if let Some(viewport_id) = silhouette_viewport {
        writer.write_bit_long(1); // silhouettes
        if version.r2010_plus() {
            writer.write_bit_long_long(viewport_id);
        } else {
            writer.write_bit_long(viewport_id as i32);
        }
        writer.write_3bit_double(Vector3::ZERO); // target
        writer.write_3bit_double(Vector3::UNIT_Z); // view direction
        writer.write_3bit_double(Vector3::UNIT_Y); // up vector
        writer.write_bit(false); // perspective
        writer.write_bit(false); // no silhouette wires
    } else {
        writer.write_bit_long(0); // silhouettes
    }
    writer.write_bit(true); // no extra ACIS body
    if version.r2007_plus() {
        writer.write_bit_long(0); // materials / AcDs trailing BL
    }
    if version.r2013_plus(dxf_version) {
        writer.write_bit(true);
        writer.write_bit_long(0x12345678);
        writer.write_bit_short(0x1234);
        writer.write_bit_short(0x5678);
        writer.write_bytes(&[1, 2, 3, 4, 5, 6, 7, 8]);
        writer.write_bit_long(0x87654321_u32 as i32);
    }
    if surface {
        writer.write_bit_short(17);
        writer.write_bit_short(29);
    }
    let end = writer.position_in_bits();
    let main = DwgBitReader::new(writer.into_bytes(), version, dxf_version);
    let mut reader = DwgMergedReader::from_readers(main, None, None, dxf_version);
    reader.set_handle_start(end);
    reader.set_main_data_end(end);
    reader.set_position_in_bits(bit_offset);
    (reader, geometry, end)
}

#[test]
fn native_bit_short_wire_colors_preserve_counts_geometry_and_tail() {
    for dxf_version in VERSIONS {
        let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
        for bit_offset in 0..8 {
            for (color, full_width) in [
                (0, false),
                (1, false),
                (255, false),
                (256, false),
                (0, true),
                (1, true),
                (255, true),
                (256, true),
            ] {
                let (mut reader, geometry, end) =
                    modeler_record(dxf_version, bit_offset, color, full_width, 2, false);
                let body = read_acis_entity(
                    &mut reader,
                    version,
                    dxf_version,
                    version.r2013_plus(dxf_version),
                );
                reader.check_error().unwrap_or_else(|error| {
                    panic!("{dxf_version:?}, offset {bit_offset}, color {color}: {error}")
                });
                assert_eq!(reader.position_in_bits(), end);
                if !version.r2013_plus(dxf_version) {
                    assert_eq!(body.sab_data, geometry);
                }
                assert_eq!(body.point, Vector3::new(10.0, 20.0, -5.0));
                assert_eq!(body.isolines, 2);
                assert_eq!(body.wires.len(), 1);
                assert_eq!(body.wires[0].selection_marker, -1);
                assert_eq!(body.wires[0].acis_index, 0x80FA);
                assert_eq!(body.wires[0].points.len(), 2);
                assert_eq!(
                    body.wires[0].color,
                    match color {
                        0 => Color::ByBlock,
                        256 => Color::ByLayer,
                        index => Color::Index(index as u8),
                    }
                );
                if version.r2013_plus(dxf_version) {
                    assert_eq!(
                        body.revision,
                        AcisRevision {
                            has_guid: true,
                            major: 0x12345678,
                            minor1: 0x1234,
                            minor2: 0x5678,
                            bytes: [1, 2, 3, 4, 5, 6, 7, 8],
                            end_marker: 0x87654321,
                        }
                    );
                }
            }
        }
    }
}

#[test]
fn legacy_database_body_preserves_extra_modeler_data_before_materials() {
    for dxf_version in [DxfVersion::AC1021, DxfVersion::AC1024] {
        let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
        let geometry = sab();
        let mut writer = DwgBitWriter::new(version, dxf_version);
        writer.write_bit(false); // nonempty primary body
        writer.write_bit(false);
        writer.write_bit_short(2);
        writer.write_bytes(&geometry);
        writer.write_bit(false); // no wireframe
        writer.write_bit(false); // extra modeler body present
        writer.write_bit(false);
        writer.write_bit_short(2);
        writer.write_bytes(&geometry);
        writer.write_bit_long(0); // materials
        let end = writer.position_in_bits();
        let main = DwgBitReader::new(writer.into_bytes(), version, dxf_version);
        let mut reader = DwgMergedReader::from_readers(main, None, None, dxf_version);
        reader.set_handle_start(end);
        reader.set_main_data_end(end);
        let body = read_acis_entity(&mut reader, version, dxf_version, false);
        reader.check_error().unwrap();
        assert_eq!(reader.position_in_bits(), end);
        assert_eq!(body.sab_data, geometry);
        assert_eq!(body.extra_acis_data.unwrap().sab_data, geometry);
        assert!(body.materials.is_empty());
    }
}

#[test]
fn silhouette_viewport_width_matches_the_dwg_generation() {
    for dxf_version in [
        DxfVersion::AC1018,
        DxfVersion::AC1021,
        DxfVersion::AC1024,
        DxfVersion::AC1027,
        DxfVersion::AC1032,
    ] {
        let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
        let viewport_id = 0x1234_i64;
        let (mut reader, _, end) =
            modeler_record_with_silhouette(dxf_version, 3, 256, true, 2, false, Some(viewport_id));
        let body = read_acis_entity(
            &mut reader,
            version,
            dxf_version,
            version.r2013_plus(dxf_version),
        );
        reader.check_error().unwrap();
        assert_eq!(reader.position_in_bits(), end);
        assert_eq!(body.silhouettes.len(), 1);
        assert_eq!(body.silhouettes[0].viewport_id, viewport_id);
        assert!(!body.silhouettes[0].has_wires);
    }
}

#[test]
fn surface_fields_remain_aligned_after_bylayer_wire() {
    for dxf_version in [DxfVersion::AC1018, DxfVersion::AC1032] {
        let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
        let (mut reader, geometry, end) = modeler_record(dxf_version, 3, 256, true, 2, true);
        let surface = read_surface(
            &mut reader,
            version,
            dxf_version,
            version.r2013_plus(dxf_version),
            SurfaceKind::Generic,
        );
        reader.check_error().unwrap();
        assert_eq!(reader.position_in_bits(), end);
        assert_eq!(surface.u_isolines, 17);
        assert_eq!(surface.v_isolines, 29);
        assert_eq!(surface.acis.wires[0].color, Color::ByLayer);
        if !version.r2013_plus(dxf_version) {
            assert_eq!(surface.acis.sab_data, geometry);
        }
    }
}

#[test]
fn malformed_wire_counts_are_still_rejected() {
    for dxf_version in [DxfVersion::AC1018, DxfVersion::AC1032] {
        let version = DwgVersion::from_dxf_version(dxf_version).unwrap();
        for point_count in [-1, i32::MIN, i32::MAX] {
            let (mut reader, _, _) = modeler_record(dxf_version, 5, 256, true, point_count, false);
            read_acis_entity(
                &mut reader,
                version,
                dxf_version,
                version.r2013_plus(dxf_version),
            );
            let error = reader.check_error().unwrap_err().to_string();
            assert!(error.contains("Invalid DWG array count"), "{error}");
        }
    }
}

#[test]
fn modeler_entities_survive_strict_and_failsafe_file_reading() {
    for dxf_version in VERSIONS {
        let mut document = CadDocument::with_version(dxf_version);
        let geometry = AcisData::from_sab(sab());
        let mut solid = Solid3D::from_sab(geometry.sab_data.clone());
        let mut region = Region::new();
        let mut body = Body::new();
        region.acis_data = geometry.clone();
        body.acis_data = geometry.clone();
        let wire = Wire {
            color: Color::ByLayer,
            acis_index: 0x80FA,
            points: vec![Vector3::ZERO, Vector3::new(10.0, 20.0, -5.0)],
            ..Wire::default()
        };
        solid.wires.push(wire.clone());
        region.wires.push(wire.clone());
        body.wires.push(wire.clone());
        document.add_entity(EntityType::Solid3D(solid)).unwrap();
        document.add_entity(EntityType::Region(region)).unwrap();
        document.add_entity(EntityType::Body(body)).unwrap();
        if dxf_version >= DxfVersion::AC1021 {
            let mut surface = Surface::new(SurfaceKind::Generic);
            surface.acis_data = geometry.clone();
            surface.wires.push(wire);
            surface.u_isolines = 17;
            surface.v_isolines = 29;
            document
                .add_entity(EntityType::Surface(Box::new(surface)))
                .unwrap();
        }
        let bytes = DwgWriter::write_to_vec(&document).unwrap();
        for options in [DwgReadOptions::default(), DwgReadOptions::failsafe()] {
            let mut reader = DwgReader::from_stream_with_options(Cursor::new(&bytes), options);
            let outcome = reader.read_with_stats().unwrap();
            assert!(
                outcome.stats.diagnostics.is_empty(),
                "{dxf_version:?}: {:?}",
                outcome.stats.diagnostics
            );
            assert_eq!(
                outcome.document.entities().count(),
                document.entities().count()
            );
            for entity in outcome.document.entities() {
                let acis = match entity {
                    EntityType::Solid3D(value) => &value.acis_data,
                    EntityType::Region(value) => &value.acis_data,
                    EntityType::Body(value) => &value.acis_data,
                    EntityType::Surface(value) => {
                        assert_eq!(value.u_isolines, 17);
                        assert_eq!(value.v_isolines, 29);
                        &value.acis_data
                    }
                    other => panic!("unexpected entity {other:?}"),
                };
                assert!(acis.has_data(), "{dxf_version:?} lost its modeler body");
                let parsed = if acis.is_binary {
                    SabReader::read(&acis.sab_data).unwrap()
                } else {
                    acis.parse_sat().unwrap()
                };
                assert_eq!(parsed.bodies().len(), 1);
            }
        }
    }
}

#[test]
#[ignore = "needs the six issue #129 drawings in issuesamples/"]
fn supplied_issue129_samples_keep_modeler_entities() {
    let root = std::path::Path::new("issuesamples");
    let mut files: Vec<_> = std::fs::read_dir(root)
        .unwrap_or_else(|e| panic!("{}: {e}", root.display()))
        .map(|entry| entry.unwrap().path())
        .filter(|path| {
            path.extension()
                .is_some_and(|extension| extension.eq_ignore_ascii_case("dwg"))
        })
        .collect();
    files.sort();
    assert_eq!(files.len(), 6);
    for path in files {
        let mut strict = DwgReader::from_file(&path).unwrap();
        let document = strict
            .read()
            .unwrap_or_else(|error| panic!("{}: {error}", path.display()));
        let name = path.file_name().unwrap().to_string_lossy();
        if name == "NECG76A.dwg" {
            let surfaces = document
                .entities()
                .filter(|entity| matches!(entity, EntityType::Surface(_)))
                .count();
            assert_eq!(surfaces, 28, "{}", path.display());
        } else {
            let expected = match name.as_ref() {
                "NEBE72GL.dwg" => 7,
                "NEBE74GL.dwg" => 9,
                "NECI94GE.dwg" => 5,
                "NEFE73210.dwg" => 14,
                "NEFE74215.dwg" => 15,
                _ => unreachable!(),
            };
            let solids = document
                .entities()
                .filter(|entity| matches!(entity, EntityType::Solid3D(_)))
                .count();
            assert_eq!(solids, expected, "{}", path.display());
        }
    }
}