A bit of prep for binary plist support

4 files changed, 313 insertions, 243 deletions

diff --git a/src/lib.rs b/src/lib.rs
index 9641d6b..a8d189a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,11 +1,10 @@
 extern crate rustc_serialize;
-extern crate xml;
+extern crate xml as xml_rs;
 
-mod reader;
-
-pub use reader::{Parser, StreamingParser, PlistEvent};
+pub mod xml;
 
 use std::collections::HashMap;
+use std::io::Read;
 
 #[derive(Clone, Debug, PartialEq)]
 pub enum Plist {
@@ -19,3 +18,176 @@ pub enum Plist {
 	String(String)
 }
 
+#[derive(Clone, Debug, PartialEq)]
+pub enum PlistEvent {
+	StartArray,
+	EndArray,
+
+	StartDictionary,
+	EndDictionary,
+	DictionaryKey(String),
+
+	BooleanValue(bool),
+	DataValue(Vec<u8>),
+	DateValue(String),
+	IntegerValue(i64),
+	RealValue(f64),
+	StringValue(String),
+
+	Error(())
+}
+
+
+pub enum StreamingParser<R: Read> {
+	Xml(xml::StreamingParser<R>)
+}
+
+impl<R:Read> StreamingParser<R> {
+	pub fn new() -> StreamingParser<R> {
+		panic!()
+	}
+}
+
+impl<R:Read> Iterator for StreamingParser<R> {
+	type Item = PlistEvent;
+
+	fn next(&mut self) -> Option<PlistEvent> {
+		match *self {
+			StreamingParser::Xml(ref mut parser) => parser.next()
+		}
+	}
+}
+
+pub struct Parser<T> {
+	reader: T,
+	token: Option<PlistEvent>,
+}
+
+impl<R:Read> Parser<StreamingParser<R>> {
+	pub fn new(reader: R) -> Parser<StreamingParser<R>> {
+		Parser::from_event_stream(StreamingParser::Xml(xml::StreamingParser::new(reader)))
+	}
+}
+
+impl<T:Iterator<Item=PlistEvent>> Parser<T> {
+	pub fn from_event_stream(stream: T) -> Parser<T> {
+		Parser {
+			reader: stream,
+			token: None
+		}
+	}
+
+	pub fn parse(mut self) -> Result<Plist, ()> {
+		self.bump();
+		let plist = try!(self.build_value());
+		self.bump();
+		match self.token {
+			None => (),
+			_ => return Err(())
+		};
+		Ok(plist)
+	}
+
+	fn bump(&mut self) {
+		self.token = self.reader.next();
+	}
+
+	fn build_value(&mut self) -> Result<Plist, ()> {
+		match self.token.take() {
+			Some(PlistEvent::StartArray) => Ok(Plist::Array(try!(self.build_array()))),
+			Some(PlistEvent::StartDictionary) => Ok(Plist::Dictionary(try!(self.build_dict()))),
+
+			Some(PlistEvent::BooleanValue(b)) => Ok(Plist::Boolean(b)),
+			Some(PlistEvent::DataValue(d)) => Ok(Plist::Data(d)),
+			Some(PlistEvent::DateValue(d)) => Ok(Plist::Date(d)),
+			Some(PlistEvent::IntegerValue(i)) => Ok(Plist::Integer(i)),
+			Some(PlistEvent::RealValue(f)) => Ok(Plist::Real(f)),
+			Some(PlistEvent::StringValue(s)) => Ok(Plist::String(s)),
+
+			Some(PlistEvent::EndArray) => Err(()),
+			Some(PlistEvent::EndDictionary) => Err(()),
+			Some(PlistEvent::DictionaryKey(_)) => Err(()),
+			Some(PlistEvent::Error(_)) => Err(()),
+			None => Err(())
+		}
+	}
+
+	fn build_array(&mut self) -> Result<Vec<Plist>, ()> {	
+		let mut values = Vec::new();
+
+		loop {
+			self.bump();
+			if let Some(PlistEvent::EndArray) = self.token {
+				self.token.take();
+				return Ok(values);
+			}
+			values.push(try!(self.build_value()));
+		}
+	}
+
+	fn build_dict(&mut self) -> Result<HashMap<String, Plist>, ()> {
+		let mut values = HashMap::new();
+
+		loop {
+			
+			self.bump();
+			match self.token.take() {
+				Some(PlistEvent::EndDictionary) => return Ok(values),
+				Some(PlistEvent::DictionaryKey(s)) => {
+					self.bump();
+					values.insert(s, try!(self.build_value()));
+				},
+				_ => {
+					return Err(())
+				}
+			}
+		}
+	}
+}
+
+#[cfg(test)]
+mod tests {
+	use std::collections::HashMap;
+
+	use super::*;
+
+	#[test]
+	fn parser() {
+		use super::PlistEvent::*;
+
+		// Input
+
+		let events = &[
+			StartDictionary,
+			DictionaryKey("Author".to_owned()),
+			StringValue("William Shakespeare".to_owned()),
+			DictionaryKey("Lines".to_owned()),
+			StartArray,
+			StringValue("It is a tale told by an idiot,".to_owned()),
+			StringValue("Full of sound and fury, signifying nothing.".to_owned()),
+			EndArray,
+			DictionaryKey("Birthdate".to_owned()),
+			IntegerValue(1564),
+			DictionaryKey("Height".to_owned()),
+			RealValue(1.60),
+			EndDictionary
+		];
+
+		let parser = Parser::from_event_stream(events.into_iter().cloned());
+		let plist = parser.parse();
+
+		// Expected output
+
+		let mut lines = Vec::new();
+		lines.push(Plist::String("It is a tale told by an idiot,".to_owned()));
+		lines.push(Plist::String("Full of sound and fury, signifying nothing.".to_owned()));
+
+		let mut dict = HashMap::new();
+		dict.insert("Author".to_owned(), Plist::String("William Shakespeare".to_owned()));
+		dict.insert("Lines".to_owned(), Plist::Array(lines));
+		dict.insert("Birthdate".to_owned(), Plist::Integer(1564));
+		dict.insert("Height".to_owned(), Plist::Real(1.60));
+
+		assert_eq!(plist, Ok(Plist::Dictionary(dict)));
+	}
+}
\ No newline at end of file
diff --git a/src/reader.rs b/src/reader.rs
deleted file mode 100644
index 6055b74..0000000
--- a/src/reader.rs
+++ /dev/null
@@ -1,239 +0,0 @@
-use rustc_serialize::base64::FromBase64;
-use std::collections::HashMap;
-use std::io::Read;
-use std::str::FromStr;
-use xml::reader::{EventReader, ParserConfig};
-use xml::reader::events::XmlEvent;
-
-use super::Plist;
-
-#[derive(Clone, Debug, PartialEq)]
-pub enum PlistEvent {
-	StartArray,
-	EndArray,
-
-	StartDictionary,
-	EndDictionary,
-	DictionaryKey(String),
-
-	BooleanValue(bool),
-	DataValue(Vec<u8>),
-	DateValue(String),
-	IntegerValue(i64),
-	RealValue(f64),
-	StringValue(String),
-
-	Error(())
-}
-
-pub struct StreamingParser<R: Read> {
-	xml_reader: EventReader<R>
-}
-
-impl<R: Read> StreamingParser<R> {
-	pub fn new(reader: R) -> StreamingParser<R> {
-		let config = ParserConfig {
-			trim_whitespace: false,
-			whitespace_to_characters: true,
-			cdata_to_characters: true,
-			ignore_comments: true,
-			coalesce_characters: true,
-		};
-
-		StreamingParser {
-			xml_reader: EventReader::with_config(reader, config)
-		}
-	}
-
-	fn read_string<F>(&mut self, f: F) -> PlistEvent where F:FnOnce(String) -> PlistEvent {
-		match self.xml_reader.next() {
-			XmlEvent::Characters(s) => f(s),
-			_ => PlistEvent::Error(())
-		}
-	}
-}
-
-impl<R: Read> Iterator for StreamingParser<R> {
-	type Item = PlistEvent;
-
-	fn next(&mut self) -> Option<PlistEvent> {
-		loop {
-			let first_event = self.xml_reader.next();
-			match first_event {
-				XmlEvent::StartElement { name, .. } => match &name.local_name[..] {
-					"plist" => (),
-					"array" => return Some(PlistEvent::StartArray),
-					"dict" => return Some(PlistEvent::StartDictionary),
-					"key" => return Some(self.read_string(|s| PlistEvent::DictionaryKey(s))),
-					"true" => return Some(PlistEvent::BooleanValue(true)),
-					"false" => return Some(PlistEvent::BooleanValue(false)),
-					"data" => return Some(self.read_string(|s| {
-						match FromBase64::from_base64(&s[..]) {
-							Ok(b) => PlistEvent::DataValue(b),
-							Err(_) => PlistEvent::Error(())
-						}
-					})),
-					"date" => return Some(self.read_string(|s| PlistEvent::DateValue(s))),
-					"integer" => return Some(self.read_string(|s| {
-						match FromStr::from_str(&s)	{
-							Ok(i) => PlistEvent::IntegerValue(i),
-							Err(_) => PlistEvent::Error(())
-						}
-					})),
-					"real" => return Some(self.read_string(|s| {
-						match FromStr::from_str(&s)	{
-							Ok(f) => PlistEvent::RealValue(f),
-							Err(_) => PlistEvent::Error(())
-						}
-					})),
-					"string" => return Some(self.read_string(|s| PlistEvent::StringValue(s))),
-					_ => return Some(PlistEvent::Error(()))
-				},
-				XmlEvent::EndElement { name, .. } => match &name.local_name[..] {
-					"array" => return Some(PlistEvent::EndArray),
-					"dict" => return Some(PlistEvent::EndDictionary),
-					_ => ()
-				},
-				XmlEvent::EndDocument => return None,
-				_ => ()
-			}
-		}
-	}
-}
-
-pub struct Parser<R: Read> {
-	reader: StreamingParser<R>,
-	token: Option<PlistEvent>,
-}
-
-impl<R: Read> Parser<R> {
-	pub fn new(reader: R) -> Parser<R> {
-		Parser {
-			reader: StreamingParser::new(reader),
-			token: None
-		}
-	}
-
-	pub fn parse(mut self) -> Result<Plist, ()> {
-		self.bump();
-		let plist = try!(self.build_value());
-		self.bump();
-		match self.token {
-			None => (),
-			_ => return Err(())
-		};
-		Ok(plist)
-	}
-
-	fn bump(&mut self) {
-		self.token = self.reader.next();
-	}
-
-	fn build_value(&mut self) -> Result<Plist, ()> {
-		match self.token.take() {
-			Some(PlistEvent::StartArray) => Ok(Plist::Array(try!(self.build_array()))),
-			Some(PlistEvent::StartDictionary) => Ok(Plist::Dictionary(try!(self.build_dict()))),
-
-			Some(PlistEvent::BooleanValue(b)) => Ok(Plist::Boolean(b)),
-			Some(PlistEvent::DataValue(d)) => Ok(Plist::Data(d)),
-			Some(PlistEvent::DateValue(d)) => Ok(Plist::Date(d)),
-			Some(PlistEvent::IntegerValue(i)) => Ok(Plist::Integer(i)),
-			Some(PlistEvent::RealValue(f)) => Ok(Plist::Real(f)),
-			Some(PlistEvent::StringValue(s)) => Ok(Plist::String(s)),
-
-			Some(PlistEvent::EndArray) => Err(()),
-			Some(PlistEvent::EndDictionary) => Err(()),
-			Some(PlistEvent::DictionaryKey(_)) => Err(()),
-			Some(PlistEvent::Error(_)) => Err(()),
-			None => Err(())
-		}
-	}
-
-	fn build_array(&mut self) -> Result<Vec<Plist>, ()> {	
-		let mut values = Vec::new();
-
-		loop {
-			self.bump();
-			if let Some(PlistEvent::EndArray) = self.token {
-				self.token.take();
-				return Ok(values);
-			}
-			values.push(try!(self.build_value()));
-		}
-	}
-
-	fn build_dict(&mut self) -> Result<HashMap<String, Plist>, ()> {
-		let mut values = HashMap::new();
-
-		loop {
-			
-			self.bump();
-			match self.token.take() {
-				Some(PlistEvent::EndDictionary) => return Ok(values),
-				Some(PlistEvent::DictionaryKey(s)) => {
-					self.bump();
-					values.insert(s, try!(self.build_value()));
-				},
-				_ => {
-					return Err(())
-				}
-			}
-		}
-	}
-}
-
-#[cfg(test)]
-mod tests {
-	use std::fs::File;
-	use std::collections::HashMap;
-	use std::path::Path;
-
-	use reader::*;
-	use super::super::Plist;
-
-	#[test]
-	fn streaming_parser() {
-		use reader::PlistEvent::*;
-
-		let reader = File::open(&Path::new("./tests/data/simple.plist")).unwrap();
-		let streaming_parser = StreamingParser::new(reader);
-		let events: Vec<PlistEvent> = streaming_parser.collect();
-
-		let comparison = &[
-			StartDictionary,
-			DictionaryKey("Author".to_owned()),
-			StringValue("William Shakespeare".to_owned()),
-			DictionaryKey("Lines".to_owned()),
-			StartArray,
-			StringValue("It is a tale told by an idiot,".to_owned()),
-			StringValue("Full of sound and fury, signifying nothing.".to_owned()),
-			EndArray,
-			DictionaryKey("Birthdate".to_owned()),
-			IntegerValue(1564),
-			DictionaryKey("Height".to_owned()),
-			RealValue(1.60),
-			EndDictionary
-		];
-
-		assert_eq!(events, comparison);
-	}
-
-	#[test]
-	fn parser() {
-		let reader = File::open(&Path::new("./tests/data/simple.plist")).unwrap();
-		let parser = Parser::new(reader);
-		let plist = parser.parse();
-
-		let mut lines = Vec::new();
-		lines.push(Plist::String("It is a tale told by an idiot,".to_owned()));
-		lines.push(Plist::String("Full of sound and fury, signifying nothing.".to_owned()));
-
-		let mut dict = HashMap::new();
-		dict.insert("Author".to_owned(), Plist::String("William Shakespeare".to_owned()));
-		dict.insert("Lines".to_owned(), Plist::Array(lines));
-		dict.insert("Birthdate".to_owned(), Plist::Integer(1564));
-		dict.insert("Height".to_owned(), Plist::Real(1.60));
-
-		assert_eq!(plist, Ok(Plist::Dictionary(dict)));
-	}
-}
\ No newline at end of file
diff --git a/src/xml.rs b/src/xml.rs
new file mode 100644
index 0000000..3c5105d
--- /dev/null
+++ b/src/xml.rs
@@ -0,0 +1,135 @@
+use rustc_serialize::base64::FromBase64;
+use std::io::Read;
+use std::str::FromStr;
+use xml_rs::reader::{EventReader, ParserConfig};
+use xml_rs::reader::events::XmlEvent;
+
+use super::PlistEvent;
+
+pub struct StreamingParser<R: Read> {
+	xml_reader: EventReader<R>,
+	element_stack: Vec<String>
+}
+
+impl<R: Read> StreamingParser<R> {
+	pub fn new(reader: R) -> StreamingParser<R> {
+		let config = ParserConfig {
+			trim_whitespace: false,
+			whitespace_to_characters: true,
+			cdata_to_characters: true,
+			ignore_comments: true,
+			coalesce_characters: true,
+		};
+
+		StreamingParser {
+			xml_reader: EventReader::with_config(reader, config),
+			element_stack: Vec::new()
+		}
+	}
+
+	fn read_content<F>(&mut self, f: F) -> PlistEvent where F:FnOnce(String) -> PlistEvent {
+		match self.xml_reader.next() {
+			XmlEvent::Characters(s) => f(s),
+			_ => PlistEvent::Error(())
+		}
+	}
+}
+
+impl<R: Read> Iterator for StreamingParser<R> {
+	type Item = PlistEvent;
+
+	fn next(&mut self) -> Option<PlistEvent> {
+		loop {
+			match self.xml_reader.next() {
+				XmlEvent::StartElement { name, .. } => {
+					// Add the current element to the element stack
+					self.element_stack.push(name.local_name.clone());
+					
+					match &name.local_name[..] {
+						"plist" => (),
+						"array" => return Some(PlistEvent::StartArray),
+						"dict" => return Some(PlistEvent::StartDictionary),
+						"key" => return Some(self.read_content(|s| PlistEvent::DictionaryKey(s))),
+						"true" => return Some(PlistEvent::BooleanValue(true)),
+						"false" => return Some(PlistEvent::BooleanValue(false)),
+						"data" => return Some(self.read_content(|s| {
+							match FromBase64::from_base64(&s[..]) {
+								Ok(b) => PlistEvent::DataValue(b),
+								Err(_) => PlistEvent::Error(())
+							}
+						})),
+						"date" => return Some(self.read_content(|s| PlistEvent::DateValue(s))),
+						"integer" => return Some(self.read_content(|s| {
+							match FromStr::from_str(&s)	{
+								Ok(i) => PlistEvent::IntegerValue(i),
+								Err(_) => PlistEvent::Error(())
+							}
+						})),
+						"real" => return Some(self.read_content(|s| {
+							match FromStr::from_str(&s)	{
+								Ok(f) => PlistEvent::RealValue(f),
+								Err(_) => PlistEvent::Error(())
+							}
+						})),
+						"string" => return Some(self.read_content(|s| PlistEvent::StringValue(s))),
+						_ => return Some(PlistEvent::Error(()))
+					}
+				},
+				XmlEvent::EndElement { name, .. } => {
+					// Check the corrent element is being closed
+					match self.element_stack.pop() {
+						Some(ref open_name) if &name.local_name == open_name => (),
+						Some(ref open_name) => return Some(PlistEvent::Error(())),
+						None => return Some(PlistEvent::Error(()))
+					}
+
+					match &name.local_name[..] {
+						"array" => return Some(PlistEvent::EndArray),
+						"dict" => return Some(PlistEvent::EndDictionary),
+						_ => ()
+					}
+				},
+				XmlEvent::EndDocument => return None,
+				_ => ()
+			}
+		}
+	}
+}
+
+#[cfg(test)]
+mod tests {
+	use std::fs::File;
+	use std::path::Path;
+
+	use super::*;
+	use super::super::PlistEvent;
+
+	#[test]
+	fn streaming_parser() {
+		use super::super::PlistEvent::*;
+
+		let reader = File::open(&Path::new("./tests/data/xml.plist")).unwrap();
+		let streaming_parser = StreamingParser::new(reader);
+		let events: Vec<PlistEvent> = streaming_parser.collect();
+
+		let comparison = &[
+			StartDictionary,
+			DictionaryKey("Author".to_owned()),
+			StringValue("William Shakespeare".to_owned()),
+			DictionaryKey("Lines".to_owned()),
+			StartArray,
+			StringValue("It is a tale told by an idiot,".to_owned()),
+			StringValue("Full of sound and fury, signifying nothing.".to_owned()),
+			EndArray,
+			DictionaryKey("Birthdate".to_owned()),
+			IntegerValue(1564),
+			DictionaryKey("Height".to_owned()),
+			RealValue(1.60),
+			DictionaryKey("Data".to_owned()),
+			DataValue(vec![0, 0, 0, 190, 0, 0, 0, 3, 0, 0, 0, 30, 0, 0, 0]),
+			EndDictionary
+		];
+
+		assert_eq!(events, comparison);
+	}
+}
\ No newline at end of file
diff --git a/tests/data/simple.plist b/tests/data/xml.plist
index 7fb0208..d2599f2 100644
--- a/tests/data/simple.plist
+++ b/tests/data/xml.plist
@@ -13,5 +13,7 @@
     <integer>1564</integer>
     <key>Height</key>
     <real>1.60</real>
+    <key>Data</key>
+    <data>AAAAvgAAAAMAAAAeAAAA</data>
 </dict>
 </plist>
\ No newline at end of file