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
/*! A low level, performance oriented parser for [EU4](https://en.wikipedia.org/wiki/Europa_Universalis_IV) save files and other [PDS](https://www.paradoxplaza.com/) developed titles. Jomini is the cornerstone of the [Rakaly](https://rakaly.com/eu4), an EU4 achievement leaderboard and save file analyzer. This library is also used in the [Paradox Game Converters project](https://github.com/ParadoxGameConverters/EU4toVic2) to parse ironman EU4 and CK3 saves. ## Features - ✔ Versatile: Handle both plaintext and binary encoded data - ✔ Fast: Parse data at 1 GB/s - ✔ Small: Compile with zero dependencies - ✔ Safe: Extensively fuzzed against potential malicious input - ✔ Ergonomic: Use [serde](https://serde.rs/derive.html)-like macros to have parsing logic automatically implemented - ✔ Embeddable: Cross platform native apps, statically compiled services, or in the browser via [WASM](https://webassembly.org/) - ✔ Agnostic: Parse EU4, HOIV, Imperator, CK3, etc save files ## Quick Start Below is a demonstration on parsing plaintext data using jomini tools. ```rust # #[cfg(feature = "derive")] { use jomini::{JominiDeserialize, TextDeserializer}; #[derive(JominiDeserialize, PartialEq, Debug)] pub struct Model { human: bool, first: Option<u16>, #[jomini(alias = "forth")] fourth: u16, #[jomini(alias = "core", duplicated)] cores: Vec<String>, names: Vec<String>, } let data = br#" human = yes forth = 10 core = "HAB" names = { "Johan" "Frederick" } core = FRA "#; let expected = Model { human: true, first: None, fourth: 10, cores: vec!["HAB".to_string(), "FRA".to_string()], names: vec!["Johan".to_string(), "Frederick".to_string()], }; let actual: Model = TextDeserializer::from_windows1252_slice(data)?; assert_eq!(actual, expected); # } # Ok::<(), Box<dyn std::error::Error>>(()) ``` ## Binary Parsing Parsing data encoded in the binary format is done in a similar fashion but with an extra step. Tokens can be encoded into 16 integers, and so one must provide a map from these integers to their textual representations ```rust # #[cfg(feature = "derive")] { use jomini::{JominiDeserialize, BinaryDeserializer}; use std::collections::HashMap; #[derive(JominiDeserialize, PartialEq, Debug)] struct MyStruct { field1: String, } let data = [ 0x82, 0x2d, 0x01, 0x00, 0x0f, 0x00, 0x03, 0x00, 0x45, 0x4e, 0x47 ]; let mut map = HashMap::new(); map.insert(0x2d82, "field1"); let actual: MyStruct = BinaryDeserializer::from_eu4(&data[..], &map)?; assert_eq!(actual, MyStruct { field1: "ENG".to_string() }); # } # Ok::<(), Box<dyn std::error::Error>>(()) ``` When done correctly, one can use the same structure to represent both the plaintext and binary data without any duplication. One can configure the behavior when a token is unknown (ie: fail immediately or try to continue). ## Caveats Caller is responsible for: - Determining the correct format (text or binary) ahead of time - Stripping off any header that may be present (eg: `EU4txt` / `EU4bin`) - Providing the token resolver for the binary format - Providing the conversion to reconcile how, for example, a date may be encoded as an integer in the binary format, but as a string when in plaintext. The plaintext parser is geared towards save file parsing and is not yet general enough to handle files that embed operators other than equals. ## One Level Lower If the automatic deserialization via `JominiDeserialize` is too high level, one can interact with the raw data directly via `TextTape` and `BinaryTape`. ```rust use jomini::{TextTape, TextToken, Scalar}; let data = b"foo=bar"; assert_eq!( TextTape::from_slice(&data[..])?.tokens(), &[ TextToken::Scalar(Scalar::new(b"foo")), TextToken::Scalar(Scalar::new(b"bar")), ] ); # Ok::<(), Box<dyn std::error::Error>>(()) ``` If one will only use `TextTape` and `BinaryTape` then `jomini` can be compiled without default features, resulting in a build without dependencies. */ pub(crate) mod ascii; mod binary; mod data; #[cfg(feature = "derive")] pub(crate) mod de; mod encoding; mod errors; mod scalar; mod text; pub(crate) mod util; pub use self::binary::*; pub use self::data::Rgb; pub use self::encoding::*; pub use self::errors::*; pub use self::scalar::{Scalar, ScalarError}; pub use self::text::*; #[cfg(feature = "derive")] pub use jomini_derive::*;