Merge #131

131: Remove unproven r=burrbull a=brainstorm

Fixes #116

@marcoieni @burrbull Let's do what you suggest on #116, shall we? See the integration [test mostly borrowed from @marcoieni's `svd_parser`](https://github.com/rust-embedded/svd/pull/131/files#diff-eb771f54a1fdc1c330a82981d7d27d1202a5cbe3a59581ff67af5e3361f5f90e)

Getting the following error for now, ~seems like getting the same capitalization (and perhaps ordering?) might be challenging for integration testing purposes~... nope, it's just `<fields />` being empty,  I guess the SVD parser should tolerate that?:

```xml
    <peripheral>
           <name>RNG</name>
           <description>RNG register</description>
           <baseAddress>0x3FF20E44</baseAddress>
           <addressBlock>
                       <offset>0</offset>
                       <size>32</size>
                       <usage>RNG register</usage>
           </addressBlock>
           <registers>
                  <register>
                       <name>rng</name>
                       <fields />
                       <description>RNG register</description>
                       <addressOffset>0</addressOffset>
                       <size>32</size>
                       <access>read-only</access>
                      <resetValue>0</resetValue>
                   </register>
        </registers>
     </peripheral>
```

```rust
---- read_and_write stdout ----
thread 'read_and_write' panicked at 'Failed to parse the SVD file into Rust structs: In device `esp8266`

Caused by:
    0: In peripheral `RNG`
    1: In register `rng`
    2: Register have `fields` tag, but it is empty', tests/integration.rs:14:38
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
```

Co-authored-by: Roman Valls Guimera <[email protected]>

Author: bors[bot]

.gitignore

@@ -2,4 +2,3 @@
 [._]*.sw[a-p]
 Cargo.lock
 target
-tests/

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Fix: produce error on 0-width fields
 - Fix: error instead of panic when an array/cluster name is missing the `%s` placeholder
 - [breaking-change] Add support for 64 addresses, register values, enum values and writeConstraints
+- [breaking-change] Remove unproven flag
 
 ## [v0.9.0] - 2019-11-17
 

Cargo.toml

@@ -15,14 +15,13 @@ readme = "README.md"
 
 [features]
 derive-from = []
-unproven = []
 
 [dependencies]
 xmltree = "0.8"
 anyhow = "1.0.19"
 thiserror = "1.0.5"
-rayon = "1.3.0"
-once_cell = "1.3.1"
+rayon = "1.5.0"
+once_cell = "1.5.2"
 regex = "1"
 
 [dependencies.serde]

cmsis-svd

@@ -24,9 +24,7 @@
 
 #![deny(warnings)]
 
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
-
 use xmltree::Element;
 
 // ElementExt extends XML elements with useful methods
@@ -41,9 +39,7 @@ use anyhow::Result;
 pub mod parse;
 use parse::Parse;
 // Encode defines encoding interfaces
-#[cfg(feature = "unproven")]
 pub mod encode;
-#[cfg(feature = "unproven")]
 use encode::Encode;
 // Types defines simple types and parse/encode implementations
 pub mod types;
@@ -61,7 +57,6 @@ pub fn parse(xml: &str) -> Result<Device> {
 }
 
 /// Encodes a device object to an SVD (XML) string
-#[cfg(feature = "unproven")]
 pub fn encode(d: &Device) -> Result<String> {
     let root = d.encode()?;
     let mut wr = Vec::new();
@@ -79,7 +74,6 @@ fn trim_utf8_bom(s: &str) -> &str {
 }
 
 /// Helper to create new base xml elements
-#[cfg(feature = "unproven")]
 pub(crate) fn new_element(name: &str, text: Option<String>) -> Element {
     Element {
         prefix: None,
@@ -96,7 +90,6 @@ pub(crate) fn new_element(name: &str, text: Option<String>) -> Element {
 /// Takes an array of (item, xml) pairs where the item implements
 /// Parse and Encode and tests object encoding and decoding
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 pub fn run_test<
     T: Parse<Error = anyhow::Error, Object = T>
         + Encode<Error = anyhow::Error>

src/lib.rs

@@ -1,10 +1,8 @@
 use xmltree::Element;
 
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-#[cfg(feature = "unproven")]
 use crate::new_element;
 use crate::types::Parse;
 
@@ -36,7 +34,6 @@ impl Parse for Access {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for Access {
     type Error = anyhow::Error;
 
@@ -54,7 +51,6 @@ impl Encode for Access {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/access.rs

@@ -1,15 +1,12 @@
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use crate::elementext::ElementExt;
 use xmltree::Element;
 
 use crate::types::Parse;
 
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-#[cfg(feature = "unproven")]
 use crate::new_element;
 
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
@@ -33,7 +30,6 @@ impl Parse for AddressBlock {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for AddressBlock {
     type Error = anyhow::Error;
 
@@ -55,7 +51,6 @@ impl Encode for AddressBlock {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/addressblock.rs

@@ -1,7 +1,6 @@
 use xmltree::Element;
 
 use crate::error::*;
-#[cfg(feature = "unproven")]
 use crate::new_element;
 use crate::types::Parse;
 
@@ -120,7 +119,7 @@ impl Parse for BitRange {
         })
     }
 }
-#[cfg(feature = "unproven")]
+
 impl BitRange {
     // TODO: Encode method differs from Encode trait as it acts on a set of possible children, create an interface or decide how to better do this
     pub fn encode(&self) -> Result<Vec<Element>> {
@@ -142,7 +141,6 @@ impl BitRange {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
 

src/svd/bitrange.rs

@@ -3,9 +3,7 @@ use xmltree::Element;
 
 use crate::types::Parse;
 
-#[cfg(feature = "unproven")]
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
 use crate::svd::{clusterinfo::ClusterInfo, dimelement::DimElement};
@@ -55,7 +53,6 @@ impl Parse for Cluster {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for Cluster {
     type Error = anyhow::Error;
 

src/svd/cluster.rs

@@ -3,9 +3,7 @@ use xmltree::Element;
 
 use crate::types::Parse;
 
-#[cfg(feature = "unproven")]
 use crate::encode::{Encode, EncodeChildren};
-#[cfg(feature = "unproven")]
 use crate::new_element;
 
 use crate::error::*;
@@ -153,7 +151,6 @@ impl ClusterInfo {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for ClusterInfo {
     type Error = anyhow::Error;
 

src/svd/clusterinfo.rs

@@ -1,13 +1,11 @@
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
 
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-#[cfg(feature = "unproven")]
+
 use crate::new_element;
 use crate::svd::endian::Endian;
 use crate::types::Parse;
@@ -137,7 +135,6 @@ impl Parse for Cpu {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for Cpu {
     type Error = anyhow::Error;
 
@@ -172,7 +169,6 @@ impl Cpu {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/cpu.rs

@@ -1,5 +1,4 @@
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 use xmltree::Element;
 
@@ -8,10 +7,9 @@ use rayon::prelude::*;
 use crate::parse;
 use crate::types::Parse;
 
-#[cfg(feature = "unproven")]
 use crate::encode::{Encode, EncodeChildren};
 use crate::error::*;
-#[cfg(feature = "unproven")]
+
 use crate::new_element;
 use crate::svd::{cpu::Cpu, peripheral::Peripheral, registerproperties::RegisterProperties};
 
@@ -180,7 +178,6 @@ impl Device {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for Device {
     type Error = anyhow::Error;
 

src/svd/device.rs

@@ -3,9 +3,7 @@ use xmltree::Element;
 use crate::types::{parse_optional, DimIndex, Parse};
 
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
-#[cfg(feature = "unproven")]
 use crate::new_element;
 
 use crate::error::*;
@@ -77,7 +75,6 @@ impl Parse for DimElement {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for DimElement {
     type Error = anyhow::Error;
 
@@ -100,7 +97,6 @@ impl Encode for DimElement {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/dimelement.rs

@@ -1,10 +1,8 @@
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use xmltree::Element;
 
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::types::Parse;
 
@@ -36,7 +34,6 @@ impl Parse for Endian {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for Endian {
     type Error = anyhow::Error;
 
@@ -61,7 +58,6 @@ impl Encode for Endian {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/endian.rs

@@ -1,14 +1,11 @@
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use crate::elementext::ElementExt;
 use crate::parse;
 use xmltree::Element;
 
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-#[cfg(feature = "unproven")]
 use crate::new_element;
 use crate::types::Parse;
 
@@ -130,7 +127,6 @@ impl Parse for EnumeratedValue {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for EnumeratedValue {
     type Error = anyhow::Error;
 
@@ -165,7 +161,6 @@ impl Encode for EnumeratedValue {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::run_test;

src/svd/enumeratedvalue.rs

@@ -1,13 +1,11 @@
-#[cfg(feature = "unproven")]
 use std::collections::HashMap;
 
 use crate::elementext::ElementExt;
 use xmltree::Element;
 
-#[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-#[cfg(feature = "unproven")]
+
 use crate::new_element;
 use crate::parse;
 use crate::svd::{enumeratedvalue::EnumeratedValue, usage::Usage};
@@ -143,7 +141,6 @@ impl Parse for EnumeratedValues {
     }
 }
 
-#[cfg(feature = "unproven")]
 impl Encode for EnumeratedValues {
     type Error = anyhow::Error;
 
@@ -180,7 +177,6 @@ impl Encode for EnumeratedValues {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::svd::enumeratedvalue::EnumeratedValueBuilder;

src/svd/enumeratedvalues.rs

@@ -4,9 +4,8 @@ use xmltree::Element;
 
 use crate::types::Parse;
 
-#[cfg(feature = "unproven")]
 use crate::elementext::ElementExt;
-#[cfg(feature = "unproven")]
+
 use crate::encode::Encode;
 use crate::error::*;
 use crate::svd::{dimelement::DimElement, fieldinfo::FieldInfo};
@@ -51,7 +50,7 @@ impl Parse for Field {
     }
 }
 
-#[cfg(feature = "unproven")]
+
 impl Encode for Field {
     type Error = anyhow::Error;
 
@@ -69,7 +68,6 @@ impl Encode for Field {
 }
 
 #[cfg(test)]
-#[cfg(feature = "unproven")]
 mod tests {
     use super::*;
     use crate::bitrange::{BitRange, BitRangeType};