project-wormhole-esm 0.1.0

ESM file format parser for Project Wormhole
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

use nom_derive::nom::IResult;

use crate::{dev::*, structs::field::{Field, FieldHeader}};


// ====================================================================================================

pub trait FieldParser<T> {
    fn parse_field(i: &[u8]) -> IResult<&[u8], Field<T>, nom::error::Error<&[u8]>> {
        let (i, header) = FieldHeader::parse(i)?;
        let (i, data) = Self::parse_field_body(i, header)?;
        Ok((i, Field { header, data }))
    }

    fn parse_field_body(i: &[u8], header: FieldHeader) -> IResult<&[u8], T, nom::error::Error<&[u8]>>;
}

// ====================================================================================================

pub trait RecordParser<T> where T: for<'esm> Parse<&'esm[u8]> {
    fn parse_body(i: &[u8]) -> IResult<&[u8], Vec<T>, nom::error::Error<&[u8]>> {
        let (i, fields) = many0(T::parse_le)(i)?;
        Ok((i, fields))
    }
    fn parse_record(i: &[u8]) -> IResult<&[u8], Record<T>, nom::error::Error<&[u8]>> {
        let (i, (header, raw)) = alloc_record(i)?;

        if header.flags.is_compressed() {
            if let Ok(dec) = decompress_record(raw) {
                if let Ok((_, fields)) = Self::parse_body(&dec) {
                    Ok((i, Record { header, fields }))
                } else {
                    println!("Failed to parse decompressed record: {:?}", header);
                    Ok((i, Record { header, fields: Vec::new() }))
                }
            } else {
                println!("Failed to decompress record: {:?}", header);
                Ok((i, Record { header, fields: Vec::new() }))
            }
        } else {
            let (_, fields) = Self::parse_body(raw)?;
            Ok((i, Record { header, fields }))
        }
    }
}

// ====================================================================================================

pub trait GroupParser<T> where T: for<'esm> Parse<&'esm[u8]> {
    fn parse_group(i: &[u8]) -> IResult<&[u8], Group<T>> {
        let (i, (header, raw)) = alloc_group(i)?;
        let (_, items) = many0(T::parse_le)(raw)?;
        Ok((i, Group { header, data: items} ))
    }
}


// ====================================================================================================

// pub trait ESMParser<T> where T: for<'esm> Parse<&'esm[u8]> {
//     fn parse_as_group(i: &[u8]) -> IResult<&[u8], Group<T>> {
//         let (i, (header, raw)) = alloc_group(i)?;
//         let (_, items) = many0(T::parse_le)(raw)?;
//         Ok((i, Group { header, data: items} ))
//     }
//     fn parse_as_record(i: &[u8]) -> IResult<&[u8], Record<T>> {
//         let (i, (header, raw)) = alloc_record(i)?;
//         let (_, fields) = many0(T::parse_le)(raw)?;
//         Ok((i, Record { header, fields }))
//     }
// }

// ====================================================================================================

// These will be automatically implemented for most Records
pub trait RecordTraits {
    fn get_record_header(&self) -> &RecordHeader;
    fn try_get_editor_id(&self) -> Option<&ESMString> { None }
    fn try_get_full_name(&self) -> Option<&LocalizedString> { None }
    fn try_get_keywords(&self) -> Option<&Vec<FormId>> { None }
    fn try_get_description(&self) -> Option<&LocalizedString> { None }
    fn try_get_native_terminal(&self) -> Option<&FormId> { None }
    fn try_get_virtual_machine_adapter(&self) -> Option<&VirtualMachineAdapter> { None }
}


// ====================================================================================================