Merge #80

80: Serde r=therealprof a=burrbull

Rebased and shortened #76 

Co-authored-by: WRR <-@->
Co-authored-by: Andrey Zgarbul <zgarbul.andrey@gmail.com>

Author: 3 people

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   and added into `Peripheral` and `ClusterInfo`
 - Updated dependencies, use `Edition 2018`
 - Added missing `zeroToToggle`
+- Added serializing/deserializing with `serde`
 
 ## [v0.7.0] - 2019-01-11
 

Cargo.toml

@@ -16,3 +16,15 @@ unproven = []
 either = "1.5"
 xmltree = "0.8"
 failure = "0.1"
+
+[dependencies.serde]
+version = "1.0"
+features = ["derive"]
+optional = true
+
+[dev-dependencies]
+serde_json = "1.0"
+
+[[example]]
+name = "svd2json"
+required-features = ["serde"]

examples/svd2json.rs

@@ -0,0 +1,39 @@
+use serde_json as json;
+use svd_parser as svd;
+
+use json::Value;
+use std::env::args;
+use std::fs::File;
+use std::io::{Read, Write};
+
+fn main() {
+    // Collect command-line arguments.
+    let argv: Vec<String> = args().collect();
+    // Expect exactly one argument, with the name of the SVD file.
+    // (Arg #0 is this program's name, Arg #1 is the actual argument)
+    if argv.len() != 2 {
+        println!("Usage: (svd2json) file.svd");
+        return;
+    }
+    let svd_fn: String = argv[1].clone();
+
+    // Open the XML-formatted SVD file and read it into a String.
+    let svd_xml = &mut String::new();
+    File::open(&svd_fn)
+        .expect("Failed to open SVD input file")
+        .read_to_string(svd_xml)
+        .expect("Failed to read SVD input file to a String");
+
+    // Use the 'svd_parser' crate to parse the file.
+    let device = svd::parse(svd_xml).expect("Failed to parse the SVD file into Rust structs");
+
+    // Convert the parsed data into JSON format.
+    let v: Value = json::to_value(device).expect("Failed to parse Rust structs into JSON format");
+
+    // Write the JSON-formatted device description to a file.
+    let json_fn: String = svd_fn + ".json";
+    File::create(json_fn)
+        .expect("Failed to open JSON output file")
+        .write_all(json::to_string_pretty(&v).unwrap().as_bytes())
+        .expect("Failed to write to JSON output file");
+}

src/svd/access.rs

@@ -8,6 +8,7 @@ use crate::error::*;
 use crate::new_element;
 use crate::types::Parse;
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum Access {
     ReadOnly,

src/svd/addressblock.rs

@@ -12,6 +12,7 @@ use crate::error::SVDError;
 #[cfg(feature = "unproven")]
 use crate::new_element;
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct AddressBlock {
     pub offset: u32,

src/svd/bitrange.rs

@@ -6,13 +6,15 @@ use crate::error::*;
 use crate::new_element;
 use crate::types::Parse;
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub struct BitRange {
     pub offset: u32,
     pub width: u32,
     pub range_type: BitRangeType,
 }
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
 pub enum BitRangeType {
     BitRange,

src/svd/cluster.rs

@@ -13,6 +13,7 @@ use crate::svd::{
     registerclusterarrayinfo::RegisterClusterArrayInfo,
 };
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum Cluster {
     Single(ClusterInfo),

src/svd/clusterinfo.rs

@@ -14,6 +14,7 @@ use crate::svd::{
     registerproperties::RegisterProperties,
 };
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct ClusterInfo {
     pub name: String,

src/svd/cpu.rs

@@ -12,6 +12,7 @@ use crate::new_element;
 use crate::svd::endian::Endian;
 use crate::types::Parse;
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub struct Cpu {
     pub name: String,

src/svd/device.rs

@@ -17,6 +17,7 @@ use crate::svd::{
     peripheral::Peripheral,
 };
 
+#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug)]
 pub struct Device {
     pub name: String,