src/libserialize/opaque.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use leb128::{self, read_signed_leb128, write_signed_leb128};
  12 use std::borrow::Cow;
  13 use serialize;
  14
  15 // -----------------------------------------------------------------------------
  16 // Encoder
  17 // -----------------------------------------------------------------------------
  18
  19 pub type EncodeResult = Result<(), !>;
  20
  21 pub struct Encoder {
  22     pub data: Vec<u8>,
  23 }
  24
  25 impl Encoder {
  26     pub fn new(data: Vec<u8>) -> Encoder {
  27         Encoder { data }
  28     }
  29
  30     pub fn into_inner(self) -> Vec<u8> {
  31         self.data
  32     }
  33
  34     #[inline]
  35     pub fn emit_raw_bytes(&mut self, s: &[u8]) {
  36         self.data.extend_from_slice(s);
  37     }
  38 }
  39
  40 macro_rules! write_uleb128 {
  41     ($enc:expr, $value:expr, $fun:ident) => {{
  42         leb128::$fun(&mut $enc.data, $value);
  43         Ok(())
  44     }}
  45 }
  46
  47 macro_rules! write_sleb128 {
  48     ($enc:expr, $value:expr) => {{
  49         write_signed_leb128(&mut $enc.data, $value as i128);
  50         Ok(())
  51     }}
  52 }
  53
  54 impl serialize::Encoder for Encoder {
  55     type Error = !;
  56
  57     #[inline]
  58     fn emit_nil(&mut self) -> EncodeResult {
  59         Ok(())
  60     }
  61
  62     #[inline]
  63     fn emit_usize(&mut self, v: usize) -> EncodeResult {
  64         write_uleb128!(self, v, write_usize_leb128)
  65     }
  66
  67     #[inline]
  68     fn emit_u128(&mut self, v: u128) -> EncodeResult {
  69         write_uleb128!(self, v, write_u128_leb128)
  70     }
  71
  72     #[inline]
  73     fn emit_u64(&mut self, v: u64) -> EncodeResult {
  74         write_uleb128!(self, v, write_u64_leb128)
  75     }
  76
  77     #[inline]
  78     fn emit_u32(&mut self, v: u32) -> EncodeResult {
  79         write_uleb128!(self, v, write_u32_leb128)
  80     }
  81
  82     #[inline]
  83     fn emit_u16(&mut self, v: u16) -> EncodeResult {
  84         write_uleb128!(self, v, write_u16_leb128)
  85     }
  86
  87     #[inline]
  88     fn emit_u8(&mut self, v: u8) -> EncodeResult {
  89         self.data.push(v);
  90         Ok(())
  91     }
  92
  93     #[inline]
  94     fn emit_isize(&mut self, v: isize) -> EncodeResult {
  95         write_sleb128!(self, v)
  96     }
  97
  98     #[inline]
  99     fn emit_i128(&mut self, v: i128) -> EncodeResult {
 100         write_sleb128!(self, v)
 101     }
 102
 103     #[inline]
 104     fn emit_i64(&mut self, v: i64) -> EncodeResult {
 105         write_sleb128!(self, v)
 106     }
 107
 108     #[inline]
 109     fn emit_i32(&mut self, v: i32) -> EncodeResult {
 110         write_sleb128!(self, v)
 111     }
 112
 113     #[inline]
 114     fn emit_i16(&mut self, v: i16) -> EncodeResult {
 115         write_sleb128!(self, v)
 116     }
 117
 118     #[inline]
 119     fn emit_i8(&mut self, v: i8) -> EncodeResult {
 120         let as_u8: u8 = unsafe { ::std::mem::transmute(v) };
 121         self.emit_u8(as_u8)
 122     }
 123
 124     #[inline]
 125     fn emit_bool(&mut self, v: bool) -> EncodeResult {
 126         self.emit_u8(if v {
 127             1
 128         } else {
 129             0
 130         })
 131     }
 132
 133     #[inline]
 134     fn emit_f64(&mut self, v: f64) -> EncodeResult {
 135         let as_u64: u64 = unsafe { ::std::mem::transmute(v) };
 136         self.emit_u64(as_u64)
 137     }
 138
 139     #[inline]
 140     fn emit_f32(&mut self, v: f32) -> EncodeResult {
 141         let as_u32: u32 = unsafe { ::std::mem::transmute(v) };
 142         self.emit_u32(as_u32)
 143     }
 144
 145     #[inline]
 146     fn emit_char(&mut self, v: char) -> EncodeResult {
 147         self.emit_u32(v as u32)
 148     }
 149
 150     #[inline]
 151     fn emit_str(&mut self, v: &str) -> EncodeResult {
 152         self.emit_usize(v.len())?;
 153         self.emit_raw_bytes(v.as_bytes());
 154         Ok(())
 155     }
 156 }
 157
 158 impl Encoder {
 159     #[inline]
 160     pub fn position(&self) -> usize {
 161         self.data.len()
 162     }
 163 }
 164
 165 // -----------------------------------------------------------------------------
 166 // Decoder
 167 // -----------------------------------------------------------------------------
 168
 169 pub struct Decoder<'a> {
 170     pub data: &'a [u8],
 171     position: usize,
 172 }
 173
 174 impl<'a> Decoder<'a> {
 175     pub fn new(data: &'a [u8], position: usize) -> Decoder<'a> {
 176         Decoder {
 177             data,
 178             position,
 179         }
 180     }
 181
 182     #[inline]
 183     pub fn position(&self) -> usize {
 184         self.position
 185     }
 186
 187     #[inline]
 188     pub fn set_position(&mut self, pos: usize) {
 189         self.position = pos
 190     }
 191
 192     #[inline]
 193     pub fn advance(&mut self, bytes: usize) {
 194         self.position += bytes;
 195     }
 196
 197     #[inline]
 198     pub fn read_raw_bytes(&mut self, s: &mut [u8]) -> Result<(), String> {
 199         let start = self.position;
 200         let end = start + s.len();
 201
 202         s.copy_from_slice(&self.data[start..end]);
 203
 204         self.position = end;
 205
 206         Ok(())
 207     }
 208 }
 209
 210 macro_rules! read_uleb128 {
 211     ($dec:expr, $t:ty, $fun:ident) => ({
 212         let (value, bytes_read) = leb128::$fun(&$dec.data[$dec.position ..]);
 213         $dec.position += bytes_read;
 214         Ok(value)
 215     })
 216 }
 217
 218 macro_rules! read_sleb128 {
 219     ($dec:expr, $t:ty) => ({
 220         let (value, bytes_read) = read_signed_leb128($dec.data, $dec.position);
 221         $dec.position += bytes_read;
 222         Ok(value as $t)
 223     })
 224 }
 225
 226
 227 impl<'a> serialize::Decoder for Decoder<'a> {
 228     type Error = String;
 229
 230     #[inline]
 231     fn read_nil(&mut self) -> Result<(), Self::Error> {
 232         Ok(())
 233     }
 234
 235     #[inline]
 236     fn read_u128(&mut self) -> Result<u128, Self::Error> {
 237         read_uleb128!(self, u128, read_u128_leb128)
 238     }
 239
 240     #[inline]
 241     fn read_u64(&mut self) -> Result<u64, Self::Error> {
 242         read_uleb128!(self, u64, read_u64_leb128)
 243     }
 244
 245     #[inline]
 246     fn read_u32(&mut self) -> Result<u32, Self::Error> {
 247         read_uleb128!(self, u32, read_u32_leb128)
 248     }
 249
 250     #[inline]
 251     fn read_u16(&mut self) -> Result<u16, Self::Error> {
 252         read_uleb128!(self, u16, read_u16_leb128)
 253     }
 254
 255     #[inline]
 256     fn read_u8(&mut self) -> Result<u8, Self::Error> {
 257         let value = self.data[self.position];
 258         self.position += 1;
 259         Ok(value)
 260     }
 261
 262     #[inline]
 263     fn read_usize(&mut self) -> Result<usize, Self::Error> {
 264         read_uleb128!(self, usize, read_usize_leb128)
 265     }
 266
 267     #[inline]
 268     fn read_i128(&mut self) -> Result<i128, Self::Error> {
 269         read_sleb128!(self, i128)
 270     }
 271
 272     #[inline]
 273     fn read_i64(&mut self) -> Result<i64, Self::Error> {
 274         read_sleb128!(self, i64)
 275     }
 276
 277     #[inline]
 278     fn read_i32(&mut self) -> Result<i32, Self::Error> {
 279         read_sleb128!(self, i32)
 280     }
 281
 282     #[inline]
 283     fn read_i16(&mut self) -> Result<i16, Self::Error> {
 284         read_sleb128!(self, i16)
 285     }
 286
 287     #[inline]
 288     fn read_i8(&mut self) -> Result<i8, Self::Error> {
 289         let as_u8 = self.data[self.position];
 290         self.position += 1;
 291         unsafe { Ok(::std::mem::transmute(as_u8)) }
 292     }
 293
 294     #[inline]
 295     fn read_isize(&mut self) -> Result<isize, Self::Error> {
 296         read_sleb128!(self, isize)
 297     }
 298
 299     #[inline]
 300     fn read_bool(&mut self) -> Result<bool, Self::Error> {
 301         let value = self.read_u8()?;
 302         Ok(value != 0)
 303     }
 304
 305     #[inline]
 306     fn read_f64(&mut self) -> Result<f64, Self::Error> {
 307         let bits = self.read_u64()?;
 308         Ok(unsafe { ::std::mem::transmute(bits) })
 309     }
 310
 311     #[inline]
 312     fn read_f32(&mut self) -> Result<f32, Self::Error> {
 313         let bits = self.read_u32()?;
 314         Ok(unsafe { ::std::mem::transmute(bits) })
 315     }
 316
 317     #[inline]
 318     fn read_char(&mut self) -> Result<char, Self::Error> {
 319         let bits = self.read_u32()?;
 320         Ok(::std::char::from_u32(bits).unwrap())
 321     }
 322
 323     #[inline]
 324     fn read_str(&mut self) -> Result<Cow<str>, Self::Error> {
 325         let len = self.read_usize()?;
 326         let s = ::std::str::from_utf8(&self.data[self.position..self.position + len]).unwrap();
 327         self.position += len;
 328         Ok(Cow::Borrowed(s))
 329     }
 330
 331     #[inline]
 332     fn error(&mut self, err: &str) -> Self::Error {
 333         err.to_string()
 334     }
 335 }
 336
 337
 338 #[cfg(test)]
 339 mod tests {
 340     use serialize::{Encodable, Decodable};
 341     use std::fmt::Debug;
 342     use super::{Encoder, Decoder};
 343
 344     #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
 345     struct Struct {
 346         a: (),
 347         b: u8,
 348         c: u16,
 349         d: u32,
 350         e: u64,
 351         f: usize,
 352
 353         g: i8,
 354         h: i16,
 355         i: i32,
 356         j: i64,
 357         k: isize,
 358
 359         l: char,
 360         m: String,
 361         n: f32,
 362         o: f64,
 363         p: bool,
 364         q: Option<u32>,
 365     }
 366
 367
 368     fn check_round_trip<T: Encodable + Decodable + PartialEq + Debug>(values: Vec<T>) {
 369         let mut encoder = Encoder::new(Vec::new());
 370
 371         for value in &values {
 372             Encodable::encode(&value, &mut encoder).unwrap();
 373         }
 374
 375         let data = encoder.into_inner();
 376         let mut decoder = Decoder::new(&data[..], 0);
 377
 378         for value in values {
 379             let decoded = Decodable::decode(&mut decoder).unwrap();
 380             assert_eq!(value, decoded);
 381         }
 382     }
 383
 384     #[test]
 385     fn test_unit() {
 386         check_round_trip(vec![(), (), (), ()]);
 387     }
 388
 389     #[test]
 390     fn test_u8() {
 391         let mut vec = vec![];
 392         for i in ::std::u8::MIN..::std::u8::MAX {
 393             vec.push(i);
 394         }
 395         check_round_trip(vec);
 396     }
 397
 398     #[test]
 399     fn test_u16() {
 400         for i in ::std::u16::MIN..::std::u16::MAX {
 401             check_round_trip(vec![1, 2, 3, i, i, i]);
 402         }
 403     }
 404
 405     #[test]
 406     fn test_u32() {
 407         check_round_trip(vec![1, 2, 3, ::std::u32::MIN, 0, 1, ::std::u32::MAX, 2, 1]);
 408     }
 409
 410     #[test]
 411     fn test_u64() {
 412         check_round_trip(vec![1, 2, 3, ::std::u64::MIN, 0, 1, ::std::u64::MAX, 2, 1]);
 413     }
 414
 415     #[test]
 416     fn test_usize() {
 417         check_round_trip(vec![1, 2, 3, ::std::usize::MIN, 0, 1, ::std::usize::MAX, 2, 1]);
 418     }
 419
 420     #[test]
 421     fn test_i8() {
 422         let mut vec = vec![];
 423         for i in ::std::i8::MIN..::std::i8::MAX {
 424             vec.push(i);
 425         }
 426         check_round_trip(vec);
 427     }
 428
 429     #[test]
 430     fn test_i16() {
 431         for i in ::std::i16::MIN..::std::i16::MAX {
 432             check_round_trip(vec![-1, 2, -3, i, i, i, 2]);
 433         }
 434     }
 435
 436     #[test]
 437     fn test_i32() {
 438         check_round_trip(vec![-1, 2, -3, ::std::i32::MIN, 0, 1, ::std::i32::MAX, 2, 1]);
 439     }
 440
 441     #[test]
 442     fn test_i64() {
 443         check_round_trip(vec![-1, 2, -3, ::std::i64::MIN, 0, 1, ::std::i64::MAX, 2, 1]);
 444     }
 445
 446     #[test]
 447     fn test_isize() {
 448         check_round_trip(vec![-1, 2, -3, ::std::isize::MIN, 0, 1, ::std::isize::MAX, 2, 1]);
 449     }
 450
 451     #[test]
 452     fn test_bool() {
 453         check_round_trip(vec![false, true, true, false, false]);
 454     }
 455
 456     #[test]
 457     fn test_f32() {
 458         let mut vec = vec![];
 459         for i in -100..100 {
 460             vec.push((i as f32) / 3.0);
 461         }
 462         check_round_trip(vec);
 463     }
 464
 465     #[test]
 466     fn test_f64() {
 467         let mut vec = vec![];
 468         for i in -100..100 {
 469             vec.push((i as f64) / 3.0);
 470         }
 471         check_round_trip(vec);
 472     }
 473
 474     #[test]
 475     fn test_char() {
 476         let vec = vec!['a', 'b', 'c', 'd', 'A', 'X', ' ', '#', 'Ö', 'Ä', 'µ', '€'];
 477         check_round_trip(vec);
 478     }
 479
 480     #[test]
 481     fn test_string() {
 482         let vec = vec!["abcbuÖeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 483                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 484                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpapmaebn".to_string(),
 485                        "abcbuÖganeiovÄnameÜavmpßvmeabpnvapeapmaebn".to_string(),
 486                        "abcbuÖganeiÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
 487                        "abcbuÖganeiovÄnameÜavmpßvmea€µsbpmaebn".to_string(),
 488                        "abcbuÖganeiovÄnameÜavmpßvmea€µnvapeapmaebn".to_string()];
 489
 490         check_round_trip(vec);
 491     }
 492
 493     #[test]
 494     fn test_option() {
 495         check_round_trip(vec![Some(-1i8)]);
 496         check_round_trip(vec![Some(-2i16)]);
 497         check_round_trip(vec![Some(-3i32)]);
 498         check_round_trip(vec![Some(-4i64)]);
 499         check_round_trip(vec![Some(-5isize)]);
 500
 501         let none_i8: Option<i8> = None;
 502         check_round_trip(vec![none_i8]);
 503
 504         let none_i16: Option<i16> = None;
 505         check_round_trip(vec![none_i16]);
 506
 507         let none_i32: Option<i32> = None;
 508         check_round_trip(vec![none_i32]);
 509
 510         let none_i64: Option<i64> = None;
 511         check_round_trip(vec![none_i64]);
 512
 513         let none_isize: Option<isize> = None;
 514         check_round_trip(vec![none_isize]);
 515     }
 516
 517     #[test]
 518     fn test_struct() {
 519         check_round_trip(vec![Struct {
 520                                   a: (),
 521                                   b: 10,
 522                                   c: 11,
 523                                   d: 12,
 524                                   e: 13,
 525                                   f: 14,
 526
 527                                   g: 15,
 528                                   h: 16,
 529                                   i: 17,
 530                                   j: 18,
 531                                   k: 19,
 532
 533                                   l: 'x',
 534                                   m: "abc".to_string(),
 535                                   n: 20.5,
 536                                   o: 21.5,
 537                                   p: false,
 538                                   q: None,
 539                               }]);
 540
 541         check_round_trip(vec![Struct {
 542                                   a: (),
 543                                   b: 101,
 544                                   c: 111,
 545                                   d: 121,
 546                                   e: 131,
 547                                   f: 141,
 548
 549                                   g: -15,
 550                                   h: -16,
 551                                   i: -17,
 552                                   j: -18,
 553                                   k: -19,
 554
 555                                   l: 'y',
 556                                   m: "def".to_string(),
 557                                   n: -20.5,
 558                                   o: -21.5,
 559                                   p: true,
 560                                   q: Some(1234567),
 561                               }]);
 562     }
 563
 564     #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
 565     enum Enum {
 566         Variant1,
 567         Variant2(usize, f32),
 568         Variant3 {
 569             a: i32,
 570             b: char,
 571             c: bool,
 572         },
 573     }
 574
 575     #[test]
 576     fn test_enum() {
 577         check_round_trip(vec![Enum::Variant1,
 578                               Enum::Variant2(1, 2.5),
 579                               Enum::Variant3 {
 580                                   a: 3,
 581                                   b: 'b',
 582                                   c: false,
 583                               },
 584                               Enum::Variant3 {
 585                                   a: -4,
 586                                   b: 'f',
 587                                   c: true,
 588                               }]);
 589     }
 590
 591     #[test]
 592     fn test_sequence() {
 593         let mut vec = vec![];
 594         for i in -100i64..100i64 {
 595             vec.push(i * 100000);
 596         }
 597
 598         check_round_trip(vec![vec]);
 599     }
 600
 601     #[test]
 602     fn test_hash_map() {
 603         use std::collections::HashMap;
 604         let mut map = HashMap::new();
 605         for i in -100i64..100i64 {
 606             map.insert(i * 100000, i * 10000);
 607         }
 608
 609         check_round_trip(vec![map]);
 610     }
 611
 612     #[test]
 613     fn test_tuples() {
 614         check_round_trip(vec![('x', (), false, 0.5f32)]);
 615         check_round_trip(vec![(9i8, 10u16, 1.5f64)]);
 616         check_round_trip(vec![(-12i16, 11u8, 12usize)]);
 617         check_round_trip(vec![(1234567isize, 100000000000000u64, 99999999999999i64)]);
 618         check_round_trip(vec![(String::new(), "some string".to_string())]);
 619     }
 620 }