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
use apint::{ApInt};
use digit::{Digit};
use bitwidth::{BitWidth};

use serde::{
    Serialize,
    Serializer
};
use serde::ser::{
    SerializeTupleStruct
};

impl Serialize for Digit {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where S: Serializer
    {
        serializer.serialize_u64(self.repr())
    }
}

impl Serialize for BitWidth {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where S: Serializer
    {
        if serializer.is_human_readable() {
            let mut s = serializer.serialize_tuple_struct("BitWidth", 1)?;
            s.serialize_field(&(self.to_usize() as u64))?;
            s.end()
        }
        else {
            serializer.serialize_u64(self.to_usize() as u64)
        }
    }
}

impl Serialize for ApInt {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where S: Serializer
    {
        use serde::ser::{SerializeStruct, SerializeTuple};

        if serializer.is_human_readable() {
            let mut s = serializer.serialize_struct("ApInt", 2)?;
            s.serialize_field("width", &self.len)?;
            s.serialize_field("digits", self.as_digit_slice())?;
            s.end()
        }
        else {
            let mut s = serializer.serialize_tuple(2)?;
            s.serialize_element(&self.len)?;
            s.serialize_element(&self.as_digit_slice())?;
            s.end()
        }
    }
}

use serde::{
    Deserialize,
    Deserializer
};
use serde::de::{
    Visitor,
    SeqAccess,
    MapAccess
};
use serde::de;
use std::fmt;

impl<'de> Deserialize<'de> for BitWidth {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where D: Deserializer<'de>
    {
        struct HumanReadableBitWidthVisitor;
    
        fn try_new_bitwidth<E>(width: usize) -> Result<BitWidth, E>
            where E: de::Error
        {
            BitWidth::new(width as usize)
                .map_err(|_| de::Error::invalid_value(
                        de::Unexpected::Unsigned(width as u64),
                        &"a valid `u64` `BitWidth` representation"
                    )
                )
        }

        impl<'de> Visitor<'de> for HumanReadableBitWidthVisitor {
            type Value = BitWidth;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("human-readable repr of `BitWidth`")
            }

            fn visit_seq<V>(self, mut seq: V) -> Result<Self::Value, V::Error>
                where V: SeqAccess<'de>
            {
                let width_repr: u64 = seq.next_element()?
                                         .ok_or_else(|| de::Error::invalid_length(0, &self))?;
                try_new_bitwidth(width_repr as usize)
             }
        }

        struct CompactBitWidthVisitor;

        impl<'de> Visitor<'de> for CompactBitWidthVisitor {
            type Value = BitWidth;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("compact repr of `BitWidth`")
            }

            fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>
                where E: de::Error
            {
                try_new_bitwidth(v as usize)
            }
        }

        if deserializer.is_human_readable() {
            deserializer.deserialize_tuple_struct("BitWidth", 1, HumanReadableBitWidthVisitor)
        }
        else {
            deserializer.deserialize_u64(CompactBitWidthVisitor)
        }
    }
}

impl<'de> Deserialize<'de> for Digit {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where D: Deserializer<'de>
    {
        struct DigitVisitor;

        impl<'de> Visitor<'de> for DigitVisitor {
            type Value = Digit;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("`u64` repr of `Digit`")
            }

            fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>
                where E: de::Error
            {
                Ok(Digit(v))
            }
        }

        deserializer.deserialize_u64(DigitVisitor)
    }
}

impl<'de> Deserialize<'de> for ApInt {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where D: Deserializer<'de>
    {
        enum Field { Width, Digits }
        const FIELDS: &[&str] = &["width", "digits"];

        impl<'de> Deserialize<'de> for Field {
            fn deserialize<D>(deserializer: D) -> Result<Field, D::Error>
                where D: Deserializer<'de>
            {
                struct FieldVisitor;

                impl<'de> Visitor<'de> for FieldVisitor {
                    type Value = Field;

                    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                        formatter.write_str("`width` or `digits`")
                    }

                    fn visit_str<E>(self, value: &str) -> Result<Field, E>
                        where E: de::Error
                    {
                        match value {
                            "width" => Ok(Field::Width),
                            "digits" => Ok(Field::Digits),
                            _ => Err(de::Error::unknown_field(value, FIELDS))
                        }
                    }
                }

                deserializer.deserialize_identifier(FieldVisitor)
            }
        }

        struct HumanReadableApIntVisitor;

        impl<'de> Visitor<'de> for HumanReadableApIntVisitor {
            type Value = ApInt;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("struct ApInt")
            }

            fn visit_map<V>(self, mut map: V) -> Result<ApInt, V::Error>
                where V: MapAccess<'de>
            {
                let mut width : Option<BitWidth>   = None;
                let mut digits: Option<Vec<Digit>> = None;
                while let Some(key) = map.next_key()? {
                    match key {
                        Field::Width => {
                            if width.is_some() {
                                return Err(de::Error::duplicate_field("width"));
                            }
                            width = Some(map.next_value()?);
                        }
                        Field::Digits => {
                            if digits.is_some() {
                                return Err(de::Error::duplicate_field("digits"));
                            }
                            digits = Some(map.next_value()?);
                        }
                    }
                }
                let width = width.ok_or_else(|| de::Error::missing_field("width"))?;
                let digits = digits.ok_or_else(|| de::Error::missing_field("digits"))?;

                if width.required_digits() != digits.len() {
                    return Err(de::Error::invalid_value(
                        de::Unexpected::Unsigned(digits.len() as u64),
                        &"require `width` to be compatible with `digits.len()`"))
                }

                Ok(ApInt::from_iter(digits)
                    .expect("We already asserted that we deserialized the lower-bound \
                             of `required_digits` so `ApInt::from_iter` is fail free.")
                    .into_truncate(width)
                    .expect("An `into_truncate` call to `width` cannot fail since `digits`
                             contains exactly `required_digits` digits and `ApInt::from_iter \
                             always creates an `ApInt` with an upper bound bit width."))
            }
        }

        struct CompactApIntVisitor;

        impl<'de> Visitor<'de> for CompactApIntVisitor {
            type Value = ApInt;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("compact ApInt")
            }

            fn visit_seq<V>(self, mut seq: V) -> Result<ApInt, V::Error>
                where V: SeqAccess<'de>
            {
                let width: BitWidth = seq.next_element()?.unwrap();
                let digits: Vec<Digit> = seq.next_element()?
                                            .ok_or_else(|| de::Error::invalid_length(1, &self))?;

                if width.required_digits() != digits.len() {
                    return Err(de::Error::invalid_value(
                        de::Unexpected::Seq, &"unexpected number of digits found"))
                }

                Ok(ApInt::from_iter(digits)
                    .expect("We already asserted that we deserialized the lower-bound \
                             of `required_digits` so `ApInt::from_iter` is fail free.")
                    .into_truncate(width)
                    .expect("An `into_truncate` call to `width` cannot fail since `digits`
                             contains exactly `required_digits` digits and `ApInt::from_iter \
                             always creates an `ApInt` with an upper bound bit width."))
            }
        }

        if deserializer.is_human_readable() {
            deserializer.deserialize_struct("ApInt", FIELDS, HumanReadableApIntVisitor)
        }
        else {
            deserializer.deserialize_tuple(2, CompactApIntVisitor)
        }
    }
}

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

    use serde_test::{
        Token,
        Configure,
        assert_tokens
    };

    mod compact {
        use super::*;

        #[test]
        fn test_small() {
            let x = ApInt::from_u64(0xFEDC_BA98_7654_3210);
            let expected = &[
                Token::Tuple{ len: 2 },
                Token::U64(64),
                Token::Seq{ len: Some(1) },
                Token::U64(0xFEDC_BA98_7654_3210),
                Token::SeqEnd,
                Token::TupleEnd
            ];
            assert_tokens(&x.compact(), expected)
        }

        #[test]
        fn test_large() {
            let x = ApInt::from_u128(
                0xFEDC_BA98_7654_3210__0101_1010_0110_1001);
            let expected = &[
                Token::Tuple{ len: 2 },
                Token::U64(128),
                Token::Seq{ len: Some(2) },
                Token::U64(0x0101_1010_0110_1001),
                Token::U64(0xFEDC_BA98_7654_3210),
                Token::SeqEnd,
                Token::TupleEnd
            ];
            assert_tokens(&x.compact(), expected)
        }
    }

    mod human_readable {
        use super::*;

        #[test]
        fn test_small() {
            let x = ApInt::from_u64(42);
            let expected = &[
                Token::Struct{
                    name: "ApInt",
                    len: 2
                },
                Token::Str("width"),
                Token::TupleStruct{ name: "BitWidth", len: 1 },
                Token::U64(64),
                Token::TupleStructEnd,
                Token::Str("digits"),
                Token::Seq{ len: Some(1) },
                Token::U64(42),
                Token::SeqEnd,
                Token::StructEnd
            ];
            assert_tokens(&x.clone().readable(), expected);
        }

        #[test]
        fn test_large() {
            let x = ApInt::from_u128(1337);
            let expected = &[
                Token::Struct{
                    name: "ApInt",
                    len: 2
                },
                Token::Str("width"),
                Token::TupleStruct{ name: "BitWidth", len: 1 },
                Token::U64(128),
                Token::TupleStructEnd,
                Token::Str("digits"),
                Token::Seq{ len: Some(2) },
                Token::U64(1337),
                Token::U64(0),
                Token::SeqEnd,
                Token::StructEnd
            ];
            assert_tokens(&x.clone().readable(), expected);
        }
    }
}