move load_from to lib.rs

this also makes `util` and `generate` visible to library consumers.

Author: Emilgardis

src/lib.rs

@@ -502,8 +502,8 @@
 use quote::quote;
 use svd_parser::svd;
 
-mod generate;
-mod util;
+pub mod generate;
+pub mod util;
 
 pub use crate::util::{Config, Target};
 
@@ -519,7 +519,8 @@ pub struct DeviceSpecific {
     pub build_rs: String,
 }
 
-use anyhow::Result;
+use anyhow::{Context, Result};
+
 #[derive(Debug, thiserror::Error)]
 pub enum SvdError {
     #[error("Cannot format crate")]
@@ -532,7 +533,7 @@ pub enum SvdError {
 pub fn generate(input: &str, config: &Config) -> Result<Generation> {
     use std::fmt::Write;
 
-    let device = crate::util::load_from(input, config)?;
+    let device = load_from(input, config)?;
     let mut device_x = String::new();
     let items =
         generate::device::render(&device, config, &mut device_x).or(Err(SvdError::Render))?;
@@ -562,6 +563,30 @@ pub fn generate(input: &str, config: &Config) -> Result<Generation> {
     })
 }
 
+/// Load a [Device] from a string slice with given [config](crate::util::Config).
+pub fn load_from(input: &str, config: &crate::util::Config) -> Result<svd::Device> {
+    use self::util::SourceType;
+    use svd_parser::ValidateLevel;
+
+    Ok(match config.source_type {
+        SourceType::Xml => {
+            let mut parser_config = svd_parser::Config::default();
+            parser_config.validate_level = if config.strict {
+                ValidateLevel::Strict
+            } else {
+                ValidateLevel::Weak
+            };
+
+            svd_parser::parse_with_config(input, &parser_config)
+                .with_context(|| "Error parsing SVD XML file".to_string())?
+        }
+        SourceType::Yaml => serde_yaml::from_str(input)
+            .with_context(|| "Error parsing SVD YAML file".to_string())?,
+        SourceType::Json => serde_json::from_str(input)
+            .with_context(|| "Error parsing SVD JSON file".to_string())?,
+    })
+}
+
 /// Assigns a handler to an interrupt
 ///
 /// **NOTE** The `interrupt!` macro on Cortex-M and MSP430 device crates is closer in syntax to the

src/main.rs

@@ -2,10 +2,6 @@
 
 use log::{error, info};
 use std::path::{Path, PathBuf};
-use svd_parser::svd;
-
-mod generate;
-mod util;
 
 use std::fs::File;
 use std::io::Write;
@@ -14,7 +10,10 @@ use std::process;
 use anyhow::{Context, Result};
 use clap::{App, Arg};
 
-use crate::util::{build_rs, load_from, Config, Source, Target};
+use svd2rust::{
+    generate, load_from,
+    util::{build_rs, Config, SourceType, Target},
+};
 
 fn run() -> Result<()> {
     use clap_conf::prelude::*;
@@ -156,11 +155,11 @@ fn run() -> Result<()> {
         .arg("source_type")
         .conf("source_type")
         .done()
-        .and_then(|s| Source::from_str(&s))
+        .and_then(|s| SourceType::from_extension(&s))
         .unwrap_or_default();
 
     if let Some(file) = matches.value_of("input") {
-        source_type = Source::from_path(Path::new(file))
+        source_type = SourceType::from_path(Path::new(file))
     }
 
     let config = Config {

src/util.rs

@@ -1,6 +1,8 @@
 use std::borrow::Cow;
 
-use crate::svd::{Access, Cluster, Device, Field, Register, RegisterCluster, RegisterInfo, RegisterProperties,, ValidateLevel};
+use crate::svd::{
+    Access, Cluster, Field, Register, RegisterCluster, RegisterInfo, RegisterProperties,
+};
 use inflections::Inflect;
 use proc_macro2::{Ident, Literal, Span, TokenStream};
 use quote::{quote, ToTokens};
@@ -14,26 +16,6 @@ pub const BITS_PER_BYTE: u32 = 8;
 /// that are not valid in Rust ident
 const BLACKLIST_CHARS: &[char] = &['(', ')', '[', ']', '/', ' ', '-'];
 
-pub(crate) fn load_from(input: &str, config: &crate::util::Config) -> Result<Device> {
-    Ok(match config.source_type {
-        Source::Xml => {
-            let mut parser_config = svd_parser::Config::default();
-            parser_config.validate_level = if config.strict {
-                ValidateLevel::Strict
-            } else {
-                ValidateLevel::Weak
-            };
-
-            svd_parser::parse_with_config(input, &parser_config)
-                .with_context(|| "Error parsing SVD XML file".to_string())?
-        }
-        Source::Yaml => serde_yaml::from_str(input)
-            .with_context(|| "Error parsing SVD YAML file".to_string())?,
-        Source::Json => serde_json::from_str(input)
-            .with_context(|| "Error parsing SVD JSON file".to_string())?,
-    })
-}
-
 #[derive(Clone, PartialEq, Debug)]
 pub struct Config {
     pub target: Target,
@@ -44,7 +26,7 @@ pub struct Config {
     pub ignore_groups: bool,
     pub strict: bool,
     pub output_dir: PathBuf,
-    pub source_type: Source,
+    pub source_type: SourceType,
 }
 
 impl Default for Config {
@@ -58,7 +40,7 @@ impl Default for Config {
             ignore_groups: false,
             strict: false,
             output_dir: PathBuf::from("."),
-            source_type: Source::default(),
+            source_type: SourceType::default(),
         }
     }
 }
@@ -96,20 +78,21 @@ impl Default for Target {
 }
 
 #[derive(Clone, Copy, PartialEq, Debug)]
-pub enum Source {
+pub enum SourceType {
     Xml,
     Yaml,
     Json,
 }
 
-impl Default for Source {
+impl Default for SourceType {
     fn default() -> Self {
         Self::Xml
     }
 }
 
-impl Source {
-    pub fn from_str(s: &str) -> Option<Self> {
+impl SourceType {
+    /// Make a new [`Source`] from a given extension.
+    pub fn from_extension(s: &str) -> Option<Self> {
         match s {
             "yml" | "yaml" => Some(Self::Yaml),
             "json" => Some(Self::Json),
@@ -120,7 +103,7 @@ impl Source {
     pub fn from_path(path: &Path) -> Self {
         path.extension()
             .and_then(|e| e.to_str())
-            .and_then(Self::from_str)
+            .and_then(Self::from_extension)
             .unwrap_or_default()
     }
 }