esl 0.19.6

A library for reading, writing and processing ESM/ESP/ESS 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
use crate::code_page::CodePage;
use educe::Educe;
use either::{Either, Left,  Right};
use iter_identify_first_last::IteratorIdentifyFirstLastExt;
use phantom_type::PhantomType;
use serde::{Serialize, Deserialize, Serializer, Deserializer};
use serde::de::{self, Unexpected, DeserializeSeed};
use serde::de::Error as de_Error;
use serde::ser::Error as ser_Error;
use serde::ser::SerializeTuple;
use serde_serialize_seed::{SerializeSeed, ValueWithSeed};
use std::fmt::{self, Display, Formatter};
use std::fmt::Write as fmt_Write;
use std::str::FromStr;

#[derive(Clone)]
pub struct HexDump;

impl SerializeSeed for HexDump {
    type Value = [u8];

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            let lines = value.chunks(32).map(|x| {
                let mut s = String::with_capacity(32 * 2 + 31);
                for (is_first, b) in x.iter().copied().identify_first() {
                    if !is_first { s.push(' '); }
                    write!(&mut s, "{b:02X}").unwrap();
                }
                s
            }).collect::<Vec<_>>();
            lines.serialize(serializer)
        } else {
            value.serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for HexDump {
    type Value = Vec<u8>;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            let lines = <Vec<String>>::deserialize(deserializer)?;
            lines
                .into_iter()
                .flat_map(|x| x.split(' ').filter(|x| !x.is_empty()).map(|x| u8::from_str_radix(x, 16)).collect::<Vec<_>>())
                .try_collect()
                .map_err(|x| D::Error::custom(x.to_string()))
        } else {
            <Vec<u8>>::deserialize(deserializer)
        }
    }
}

#[derive(Educe)]
#[educe(Clone)]
pub struct ArraySerde<T> {
    pub len: usize,
    pub phantom: PhantomType<T>,
}

impl<T: Serialize> SerializeSeed for ArraySerde<T> {
    type Value = [T];

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        assert_eq!(value.len(), self.len);
        let mut serializer = serializer.serialize_tuple(self.len)?;
        for item in value {
            serializer.serialize_element(item)?;
        }
        serializer.end()
    }
}

struct ArrayDeVisitor<T>(PhantomType<T>);

impl<'de, T: Deserialize<'de>> de::Visitor<'de> for ArrayDeVisitor<T> {
    type Value = Vec<T>;

    fn expecting(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "array")
    }

    fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error> where A: de::SeqAccess<'de> {
        let mut res = seq.size_hint().map_or_else(Vec::new, Vec::with_capacity);
        while let Some(item) = seq.next_element()? {
            res.push(item);
        }
        Ok(res)
    }
}

impl<'de, T: Deserialize<'de>> DeserializeSeed<'de> for ArraySerde<T> {
    type Value = Vec<T>;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        deserializer.deserialize_tuple(self.len, ArrayDeVisitor(PhantomType::new()))
    }
}

#[derive(Clone)]
pub struct NoneU8Serde { pub none: u8 }

impl SerializeSeed for NoneU8Serde {
    type Value = ();

    fn serialize<S: Serializer>(&self, _value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            ().serialize(serializer)
        } else {
            self.none.serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for NoneU8Serde {
    type Value = ();

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            <()>::deserialize(deserializer)
        } else {
            let d = u8::deserialize(deserializer)?;
            if d != self.none {
                let e: &str = &format!("{}", self.none);
                Err(D::Error::invalid_value(Unexpected::Unsigned(d as u64), &e))
            } else {
                Ok(())
            }
        }
    }
}

#[derive(Clone)]
pub struct BoolU8Serde;

impl SerializeSeed for BoolU8Serde {
    type Value = bool;

    fn serialize<S: Serializer>(&self, &value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            u8::from(value).serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for BoolU8Serde {
    type Value = bool;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            Ok(bool::deserialize(deserializer)?)
        } else {
            let d = u8::deserialize(deserializer)?;
            match d {
                0 => Ok(false),
                1 => Ok(true),
                d => Err(D::Error::invalid_value(Unexpected::Unsigned(d as u64), &"0 or 1"))
            }
        }
    }
}

#[derive(Clone)]
pub struct BoolU32Serde;

impl SerializeSeed for BoolU32Serde {
    type Value = bool;

    fn serialize<S: Serializer>(&self, &value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            u32::from(value).serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for BoolU32Serde {
    type Value = bool;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            Ok(bool::deserialize(deserializer)?)
        } else {
            let d = u32::deserialize(deserializer)?;
            match d {
                0 => Ok(false),
                1 => Ok(true),
                d => Err(D::Error::invalid_value(Unexpected::Unsigned(d as u64), &"0 or 1"))
            }
        }
    }
}

#[derive(Clone)]
pub struct OptionIndexSerde<
    I: Copy + Eq + Display,
    T: Copy,
    From: Fn(I) -> Option<T>,
    Into: Fn(T) -> I,
> {
    pub name: &'static str,
    pub none: I,
    pub from: From,
    pub into: Into,
}

impl<
    I: Copy + Eq + Display + Serialize,
    T: Copy + Serialize,
    From: Fn(I) -> Option<T>,
    Into: Fn(T) -> I,
> SerializeSeed for OptionIndexSerde<I, T, From, Into> {
    type Value = Either<Option<I>, T>;

    fn serialize<S: Serializer>(&self, &value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            match value {
                Left(i) => OptionIndexHRSurrogate::None(i),
                Right(v) => OptionIndexHRSurrogate::Some(v),
            }.serialize(serializer)
        } else {
            let v = match value {
                Left(Some(i)) => {
                    if i == self.none || (self.from)(i).is_some() {
                        let err = format!("{} is not valid undefined {} value", i, self.name);
                        return Err(S::Error::custom(err));
                    }
                    i
                },
                Left(None) => self.none,
                Right(a) => (self.into)(a)
            };
            v.serialize(serializer)
        }
    }
}

impl<
    'de,
    I: Copy + Eq + Display + Deserialize<'de>,
    T: Copy + Deserialize<'de>,
    From: Fn(I) -> Option<T>,
    Into: Fn(T) -> I,
> DeserializeSeed<'de> for OptionIndexSerde<I, T, From, Into> {
    type Value = Either<Option<I>, T>;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            let v = <OptionIndexHRSurrogate<I, T>>::deserialize(deserializer)?;
            Ok(match v {
                OptionIndexHRSurrogate::None(i) => Left(i),
                OptionIndexHRSurrogate::Some(v) => Right(v),
            })
        } else {
            let d = I::deserialize(deserializer)?;
            if d == self.none { return Ok(Left(None)); }
            if let Some(a) = (self.from)(d) {
                Ok(Right(a))
            } else {
                Ok(Left(Some(d)))
            }
        }
    }
}

#[derive(Serialize, Deserialize)]
#[serde(untagged)]
#[serde(rename="OptionIndex")]
enum OptionIndexHRSurrogate<I, T> {
    None(Option<I>),
    Some(T)
}

#[derive(Clone)]
pub struct F32AsIsSerde;

impl SerializeSeed for F32AsIsSerde {
    type Value = f32;

    fn serialize<S>(&self, &value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
        if !serializer.is_human_readable() {
            value.serialize(serializer)
        } else if value.is_nan() {
            let d: u32 = value.to_bits();
            if d == 0xFFFFFFFF {
                value.serialize(serializer)
            } else {
                format!("nan{d:08X}").serialize(serializer)
            }
        } else {
            f64::from_str(&value.to_string()).unwrap().copysign(value as f64).serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for F32AsIsSerde {
    type Value = f32;

    fn deserialize<D>(self, deserializer: D) -> Result<Self::Value, D::Error> where D: Deserializer<'de> {
        if deserializer.is_human_readable() {
            deserializer.deserialize_any(F32HRDeVisitor)
        } else {
            Ok(f32::deserialize(deserializer)?)
        }
    }
}

struct F32HRDeVisitor;

impl<'de> de::Visitor<'de> for F32HRDeVisitor {
    type Value = f32;

    fn expecting(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "32-bit float value or 'nanXXXXXXXX' (where X is hex digit)")
    }

    fn visit_f32<E>(self, v: f32) -> Result<Self::Value, E> where E: de::Error {
        Ok(if v.is_nan() { f32::from_bits(0xFFFFFFFFu32) } else { v })
    }

    fn visit_f64<E>(self, v: f64) -> Result<Self::Value, E> where E: de::Error {
        let v_as_f32 = v as f32;
        if !v_as_f32.is_nan() || !v.is_nan() {
            let v_as_u64: u64 = v.to_bits();
            let v_as_u32_as_u64: u64 = f64::from_str(&v_as_f32.to_string()).unwrap().copysign(v_as_f32 as f64).to_bits();
            if v_as_u32_as_u64 != v_as_u64 {
                return Err(E::invalid_value(Unexpected::Float(v), &self));
            }
        }
        self.visit_f32(v_as_f32)
    }

    fn visit_str<E>(self, s: &str) -> Result<Self::Value, E> where E: de::Error {
        if s.len() != 3 + 8 || !s.starts_with("nan") || &s[4..5] == "+" {
            return Err(E::invalid_value(Unexpected::Str(s), &self));
        }
        let d = u32::from_str_radix(&s[3..], 16).map_err(|_| E::invalid_value(Unexpected::Str(s), &self))?;
        if d == 0xFFFFFFFF {
            return Err(E::invalid_value(Unexpected::Str(s), &self));
        }
        Ok(f32::from_bits(d))
    }
}

#[derive(Clone)]
pub struct F64AsIsSerde;

impl SerializeSeed for F64AsIsSerde {
    type Value = f64;

    fn serialize<S>(&self, &value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
        if !serializer.is_human_readable() {
            value.serialize(serializer)
        } else if value.is_nan() {
            let d: u64 = value.to_bits();
            if d == 0xFFFFFFFFFFFFFFFF {
                value.serialize(serializer)
            } else {
                format!("nan{d:016X}").serialize(serializer)
            }
        } else {
            value.serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for F64AsIsSerde {
    type Value = f64;

    fn deserialize<D>(self, deserializer: D) -> Result<Self::Value, D::Error> where D: Deserializer<'de> {
        if deserializer.is_human_readable() {
            deserializer.deserialize_any(F64HRDeVisitor)
        } else {
            Ok(f64::deserialize(deserializer)?)
        }
    }
}

struct F64HRDeVisitor;

impl<'de> de::Visitor<'de> for F64HRDeVisitor {
    type Value = f64;

    fn expecting(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "64-bit float value or 'nanXXXXXXXXXXXXXXXX' (where X is hex digit)")
    }

    fn visit_f64<E>(self, v: f64) -> Result<Self::Value, E> where E: de::Error {
        Ok(if v.is_nan() { f64::from_bits(0xFFFFFFFFFFFFFFFFu64) } else { v })
    }

    fn visit_str<E>(self, s: &str) -> Result<Self::Value, E> where E: de::Error {
        if s.len() != 3 + 16 || !s.starts_with("nan") || &s[4..5] == "+" {
            return Err(E::invalid_value(Unexpected::Str(s), &self));
        }
        let d = u64::from_str_radix(&s[3..], 16).map_err(|_| E::invalid_value(Unexpected::Str(s), &self))?;
        if d == 0xFFFFFFFFFFFFFFFF {
            return Err(E::invalid_value(Unexpected::Str(s), &self));
        }
        Ok(f64::from_bits(d))
    }
}

#[derive(Clone)]
pub struct I8PrefixedStringSerde {
    pub code_page: Option<CodePage>,
}

impl SerializeSeed for I8PrefixedStringSerde {
    type Value = (i8, String);

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            let Some(code_page) = self.code_page else {
                return Err(S::Error::custom("code page required for binary serialization"));
            };
            let mut bytes = code_page.encode(&value.1).map_err(|e| match e {
                None => S::Error::custom(format!(
                    "the '{}' string does not correspond to any source byte sequence", &value.1
                )),
                Some(c) => S::Error::custom(format!("the '{c}' char is not representable in {code_page:?} code page"))
            })?;
            bytes.insert(0, value.0.cast_unsigned());
            bytes.serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for I8PrefixedStringSerde {
    type Value = (i8, String);

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            <(i8, String)>::deserialize(deserializer)
        } else {
            let bytes = <Vec<u8>>::deserialize(deserializer)?;
            if bytes.len() == 0 {
                return Err(D::Error::custom("At least one byte expected"));
            }
            let Some(code_page) = self.code_page else {
                return Err(D::Error::custom("code page required for binary serialization"));
            };
            Ok((bytes[0].cast_signed(), code_page.decode(&bytes[1 ..])))
        }
    }
}

#[derive(Clone)]
pub struct I32I8I32PrefixedStringSerde {
    pub code_page: Option<CodePage>,
}

impl SerializeSeed for I32I8I32PrefixedStringSerde {
    type Value = (i32, i8, i32, String);

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            let Some(code_page) = self.code_page else {
                return Err(S::Error::custom("code page required for binary serialization"));
            };
            let bytes = code_page.encode(&value.3).map_err(|e| match e {
                None => S::Error::custom(format!(
                    "the '{}' string does not correspond to any source byte sequence", &value.2
                )),
                Some(c) => S::Error::custom(format!("the '{c}' char is not representable in {code_page:?} code page"))
            })?;
            let mut r = Vec::new();
            r.extend_from_slice(&value.0.to_le_bytes());
            r.push(value.1.cast_unsigned());
            r.extend_from_slice(&value.2.to_le_bytes());
            r.extend_from_slice(&bytes);
            r.serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for I32I8I32PrefixedStringSerde {
    type Value = (i32, i8, i32, String);

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            <(i32, i8, i32, String)>::deserialize(deserializer)
        } else {
            let bytes = <Vec<u8>>::deserialize(deserializer)?;
            if bytes.len() < 9 {
                return Err(D::Error::custom("At least 9 bytes expected"));
            }
            let Some(code_page) = self.code_page else {
                return Err(D::Error::custom("code page required for binary serialization"));
            };
            Ok((
                i32::from_le_bytes(bytes[0 .. 4].try_into().unwrap()),
                bytes[4].cast_signed(),
                i32::from_le_bytes(bytes[5 .. 9].try_into().unwrap()),
                code_page.decode(&bytes[9 ..])
            ))
        }
    }
}

#[derive(Clone)]
pub struct StringSerde {
    pub code_page: Option<CodePage>,
    pub len: Option<usize>
}

impl SerializeSeed for StringSerde {
    type Value = str;

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            let Some(code_page) = self.code_page else {
                return Err(S::Error::custom("code page required for binary serialization"));
            };
            let mut bytes = code_page.encode(value).map_err(|e| match e {
                None => S::Error::custom(format!("the '{value}' string does not correspond to any source byte sequence")),
                Some(c) => S::Error::custom(format!("the '{c}' char is not representable in {code_page:?} code page"))
            })?;
            if let Some(len) = self.len {
                if bytes.len() > len {
                    return Err(S::Error::custom(format!(
                        "short string (len = {}) does not fit (max len = {})", bytes.len(), len
                    )));
                }
                if bytes.last() == Some(&0) {
                    return Err(S::Error::custom("short string value has tail zero"));
                }
                bytes.resize(len, 0);
                ValueWithSeed(&bytes[..], ArraySerde { len, phantom: PhantomType::new() }).serialize(serializer)
            } else {
                bytes.serialize(serializer)
            }
        }
    }
}

impl<'de> DeserializeSeed<'de> for StringSerde {
    type Value = String;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            String::deserialize(deserializer)
        } else {
            let bytes = if let Some(len) = self.len {
                ArraySerde { len, phantom: PhantomType::new() }.deserialize(deserializer)?
            } else {
                <Vec<u8>>::deserialize(deserializer)?
            };
            let bytes = if self.len.is_some() {
                let trim = bytes.iter().copied().rev().take_while(|&x| x == 0).count();
                &bytes[.. bytes.len() - trim]
            } else {
                &bytes
            };
            let Some(code_page) = self.code_page else {
                return Err(D::Error::custom("code page required for binary serialization"));
            };
            Ok(code_page.decode(bytes))
        }
    }
}

#[derive(Clone)]
pub struct StringListSerde {
    pub code_page: Option<CodePage>,
    pub separator: &'static str,
    pub len: Option<usize>
}

impl SerializeSeed for StringListSerde {
    type Value = [String];

    fn serialize<S: Serializer>(&self, value: &Self::Value, serializer: S) -> Result<S::Ok, S::Error> {
        if serializer.is_human_readable() {
            value.serialize(serializer)
        } else {
            if self.separator.is_empty() {
                return Err(S::Error::custom("empty string list separator"));
            }
            if value.is_empty() {
                return Err(S::Error::custom("\
                    empty string list cannot be serialized bacause \
                    it is indistinguishable from list with one empty string\
                "));
            }
            let mut capacity = 0;
            for line in value {
                if line.contains(self.separator) {
                    return Err(S::Error::custom("string list item contains separator"));
                }
                capacity += line.len() + self.separator.len();
            }
            let mut text = String::with_capacity(capacity);
            for line in value.iter() {
                text.push_str(line);
                text.push_str(self.separator);
            }
            text.truncate(text.len() - self.separator.len());
            ValueWithSeed(text.as_str(), StringSerde { code_page: self.code_page, len: self.len }).serialize(serializer)
        }
    }
}

impl<'de> DeserializeSeed<'de> for StringListSerde {
    type Value = Vec<String>;

    fn deserialize<D: Deserializer<'de>>(self, deserializer: D) -> Result<Self::Value, D::Error> {
        if deserializer.is_human_readable() {
            <Vec<String>>::deserialize(deserializer)
        } else {
            if self.separator.is_empty() {
                return Err(D::Error::custom("empty string list separator"));
            }
            let s = StringSerde { code_page: self.code_page, len: self.len }.deserialize(deserializer)?;
            Ok(s.split(self.separator).map(|x| x.into()).collect())
        }
    }
}