autosar-data 0.18.0

read, write and modify Autosar arxml data
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
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
use std::borrow::Cow;
use std::fmt::Display;
use std::str::FromStr;

use super::{AutosarVersion, CharacterData, CharacterDataSpec, EnumItem};

impl CharacterData {
    pub(crate) fn check_value(value: &CharacterData, spec: &CharacterDataSpec, file_version: AutosarVersion) -> bool {
        match spec {
            // the specification must call for an enum
            CharacterDataSpec::Enum { items } => {
                // the actual value must be an enum item
                if let CharacterData::Enum(enumitem) = &value {
                    // find the given enum item in the specified list of values
                    if let Some((_, version_mask)) = items.iter().find(|(name, _)| *name == *enumitem) {
                        // and finally check that this value is allowed in the active autosar version
                        if *version_mask & (file_version as u32) != 0 {
                            return true;
                        }
                    }
                }
            }
            CharacterDataSpec::Pattern {
                check_fn, max_length, ..
            } => {
                if let CharacterData::String(stringval) = &value {
                    if stringval.len() <= max_length.unwrap_or(usize::MAX) && check_fn(stringval.as_bytes()) {
                        return true;
                    }
                }
            }
            CharacterDataSpec::String { max_length, .. } => {
                if let CharacterData::String(stringval) = &value {
                    if stringval.len() <= max_length.unwrap_or(usize::MAX) {
                        return true;
                    }
                }
            }
            CharacterDataSpec::UnsignedInteger => {
                if let CharacterData::UnsignedInteger(_) = &value {
                    return true;
                }
            }
            CharacterDataSpec::Float => {
                if let CharacterData::Float(_) = &value {
                    return true;
                }
            }
        }
        false
    }

    pub(crate) fn check_version_compatibility(
        &self,
        data_spec: &CharacterDataSpec,
        target_version: AutosarVersion,
    ) -> (bool, u32) {
        if let CharacterDataSpec::Enum { items } = data_spec {
            if let CharacterData::Enum(attrval) = self {
                if let Some((_, enumitem_version_mask)) = items.iter().find(|(item, _)| *item == *attrval) {
                    if target_version.compatible(*enumitem_version_mask) {
                        (true, *enumitem_version_mask)
                    } else {
                        (false, *enumitem_version_mask)
                    }
                } else {
                    // no spec for this item -> not allowed in any version
                    (false, 0)
                }
            } else {
                // content is not an enum item, but an enum item is expected
                (false, u32::MAX)
            }
        } else {
            (true, u32::MAX)
        }
    }

    pub(crate) fn parse(input: &str, character_data_spec: &CharacterDataSpec, version: AutosarVersion) -> Option<Self> {
        match character_data_spec {
            CharacterDataSpec::Enum { items } => {
                if let Ok(enumitem) = EnumItem::from_str(input) {
                    if let Some((_, version_mask)) = items.iter().find(|(item, _)| *item == enumitem) {
                        if version as u32 & version_mask != 0 {
                            return Some(CharacterData::Enum(enumitem));
                        }
                    }
                }
            }
            CharacterDataSpec::Pattern {
                check_fn, max_length, ..
            } => {
                if input.len() <= max_length.unwrap_or(usize::MAX) && check_fn(input.as_bytes()) {
                    return Some(CharacterData::String(input.to_owned()));
                }
            }
            CharacterDataSpec::String { max_length, .. } => {
                if input.len() <= max_length.unwrap_or(usize::MAX) {
                    return Some(CharacterData::String(input.to_owned()));
                }
            }
            CharacterDataSpec::UnsignedInteger => {
                if let Ok(value) = input.parse() {
                    return Some(CharacterData::UnsignedInteger(value));
                }
            }
            CharacterDataSpec::Float => {
                if let Ok(value) = input.parse() {
                    return Some(CharacterData::Float(value));
                }
            }
        }
        None
    }

    pub(crate) fn serialize_internal(&self, outstring: &mut String) {
        match self {
            CharacterData::Enum(enumval) => outstring.push_str(enumval.to_str()),
            CharacterData::String(strval) => outstring.push_str(&escape_text(strval)),
            CharacterData::UnsignedInteger(intval) => outstring.push_str(&intval.to_string()),
            CharacterData::Float(floatval) => outstring.push_str(&floatval.to_string()),
        }
    }

    /// Get the contained enum value
    ///
    /// Returns the enum value if the content is an enum, or None otherwise
    #[must_use]
    pub fn enum_value(&self) -> Option<EnumItem> {
        if let CharacterData::Enum(item) = self {
            Some(*item)
        } else {
            None
        }
    }

    /// Get the contained string
    ///
    /// Returns the string if the content is a string, or None otherwise
    #[must_use]
    pub fn string_value(&self) -> Option<String> {
        if let CharacterData::String(value) = self {
            Some(value.to_owned())
        } else {
            None
        }
    }

    /// Get the contained unsigned integer
    ///
    /// Returns the string if the content is a string, or None otherwise
    #[must_use]
    pub fn unsigned_integer_value(&self) -> Option<u64> {
        if let CharacterData::UnsignedInteger(uintval) = self {
            Some(*uintval)
        } else {
            None
        }
    }

    /// Get the contained floating point value
    ///
    /// Returns the value if the content is a float, or None otherwise
    #[must_use]
    pub fn float_value(&self) -> Option<f64> {
        if let CharacterData::Float(value) = self {
            Some(*value)
        } else {
            None
        }
    }

    /// parse the stored charcter data value as an integer
    ///
    /// Many numbers are stored as strings in order to allow hexadecimal, octal, and binary encoding.
    /// This function handles the conversion from text to integer.
    /// If the stored value is already an integer, it will be converted to the output type.
    ///
    /// Returns the value if the conversion succeeds, or None otherwise
    ///
    /// # Example
    ///
    /// ```
    /// # use autosar_data::CharacterData;
    /// let data = CharacterData::String("0x1234".to_string());
    /// let value = data.parse_integer::<u32>().unwrap();
    /// assert_eq!(value, 0x1234);
    /// ```
    #[must_use]
    pub fn parse_integer<T: num_traits::Num + TryFrom<u64>>(&self) -> Option<T> {
        if let CharacterData::String(text) = self {
            if text == "0" {
                // handle this first to avoid hitting the octal case
                T::try_from(0u64).ok()
            } else if let Some(hexstr) = text.strip_prefix("0x") {
                T::from_str_radix(hexstr, 16).ok()
            } else if let Some(hexstr) = text.strip_prefix("0X") {
                T::from_str_radix(hexstr, 16).ok()
            } else if let Some(binstr) = text.strip_prefix("0b") {
                T::from_str_radix(binstr, 2).ok()
            } else if let Some(binstr) = text.strip_prefix("0B") {
                T::from_str_radix(binstr, 2).ok()
            } else if let Some(octstr) = text.strip_prefix('0') {
                T::from_str_radix(octstr, 8).ok()
            } else {
                T::from_str_radix(text, 10).ok()
            }
        } else if let CharacterData::UnsignedInteger(value) = self {
            T::try_from(*value).ok()
        } else {
            None
        }
    }

    /// parse the stored character data value as a floating point number
    ///
    /// When the meta model declares that a value is of class "Numerical", this means it is stored as a string.
    /// The regex associated with "Numerical" allows signed integers, floating point values (including scientific
    /// notation, as well as INF and NaN), hexadecimal, octal, and binary numbers.
    /// This function handles the conversion from text to floating point.
    ///
    /// Returns the value if the conversion succeeds, or None otherwise
    ///
    /// # Example
    ///
    /// ```
    /// # use autosar_data::CharacterData;
    /// let data = CharacterData::String("0x1234".to_string());
    /// let value = data.parse_float().unwrap();
    /// assert_eq!(value, 0x1234 as f64);
    ///
    /// let data = CharacterData::String("1.234e5".to_string());
    /// let value = data.parse_float().unwrap();
    /// assert_eq!(value, 1.234e5);
    /// ```
    #[must_use]
    pub fn parse_float(&self) -> Option<f64> {
        if let CharacterData::String(text) = self {
            if text == "0" {
                // handle this first to avoid hitting the octal case
                Some(0f64)
            } else if let Some(hexval) = text
                .strip_prefix("0x")
                .and_then(|hextxt| u64::from_str_radix(hextxt, 16).ok())
            {
                Some(hexval as f64)
            } else if let Some(hexval) = text
                .strip_prefix("0X")
                .and_then(|hextxt| u64::from_str_radix(hextxt, 16).ok())
            {
                Some(hexval as f64)
            } else if let Some(binval) = text
                .strip_prefix("0b")
                .and_then(|bintxt| u64::from_str_radix(bintxt, 2).ok())
            {
                Some(binval as f64)
            } else if let Some(binval) = text
                .strip_prefix("0B")
                .and_then(|bintxt| u64::from_str_radix(bintxt, 2).ok())
            {
                Some(binval as f64)
            } else if let Some(octval) = text
                .strip_prefix('0')
                .and_then(|octtxt| u64::from_str_radix(octtxt, 8).ok())
            {
                Some(octval as f64)
            } else {
                // normal float conversion
                text.parse().ok()
            }
        } else if let CharacterData::Float(value) = self {
            Some(*value)
        } else if let CharacterData::UnsignedInteger(value) = self {
            Some(*value as f64)
        } else {
            None
        }
    }

    /// parse the stored character data value as a boolean
    ///
    /// `CharacterData` doesn't store a boolean type natively: Autosar describes booleans as strings with the values
    /// "true" or "1" for true, and "false" or "0" for false.
    ///
    /// Returns the value if the conversion succeeds, or None otherwise
    ///
    /// # Example
    ///
    /// ```
    /// # use autosar_data::CharacterData;
    /// let data = CharacterData::String("true".to_string());
    /// let value = data.parse_bool().unwrap();
    /// assert_eq!(value, true);
    /// ```
    #[must_use]
    pub fn parse_bool(&self) -> Option<bool> {
        if let CharacterData::String(text) = self {
            match text.as_str() {
                "true" | "1" => Some(true),
                "false" | "0" => Some(false),
                _ => None,
            }
        } else {
            None
        }
    }
}

impl From<String> for CharacterData {
    fn from(value: String) -> Self {
        Self::String(value)
    }
}

impl From<&str> for CharacterData {
    fn from(value: &str) -> Self {
        Self::String(value.to_string())
    }
}

impl From<EnumItem> for CharacterData {
    fn from(value: EnumItem) -> Self {
        Self::Enum(value)
    }
}

impl From<u64> for CharacterData {
    fn from(value: u64) -> Self {
        Self::UnsignedInteger(value)
    }
}

impl From<f64> for CharacterData {
    fn from(value: f64) -> Self {
        Self::Float(value)
    }
}

impl From<bool> for CharacterData {
    fn from(value: bool) -> Self {
        Self::String(value.to_string())
    }
}

impl Display for CharacterData {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            CharacterData::Enum(enumitem) => f.write_str(enumitem.to_str()),
            CharacterData::String(stringval) => f.write_str(stringval),
            CharacterData::UnsignedInteger(uintval) => f.write_str(&uintval.to_string()),
            CharacterData::Float(f64val) => f.write_str(&f64val.to_string()),
        }
    }
}

impl Ord for CharacterData {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        // compare two CharacterData values
        // if the types are different, the order is determined by the type so that there is a consistent order
        // sort order: enum < string < unsigned integer < float - this is arbitrary
        match (self, other) {
            (CharacterData::Enum(a), CharacterData::Enum(b)) => a.to_str().cmp(b.to_str()),
            (CharacterData::String(a), CharacterData::String(b)) => a.cmp(b),
            (CharacterData::UnsignedInteger(a), CharacterData::UnsignedInteger(b)) => a.cmp(b),
            (CharacterData::Float(a), CharacterData::Float(b)) => a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal),
            (CharacterData::Enum(_), _) => std::cmp::Ordering::Less,
            (CharacterData::String(_), CharacterData::Enum(_)) => std::cmp::Ordering::Greater,
            (CharacterData::String(_), _) => std::cmp::Ordering::Less,
            (CharacterData::UnsignedInteger(_), CharacterData::Enum(_)) => std::cmp::Ordering::Greater,
            (CharacterData::UnsignedInteger(_), CharacterData::String(_)) => std::cmp::Ordering::Greater,
            (CharacterData::UnsignedInteger(_), _) => std::cmp::Ordering::Less,
            (CharacterData::Float(_), _) => std::cmp::Ordering::Greater,
        }
    }
}

impl PartialOrd for CharacterData {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Eq for CharacterData {}

fn escape_text(input: &str) -> Cow<str> {
    if input.contains(['&', '>', '<', '\'', '"']) {
        let mut escaped = String::with_capacity(input.len() + 6);

        for c in input.chars() {
            match c {
                '<' => escaped.push_str("&lt;"),
                '>' => escaped.push_str("&gt;"),
                '&' => escaped.push_str("&amp;"),
                '"' => escaped.push_str("&quot;"),
                '\'' => escaped.push_str("&apos;"),
                other => escaped.push(other),
            }
        }

        Cow::Owned(escaped)
    } else {
        Cow::Borrowed(input)
    }
}

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

    fn dummy_validate(s: &[u8]) -> bool {
        s.len() == 1 && (s[0] == b'0' || s[0] == b'1')
    }

    #[test]
    fn check_value() {
        let spec_enum = CharacterDataSpec::Enum {
            items: &[(EnumItem::default, 0x3ffff), (EnumItem::preserve, 0x0ffff)],
        };
        let data = CharacterData::Enum(EnumItem::default);
        assert!(CharacterData::check_value(
            &data,
            &spec_enum,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::Enum(EnumItem::preserve);
        assert!(!CharacterData::check_value(
            &data,
            &spec_enum,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::Enum(EnumItem::Abstract);
        assert!(!CharacterData::check_value(
            &data,
            &spec_enum,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::Float(1.23);
        assert!(!CharacterData::check_value(
            &data,
            &spec_enum,
            AutosarVersion::Autosar_00050
        ));

        let spec_double = CharacterDataSpec::Float;
        let data = CharacterData::Float(1.23);
        assert!(CharacterData::check_value(
            &data,
            &spec_double,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::String("1.23".to_string());
        assert!(!CharacterData::check_value(
            &data,
            &spec_double,
            AutosarVersion::Autosar_00050
        ));

        let spec_uint = CharacterDataSpec::UnsignedInteger;
        let data = CharacterData::UnsignedInteger(123);
        assert!(CharacterData::check_value(
            &data,
            &spec_uint,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::String("123".to_string());
        assert!(!CharacterData::check_value(
            &data,
            &spec_uint,
            AutosarVersion::Autosar_00050
        ));

        let spec_string = CharacterDataSpec::String {
            preserve_whitespace: false,
            max_length: Some(10),
        };
        let data = CharacterData::String("123".to_string());
        assert!(CharacterData::check_value(
            &data,
            &spec_string,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::String("12345678901".to_string());
        assert!(!CharacterData::check_value(
            &data,
            &spec_string,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::UnsignedInteger(1);
        assert!(!CharacterData::check_value(
            &data,
            &spec_string,
            AutosarVersion::Autosar_00050
        ));

        let spec_pattern = CharacterDataSpec::Pattern {
            check_fn: dummy_validate,
            regex: r"0|1",
            max_length: Some(1),
        };
        let data = CharacterData::String("0".to_string());
        assert!(CharacterData::check_value(
            &data,
            &spec_pattern,
            AutosarVersion::Autosar_00050
        ));
        let data = CharacterData::String("2".to_string());
        assert!(!CharacterData::check_value(
            &data,
            &spec_pattern,
            AutosarVersion::Autosar_00050
        ));
    }

    #[test]
    fn check_version_compatibility() {
        let spec_enum = CharacterDataSpec::Enum {
            items: &[(EnumItem::default, 0x0001), (EnumItem::preserve, 0x0002)],
        };
        let data = CharacterData::Enum(EnumItem::default);
        let (result, _) = data.check_version_compatibility(&spec_enum, AutosarVersion::Autosar_4_0_1);
        assert!(result);
        let (result, _) = data.check_version_compatibility(&spec_enum, AutosarVersion::Autosar_00050);
        assert!(!result);
        let data = CharacterData::Enum(EnumItem::Abstract);
        let (result, _) = data.check_version_compatibility(&spec_enum, AutosarVersion::Autosar_00050);
        assert!(!result);
        let data = CharacterData::UnsignedInteger(0);
        let (result, _) = data.check_version_compatibility(&spec_enum, AutosarVersion::Autosar_00050);
        assert!(!result);
    }

    #[test]
    fn parse() {
        let spec_enum = CharacterDataSpec::Enum {
            items: &[(EnumItem::default, 0x3ffff), (EnumItem::preserve, 0x0ffff)],
        };
        let data = CharacterData::parse("default", &spec_enum, AutosarVersion::Autosar_00050).unwrap();
        assert_eq!(data.enum_value().unwrap(), EnumItem::default);
        let data = CharacterData::parse("preserve", &spec_enum, AutosarVersion::Autosar_00050);
        assert!(data.is_none());
        let data = CharacterData::parse("ABSTRACT", &spec_enum, AutosarVersion::Autosar_00050);
        assert!(data.is_none());
        let data = CharacterData::parse("", &spec_enum, AutosarVersion::Autosar_00050);
        assert!(data.is_none());

        let spec_double = CharacterDataSpec::Float;
        let data = CharacterData::parse("2.0", &spec_double, AutosarVersion::Autosar_00050).unwrap();
        assert_eq!(data.float_value().unwrap(), 2.0);
        let data = CharacterData::parse("text", &spec_double, AutosarVersion::Autosar_00050);
        assert!(data.is_none());

        let spec_uint = CharacterDataSpec::UnsignedInteger;
        let data = CharacterData::parse("2", &spec_uint, AutosarVersion::Autosar_00050).unwrap();
        assert_eq!(data.unsigned_integer_value().unwrap(), 2);
        let data = CharacterData::parse("text", &spec_uint, AutosarVersion::Autosar_00050);
        assert!(data.is_none());

        let spec_string = CharacterDataSpec::String {
            preserve_whitespace: false,
            max_length: Some(10),
        };
        let data = CharacterData::parse("text", &spec_string, AutosarVersion::Autosar_00050).unwrap();
        assert_eq!(data.string_value().unwrap(), "text");
        let data = CharacterData::parse("text text text", &spec_string, AutosarVersion::Autosar_00050);
        assert!(data.is_none());

        let spec_pattern = CharacterDataSpec::Pattern {
            check_fn: dummy_validate,
            regex: r"0|1",
            max_length: Some(1),
        };
        let data = CharacterData::parse("0", &spec_pattern, AutosarVersion::Autosar_00050).unwrap();
        assert_eq!(data.string_value().unwrap(), "0");
        let data = CharacterData::parse("2", &spec_pattern, AutosarVersion::Autosar_00050);
        assert!(data.is_none());
    }

    #[test]
    fn serialize() {
        let mut out = "".to_string();
        let data = CharacterData::Enum(EnumItem::Abstract);
        data.serialize_internal(&mut out);
        assert_eq!(out, "ABSTRACT");
        assert_eq!(format!("{data}"), "ABSTRACT");

        let mut out = "".to_string();
        let data = CharacterData::Float(1.23);
        data.serialize_internal(&mut out);
        assert_eq!(out, "1.23");
        assert_eq!(format!("{data}"), "1.23");

        let mut out = "".to_string();
        let data = CharacterData::UnsignedInteger(0);
        data.serialize_internal(&mut out);
        assert_eq!(out, "0");
        assert_eq!(format!("{data}"), "0");

        let mut out = "".to_string();
        let data = CharacterData::String("text".to_string());
        data.serialize_internal(&mut out);
        assert_eq!(out, "text");
        assert_eq!(format!("{data}"), "text");

        let mut out = "".to_string();
        let data = CharacterData::String("special chars: <, >, &, \', \"".to_string());
        data.serialize_internal(&mut out);
        assert_eq!(out, "special chars: &lt;, &gt;, &amp;, &apos;, &quot;");
        assert_eq!(format!("{data}"), "special chars: <, >, &, \', \"");
    }

    #[test]
    fn get_value() {
        assert!(CharacterData::Enum(EnumItem::Abstract).enum_value().is_some());
        assert!(CharacterData::Enum(EnumItem::Abstract).string_value().is_none());

        assert!(CharacterData::Float(1.23).float_value().is_some());
        assert!(CharacterData::Float(1.23).unsigned_integer_value().is_none());

        assert!(CharacterData::String("x".to_string()).string_value().is_some());
        assert!(CharacterData::String("x".to_string()).float_value().is_none());

        assert!(CharacterData::UnsignedInteger(1).unsigned_integer_value().is_some());
        assert!(CharacterData::UnsignedInteger(1).enum_value().is_none());
    }

    #[test]
    fn parse_integer() {
        let data = CharacterData::String("text".to_string());
        let result = data.parse_integer::<u32>();
        assert!(result.is_none());

        let data = CharacterData::String("0x123412341234".to_string());
        let result = data.parse_integer::<u32>();
        assert!(result.is_none());

        let data = CharacterData::String("0x1234".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 0x1234);

        let data = CharacterData::String("0X123456".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 0x123456);

        let data = CharacterData::String("0b1010".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 10);

        let data = CharacterData::String("0B101010".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 42);

        let data = CharacterData::String("0733".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 475);

        let data = CharacterData::String("0".to_string());
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 0);

        let data = CharacterData::String("-55".to_string());
        let result = data.parse_integer::<i32>().unwrap();
        assert_eq!(result, -55);

        let data = CharacterData::UnsignedInteger(0);
        let result = data.parse_integer::<u32>().unwrap();
        assert_eq!(result, 0);

        let data = CharacterData::Float(0.0);
        let result = data.parse_integer::<u32>();
        assert!(result.is_none());
    }

    #[test]
    fn parse_float() {
        // not a number
        let data = CharacterData::String("text".to_string());
        let result = data.parse_float();
        assert!(result.is_none());

        // zero
        let data = CharacterData::String("0".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 0.0);

        // hex (> 32 bits)
        let data = CharacterData::String("0xFFFFFFFFF".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 68719476735.0);

        // invalid format, hex and float can't be mixed like this
        let data = CharacterData::String("0x1.234".to_string());
        let result = data.parse_float();
        assert!(result.is_none());

        // float: normal number
        let data = CharacterData::String("0.0001".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 0.0001);

        // float: normal number
        let data = CharacterData::String("1.234e5".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 1.234e5);

        // float: 0.12 - not octal, note the leading zero!
        let data = CharacterData::String("00.12".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 0.12);

        // float: NaN
        let data = CharacterData::String("NaN".to_string());
        let result = data.parse_float().unwrap();
        assert!(result.is_nan());

        // float: infinity
        let data = CharacterData::String("INF".to_string());
        let result = data.parse_float().unwrap();
        assert!(result.is_infinite());

        // hex
        let data = CharacterData::String("0x1234".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 4660.0);

        // hex
        let data = CharacterData::String("0X1234".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 4660.0);

        // binary
        let data = CharacterData::String("0b1101".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 13.0);

        // binary
        let data = CharacterData::String("0B1101".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 13.0);

        // octal
        let data = CharacterData::String("0777".to_string());
        let result = data.parse_float().unwrap();
        assert_eq!(result, 511.0);

        // integer value
        let data = CharacterData::UnsignedInteger(0);
        let result = data.parse_float().unwrap();
        assert_eq!(result, 0.0);

        // float value
        let data = CharacterData::Float(5.0);
        let result = data.parse_float().unwrap();
        assert_eq!(result, 5.0);

        // enum value
        let data = CharacterData::Enum(EnumItem::Abstract);
        let result = data.parse_float();
        assert!(result.is_none());
    }

    #[test]
    fn parse_bool() {
        let data = CharacterData::String("true".to_string());
        let result = data.parse_bool().unwrap();
        assert!(result);

        let data = CharacterData::String("1".to_string());
        let result = data.parse_bool().unwrap();
        assert!(result);

        let data = CharacterData::String("false".to_string());
        let result = data.parse_bool().unwrap();
        assert!(!result);

        let data = CharacterData::String("0".to_string());
        let result = data.parse_bool().unwrap();
        assert!(!result);

        let data = CharacterData::String("text".to_string());
        let result = data.parse_bool();
        assert!(result.is_none());

        let data = CharacterData::UnsignedInteger(0);
        let result = data.parse_bool();
        assert!(result.is_none());
    }

    #[test]
    fn ordering() {
        let enum1 = CharacterData::Enum(EnumItem::Abstract);
        let enum2 = CharacterData::Enum(EnumItem::default);
        assert!(enum1 < enum2);

        let string1 = CharacterData::String("abcdef".to_string());
        let string2 = CharacterData::String("text".to_string());
        assert!(string1 < string2);

        let integer1 = CharacterData::UnsignedInteger(123);
        let integer2 = CharacterData::UnsignedInteger(456);
        assert!(integer1 < integer2);

        let float1 = CharacterData::Float(1.23);
        let float2 = CharacterData::Float(4.56);
        assert!(float1 < float2);

        // for unequal data types, the order is (arbitrarily) defined as enum < string < unsigned integer < float
        assert!(enum1 < string1);
        assert!(enum1 < integer1);
        assert!(enum1 < float1);
        assert!(string1 > enum1);
        assert!(string1 < integer1);
        assert!(string1 < float1);
        assert!(integer1 > enum1);
        assert!(integer1 > string1);
        assert!(integer1 < float1);
        assert!(float1 > enum1);
        assert!(float1 > string1);
        assert!(float1 > integer1);

        // PartialOrd
        assert!(enum1.partial_cmp(&enum2).unwrap() == std::cmp::Ordering::Less);
    }

    #[test]
    fn cdata_conversion() {
        let cdata: CharacterData = 0.into();
        assert_eq!(cdata, CharacterData::UnsignedInteger(0));

        let cdata: CharacterData = (1.0).into();
        assert_eq!(cdata, CharacterData::Float(1.0));

        let cdata: CharacterData = "text".into();
        assert_eq!(cdata, CharacterData::String("text".to_string()));

        let cdata: CharacterData = String::from("text").into();
        assert_eq!(cdata, CharacterData::String("text".to_string()));

        let cdata: CharacterData = EnumItem::Abstract.into();
        assert_eq!(cdata, CharacterData::Enum(EnumItem::Abstract));

        let cdata: CharacterData = true.into();
        assert_eq!(cdata, CharacterData::String("true".to_string()));
    }
}