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.
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.
11 use Error as DecodeError;
12 use writer::EncodeResult;
13 use leb128::{read_signed_leb128, read_unsigned_leb128, write_signed_leb128, write_unsigned_leb128};
14 use std::io::{self, Write};
17 // -----------------------------------------------------------------------------
19 // -----------------------------------------------------------------------------
21 pub struct Encoder<'a> {
22 pub cursor: &'a mut io::Cursor<Vec<u8>>,
25 impl<'a> Encoder<'a> {
26 pub fn new(cursor: &'a mut io::Cursor<Vec<u8>>) -> Encoder<'a> {
27 Encoder { cursor: cursor }
32 macro_rules! write_uleb128 {
33 ($enc:expr, $value:expr) => {{
34 let pos = $enc.cursor.position() as usize;
35 let bytes_written = write_unsigned_leb128($enc.cursor.get_mut(), pos, $value as u64);
36 $enc.cursor.set_position((pos + bytes_written) as u64);
41 macro_rules! write_sleb128 {
42 ($enc:expr, $value:expr) => {{
43 let pos = $enc.cursor.position() as usize;
44 let bytes_written = write_signed_leb128($enc.cursor.get_mut(), pos, $value as i64);
45 $enc.cursor.set_position((pos + bytes_written) as u64);
50 impl<'a> serialize::Encoder for Encoder<'a> {
51 type Error = io::Error;
53 fn emit_nil(&mut self) -> EncodeResult {
57 fn emit_uint(&mut self, v: usize) -> EncodeResult {
58 write_uleb128!(self, v)
61 fn emit_u64(&mut self, v: u64) -> EncodeResult {
62 write_uleb128!(self, v)
65 fn emit_u32(&mut self, v: u32) -> EncodeResult {
66 write_uleb128!(self, v)
69 fn emit_u16(&mut self, v: u16) -> EncodeResult {
70 write_uleb128!(self, v)
73 fn emit_u8(&mut self, v: u8) -> EncodeResult {
74 let _ = self.cursor.write_all(&[v]);
78 fn emit_int(&mut self, v: isize) -> EncodeResult {
79 write_sleb128!(self, v)
82 fn emit_i64(&mut self, v: i64) -> EncodeResult {
83 write_sleb128!(self, v)
86 fn emit_i32(&mut self, v: i32) -> EncodeResult {
87 write_sleb128!(self, v)
90 fn emit_i16(&mut self, v: i16) -> EncodeResult {
91 write_sleb128!(self, v)
94 fn emit_i8(&mut self, v: i8) -> EncodeResult {
95 let as_u8: u8 = unsafe { ::std::mem::transmute(v) };
96 let _ = self.cursor.write_all(&[as_u8]);
100 fn emit_bool(&mut self, v: bool) -> EncodeResult {
108 fn emit_f64(&mut self, v: f64) -> EncodeResult {
109 let as_u64: u64 = unsafe { ::std::mem::transmute(v) };
110 self.emit_u64(as_u64)
113 fn emit_f32(&mut self, v: f32) -> EncodeResult {
114 let as_u32: u32 = unsafe { ::std::mem::transmute(v) };
115 self.emit_u32(as_u32)
118 fn emit_char(&mut self, v: char) -> EncodeResult {
119 self.emit_u32(v as u32)
122 fn emit_str(&mut self, v: &str) -> EncodeResult {
123 try!(self.emit_uint(v.len()));
124 let _ = self.cursor.write_all(v.as_bytes());
128 fn emit_enum<F>(&mut self, _name: &str, f: F) -> EncodeResult
129 where F: FnOnce(&mut Self) -> EncodeResult
134 fn emit_enum_variant<F>(&mut self,
140 where F: FnOnce(&mut Self) -> EncodeResult
142 try!(self.emit_uint(v_id));
146 fn emit_enum_variant_arg<F>(&mut self, _: usize, f: F) -> EncodeResult
147 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
152 fn emit_enum_struct_variant<F>(&mut self,
158 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
160 self.emit_enum_variant(v_name, v_id, cnt, f)
163 fn emit_enum_struct_variant_field<F>(&mut self, _: &str, idx: usize, f: F) -> EncodeResult
164 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
166 self.emit_enum_variant_arg(idx, f)
169 fn emit_struct<F>(&mut self, _: &str, _len: usize, f: F) -> EncodeResult
170 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
175 fn emit_struct_field<F>(&mut self, _name: &str, _: usize, f: F) -> EncodeResult
176 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
181 fn emit_tuple<F>(&mut self, len: usize, f: F) -> EncodeResult
182 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
184 self.emit_seq(len, f)
187 fn emit_tuple_arg<F>(&mut self, idx: usize, f: F) -> EncodeResult
188 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
190 self.emit_seq_elt(idx, f)
193 fn emit_tuple_struct<F>(&mut self, _: &str, len: usize, f: F) -> EncodeResult
194 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
196 self.emit_seq(len, f)
199 fn emit_tuple_struct_arg<F>(&mut self, idx: usize, f: F) -> EncodeResult
200 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
202 self.emit_seq_elt(idx, f)
205 fn emit_option<F>(&mut self, f: F) -> EncodeResult
206 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
208 self.emit_enum("Option", f)
211 fn emit_option_none(&mut self) -> EncodeResult {
212 self.emit_enum_variant("None", 0, 0, |_| Ok(()))
215 fn emit_option_some<F>(&mut self, f: F) -> EncodeResult
216 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
218 self.emit_enum_variant("Some", 1, 1, f)
221 fn emit_seq<F>(&mut self, len: usize, f: F) -> EncodeResult
222 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
224 try!(self.emit_uint(len));
228 fn emit_seq_elt<F>(&mut self, _idx: usize, f: F) -> EncodeResult
229 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
234 fn emit_map<F>(&mut self, len: usize, f: F) -> EncodeResult
235 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
237 try!(self.emit_uint(len));
241 fn emit_map_elt_key<F>(&mut self, _idx: usize, f: F) -> EncodeResult
242 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
247 fn emit_map_elt_val<F>(&mut self, _idx: usize, f: F) -> EncodeResult
248 where F: FnOnce(&mut Encoder<'a>) -> EncodeResult
254 impl<'a> Encoder<'a> {
255 pub fn position(&self) -> usize {
256 self.cursor.position() as usize
259 pub fn from_rbml<'b: 'c, 'c>(rbml: &'c mut ::writer::Encoder<'b>) -> Encoder<'c> {
260 Encoder { cursor: rbml.writer }
264 // -----------------------------------------------------------------------------
266 // -----------------------------------------------------------------------------
268 pub struct Decoder<'a> {
273 impl<'a> Decoder<'a> {
274 pub fn new(data: &'a [u8], position: usize) -> Decoder<'a> {
281 pub fn position(&self) -> usize {
285 pub fn advance(&mut self, bytes: usize) {
286 self.position += bytes;
290 macro_rules! read_uleb128 {
291 ($dec:expr, $t:ty) => ({
292 let (value, bytes_read) = read_unsigned_leb128($dec.data, $dec.position);
293 $dec.position += bytes_read;
298 macro_rules! read_sleb128 {
299 ($dec:expr, $t:ty) => ({
300 let (value, bytes_read) = read_signed_leb128($dec.data, $dec.position);
301 $dec.position += bytes_read;
307 impl<'a> serialize::Decoder for Decoder<'a> {
308 type Error = DecodeError;
310 fn read_nil(&mut self) -> Result<(), Self::Error> {
314 fn read_u64(&mut self) -> Result<u64, Self::Error> {
315 read_uleb128!(self, u64)
318 fn read_u32(&mut self) -> Result<u32, Self::Error> {
319 read_uleb128!(self, u32)
322 fn read_u16(&mut self) -> Result<u16, Self::Error> {
323 read_uleb128!(self, u16)
326 fn read_u8(&mut self) -> Result<u8, Self::Error> {
327 let value = self.data[self.position];
332 fn read_uint(&mut self) -> Result<usize, Self::Error> {
333 read_uleb128!(self, usize)
336 fn read_i64(&mut self) -> Result<i64, Self::Error> {
337 read_sleb128!(self, i64)
340 fn read_i32(&mut self) -> Result<i32, Self::Error> {
341 read_sleb128!(self, i32)
344 fn read_i16(&mut self) -> Result<i16, Self::Error> {
345 read_sleb128!(self, i16)
348 fn read_i8(&mut self) -> Result<i8, Self::Error> {
349 let as_u8 = self.data[self.position];
351 unsafe { Ok(::std::mem::transmute(as_u8)) }
354 fn read_int(&mut self) -> Result<isize, Self::Error> {
355 read_sleb128!(self, isize)
358 fn read_bool(&mut self) -> Result<bool, Self::Error> {
359 let value = try!(self.read_u8());
363 fn read_f64(&mut self) -> Result<f64, Self::Error> {
364 let bits = try!(self.read_u64());
365 Ok(unsafe { ::std::mem::transmute(bits) })
368 fn read_f32(&mut self) -> Result<f32, Self::Error> {
369 let bits = try!(self.read_u32());
370 Ok(unsafe { ::std::mem::transmute(bits) })
373 fn read_char(&mut self) -> Result<char, Self::Error> {
374 let bits = try!(self.read_u32());
375 Ok(::std::char::from_u32(bits).unwrap())
378 fn read_str(&mut self) -> Result<String, Self::Error> {
379 let len = try!(self.read_uint());
380 let s = ::std::str::from_utf8(&self.data[self.position..self.position + len]).unwrap();
381 self.position += len;
385 fn read_enum<T, F>(&mut self, _name: &str, f: F) -> Result<T, Self::Error>
386 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
391 fn read_enum_variant<T, F>(&mut self, _: &[&str], mut f: F) -> Result<T, Self::Error>
392 where F: FnMut(&mut Decoder<'a>, usize) -> Result<T, Self::Error>
394 let disr = try!(self.read_uint());
398 fn read_enum_variant_arg<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error>
399 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
404 fn read_enum_struct_variant<T, F>(&mut self, _: &[&str], mut f: F) -> Result<T, Self::Error>
405 where F: FnMut(&mut Decoder<'a>, usize) -> Result<T, Self::Error>
407 let disr = try!(self.read_uint());
411 fn read_enum_struct_variant_field<T, F>(&mut self,
415 -> Result<T, Self::Error>
416 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
421 fn read_struct<T, F>(&mut self, _name: &str, _: usize, f: F) -> Result<T, Self::Error>
422 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
427 fn read_struct_field<T, F>(&mut self, _name: &str, _idx: usize, f: F) -> Result<T, Self::Error>
428 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
433 fn read_tuple<T, F>(&mut self, tuple_len: usize, f: F) -> Result<T, Self::Error>
434 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
436 self.read_seq(move |d, len| {
437 if len == tuple_len {
440 let err = format!("Invalid tuple length. Expected {}, found {}",
443 Err(DecodeError::Expected(err))
448 fn read_tuple_arg<T, F>(&mut self, idx: usize, f: F) -> Result<T, Self::Error>
449 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
451 self.read_seq_elt(idx, f)
454 fn read_tuple_struct<T, F>(&mut self, _name: &str, len: usize, f: F) -> Result<T, Self::Error>
455 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
457 self.read_tuple(len, f)
460 fn read_tuple_struct_arg<T, F>(&mut self, idx: usize, f: F) -> Result<T, Self::Error>
461 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
463 self.read_tuple_arg(idx, f)
466 fn read_option<T, F>(&mut self, mut f: F) -> Result<T, Self::Error>
467 where F: FnMut(&mut Decoder<'a>, bool) -> Result<T, Self::Error>
469 self.read_enum("Option", move |this| {
470 this.read_enum_variant(&["None", "Some"], move |this, idx| {
475 let msg = format!("Invalid Option index: {}", idx);
476 Err(DecodeError::Expected(msg))
483 fn read_seq<T, F>(&mut self, f: F) -> Result<T, Self::Error>
484 where F: FnOnce(&mut Decoder<'a>, usize) -> Result<T, Self::Error>
486 let len = try!(self.read_uint());
490 fn read_seq_elt<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error>
491 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
496 fn read_map<T, F>(&mut self, f: F) -> Result<T, Self::Error>
497 where F: FnOnce(&mut Decoder<'a>, usize) -> Result<T, Self::Error>
499 let len = try!(self.read_uint());
503 fn read_map_elt_key<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error>
504 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
509 fn read_map_elt_val<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error>
510 where F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>
515 fn error(&mut self, err: &str) -> Self::Error {
516 DecodeError::ApplicationError(err.to_string())
523 use serialize::{Encodable, Decodable};
526 use super::{Encoder, Decoder};
528 #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
552 fn check_round_trip<T: Encodable + Decodable + PartialEq + Debug>(values: Vec<T>) {
553 let mut cursor = Cursor::new(Vec::new());
555 for value in &values {
556 let mut encoder = Encoder::new(&mut cursor);
557 Encodable::encode(&value, &mut encoder).unwrap();
560 let data = cursor.into_inner();
561 let mut decoder = Decoder::new(&data[..], 0);
563 for value in values {
564 let decoded = Decodable::decode(&mut decoder).unwrap();
565 assert_eq!(value, decoded);
571 check_round_trip(vec![(), (), (), ()]);
576 let mut vec = vec![];
577 for i in ::std::u8::MIN..::std::u8::MAX {
580 check_round_trip(vec);
585 for i in ::std::u16::MIN..::std::u16::MAX {
586 check_round_trip(vec![1, 2, 3, i, i, i]);
592 check_round_trip(vec![1, 2, 3, ::std::u32::MIN, 0, 1, ::std::u32::MAX, 2, 1]);
597 check_round_trip(vec![1, 2, 3, ::std::u64::MIN, 0, 1, ::std::u64::MAX, 2, 1]);
602 check_round_trip(vec![1, 2, 3, ::std::usize::MIN, 0, 1, ::std::usize::MAX, 2, 1]);
607 let mut vec = vec![];
608 for i in ::std::i8::MIN..::std::i8::MAX {
611 check_round_trip(vec);
616 for i in ::std::i16::MIN..::std::i16::MAX {
617 check_round_trip(vec![-1, 2, -3, i, i, i, 2]);
623 check_round_trip(vec![-1, 2, -3, ::std::i32::MIN, 0, 1, ::std::i32::MAX, 2, 1]);
628 check_round_trip(vec![-1, 2, -3, ::std::i64::MIN, 0, 1, ::std::i64::MAX, 2, 1]);
633 check_round_trip(vec![-1, 2, -3, ::std::isize::MIN, 0, 1, ::std::isize::MAX, 2, 1]);
638 check_round_trip(vec![false, true, true, false, false]);
643 let mut vec = vec![];
645 vec.push((i as f32) / 3.0);
647 check_round_trip(vec);
652 let mut vec = vec![];
654 vec.push((i as f64) / 3.0);
656 check_round_trip(vec);
661 let vec = vec!['a', 'b', 'c', 'd', 'A', 'X', ' ', '#', 'Ö', 'Ä', 'µ', '€'];
662 check_round_trip(vec);
667 let vec = vec!["abcbuÖeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
668 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
669 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpapmaebn".to_string(),
670 "abcbuÖganeiovÄnameÜavmpßvmeabpnvapeapmaebn".to_string(),
671 "abcbuÖganeiÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
672 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpmaebn".to_string(),
673 "abcbuÖganeiovÄnameÜavmpßvmea€µnvapeapmaebn".to_string()];
675 check_round_trip(vec);
680 check_round_trip(vec![Some(-1i8)]);
681 check_round_trip(vec![Some(-2i16)]);
682 check_round_trip(vec![Some(-3i32)]);
683 check_round_trip(vec![Some(-4i64)]);
684 check_round_trip(vec![Some(-5isize)]);
686 let none_i8: Option<i8> = None;
687 check_round_trip(vec![none_i8]);
689 let none_i16: Option<i16> = None;
690 check_round_trip(vec![none_i16]);
692 let none_i32: Option<i32> = None;
693 check_round_trip(vec![none_i32]);
695 let none_i64: Option<i64> = None;
696 check_round_trip(vec![none_i64]);
698 let none_isize: Option<isize> = None;
699 check_round_trip(vec![none_isize]);
704 check_round_trip(vec![Struct {
719 m: "abc".to_string(),
726 check_round_trip(vec![Struct {
741 m: "def".to_string(),
749 #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
752 Variant2(usize, f32),
762 check_round_trip(vec![Enum::Variant1,
763 Enum::Variant2(1, 2.5),
778 let mut vec = vec![];
779 for i in -100i64..100i64 {
780 vec.push(i * 100000);
783 check_round_trip(vec![vec]);
788 use std::collections::HashMap;
789 let mut map = HashMap::new();
790 for i in -100i64..100i64 {
791 map.insert(i * 100000, i * 10000);
794 check_round_trip(vec![map]);
799 check_round_trip(vec![('x', (), false, 0.5f32)]);
800 check_round_trip(vec![(9i8, 10u16, 1.5f64)]);
801 check_round_trip(vec![(-12i16, 11u8, 12usize)]);
802 check_round_trip(vec![(1234567isize, 100000000000000u64, 99999999999999i64)]);
803 check_round_trip(vec![(String::new(), "some string".to_string())]);