rustfmt; +exports; -dep; bump

- format code with rustfmt
- add some additionaly type exports
- remove unneeded dependency
- bump version

Author: joseluis

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "sofiza"
 description = "SFZ format parser"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2018"
 authors = ["José Luis Cruz <joseluis@andamira.net>"]
 repository = "https://github.com/andamira/sofiza"
@@ -21,7 +21,6 @@ logos = "0.11.4"
 regex = "1"
 
 shellexpand = "1.1.1"
-path-slash = "0.1.3"
 
 phf = { version = "0.8", features = ["macros"] }
 

src/lib.rs

@@ -1,12 +1,10 @@
 pub mod sfz;
 
 pub use sfz::{
+    group::Group,
+    headers::Header,
     instrument::Instrument,
-
-    // headers::Header,
-    // group::Group,
-    // region::Region,
     opcodes::Opcode,
-    //
-    // types::{loop_mode, trigger, fil_type, UndefinedInteger, UndefinedUnsignedInteger, UnknownType},
+    region::Region,
+    types::{fil_type, loop_mode, trigger},
 };

src/sfz/group.rs

@@ -3,15 +3,14 @@ use std::fmt::Debug;
 
 use crate::sfz::{Opcode, OpcodeMap};
 
-
 /// Groups allow entering common parameters for multiple regions.
 ///
 /// A group is defined with the <group> opcode, and the parameters enumerated
 /// on it last till the next group opcode, or till the end of the file.
 ///
 #[derive(Debug)]
 pub struct Group {
-    opcodes: OpcodeMap,  // these opcodes overwrites the defaults, and the inherited
+    opcodes: OpcodeMap, // these opcodes overwrites the defaults, and the inherited
     label: String,
 }
 
@@ -27,4 +26,3 @@ impl Group {
         self.opcodes.insert(o.str_name(), o.clone());
     }
 }
-

src/sfz/headers.rs

@@ -2,7 +2,6 @@ use logos::Lexer;
 
 use crate::sfz::SfzToken;
 
-
 /// SFZ files are subdivided into sections by headers.
 ///
 /// The global/group/region or global/master/group/region hierarchy contains the opcodes
@@ -12,9 +11,7 @@ use crate::sfz::SfzToken;
 
 #[derive(Debug, PartialEq)]
 pub enum Header {
-
     // sfz v1 headers
-
     /// The basic component of an instrument. An instrument is defined by one or more regions.
     ///
     /// - version: v1
@@ -28,7 +25,6 @@ pub enum Header {
     Group,
 
     // sfz v2 headers:
-
     /// The control header would be found at the beginning of the file
     /// and includes special opcodes for setting up MIDI CC controls.
     ///
@@ -63,7 +59,6 @@ pub enum Header {
     Effect,
 
     // aria headers:
-
     /// The master header is an extra level added inbetween group and global for the ARIA player.
     ///
     /// - version: aria extension
@@ -78,32 +73,30 @@ pub enum Header {
     Midi,
 
     // cakewalk headers:
-
     /// Allows to embed sample data directly in SFZ files (Rapture).
     ///
     /// - version: cakewalk extension
     /// - info: [sample](https://sfzformat.com/headers/sample)
     Sample,
 }
 
-
 impl Header {
     /// Parses the opcode, making it lowercase and removing the brackets
     ///
     pub(crate) fn parse_header(lex: &mut Lexer<SfzToken>) -> Option<Header> {
         let slice = lex.slice().to_ascii_lowercase();
-        let name = &slice[1..slice.len()-1];
+        let name = &slice[1..slice.len() - 1];
         match name {
-             "region" => Some(Header::Region),
-             "group" => Some(Header::Group),
-             "control" => Some(Header::Control),
-             "global" => Some(Header::Global),
-             "curve" => Some(Header::Curve),
-             "effect" => Some(Header::Effect),
-             "master" => Some(Header::Master),
-             "midi" => Some(Header::Midi),
-             "sample" => Some(Header::Sample),
-             _ => None,
+            "region" => Some(Header::Region),
+            "group" => Some(Header::Group),
+            "control" => Some(Header::Control),
+            "global" => Some(Header::Global),
+            "curve" => Some(Header::Curve),
+            "effect" => Some(Header::Effect),
+            "master" => Some(Header::Master),
+            "midi" => Some(Header::Midi),
+            "sample" => Some(Header::Sample),
+            _ => None,
         }
     }
 }

src/sfz/instrument.rs

@@ -1,13 +1,13 @@
+use std::fmt::Debug;
 use std::fs::File;
-use std::io::{Error, prelude::*};
+use std::io::{prelude::*, Error};
 use std::path::{Path, PathBuf};
 use std::result::Result;
-use std::fmt::Debug;
 
 use logos::Logos;
 
-use crate::sfz::{Group, Header, Opcode, Region, SfzToken};
 use crate::sfz::types::OpcodeMap;
+use crate::sfz::{Group, Header, Opcode, Region, SfzToken};
 
 /// Represents the SFZ instrument parsed
 ///
@@ -21,22 +21,19 @@ use crate::sfz::types::OpcodeMap;
 ///
 #[derive(Debug)]
 pub struct Instrument {
-    global: OpcodeMap,     // these opcodes apply by default
-    groups: Vec<Group>,    // these opcodes override those in global for current region
-    regions: Vec<Region>,  // these opcodes override global, and their group ones
+    global: OpcodeMap,    // these opcodes apply by default
+    groups: Vec<Group>,   // these opcodes override those in global for current region
+    regions: Vec<Region>, // these opcodes override global, and their group ones
 
     // maybe make this later a: struct Control
     // https://sfzformat.com/headers/control
     default_path: PathBuf,
 }
 
-
 impl Instrument {
-
     /// Creates an Instrument via loading and parsing some SFZ code in a file
     ///
     pub fn from_file(sfz_path: &Path) -> Result<Self, Error> {
-
         // open sfz file, and read it into sfz_text
         let mut sfz_file = File::open(&sfz_path)?;
         let mut sfz_text = String::new();
@@ -45,14 +42,12 @@ impl Instrument {
         Self::from_sfz(&sfz_text, sfz_path.parent().unwrap())
     }
 
-
     /// Creates an Instrument via parsing some SFZ code in a string
     ///
     /// sfz_path would be the root location from where to find the samples
     /// and default_path opcode value is appended to it.
     ///
     pub fn from_sfz(sfz: &str, sfz_path: &Path) -> Result<Self, Error> {
-
         // Initializes an instrument for construction
         let mut instrument = Instrument {
             global: OpcodeMap::new(),
@@ -61,77 +56,70 @@ impl Instrument {
             default_path: sfz_path.to_path_buf(),
         };
 
-
         // parser loop status
         let mut status = InstrumentParsingStatus::init();
 
         // parser loop
         let lex = SfzToken::lexer(&sfz);
-        for t in lex { match &t {
-
+        for t in lex {
+            match &t {
                 SfzToken::Header(h) => {
                     match h {
                         Header::Group => {
                             status.new_group();
                             instrument.groups.push(Group::new());
-                        },
+                        }
                         Header::Region => {
                             status.new_region();
 
                             // FIXME: NOTE: an empty region (or without a sample) should be discarded
                             instrument.regions.push(Region::new());
-                        },
+                        }
                         Header::Control => {
                             status.new_control();
-                        },
+                        }
                         Header::Global => {
                             status.new_global();
-                        },
+                        }
                         // TBD
                         Header::Curve => println!("\n<curve>"),
                         // TBD
                         Header::Effect => println!("\n<effect>"),
-                        _ => ()
+                        _ => (),
                     }
-                },
+                }
 
                 SfzToken::Opcode(o) => {
-
                     // an opcode for <global>
                     if status.is_header_global {
                         instrument.global.insert(o.str_name(), o.clone());
 
                     // an opcode for <control>
                     } else if status.is_header_control {
                         match o {
-                            Opcode::default_path(p) => {
-                                instrument.default_path.push(p)
-                            },
-                            _ => ()
+                            Opcode::default_path(p) => instrument.default_path.push(p),
+                            _ => (),
                         }
-
                     } else {
-
                         // an opcode for the <region>
                         if status.are_regions() {
                             instrument.add_region_opcode(&status, o);
 
                         // an opcode for the <group>
                         } else if status.are_groups() {
                             instrument.add_group_opcode(&status, o);
-
                         } else {
                             unreachable!();
                         }
                     }
-                },
+                }
                 _ => (),
-            }}
+            }
+        }
 
         Ok(instrument)
     }
 
-
     fn add_region_opcode(&mut self, status: &InstrumentParsingStatus, opcode: &Opcode) {
         self.regions[status.region_counter.unwrap()].add(opcode, status.group_counter);
     }
@@ -141,7 +129,6 @@ impl Instrument {
     }
 }
 
-
 /// The current status of the parsing of the instrument
 #[derive(Debug)]
 struct InstrumentParsingStatus {
@@ -162,7 +149,6 @@ impl InstrumentParsingStatus {
         }
     }
 
-
     /// A new group header appears
     ///
     pub fn new_group(&mut self) {
@@ -187,7 +173,6 @@ impl InstrumentParsingStatus {
         self.region_increment();
     }
 
-
     /// A new control header appears
     ///
     /// There can only be one, and must appear
@@ -198,8 +183,8 @@ impl InstrumentParsingStatus {
         if !self.is_header_control
             && !self.is_header_global
             && self.group_counter == None
-            && self.region_counter == None {
-
+            && self.region_counter == None
+        {
             // enter the <control> header
             self.is_header_control = true;
         }
@@ -212,10 +197,7 @@ impl InstrumentParsingStatus {
     ///
     // TODO: if incorrectly placed, following opcodes should be ignored
     pub fn new_global(&mut self) {
-        if !self.is_header_global
-            && self.group_counter == None
-            && self.region_counter == None {
-
+        if !self.is_header_global && self.group_counter == None && self.region_counter == None {
             // ensure we are out of the <control> header
             self.is_header_control = false;
             // enter the <global> header
@@ -226,7 +208,7 @@ impl InstrumentParsingStatus {
     /// Increments the region counter
     fn region_increment(&mut self) {
         match self.region_counter {
-            Some(c) => self.region_counter = Some(c+1),
+            Some(c) => self.region_counter = Some(c + 1),
             None => self.region_counter = Some(0),
         }
     }
@@ -237,7 +219,7 @@ impl InstrumentParsingStatus {
     /// Increments the group counter
     fn group_increment(&mut self) {
         match self.region_counter {
-            Some(c) => self.group_counter = Some(c+1),
+            Some(c) => self.group_counter = Some(c + 1),
             None => self.group_counter = Some(0),
         }
     }

src/sfz/mod.rs

@@ -4,9 +4,9 @@
 //! Multiple regions can be arranged in a group.
 //! Groups allow entering common parameters for multiple regions.
 
+pub mod group;
 pub mod headers;
 pub mod instrument;
-pub mod group;
 pub mod opcodes;
 pub mod region;
 

src/sfz/opcodes/defaults.rs

@@ -2,7 +2,6 @@ use phf::phf_map;
 
 use crate::sfz::types::{fil_type, trigger, OpcodeType};
 
-
 /// This map returns the optional default value of an opcode type
 pub(crate) static OPCODE_DEFAULT: phf::Map<&'static str, OpcodeType> = phf_map! {