nwn-lib-rs 0.4.0

Parsing library and command-line tools for Neverwinter Nights 1 and 2 data files
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
//! ERF file format (.erf, .hak, .mod, .pwc)
//!
//! Example
//! ```rust
//! #![feature(generic_const_exprs)]
//! use nwn_lib_rs::erf::Erf;
//!
//! // Read a ERF file without loading everything in memory
//! let mut erf_file = std::fs::File::open("unittest/nwn2_module.mod").unwrap();
//! let erf = Erf::from_stream_head(&mut erf_file).expect("Failed to parse ERF file header");
//!
//! // Find specific resource
//! let moduleifo_res = erf.resources
//!     .iter()
//!     .find(|res| res.get_filename() == "module.ifo")
//!     .unwrap();
//!
//! // Load the resource in memory
//! let moduleifo_data = moduleifo_res.data.archiveoffset_seek(&mut erf_file)
//!     .unwrap();
//! ```
//!

#![allow(dead_code)]

use std::collections::BTreeMap;

use nom::bytes::streaming::take;
use nom::number::streaming::{le_u16, le_u32};

use chrono::prelude::*;

use crate::parsing::*;

mod resource_type;
pub use resource_type::*;

/// ERF type identification (.erf, .hak, .mod, .pwc)
#[derive(Debug, Copy, Clone)]
pub enum FileType {
    Erf,
    Hak,
    Mod,
    Pwc,
}
impl FileType {
    /// Returns the fixed string used to represent the file type in the header
    pub fn to_fixed_string(&self) -> FixedSizeString<4> {
        FixedSizeString::<4>::from_str(match self {
            FileType::Erf => "ERF ",
            FileType::Hak => "HAK ",
            FileType::Mod => "MOD ",
            FileType::Pwc => "PWC ",
        })
        .unwrap()
    }
    #[allow(clippy::should_implement_trait)]
    /// Returns the FileType corresponding to the file type header
    pub fn from_str(ftype: &str) -> Option<Self> {
        match ftype {
            "ERF " => Some(FileType::Erf),
            "HAK " => Some(FileType::Hak),
            "MOD " => Some(FileType::Mod),
            "PWC " => Some(FileType::Pwc),
            _ => None,
        }
    }
    /// Guess the FileType of a file name
    pub fn guess(file_name: &std::path::Path) -> Option<Self> {
        match file_name.extension()?.to_str().unwrap() {
            "erf" => Some(FileType::Erf),
            "hak" => Some(FileType::Hak),
            "mod" => Some(FileType::Mod),
            "pwc" => Some(FileType::Pwc),
            _ => None,
        }
    }
}

/// ERF file header
#[derive(Debug, Clone)]
pub struct Header {
    /// File type. See FileType
    pub file_type: FixedSizeString<4>,
    /// File version. "v1.1" or higher to use 32-char resource names, v1.0 or lower for 16-char resource names
    pub file_version: FixedSizeString<4>,
    /// Build date. Unused / not relevant
    pub build_date: NaiveDate,
    /// ERF file description (only used for .mod files)
    pub description_strref: u32,
}

struct HeaderParsingInfo {
    localizedstrings_count: u32,
    localizedstrings_size: u32,
    keys_count: u32,

    localizedstrings_offset: u32,
    keys_offset: u32,
    resources_offset: u32,
}

impl Header {
    fn from_bytes(input: &[u8]) -> NWNParseResult<(Self, HeaderParsingInfo)> {
        let (input, file_type) = FixedSizeString::<4>::from_bytes(input)?;
        let (input, file_version) = FixedSizeString::<4>::from_bytes(input)?;

        let (input, localizedstrings_count) = le_u32(input)?;
        let (input, localizedstrings_size) = le_u32(input)?;
        let (input, keys_count) = le_u32(input)?;

        let (input, localizedstrings_offset) = le_u32(input)?;
        let (input, keys_offset) = le_u32(input)?;
        let (input, resources_offset) = le_u32(input)?;

        let (input, build_year) = le_u32(input)?;
        let build_year = build_year + 1900;
        let (input, build_day) = le_u32(input)?;
        let build_day = build_day + 1;
        let (input, description_strref) = le_u32(input)?;

        let (input, _) = take(116u8)(input)?;

        Ok((
            input,
            (
                Self {
                    file_type,
                    file_version,
                    build_date: NaiveDate::from_yo_opt(build_year as i32, build_day)
                        .unwrap_or(NaiveDate::from_yo_opt(1900, 1).unwrap()),
                    description_strref,
                },
                HeaderParsingInfo {
                    localizedstrings_count,
                    localizedstrings_size,
                    keys_count,
                    localizedstrings_offset,
                    keys_offset,
                    resources_offset,
                },
            ),
        ))
    }

    fn to_bytes(&self, pi: &HeaderParsingInfo) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        let mut output = vec![];
        output.extend(self.file_type.as_bytes());
        output.extend(self.file_version.as_bytes());

        output.extend(pi.localizedstrings_count.to_le_bytes());
        output.extend(pi.localizedstrings_size.to_le_bytes());
        output.extend(pi.keys_count.to_le_bytes());

        output.extend(pi.localizedstrings_offset.to_le_bytes());
        output.extend(pi.keys_offset.to_le_bytes());
        output.extend(pi.resources_offset.to_le_bytes());

        let build_year: u32 = (self.build_date.year() as u32)
            .checked_sub(1900)
            .ok_or("Build year cannot be lower than 1900".to_string())?;
        let build_day: u32 = self
            .build_date
            .ordinal()
            .checked_sub(1)
            .ok_or("Build day cannot be lower than 1".to_string())?;

        output.extend(build_year.to_le_bytes());
        output.extend(build_day.to_le_bytes());
        output.extend(self.description_strref.to_le_bytes());

        output.extend(&[0; 116]);
        assert_eq!(output.len(), 160);
        Ok(output)
    }
}

/// ERF resource (i.e. a file in an archive)
#[derive(Debug)]
pub struct Resource {
    // Resource file name (without extension)
    pub file_name: FixedSizeString<32>,
    // Resource type ID. Should correspond to a `erf::ResourceType`
    pub resource_type: u16,
    /// Resource data source
    pub data: ResourceData,
}

impl Resource {
    /// Returns the full file name with the file extension
    pub fn get_filename(&self) -> String {
        self.file_name.to_string() + "." + ResourceType::from(self.resource_type).ext()
    }

    /// Creates a new resource that references an external file.
    ///
    /// Note: Does not check if the file actually exists. Serialization will fail if the file cannot be opened
    pub fn from_file(
        file_path: &std::path::Path,
        resource_type: Option<u16>,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        let resource_type = resource_type.unwrap_or(ResourceType::from(
            file_path
                .extension()
                .ok_or(format!("failed to find file extension for {:?}", file_path))?
                .to_str()
                .unwrap(),
        ) as u16);

        Ok(Self {
            file_name: FixedSizeString::<32>::from_str(
                file_path
                    .file_stem()
                    .unwrap_or(
                        file_path
                            .file_name()
                            .ok_or(format!("failed to find file name for {:?}", file_path))?,
                    )
                    .to_str()
                    .unwrap(),
            )?,
            resource_type,
            data: ResourceData::File(file_path.to_path_buf()),
        })
    }
}

/// ERF resource data source
#[derive(Debug)]
pub enum ResourceData {
    /// The resource data is located in a separate file
    File(std::path::PathBuf),
    /// The resource data is located here in a buffer
    Buffer(Vec<u8>),
    /// The resource data is located in the ERF file and is not available
    /// because the ERF file has not been loaded in memory
    ArchiveOffset { offset: u32, size: u32 },
}
impl ResourceData {
    /// Returns the length of the resource in bytes. None if it is unknown
    pub fn len(&self) -> Option<usize> {
        match self {
            ResourceData::File(path) => Some(std::fs::metadata(path).ok()?.len() as usize),
            ResourceData::Buffer(buf) => Some(buf.len()),
            ResourceData::ArchiveOffset { offset: _, size } => Some(*size as usize),
        }
    }
    pub fn is_empty(&self) -> Option<bool> {
        self.len().map(|e| e == 0)
    }

    /// Read the file of a [`ResourceData::File`] and returns its data
    ///
    /// # Panics
    /// If self is not a [`ResourceData::File`]
    pub fn file_read(&self) -> Result<Vec<u8>, std::io::Error> {
        if let ResourceData::File(path) = self {
            std::fs::read(path)
        } else {
            panic!("not a ResourceData::File");
        }
    }
    /// Converts a [`ResourceData::File`] into a [`ResourceData::Buffer`] by
    /// loading the file content in memory
    ///
    /// # Panics
    /// If self is not a [`ResourceData::File`]
    pub fn file_load(&mut self) -> Result<(), std::io::Error> {
        *self = ResourceData::Buffer(self.file_read()?);
        Ok(())
    }

    /// Seeks and returns the data pointed by the [`ResourceData::ArchiveOffset`]
    ///
    /// This is typically used to fetch a resource data when only the head of
    /// the ERF file has been parsed
    ///
    /// # Panics
    /// If self is not a [`ResourceData::ArchiveOffset`]
    pub fn archiveoffset_seek(
        &self,
        stream: &mut (impl std::io::Seek + std::io::Read),
    ) -> Result<Vec<u8>, std::io::Error> {
        if let ResourceData::ArchiveOffset { offset, size } = self {
            stream.seek(std::io::SeekFrom::Start(*offset as u64))?;

            let mut buf = vec![0u8; *size as usize];
            stream.read_exact(&mut buf)?;
            Ok(buf)
        } else {
            panic!("not a ResourceData::ArchiveOffset");
        }
    }

    /// Converts a [`ResourceData::ArchiveOffset`] into a
    /// [`ResourceData::Buffer`] by loading the file content in memory
    ///
    /// # Panics
    /// If self is not a [`ResourceData::ArchiveOffset`]
    pub fn archiveoffset_load_stream(
        &mut self,
        stream: &mut (impl std::io::Seek + std::io::Read),
    ) -> Result<(), std::io::Error> {
        *self = ResourceData::Buffer(self.archiveoffset_seek(stream)?);
        Ok(())
    }

    /// Converts a [`ResourceData::ArchiveOffset`] into a
    /// [`ResourceData::Buffer`] by referencing data from buffer
    ///
    /// # Args:
    /// * buffer: bytes buffer containing the archive data
    /// * buffer_offset: offset if the buffer has been truncated
    ///
    /// # Panics
    /// If self is not a [`ResourceData::ArchiveOffset`]
    pub fn archiveoffset_load(&mut self, buffer: &[u8], buffer_offset: u32) -> Result<(), String> {
        if let ResourceData::ArchiveOffset { offset, size } = &self {
            let start = (offset - buffer_offset) as usize;
            let end = (offset + size - buffer_offset) as usize;
            let data = buffer
                .get(start..end)
                .ok_or(format!(
                    "resourceData is outside of buffer: start={}, end={} buffer.len()={}",
                    start,
                    end,
                    buffer.len(),
                ))?
                .to_vec();
            *self = ResourceData::Buffer(data);
        }
        Ok(())
    }
}

/// ERF file format (.erf, .hak, .mod, .pwc)
#[derive(Debug)]
pub struct Erf {
    /// Header
    pub header: Header,
    /// Localized ERF file description (only used for .mod files)
    pub description: BTreeMap<u32, String>,
    /// Resource list (i.e. files)
    pub resources: Vec<Resource>,
}

impl Erf {
    /// Creates an new empty ERF archive
    pub fn new(
        file_type: FixedSizeString<4>,
        nwn1: bool,
        build_date: chrono::NaiveDate,
        description_strref: Option<u32>,
    ) -> Self {
        Self {
            header: Header {
                file_type,
                file_version: if nwn1 {
                    FixedSizeString::<4>::from_str("V1.0").unwrap()
                } else {
                    FixedSizeString::<4>::from_str("V1.1").unwrap()
                },
                build_date,
                description_strref: description_strref.unwrap_or(0),
            },
            resources: vec![],
            description: BTreeMap::new(),
        }
    }

    /// Parse only the top of the ERF file, containing the resources
    /// information without their data. Resources data will be set as
    /// [`ResourceData::ArchiveOffset`]
    pub fn from_stream_head(
        input: &mut dyn std::io::Read,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        // Read only the header
        let mut buf = vec![0; 160];
        input.read_exact(&mut buf)?;

        let (_, (_header, header_parse_info)) =
            nom_parse_context("while parsing header", Header::from_bytes(&buf))
                .map_err(|e| e.to_string())?; // drop reference to buf. TODO: return a nom::Err instead

        let head_end = header_parse_info.resources_offset + header_parse_info.keys_count * 8;

        // Read the rest of the head of the ERF file
        buf.resize(head_end as usize, 0);
        input.read_exact(&mut buf[160..])?;
        let (_, erf) = Self::from_bytes_head(&buf).map_err(|e| e.to_string())?; // drop reference to buf. TODO: return a nom::Err instead

        Ok(erf)
    }

    /// Parse only the top of the ERF file, containing the resources
    /// information without their data. Resources data will be set as
    /// [`ResourceData::ArchiveOffset`]
    pub fn from_bytes_head(input: &[u8]) -> NWNParseResult<Self> {
        let (_, (header, header_parse_info)) = Header::from_bytes(input)?;

        // 16 / 32-bit resource names detection
        let has_long_resnames = header.file_version.as_str() >= "V1.1";

        // Description section (only used in mod files)
        let mut description = BTreeMap::new();
        {
            let mut locstr_input = input
                .get(header_parse_info.localizedstrings_offset as usize..)
                .ok_or(nom::Err::Error(NWNParseError::from_string(format!(
                    "localized strings offset {} is out of bounds",
                    header_parse_info.localizedstrings_offset
                ))))?;

            for _ in 0..header_parse_info.localizedstrings_count {
                let language_id;
                (locstr_input, language_id) = le_u32(locstr_input)?;
                let string_size;
                (locstr_input, string_size) = le_u32(locstr_input)?;

                let str_data = locstr_input
                    .get(..string_size as usize)
                    .ok_or(nom::Err::Error(NWNParseError::from_string(format!(
                        "erf description string is too long ({}) and hits out of bounds",
                        string_size
                    ))))?;

                let text = std::str::from_utf8(str_data)
                    .map_err(|e| nom::Err::Error(NWNParseError::from(e)))?;

                locstr_input = &locstr_input[string_size as usize..];

                description.insert(language_id, text.to_string());
            }
        }

        // Keys list
        let mut resources = Vec::with_capacity(header_parse_info.keys_count as usize);
        {
            let mut keys_input =
                input
                    .get(header_parse_info.keys_offset as usize..)
                    .ok_or(nom::Err::Error(NWNParseError::from_string(format!(
                        "keys offset {} is out of bounds",
                        header_parse_info.keys_offset
                    ))))?;
            for _ in 0..header_parse_info.keys_count {
                let file_name;
                (keys_input, file_name) = if has_long_resnames {
                    FixedSizeString::<32>::from_bytes(keys_input)?
                } else {
                    let (keys_input, file_name) = FixedSizeString::<16>::from_bytes(keys_input)?;
                    (
                        keys_input,
                        FixedSizeString::<32>::from_str(file_name.as_str()).unwrap(), // cannot be larger than 32
                    )
                };
                let _resource_id;
                (keys_input, _resource_id) = le_u32(keys_input)?;
                let resource_type;
                (keys_input, resource_type) = le_u16(keys_input)?;
                (keys_input, _) = take(2u8)(keys_input)?;

                resources.push(Resource {
                    file_name,
                    resource_type,
                    data: ResourceData::ArchiveOffset { offset: 0, size: 0 }, // Will be set later
                })
            }
        }

        // Resources list
        {
            let mut resources_input = input
                .get(header_parse_info.resources_offset as usize..)
                .ok_or(nom::Err::Error(NWNParseError::from_string(format!(
                    "resources offset {} is out of bounds",
                    header_parse_info.resources_offset
                ))))?;
            for i in 0..header_parse_info.keys_count {
                let offset;
                (resources_input, offset) = le_u32(resources_input)?;
                let size;
                (resources_input, size) = le_u32(resources_input)?;

                resources[i as usize].data = ResourceData::ArchiveOffset { offset, size };
            }
        }
        Ok((
            input,
            Self {
                header,
                resources,
                description,
            },
        ))
    }

    /// Parses ERF binary data and **loads all resources in memory** (may be huge)
    pub fn from_bytes(input: &[u8]) -> Result<Self, Box<dyn std::error::Error>> {
        let (_, mut erf) =
            Self::from_bytes_head(input).map_err(|e| format!("failed to parse ERF head: {}", e))?; // drop reference to buf;
        erf.load_archiveoffsets(input, 0)?;
        Ok(erf)
    }

    /// Converts all resources with [`ResourceData::ArchiveOffset`] into
    /// [`ResourceData::Buffer`]. See [`ResourceData::archiveoffset_load_stream`]
    pub fn load_archiveoffsets_stream(
        &mut self,
        stream: &mut (impl std::io::Seek + std::io::Read),
    ) -> Result<(), std::io::Error> {
        for resource in self.resources.iter_mut() {
            if let ResourceData::ArchiveOffset { offset: _, size: _ } = &resource.data {
                resource.data.archiveoffset_load_stream(stream)?;
            }
        }

        Ok(())
    }

    /// Converts all resources with [`ResourceData::ArchiveOffset`] into
    /// [`ResourceData::Buffer`]. See [`ResourceData::archiveoffset_load`]
    pub fn load_archiveoffsets(&mut self, buffer: &[u8], buffer_offset: u32) -> Result<(), String> {
        for resource in self.resources.iter_mut() {
            if let ResourceData::ArchiveOffset { offset: _, size: _ } = &resource.data {
                resource.data.archiveoffset_load(buffer, buffer_offset)?;
            }
        }

        Ok(())
    }

    /// Converts all resources with [`ResourceData::File`] into
    /// [`ResourceData::Buffer`]. See [`ResourceData::file_load`]
    pub fn load_files(&mut self) -> std::io::Result<()> {
        for resource in self.resources.iter_mut() {
            if let ResourceData::File(_) = &resource.data {
                resource.data.file_load()?;
            }
        }

        Ok(())
    }

    /// Serialize the top of the ERF file, containing everything except resource data
    ///
    /// Returns a tuple containing the resulting header data and total file size
    pub fn to_bytes_head(&self) -> Result<(Vec<u8>, usize), Box<dyn std::error::Error>> {
        // 16 / 32-bit resource names detection
        let has_long_resnames = self.header.file_version.as_str() >= "V1.1";

        let mut output = vec![0; 160];

        // Description
        let localizedstrings_offset = output.len() as u32;
        let localizedstrings_count = self.description.len() as u32;
        for (lang_id, text) in self.description.iter() {
            output.extend(lang_id.to_le_bytes());
            output.extend((text.len() as u32).to_le_bytes());
            output.extend(text.as_bytes());
        }
        let localizedstrings_size = output.len() as u32 - localizedstrings_offset;

        output.reserve((24 + 8) * self.resources.len()); // Avoid reallocations

        // Keys
        let keys_count = self.resources.len() as u32;
        let keys_offset = output.len() as u32;
        for (i, res) in self.resources.iter().enumerate() {
            if has_long_resnames {
                output.extend(res.file_name.as_bytes());
            } else {
                if res.file_name.len() > 16 {
                    return Err(format!(
                        "resource {:?} as a name longer than 16 characters",
                        res.file_name.as_str()
                    )
                    .into());
                }
                output.extend(&res.file_name.as_bytes()[..16]);
            }
            output.extend((i as u32).to_le_bytes());
            output.extend(res.resource_type.to_le_bytes());
            output.extend(&[0u8; 2]);
        }

        let resources_offset = output.len() as u32;
        let mut resource_data_offset: u32 = resources_offset + 8 * self.resources.len() as u32;

        // Resource pointers
        for res in self.resources.iter() {
            let len = match &res.data {
                ResourceData::File(f) => std::fs::metadata(f)?.len() as u32,
                ResourceData::Buffer(buf) => buf.len() as u32,
                ResourceData::ArchiveOffset { offset: _, size } => *size,
            };

            output.extend(resource_data_offset.to_le_bytes());
            output.extend(len.to_le_bytes());

            resource_data_offset += len;
        }

        let pi = HeaderParsingInfo {
            localizedstrings_count,
            localizedstrings_size,
            keys_count,
            localizedstrings_offset,
            keys_offset,
            resources_offset,
        };

        output[..160].copy_from_slice(&self.header.to_bytes(&pi)?);

        Ok((output, resource_data_offset as usize))
    }

    /// Serialize the entire ERF file in memory (may be huge)
    pub fn to_bytes(&self) -> Result<Vec<u8>, Box<dyn std::error::Error>> {
        let mut buf = std::io::Cursor::new(vec![]);
        self.write_stream(&mut buf)?;
        Ok(buf.into_inner())
    }

    /// Write the entire ERF file to an output stream
    ///
    /// All resources data needs to be either ResourceData::File or ResourceData::Buffer.
    pub fn write_stream<T>(&self, output: &mut T) -> Result<(), Box<dyn std::error::Error>>
    where
        T: std::io::Write + std::io::Seek,
    {
        let (head_data, complete_size) = self.to_bytes_head()?;

        // Preallocate total size
        output.seek(std::io::SeekFrom::Start(complete_size as u64))?;
        output.write_all(&[])?;
        output.seek(std::io::SeekFrom::Start(0))?;

        // Write head
        output.write_all(&head_data)?;

        // Write resources
        for res in self.resources.iter() {
            match &res.data {
                ResourceData::File(f) => output.write_all(&std::fs::read(f)?),
                ResourceData::Buffer(buf) => output.write_all(buf),
                ResourceData::ArchiveOffset { offset: _, size: _ } => {
                    return Err(format!(
                        "resource {} contains ResourceData::ArchiveOffset data",
                        res.file_name
                    )
                    .into())
                }
            }?;
        }

        Ok(())
    }
}

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

    #[test]
    fn test_hak() {
        let erf_bytes = include_bytes!("../unittest/test.hak");
        let erf = Erf::from_bytes(erf_bytes).unwrap();

        assert_eq!(erf.header.file_type.as_str(), "HAK ");
        assert_eq!(erf.header.file_version.as_str(), "V1.1");
        assert_eq!(erf.header.build_date.year(), 2016);
        assert_eq!(erf.header.build_date.month(), 06);
        assert_eq!(erf.header.build_date.day(), 8);
        assert_eq!(erf.header.description_strref, 0);

        assert_eq!(erf.resources.len(), 2);
        assert_eq!(erf.resources[0].file_name.as_str(), "eye");
        assert_eq!(erf.resources[0].resource_type, ResourceType::Tga as u16);
        assert_eq!(erf.resources[1].file_name.as_str(), "test");
        assert_eq!(erf.resources[1].resource_type, ResourceType::Txt as u16);

        assert_eq!(erf.description.len(), 0);

        let data = erf.to_bytes().unwrap();
        Erf::from_bytes(&data).unwrap();
        assert_eq!(data, erf_bytes);
    }
    #[test]
    fn test_nwn2_mod() {
        let erf_bytes = include_bytes!("../unittest/nwn2_module.mod");
        let erf = Erf::from_bytes(erf_bytes).unwrap();

        assert_eq!(erf.header.file_type.as_str(), "MOD ");
        assert_eq!(erf.header.file_version.as_str(), "V1.1");
        assert_eq!(erf.header.build_date.year(), 2016);
        assert_eq!(erf.header.build_date.month(), 06);
        assert_eq!(erf.header.build_date.day(), 9);
        assert_eq!(erf.header.description_strref, 0);

        assert_eq!(erf.resources.len(), 8);
        assert_eq!(erf.resources[0].file_name.as_str(), "conversation1");
        assert_eq!(erf.resources[0].resource_type, ResourceType::Dlg as u16);
        assert_eq!(erf.resources[1].file_name.as_str(), "gr_dm1");
        assert_eq!(erf.resources[1].resource_type, ResourceType::Utc as u16);
        assert_eq!(erf.resources[2].file_name.as_str(), "module");
        assert_eq!(erf.resources[2].resource_type, ResourceType::Ifo as u16);
        assert_eq!(erf.resources[3].file_name.as_str(), "module");
        assert_eq!(erf.resources[3].resource_type, ResourceType::Jrl as u16);

        assert_eq!(erf.description.len(), 11);
        assert_eq!(erf.description[&0], "module description");
        assert_eq!(erf.description[&6], "");
        assert_eq!(erf.description[&130], "");

        let data = erf.to_bytes().unwrap();
        Erf::from_bytes(&data).unwrap();
        assert_eq!(data, erf_bytes);
    }
    fn test_nwn1_mod() {
        let erf_bytes = include_bytes!("../unittest/nwn1_module.mod");
        let erf = Erf::from_bytes(erf_bytes).unwrap();

        assert_eq!(erf.header.file_type.as_str(), "MOD ");
        assert_eq!(erf.header.file_version.as_str(), "V1.0");
        assert_eq!(erf.header.description_strref, u32::max_value());

        assert_eq!(erf.resources.len(), 16);
        assert_eq!(erf.resources[0].file_name.as_str(), "area001");
        assert_eq!(erf.resources[0].resource_type, ResourceType::Are as u16);
        assert_eq!(erf.resources[1].file_name.as_str(), "area001");
        assert_eq!(erf.resources[1].resource_type, ResourceType::Git as u16);
        assert_eq!(erf.resources[2].file_name.as_str(), "area001");
        assert_eq!(erf.resources[2].resource_type, ResourceType::Gic as u16);
        assert_eq!(erf.resources[3].file_name.as_str(), "beast001");
        assert_eq!(erf.resources[3].resource_type, ResourceType::Utc as u16);
        assert_eq!(erf.resources[4].file_name.as_str(), "creaturepalcus");
        assert_eq!(erf.resources[4].resource_type, ResourceType::Itp as u16);
        assert_eq!(erf.resources[9].file_name.as_str(), "module");
        assert_eq!(erf.resources[9].resource_type, ResourceType::Itp as u16);

        assert_eq!(erf.description.len(), 0);

        let data = erf.to_bytes().unwrap();
        Erf::from_bytes(&data).unwrap();
        assert_eq!(data, erf_bytes);
    }
}