Merge #237

237: Introduce a logging system. r=ryankurte a=achan1989

This pull request makes progress on #183.

I've replaced the existing print/eprint calls with the appropriate logging macros, and arbitrarily chose env_logger to handle the logging.

This should be functionally identical to the branch point, although the format of the logging output is different -- it's now of the form `<SEVERITY> svd2rust: <message>`.

Co-authored-by: achan1989 <achan1989@gmail.com>

Author: bors[bot]

Cargo.toml

@@ -31,8 +31,10 @@ path = "src/main.rs"
 cast = "0.2.2"
 clap = "2.26.0"
 either = "1.0.3"
+env_logger = "~0.5"
 error-chain = "0.11.0"
 inflections = "1.1.0"
+log = { version = "~0.4", features = ["std"] }
 quote = "0.3.15"
 svd-parser = "0.6"
 syn = "0.11.11"

src/generate/peripheral.rs

@@ -5,6 +5,7 @@ use either::Either;
 use quote::{ToTokens, Tokens};
 use crate::svd::{Cluster, ClusterInfo, Defaults, Peripheral, Register};
 use syn::{self, Ident};
+use log::warn;
 
 use crate::errors::*;
 use crate::util::{self, ToSanitizedSnakeCase, ToSanitizedUpperCase, BITS_PER_BYTE};
@@ -341,8 +342,8 @@ impl FieldRegions {
                 r.fields.len() > 1 && (idents.iter().filter(|ident| **ident == r.ident).count() > 1)
             })
             .inspect(|r| {
-                eprintln!(
-                    "WARNING: Found type name conflict with region {:?}, renamed to {:?}",
+                warn!(
+                    "Found type name conflict with region {:?}, renamed to {:?}",
                     r.ident,
                     r.shortest_ident()
                 )
@@ -384,8 +385,8 @@ fn register_or_cluster_block_stable(
         let pad = if let Some(pad) = reg_block_field.offset.checked_sub(offset) {
             pad
         } else {
-            eprintln!(
-                "WARNING {:?} overlaps with another register block at offset {}. \
+            warn!(
+                "{:?} overlaps with another register block at offset {}. \
                  Ignoring.",
                 reg_block_field.field.ident, reg_block_field.offset
             );
@@ -473,8 +474,8 @@ fn register_or_cluster_block_nightly(
             if reg_block_field.offset != region.offset {
                 // TODO: need to emit padding for this case.
                 // Happens for freescale_mkl43z4
-                eprintln!(
-                    "WARNING: field {:?} has different offset {} than its union container {}",
+                warn!(
+                    "field {:?} has different offset {} than its union container {}",
                     reg_block_field.field.ident, reg_block_field.offset, region.offset
                 );
             }

src/main.rs

@@ -3,10 +3,13 @@
 extern crate cast;
 extern crate clap;
 extern crate either;
+extern crate env_logger;
 #[macro_use]
 extern crate error_chain;
 extern crate inflections;
 #[macro_use]
+extern crate log;
+#[macro_use]
 extern crate quote;
 extern crate svd_parser as svd;
 extern crate syn;
@@ -48,12 +51,25 @@ fn run() -> Result<()> {
                 .long("nightly")
                 .help("Enable features only available to nightly rustc"),
         )
+        .arg(
+            Arg::with_name("log_level")
+                .long("log")
+                .short("l")
+                .help(&format!(
+                    "Choose which messages to log (overrides {})",
+                    env_logger::DEFAULT_FILTER_ENV
+                ))
+                .takes_value(true)
+                .possible_values(&["off", "error", "warn", "info", "debug", "trace"])
+        )
         .version(concat!(
             env!("CARGO_PKG_VERSION"),
             include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"))
         ))
         .get_matches();
 
+    setup_logging(&matches);
+
     let target = matches
         .value_of("target")
         .map(|s| Target::parse(s))
@@ -93,21 +109,46 @@ fn run() -> Result<()> {
     Ok(())
 }
 
+fn setup_logging(matches: &clap::ArgMatches) {
+    // * Log at info by default.
+    // * Allow users the option of setting complex logging filters using
+    //   env_logger's `RUST_LOG` environment variable.
+    // * Override both of those if the logging level is set via the `--log`
+    //   command line argument.
+    let env = env_logger::Env::default()
+        .filter_or(env_logger::DEFAULT_FILTER_ENV, "info");
+    let mut builder = env_logger::Builder::from_env(env);
+    builder.default_format_timestamp(false);
+
+    let log_lvl_from_env =
+        std::env::var_os(env_logger::DEFAULT_FILTER_ENV).is_some();
+
+    if log_lvl_from_env {
+        log::set_max_level(log::LevelFilter::Trace);
+    } else {
+        let level = match matches.value_of("log_level") {
+            Some(lvl) => lvl.parse().unwrap(),
+            None => log::LevelFilter::Info,
+        };
+        log::set_max_level(level);
+        builder.filter_level(level);
+    }
+
+    builder.init();
+}
+
 fn main() {
     if let Err(ref e) = run() {
-        let stderr = io::stderr();
-        let mut stderr = stderr.lock();
-
-        writeln!(stderr, "error: {}", e).ok();
+        error!("{}", e);
 
         for e in e.iter().skip(1) {
-            writeln!(stderr, "caused by: {}", e).ok();
+            error!("caused by: {}", e);
         }
 
         if let Some(backtrace) = e.backtrace() {
-            writeln!(stderr, "backtrace: {:?}", backtrace).ok();
+            error!("backtrace: {:?}", backtrace);
         } else {
-            writeln!(stderr, "note: run with `RUST_BACKTRACE=1` for a backtrace").ok();
+            error!("note: run with `RUST_BACKTRACE=1` for a backtrace")
         }
 
         process::exit(1);