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,
14 write_unsigned_leb128};
15 use std::io::{self, Write};
18 //=-----------------------------------------------------------------------------
20 //=-----------------------------------------------------------------------------
22 pub struct Encoder<'a> {
23 pub cursor: &'a mut io::Cursor<Vec<u8>>,
26 impl<'a> Encoder<'a> {
27 pub fn new(cursor: &'a mut io::Cursor<Vec<u8>>) -> Encoder<'a> {
35 macro_rules! write_uleb128 {
36 ($enc:expr, $value:expr) => {{
37 let pos = $enc.cursor.position() as usize;
38 let bytes_written = write_unsigned_leb128($enc.cursor.get_mut(), pos, $value as u64);
39 $enc.cursor.set_position((pos + bytes_written) as u64);
44 macro_rules! write_sleb128 {
45 ($enc:expr, $value:expr) => {{
46 let pos = $enc.cursor.position() as usize;
47 let bytes_written = write_signed_leb128($enc.cursor.get_mut(), pos, $value as i64);
48 $enc.cursor.set_position((pos + bytes_written) as u64);
53 impl<'a> serialize::Encoder for Encoder<'a> {
54 type Error = io::Error;
56 fn emit_nil(&mut self) -> EncodeResult {
60 fn emit_uint(&mut self, v: usize) -> EncodeResult {
61 write_uleb128!(self, v)
64 fn emit_u64(&mut self, v: u64) -> EncodeResult {
65 write_uleb128!(self, v)
68 fn emit_u32(&mut self, v: u32) -> EncodeResult {
69 write_uleb128!(self, v)
72 fn emit_u16(&mut self, v: u16) -> EncodeResult {
73 write_uleb128!(self, v)
76 fn emit_u8(&mut self, v: u8) -> EncodeResult {
77 let _ = self.cursor.write_all(&[v]);
81 fn emit_int(&mut self, v: isize) -> EncodeResult {
82 write_sleb128!(self, v)
85 fn emit_i64(&mut self, v: i64) -> EncodeResult {
86 write_sleb128!(self, v)
89 fn emit_i32(&mut self, v: i32) -> EncodeResult {
90 write_sleb128!(self, v)
93 fn emit_i16(&mut self, v: i16) -> EncodeResult {
94 write_sleb128!(self, v)
97 fn emit_i8(&mut self, v: i8) -> EncodeResult {
98 let as_u8: u8 = unsafe { ::std::mem::transmute(v) };
99 let _ = self.cursor.write_all(&[as_u8]);
103 fn emit_bool(&mut self, v: bool) -> EncodeResult {
104 self.emit_u8(if v { 1 } else { 0 })
107 fn emit_f64(&mut self, v: f64) -> EncodeResult {
108 let as_u64: u64 = unsafe { ::std::mem::transmute(v) };
109 self.emit_u64(as_u64)
112 fn emit_f32(&mut self, v: f32) -> EncodeResult {
113 let as_u32: u32 = unsafe { ::std::mem::transmute(v) };
114 self.emit_u32(as_u32)
117 fn emit_char(&mut self, v: char) -> EncodeResult {
118 self.emit_u32(v as u32)
121 fn emit_str(&mut self, v: &str) -> EncodeResult {
122 try!(self.emit_uint(v.len()));
123 let _ = self.cursor.write_all(v.as_bytes());
127 fn emit_enum<F>(&mut self, _name: &str, f: F) -> EncodeResult
128 where F: FnOnce(&mut Self) -> EncodeResult {
132 fn emit_enum_variant<F>(&mut self,
136 f: F) -> EncodeResult
137 where F: FnOnce(&mut Self) -> EncodeResult
139 try!(self.emit_uint(v_id));
143 fn emit_enum_variant_arg<F>(&mut self, _: usize, f: F) -> EncodeResult where
144 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
149 fn emit_enum_struct_variant<F>(&mut self,
153 f: F) -> EncodeResult where
154 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
156 self.emit_enum_variant(v_name, v_id, cnt, f)
159 fn emit_enum_struct_variant_field<F>(&mut self,
162 f: F) -> EncodeResult where
163 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
165 self.emit_enum_variant_arg(idx, f)
168 fn emit_struct<F>(&mut self, _: &str, _len: usize, f: F) -> EncodeResult where
169 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
174 fn emit_struct_field<F>(&mut self, _name: &str, _: usize, f: F) -> EncodeResult where
175 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
180 fn emit_tuple<F>(&mut self, len: usize, f: F) -> EncodeResult where
181 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
183 self.emit_seq(len, f)
186 fn emit_tuple_arg<F>(&mut self, idx: usize, f: F) -> EncodeResult where
187 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
189 self.emit_seq_elt(idx, f)
192 fn emit_tuple_struct<F>(&mut self, _: &str, len: usize, f: F) -> EncodeResult where
193 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
195 self.emit_seq(len, f)
198 fn emit_tuple_struct_arg<F>(&mut self, idx: usize, f: F) -> EncodeResult where
199 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
201 self.emit_seq_elt(idx, f)
204 fn emit_option<F>(&mut self, f: F) -> EncodeResult where
205 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
207 self.emit_enum("Option", f)
210 fn emit_option_none(&mut self) -> EncodeResult {
211 self.emit_enum_variant("None", 0, 0, |_| Ok(()))
214 fn emit_option_some<F>(&mut self, f: F) -> EncodeResult where
215 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
217 self.emit_enum_variant("Some", 1, 1, f)
220 fn emit_seq<F>(&mut self, len: usize, f: F) -> EncodeResult where
221 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
223 try!(self.emit_uint(len));
227 fn emit_seq_elt<F>(&mut self, _idx: usize, f: F) -> EncodeResult where
228 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
233 fn emit_map<F>(&mut self, len: usize, f: F) -> EncodeResult where
234 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
236 try!(self.emit_uint(len));
240 fn emit_map_elt_key<F>(&mut self, _idx: usize, f: F) -> EncodeResult where
241 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
246 fn emit_map_elt_val<F>(&mut self, _idx: usize, f: F) -> EncodeResult where
247 F: FnOnce(&mut Encoder<'a>) -> EncodeResult,
253 impl<'a> Encoder<'a> {
254 pub fn position(&self) -> usize {
255 self.cursor.position() as usize
258 pub fn from_rbml<'b: 'c, 'c>(rbml: &'c mut ::writer::Encoder<'b>) -> Encoder<'c> {
265 //=-----------------------------------------------------------------------------
267 //=-----------------------------------------------------------------------------
269 pub struct Decoder<'a> {
274 impl<'a> Decoder<'a> {
275 pub fn new(data: &'a [u8], position: usize) -> Decoder<'a> {
282 pub fn position(&self) -> usize {
286 pub fn advance(&mut self, bytes: usize) {
287 self.position += bytes;
291 macro_rules! read_uleb128 {
292 ($dec:expr, $t:ty) => ({
293 let (value, bytes_read) = read_unsigned_leb128($dec.data, $dec.position);
294 $dec.position += bytes_read;
299 macro_rules! read_sleb128 {
300 ($dec:expr, $t:ty) => ({
301 let (value, bytes_read) = read_signed_leb128($dec.data, $dec.position);
302 $dec.position += bytes_read;
308 impl<'a> serialize::Decoder for Decoder<'a> {
309 type Error = DecodeError;
311 fn read_nil(&mut self) -> Result<(), Self::Error> {
315 fn read_u64(&mut self) -> Result<u64, Self::Error> {
316 read_uleb128!(self, u64)
319 fn read_u32(&mut self) -> Result<u32, Self::Error> {
320 read_uleb128!(self, u32)
323 fn read_u16(&mut self) -> Result<u16, Self::Error> {
324 read_uleb128!(self, u16)
327 fn read_u8(&mut self) -> Result<u8, Self::Error> {
328 let value = self.data[self.position];
333 fn read_uint(&mut self) -> Result<usize, Self::Error> {
334 read_uleb128!(self, usize)
337 fn read_i64(&mut self) -> Result<i64, Self::Error> {
338 read_sleb128!(self, i64)
341 fn read_i32(&mut self) -> Result<i32, Self::Error> {
342 read_sleb128!(self, i32)
345 fn read_i16(&mut self) -> Result<i16, Self::Error> {
346 read_sleb128!(self, i16)
349 fn read_i8(&mut self) -> Result<i8, Self::Error> {
350 let as_u8 = self.data[self.position];
353 Ok(::std::mem::transmute(as_u8))
357 fn read_int(&mut self) -> Result<isize, Self::Error> {
358 read_sleb128!(self, isize)
361 fn read_bool(&mut self) -> Result<bool, Self::Error> {
362 let value = try!(self.read_u8());
366 fn read_f64(&mut self) -> Result<f64, Self::Error> {
367 let bits = try!(self.read_u64());
368 Ok(unsafe { ::std::mem::transmute(bits) })
371 fn read_f32(&mut self) -> Result<f32, Self::Error> {
372 let bits = try!(self.read_u32());
373 Ok(unsafe { ::std::mem::transmute(bits) })
376 fn read_char(&mut self) -> Result<char, Self::Error> {
377 let bits = try!(self.read_u32());
378 Ok(::std::char::from_u32(bits).unwrap())
381 fn read_str(&mut self) -> Result<String, Self::Error> {
382 let len = try!(self.read_uint());
383 let s = ::std::str::from_utf8(&self.data[self.position .. self.position + len]).unwrap();
384 self.position += len;
388 fn read_enum<T, F>(&mut self, _name: &str, f: F) -> Result<T, Self::Error> where
389 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
394 fn read_enum_variant<T, F>(&mut self,
397 -> Result<T, Self::Error>
398 where F: FnMut(&mut Decoder<'a>, usize) -> Result<T, Self::Error>,
400 let disr = try!(self.read_uint());
404 fn read_enum_variant_arg<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error> where
405 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
410 fn read_enum_struct_variant<T, F>(&mut self,
412 mut f: F) -> Result<T, Self::Error>
413 where F: FnMut(&mut Decoder<'a>, usize) -> Result<T, Self::Error>,
415 let disr = try!(self.read_uint());
419 fn read_enum_struct_variant_field<T, F>(&mut self,
423 -> Result<T, Self::Error> where
424 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
429 fn read_struct<T, F>(&mut self, _name: &str, _: usize, f: F) -> Result<T, Self::Error> where
430 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
435 fn read_struct_field<T, F>(&mut self,
438 -> Result<T, Self::Error> where
439 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
444 fn read_tuple<T, F>(&mut self, tuple_len: usize, f: F) -> Result<T, Self::Error> where
445 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
447 self.read_seq(move |d, len| {
448 if len == tuple_len {
451 let err = format!("Invalid tuple length. Expected {}, found {}",
454 Err(DecodeError::Expected(err))
459 fn read_tuple_arg<T, F>(&mut self, idx: usize, f: F) -> Result<T, Self::Error> where
460 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
462 self.read_seq_elt(idx, f)
465 fn read_tuple_struct<T, F>(&mut self,
468 -> Result<T, Self::Error> where
469 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
471 self.read_tuple(len, f)
474 fn read_tuple_struct_arg<T, F>(&mut self,
477 -> Result<T, Self::Error> where
478 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
480 self.read_tuple_arg(idx, f)
483 fn read_option<T, F>(&mut self, mut f: F) -> Result<T, Self::Error> where
484 F: FnMut(&mut Decoder<'a>, bool) -> Result<T, Self::Error>,
486 self.read_enum("Option", move |this| {
487 this.read_enum_variant(&["None", "Some"], move |this, idx| {
492 let msg = format!("Invalid Option index: {}", idx);
493 Err(DecodeError::Expected(msg))
500 fn read_seq<T, F>(&mut self, f: F) -> Result<T, Self::Error> where
501 F: FnOnce(&mut Decoder<'a>, usize) -> Result<T, Self::Error>,
503 let len = try!(self.read_uint());
507 fn read_seq_elt<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error> where
508 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
513 fn read_map<T, F>(&mut self, f: F) -> Result<T, Self::Error> where
514 F: FnOnce(&mut Decoder<'a>, usize) -> Result<T, Self::Error>,
516 let len = try!(self.read_uint());
520 fn read_map_elt_key<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error> where
521 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
526 fn read_map_elt_val<T, F>(&mut self, _idx: usize, f: F) -> Result<T, Self::Error> where
527 F: FnOnce(&mut Decoder<'a>) -> Result<T, Self::Error>,
532 fn error(&mut self, err: &str) -> Self::Error {
533 DecodeError::ApplicationError(err.to_string())
540 use serialize::{Encodable, Decodable};
541 use std::io::{Cursor};
543 use super::{Encoder, Decoder};
545 #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
569 fn check_round_trip<T: Encodable+Decodable+PartialEq+Debug>(values: Vec<T>) {
570 let mut cursor = Cursor::new(Vec::new());
572 for value in &values {
573 let mut encoder = Encoder::new(&mut cursor);
574 Encodable::encode(&value, &mut encoder).unwrap();
577 let data = cursor.into_inner();
578 let mut decoder = Decoder::new(&data[..], 0);
580 for value in values {
581 let decoded = Decodable::decode(&mut decoder).unwrap();
582 assert_eq!(value, decoded);
588 check_round_trip(vec![(), (), (), ()]);
593 let mut vec = vec![];
594 for i in ::std::u8::MIN .. ::std::u8::MAX {
597 check_round_trip(vec);
602 for i in ::std::u16::MIN .. ::std::u16::MAX {
603 check_round_trip(vec![1, 2, 3, i, i, i]);
609 check_round_trip(vec![1, 2, 3, ::std::u32::MIN, 0, 1, ::std::u32::MAX, 2, 1]);
614 check_round_trip(vec![1, 2, 3, ::std::u64::MIN, 0, 1, ::std::u64::MAX, 2, 1]);
619 check_round_trip(vec![1, 2, 3, ::std::usize::MIN, 0, 1, ::std::usize::MAX, 2, 1]);
624 let mut vec = vec![];
625 for i in ::std::i8::MIN .. ::std::i8::MAX {
628 check_round_trip(vec);
633 for i in ::std::i16::MIN .. ::std::i16::MAX {
634 check_round_trip(vec![-1, 2, -3, i, i, i, 2]);
640 check_round_trip(vec![-1, 2, -3, ::std::i32::MIN, 0, 1, ::std::i32::MAX, 2, 1]);
645 check_round_trip(vec![-1, 2, -3, ::std::i64::MIN, 0, 1, ::std::i64::MAX, 2, 1]);
650 check_round_trip(vec![-1, 2, -3, ::std::isize::MIN, 0, 1, ::std::isize::MAX, 2, 1]);
655 check_round_trip(vec![false, true, true, false, false]);
660 let mut vec = vec![];
661 for i in -100 .. 100 {
662 vec.push( (i as f32) / 3.0 );
664 check_round_trip(vec);
669 let mut vec = vec![];
670 for i in -100 .. 100 {
671 vec.push( (i as f64) / 3.0 );
673 check_round_trip(vec);
678 let vec = vec!['a', 'b', 'c', 'd', 'A', 'X', ' ', '#', 'Ö', 'Ä', 'µ', '€'];
679 check_round_trip(vec);
685 "abcbuÖeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
686 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
687 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpapmaebn".to_string(),
688 "abcbuÖganeiovÄnameÜavmpßvmeabpnvapeapmaebn".to_string(),
689 "abcbuÖganeiÄnameÜavmpßvmea€µsbpnvapeapmaebn".to_string(),
690 "abcbuÖganeiovÄnameÜavmpßvmea€µsbpmaebn".to_string(),
691 "abcbuÖganeiovÄnameÜavmpßvmea€µnvapeapmaebn".to_string()];
693 check_round_trip(vec);
698 check_round_trip(vec![Some(-1i8)]);
699 check_round_trip(vec![Some(-2i16)]);
700 check_round_trip(vec![Some(-3i32)]);
701 check_round_trip(vec![Some(-4i64)]);
702 check_round_trip(vec![Some(-5isize)]);
704 let none_i8: Option<i8> = None;
705 check_round_trip(vec![none_i8]);
707 let none_i16: Option<i16> = None;
708 check_round_trip(vec![none_i16]);
710 let none_i32: Option<i32> = None;
711 check_round_trip(vec![none_i32]);
713 let none_i64: Option<i64> = None;
714 check_round_trip(vec![none_i64]);
716 let none_isize: Option<isize> = None;
717 check_round_trip(vec![none_isize]);
722 check_round_trip(vec![Struct {
737 m: "abc".to_string(),
744 check_round_trip(vec![Struct {
759 m: "def".to_string(),
767 #[derive(PartialEq, Clone, Debug, RustcEncodable, RustcDecodable)]
770 Variant2(usize, f32),
771 Variant3 { a: i32, b: char, c: bool }
776 check_round_trip(vec![Enum::Variant1,
777 Enum::Variant2(1, 2.5),
778 Enum::Variant3 { a: 3, b: 'b', c: false },
779 Enum::Variant3 { a: -4, b: 'f', c: true }]);
784 let mut vec = vec![];
785 for i in -100i64 .. 100i64 {
789 check_round_trip(vec![vec]);
794 use std::collections::HashMap;
795 let mut map = HashMap::new();
796 for i in -100i64 .. 100i64 {
797 map.insert(i*100000, i*10000);
800 check_round_trip(vec![map]);
805 check_round_trip(vec![('x', (), false, 0.5f32)]);
806 check_round_trip(vec![(9i8, 10u16, 1.5f64)]);
807 check_round_trip(vec![(-12i16, 11u8, 12usize)]);
808 check_round_trip(vec![(1234567isize, 100000000000000u64, 99999999999999i64)]);
809 check_round_trip(vec![(String::new(), "some string".to_string())]);