Merge pull request #19 from SpontanCombust/dev

SpontanCombust · Sep 25, 2023 · a23d82a · a23d82a
2 parents 0b86bd9 + d6d91c1
commit a23d82a
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 50 deletions.
diff --git a/doc/cli_specification.md b/doc/cli_specification.md
@@ -1,5 +1,5 @@
 ```
-TW3 Settings Framework Parser 0.6.0
+TW3 Settings Framework Parser 0.6.1
 Parses a mod menu XML file and outputs witcher script code representing settings of this menu
 
 USAGE:

diff --git a/doc/mod-menu.ws b/doc/mod-menu.ws
@@ -1,4 +1,4 @@
-// Code generated using Mod Settings Framework v0.6.0 by SpontanCombust & Aeltoth
+// Code generated using Mod Settings Framework v0.6.1 by SpontanCombust & Aeltoth
 
 class MyModSettings extends ISettingsMaster
 {
@@ -76,7 +76,7 @@ class MyModSettings_tab2 extends ISettingsGroup
 
 	protected /* override */ function Parser_ValidateSettings() : void
 	{
-		anotherSlider = ClampF(anotherSlider, -100, 100);
+		anotherSlider = ClampF(anotherSlider, -1.5, 1.5);
 	}
 
 	protected /* override */ function Parser_ReadSettings(config: CInGameConfigWrapper) : void

diff --git a/doc/mod-menu.xml b/doc/mod-menu.xml
@@ -42,7 +42,7 @@
 
    	<Group id="MODtab2subtab1" msfVariable="tab2" displayName="Mods.my_mod.my_mod_tab2.subtap1">
 		<VisibleVars>
-				<Var id="anotherSlider" displayName="mod_another_slider" displayType="SLIDER;-100;100;1000"/>
+				<Var id="anotherSlider" displayName="mod_another_slider" displayType="SLIDER;-1.5;1.5;30"/>
 		</VisibleVars>
     </Group>
 	<Group id="MODtab2subtab2" msfVariable="tab3" displayName="Mods.my_mod.my_mod_tab2.subtap2">

diff --git a/modSettingsFramework/content/scripts/local/settings_master_registry.ws b/modSettingsFramework/content/scripts/local/settings_master_registry.ws
@@ -1,7 +1,7 @@
 class CSettingsMasterRegistry
 {
     public const var FRAMEWORK_VERSION : name;
-    default FRAMEWORK_VERSION = '0.6.0';
+    default FRAMEWORK_VERSION = '0.6.1';
 
     private var m_settingsEntries : array<ISettingsMaster>;
 

diff --git a/...es/DifficultyMod/Mods/modSampleDifficultyMod/content/scripts/local/difficulty_mod_base.ws b/...es/DifficultyMod/Mods/modSampleDifficultyMod/content/scripts/local/difficulty_mod_base.ws
@@ -1,4 +1,4 @@
-// Code generated using Mod Settings Framework v0.6.0 by SpontanCombust & Aeltoth
+// Code generated using Mod Settings Framework v0.6.1 by SpontanCombust & Aeltoth
 
 class ModDifficultySettingsBase extends ISettingsMaster
 {

diff --git a/...Week/Mods/modSampleMonsterOfTheWeek/content/scripts/local/monster_of_the_week_settings.ws b/...Week/Mods/modSampleMonsterOfTheWeek/content/scripts/local/monster_of_the_week_settings.ws
@@ -1,4 +1,4 @@
-// Code generated using Mod Settings Framework v0.6.0 by SpontanCombust & Aeltoth
+// Code generated using Mod Settings Framework v0.6.1 by SpontanCombust & Aeltoth
 
 class MonsterOfTheWeekSettings extends ISettingsMaster
 {

diff --git a/settings-parser/Cargo.toml b/settings-parser/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tw3-mod-settings-framework-parser"
-version = "0.6.0"
+version = "0.6.1"
 edition = "2021"
 
 [[bin]]

diff --git a/settings-parser/src/main.rs b/settings-parser/src/main.rs
@@ -37,24 +37,6 @@ fn main() -> Result<(), String>{
             return Err(format!("Error opening menu xml file: {}", e));
         }
     };
-
-    let ws_path = match &cli.output_ws_file_path  {
-        Some(path) => PathBuf::from(&path),
-        None => input_file_path.with_extension("ws")
-    };
-
-    let ws_file = OpenOptions::new()
-        .write(true)
-        .create(true)
-        .open(&ws_path);
-
-    let mut ws_file = match ws_file {
-        Ok(f) => f,
-        Err(e) => {
-            return Err(format!("Error creating witcher script output file: {}", e));
-        }
-    };
-
 
 
     let mut xml_text = String::new();
@@ -69,29 +51,47 @@ fn main() -> Result<(), String>{
         }
     };
 
+    let mut buffer = WitcherScript::new();
     match UserConfig::try_from(&doc) {
         Ok(user_config) => {
             let settings_master = SettingsMaster::try_from(user_config, &cli)?;
 
-            let mut buffer = WitcherScript::new();
-
             buffer.push_line(&format!("// Code generated using Mod Settings Framework v{} by SpontanCombust & Aeltoth", option_env!("CARGO_PKG_VERSION").unwrap()))
                   .new_line();
 
-            settings_master.ws_type_definition(&mut buffer);
-
-            // clear file content if there is any
-            ws_file.set_len(0).unwrap();
-
-            if let Err(e) = ws_file.write_all(buffer.text.as_bytes()) {
-                return Err(format!("Error writing witcher script output file: {}", e));
-            }
+            settings_master.ws_type_definition(&mut buffer);  
         },
         Err(err) => {
             return Err(format!("Error parsing menu xml file: {}", err));
         }
     }
 
+
+    let ws_path = match &cli.output_ws_file_path  {
+        Some(path) => PathBuf::from(&path),
+        None => input_file_path.with_extension("ws")
+    };
+
+    let ws_file = OpenOptions::new()
+        .write(true)
+        .create(true)
+        .open(&ws_path);
+
+    let mut ws_file = match ws_file {
+        Ok(f) => f,
+        Err(e) => {
+            return Err(format!("Error creating witcher script output file: {}", e));
+        }
+    };
+
+    // clear file content if there is any
+    ws_file.set_len(0).unwrap();
+
+    if let Err(e) = ws_file.write_all(buffer.text.as_bytes()) {
+        return Err(format!("Error writing witcher script output file: {}", e));
+    }
+
+
     println!("Successfully parsed {} into {}", cli.xml_file_path, ws_path.to_str().unwrap_or(""));
     return Ok(())
 }
diff --git a/settings-parser/src/settings_var_type.rs b/settings-parser/src/settings_var_type.rs
@@ -29,13 +29,13 @@ impl SettingsVarType {
             DisplayType::Slider { min, max, div } => {
                 if is_integral_range(*min, *max, *div) {
                     Ok(Some(SettingsVarType::Int {
-                        min: *min, 
-                        max: *max
+                        min: *min as i32, 
+                        max: *max as i32
                     }))
                 } else {
                     Ok(Some(SettingsVarType::Float { 
-                        min: *min as f32,
-                        max: *max as f32 
+                        min: *min,
+                        max: *max 
                     }))
                 }
             },

diff --git a/settings-parser/src/utils.rs b/settings-parser/src/utils.rs
@@ -34,8 +34,12 @@ pub(crate) fn strip_prefixes<'a>(s: &'a str, prefixes: &'a [String]) -> &'a str
     stripped_s
 }
 
-pub(crate) fn is_integral_range(min: i32, max: i32, div: i32) -> bool {
-    (max - min) % div == 0
+pub(crate) fn is_integral_range(min: f32, max: f32, div: f32) -> bool {
+    if min.floor() != min || max.floor() != max || div.floor() != div {
+        return false;
+    } else {
+        (max as i32 - min as i32) % div as i32 == 0
+    }
 } 
 
 pub(crate) fn common_str_prefix(v: &[String]) -> &str {

diff --git a/settings-parser/src/xml/display_type.rs b/settings-parser/src/xml/display_type.rs
@@ -12,9 +12,9 @@ pub enum DisplayType {
     Toggle,
     Options(OptionsArray), // array of displayNames
     Slider {
-        min: i32,
-        max: i32,
-        div: i32
+        min: f32,
+        max: f32,
+        div: f32
     },
     SubtleSeparator
 }
@@ -49,29 +49,29 @@ impl TryFrom<&Node<'_, '_>> for DisplayType {
             } else if spl.len() != 4 {
                 Err(format!("Invalid amount of slider parameters. Should be 3, is {}", spl.len() - 1))
             } else {
-                let min = spl[1].parse::<i32>();
+                let min = spl[1].parse::<f32>();
                 if min.is_err() {
                     return Err(format!("Slider min value parse error: {}", min.unwrap_err()));   
                 }
 
                 let min = min.unwrap();
 
 
-                let max = spl[2].parse::<i32>();
+                let max = spl[2].parse::<f32>();
                 if max.is_err() {
                     return Err(format!("Slider max value parse error: {}", max.unwrap_err()));   
                 }
 
                 let max = max.unwrap();
 
 
-                let div = spl[3].parse::<i32>();
+                let div = spl[3].parse::<f32>();
                 if div.is_err() {
                     return Err(format!("Slider div value parse error: {}", div.unwrap_err()));   
                 }
 
                 let div = div.unwrap();
-                if div <= 0 {
+                if div <= 0.0 {
                     return Err("Slider div value must be greater than 0".to_string());
                 }
 

diff --git a/settings-parser/src/xml/group.rs b/settings-parser/src/xml/group.rs
@@ -71,7 +71,14 @@ impl TryFrom<&Node<'_, '_>> for Group {
         if let Some(visible_vars_node) = node.children().find(|n| n.has_tag_name("VisibleVars")) {
             let var_nodes = visible_vars_node.children().filter(|n| n.has_tag_name("Var"));
             for var_node in var_nodes {
-                visible_vars.push(Var::try_from(&var_node)?);
+                match Var::try_from(&var_node) {
+                    Ok(var) => {
+                        visible_vars.push(var);
+                    }
+                    Err(err) => {
+                        return Err(format!("Error parsing var at {}: {}", node_pos(&var_node), err));
+                    }
+                }
             }
         }