acadrust 0.3.2

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
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
//! AC15 (R13/R14/R2000) file header writer
//!
//! Implements the linear DWG file format used by R13 through R2000.
//! The file layout is sequential: a file header with section locator
//! records followed by section data blocks in a fixed order.
//!
//! ## File Layout
//!
//! ```text
//! [File Header - 0x61 bytes]
//!   Version string (6 bytes) + padding (7 bytes)
//!   Preview seeker (4 bytes) + magic bytes (2)
//!   Code page (2 bytes) + record count (4 bytes)
//!   6 × Section locator records (9 bytes each)
//!   CRC-16 (2 bytes) + end sentinel (16 bytes)
//! [Header Variables]
//! [Classes]
//! [ObjFreeSpace]
//! [Template]
//! [AuxHeader]
//! [AcDbObjects]
//! [Handles]
//! [Preview]
//! ```
//!
//! Based on ACadSharp's `DwgFileHeaderWriterAC15`.

use std::io::{Write, Seek};
use indexmap::IndexMap;
use byteorder::{LittleEndian, WriteBytesExt};

use crate::error::DxfError;
use crate::types::DxfVersion;
use super::section_definition::{names, end_sentinels};
use super::section_descriptor::DwgSectionLocatorRecord;
use crate::io::dwg::crc;

/// File header size in bytes for AC15 format.
const FILE_HEADER_SIZE: usize = 0x61; // 97 bytes

/// AC15 file header writer for the linear DWG format.
///
/// Collects section data, computes section seekers (file offsets),
/// then writes the complete file header followed by section data.
pub struct DwgFileHeaderWriterAC15 {
    /// DXF version being written.
    version: DxfVersion,
    /// Ordered map of section name → (locator record, section data).
    /// Data is `None` until the section is added.
    records: IndexMap<String, (DwgSectionLocatorRecord, Option<Vec<u8>>)>,
}

impl DwgFileHeaderWriterAC15 {
    /// Create a new AC15 file header writer.
    ///
    /// Initializes the section record table with the standard AC15 section
    /// ordering. All sections start with no data; use `add_section` to
    /// populate them before calling `write_file`.
    pub fn new(version: DxfVersion) -> Self {
        let mut records = IndexMap::new();

        // Insert in the exact order that sections appear in the file body.
        // Records with Some(n) have a locator entry in the file header.
        // Records with None still contribute to the file layout.
        records.insert(
            names::HEADER.to_string(),
            (DwgSectionLocatorRecord::new(Some(0)), None),
        );
        records.insert(
            names::CLASSES.to_string(),
            (DwgSectionLocatorRecord::new(Some(1)), None),
        );
        records.insert(
            names::OBJ_FREE_SPACE.to_string(),
            (DwgSectionLocatorRecord::new(Some(3)), None),
        );
        records.insert(
            names::TEMPLATE.to_string(),
            (DwgSectionLocatorRecord::new(Some(4)), None),
        );
        records.insert(
            names::AUX_HEADER.to_string(),
            (DwgSectionLocatorRecord::new(Some(5)), None),
        );
        records.insert(
            names::ACDB_OBJECTS.to_string(),
            (DwgSectionLocatorRecord::new(None), None),
        );
        records.insert(
            names::HANDLES.to_string(),
            (DwgSectionLocatorRecord::new(Some(2)), None),
        );
        records.insert(
            names::PREVIEW.to_string(),
            (DwgSectionLocatorRecord::new(None), None),
        );

        Self { version, records }
    }

    /// Add section data for the given section name.
    ///
    /// The `compressed` and `decomp_size` parameters are ignored for AC15
    /// (no compression in the linear format).
    pub fn add_section(&mut self, name: &str, data: Vec<u8>) {
        if let Some(entry) = self.records.get_mut(name) {
            entry.0.size = data.len() as i64;
            entry.1 = Some(data);
        }
    }

    /// Get the file offset where the AcDbObjects section starts.
    ///
    /// This is used by the object writer to compute absolute handle→offset
    /// mappings. Returns the sum of the file header size and all section
    /// sizes before AcDbObjects.
    pub fn handle_section_offset(&self) -> usize {
        let mut offset = FILE_HEADER_SIZE;
        for (name, (_, data)) in &self.records {
            if name == names::ACDB_OBJECTS {
                break;
            }
            offset += data.as_ref().map_or(0, |d| d.len());
        }
        offset
    }

    /// Write the complete DWG file to the output stream.
    ///
    /// Computes section seekers, writes the file header with locator records
    /// and CRC, then appends all section data in order.
    pub fn write_file<W: Write + Seek>(&mut self, output: &mut W) -> Result<(), DxfError> {
        self.set_record_seekers();
        self.write_file_header(output)?;
        self.write_record_streams(output)?;
        Ok(())
    }

    /// Calculate absolute file offsets for each section.
    fn set_record_seekers(&mut self) {
        let mut curr_offset = FILE_HEADER_SIZE as i64;
        for (_, (record, data)) in self.records.iter_mut() {
            record.seeker = curr_offset;
            curr_offset += data.as_ref().map_or(0, |d| d.len()) as i64;
        }
    }

    /// Write the 0x61-byte file header to the output stream.
    fn write_file_header<W: Write>(&self, output: &mut W) -> Result<(), DxfError> {
        let mut buf: Vec<u8> = Vec::with_capacity(FILE_HEADER_SIZE);

        // 0x00: Version string (6 bytes, e.g., "AC1015")
        let version_str = self.version.as_str();
        buf.extend_from_slice(version_str.as_bytes());

        // 0x06: 5 zero bytes + maintenance version (15) + 1 (7 bytes total)
        // In R14, bytes 0x06..0x0B are zeros and ACADMAINTVER, then 0x0C = 1
        buf.extend_from_slice(&[0, 0, 0, 0, 0, 15, 1]);

        // 0x0D: Preview seeker (4-byte absolute address)
        let preview_seeker = self.records.get(names::PREVIEW)
            .map_or(0i32, |(r, _)| r.seeker as i32);
        buf.write_i32::<LittleEndian>(preview_seeker)?;

        // 0x11: Magic bytes
        buf.push(0x1B);
        buf.push(0x19);

        // 0x13: Code page (2 bytes LE) — default to 30 (ANSI_1252)
        buf.write_u16::<LittleEndian>(30)?;

        // 0x15: Number of locator records (4 bytes LE) — always 6
        buf.write_i32::<LittleEndian>(6)?;

        // 0x19: 6 × Section locator records (9 bytes each = 54 bytes)
        // Written in dictionary order, skipping records without numbers
        for (_, (record, _)) in &self.records {
            if let Some(number) = record.number {
                self.write_record(&mut buf, number, record)?;
            }
        }

        // CRC-16 over everything written so far
        let crc_value = crc::crc16(crc::CRC16_SEED, &buf);
        buf.write_i16::<LittleEndian>(crc_value as i16)?;

        // End sentinel (16 bytes)
        buf.extend_from_slice(&end_sentinels::FILE_HEADER);

        // Verify we wrote exactly FILE_HEADER_SIZE bytes
        debug_assert_eq!(buf.len(), FILE_HEADER_SIZE,
            "File header size mismatch: expected {FILE_HEADER_SIZE}, got {}", buf.len());

        output.write_all(&buf)?;
        Ok(())
    }

    /// Write a single section locator record (9 bytes).
    fn write_record(&self, buf: &mut Vec<u8>, number: u8, record: &DwgSectionLocatorRecord) -> Result<(), DxfError> {
        buf.push(number);
        buf.write_i32::<LittleEndian>(record.seeker as i32)?;
        buf.write_i32::<LittleEndian>(record.size as i32)?;
        Ok(())
    }

    /// Write all section data streams to the output.
    fn write_record_streams<W: Write>(&self, output: &mut W) -> Result<(), DxfError> {
        for (_, (_, data)) in &self.records {
            if let Some(data) = data {
                output.write_all(data)?;
            }
        }
        Ok(())
    }
}

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

    #[test]
    fn test_new_creates_all_sections() {
        let writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        assert_eq!(writer.records.len(), 8);

        // Verify numbered records
        assert_eq!(writer.records[names::HEADER].0.number, Some(0));
        assert_eq!(writer.records[names::CLASSES].0.number, Some(1));
        assert_eq!(writer.records[names::HANDLES].0.number, Some(2));
        assert_eq!(writer.records[names::OBJ_FREE_SPACE].0.number, Some(3));
        assert_eq!(writer.records[names::TEMPLATE].0.number, Some(4));
        assert_eq!(writer.records[names::AUX_HEADER].0.number, Some(5));

        // Non-numbered records
        assert_eq!(writer.records[names::ACDB_OBJECTS].0.number, None);
        assert_eq!(writer.records[names::PREVIEW].0.number, None);
    }

    #[test]
    fn test_add_section() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        writer.add_section(names::HEADER, vec![1, 2, 3, 4, 5]);

        let (record, data) = &writer.records[names::HEADER];
        assert_eq!(record.size, 5);
        assert_eq!(data.as_ref().unwrap(), &vec![1, 2, 3, 4, 5]);
    }

    #[test]
    fn test_handle_section_offset() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        // Add sections before AcDbObjects
        writer.add_section(names::HEADER, vec![0; 100]);
        writer.add_section(names::CLASSES, vec![0; 50]);
        writer.add_section(names::OBJ_FREE_SPACE, vec![0; 10]);
        writer.add_section(names::TEMPLATE, vec![0; 20]);
        writer.add_section(names::AUX_HEADER, vec![0; 30]);

        // Offset = FILE_HEADER_SIZE + 100 + 50 + 10 + 20 + 30 = 0x61 + 210 = 307
        assert_eq!(writer.handle_section_offset(), FILE_HEADER_SIZE + 210);
    }

    #[test]
    fn test_write_file_header_size() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);

        // Add empty sections for all records
        for name in [
            names::HEADER, names::CLASSES, names::OBJ_FREE_SPACE,
            names::TEMPLATE, names::AUX_HEADER, names::ACDB_OBJECTS,
            names::HANDLES, names::PREVIEW,
        ] {
            writer.add_section(name, vec![]);
        }

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();
        // With all empty sections, file should be exactly FILE_HEADER_SIZE
        assert_eq!(data.len(), FILE_HEADER_SIZE);
    }

    #[test]
    fn test_write_file_version_string() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        for name in [
            names::HEADER, names::CLASSES, names::OBJ_FREE_SPACE,
            names::TEMPLATE, names::AUX_HEADER, names::ACDB_OBJECTS,
            names::HANDLES, names::PREVIEW,
        ] {
            writer.add_section(name, vec![]);
        }

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();
        assert_eq!(&data[0..6], b"AC1015");
    }

    #[test]
    fn test_write_file_with_data() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);

        let header_data = vec![0xAA; 100];
        let classes_data = vec![0xBB; 50];
        let objects_data = vec![0xCC; 200];

        writer.add_section(names::HEADER, header_data.clone());
        writer.add_section(names::CLASSES, classes_data.clone());
        writer.add_section(names::OBJ_FREE_SPACE, vec![]);
        writer.add_section(names::TEMPLATE, vec![]);
        writer.add_section(names::AUX_HEADER, vec![]);
        writer.add_section(names::ACDB_OBJECTS, objects_data.clone());
        writer.add_section(names::HANDLES, vec![]);
        writer.add_section(names::PREVIEW, vec![]);

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();

        // File = header (0x61) + all section data
        assert_eq!(data.len(), FILE_HEADER_SIZE + 100 + 50 + 200);

        // Verify section data appears in order after header
        assert_eq!(&data[FILE_HEADER_SIZE..FILE_HEADER_SIZE + 100], &[0xAA; 100]);
        assert_eq!(&data[FILE_HEADER_SIZE + 100..FILE_HEADER_SIZE + 150], &[0xBB; 50]);
        assert_eq!(&data[FILE_HEADER_SIZE + 150..FILE_HEADER_SIZE + 350], &[0xCC; 200]);
    }

    #[test]
    fn test_write_file_seekers_correct() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);

        writer.add_section(names::HEADER, vec![0; 100]);
        writer.add_section(names::CLASSES, vec![0; 50]);
        writer.add_section(names::OBJ_FREE_SPACE, vec![]);
        writer.add_section(names::TEMPLATE, vec![]);
        writer.add_section(names::AUX_HEADER, vec![]);
        writer.add_section(names::ACDB_OBJECTS, vec![0; 200]);
        writer.add_section(names::HANDLES, vec![0; 30]);
        writer.add_section(names::PREVIEW, vec![]);

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();

        // Parse locator records from the file header
        // At offset 0x19, we have 6 records of 9 bytes each
        let mut offset = 0x19;
        let mut records: Vec<(u8, i32, i32)> = Vec::new();
        for _ in 0..6 {
            let number = data[offset];
            let seeker = i32::from_le_bytes([
                data[offset + 1], data[offset + 2],
                data[offset + 3], data[offset + 4],
            ]);
            let size = i32::from_le_bytes([
                data[offset + 5], data[offset + 6],
                data[offset + 7], data[offset + 8],
            ]);
            records.push((number, seeker, size));
            offset += 9;
        }

        // Record 0 (Header): seeker = 0x61, size = 100
        let header_rec = records.iter().find(|r| r.0 == 0).unwrap();
        assert_eq!(header_rec.1, 0x61);
        assert_eq!(header_rec.2, 100);

        // Record 1 (Classes): seeker = 0x61 + 100 = 197, size = 50
        let classes_rec = records.iter().find(|r| r.0 == 1).unwrap();
        assert_eq!(classes_rec.1, 197);
        assert_eq!(classes_rec.2, 50);
    }

    #[test]
    fn test_file_header_crc() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        for name in [
            names::HEADER, names::CLASSES, names::OBJ_FREE_SPACE,
            names::TEMPLATE, names::AUX_HEADER, names::ACDB_OBJECTS,
            names::HANDLES, names::PREVIEW,
        ] {
            writer.add_section(name, vec![]);
        }

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();

        // CRC is at offset 0x4F (right after 6 records: 0x19 + 54 = 0x4F)
        let crc_offset = 0x19 + 54;
        let stored_crc = u16::from_le_bytes([data[crc_offset], data[crc_offset + 1]]);

        // Compute CRC over the header data (before CRC)
        let computed_crc = crc::crc16(crc::CRC16_SEED, &data[..crc_offset]);
        assert_eq!(stored_crc, computed_crc, "File header CRC mismatch");
    }

    #[test]
    fn test_file_header_end_sentinel() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1015);
        for name in [
            names::HEADER, names::CLASSES, names::OBJ_FREE_SPACE,
            names::TEMPLATE, names::AUX_HEADER, names::ACDB_OBJECTS,
            names::HANDLES, names::PREVIEW,
        ] {
            writer.add_section(name, vec![]);
        }

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();

        // End sentinel is the last 16 bytes of the file header
        let sentinel_offset = FILE_HEADER_SIZE - 16;
        assert_eq!(
            &data[sentinel_offset..FILE_HEADER_SIZE],
            &end_sentinels::FILE_HEADER,
            "File header end sentinel mismatch"
        );
    }

    #[test]
    fn test_r13_version_string() {
        let mut writer = DwgFileHeaderWriterAC15::new(DxfVersion::AC1012);
        for name in [
            names::HEADER, names::CLASSES, names::OBJ_FREE_SPACE,
            names::TEMPLATE, names::AUX_HEADER, names::ACDB_OBJECTS,
            names::HANDLES, names::PREVIEW,
        ] {
            writer.add_section(name, vec![]);
        }

        let mut output = Cursor::new(Vec::new());
        writer.write_file(&mut output).unwrap();

        let data = output.into_inner();
        assert_eq!(&data[0..6], b"AC1012");
    }
}