Add support for Yu-Ris YSLB(labels) file (.ybn)

README.md

@@ -272,6 +272,7 @@ msg-tool create -t <script-type> <input> <output>
 | `yuris-ystb` | `yuris` | Yu-Ris YSTB(compiled script) file (.ybn) | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ❌ | |
 | `yuris-txt` | `yuris` | Yu-Ris scenario text file (.txt) | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ | ❌ | |
 | `yuris-ystl` | `yuris` | Yu-Ris YSTL(file list) file (.ybn) | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ✔️ | |
+| `yuris-yslb` | `yuris` | Yu-Ris YSLB(labels) file (.ybn) | ❌ | ❌ | ❌ | ❌ | ✔️ | ✔️ | ✔️ | |
 
 | Image Type | Feature Name | Name | Export | Import | Export Multiple | Import Multiple | Create | Remarks |
 |---|---|---|---|---|---|---|---|---|

src/scripts/mod.rs

@@ -190,6 +190,8 @@ lazy_static::lazy_static! {
         Box::new(yuris::img::ydg::YDGImageBuilder::new()),
         #[cfg(feature = "yuris")]
         Box::new(yuris::ystl::YSTLBuilder::new()),
+        #[cfg(feature = "yuris")]
+        Box::new(yuris::yslb::YSLBBuilder::new()),
     ];
     /// A list of all script extensions.
     pub static ref ALL_EXTS: Vec<String> =

src/scripts/yuris/mod.rs

@@ -6,5 +6,6 @@ mod types;
 pub mod yscfg;
 pub mod yscm;
 pub mod yser;
+pub mod yslb;
 pub mod ystb;
 pub mod ystl;

src/scripts/yuris/yslb.rs

@@ -0,0 +1,211 @@
+//!Yu-Ris YSLB(labels) file (.ybn)
+use crate::ext::io::*;
+use crate::scripts::base::*;
+use crate::types::*;
+use crate::utils::encoding::*;
+use crate::utils::struct_pack::*;
+use anyhow::Result;
+use msg_tool_macro::*;
+use serde::{Deserialize, Serialize};
+use std::io::{Read, Seek, Write};
+
+#[derive(Debug, StructUnpack, StructPack, Deserialize, Serialize)]
+struct Label {
+    #[pstring(u8)]
+    name: String,
+    id: u32,
+    offset: u32,
+    script_index: u16,
+    #[serde(skip)]
+    padding: u16,
+}
+
+#[derive(Debug, StructUnpack, StructPack, Deserialize, Serialize)]
+struct YSLBData {
+    version: u32,
+    #[serde(skip)]
+    num_labels: u32,
+    #[fvec = 0x100]
+    #[serde(skip)]
+    /// label_range_start_indexes[N] = index of first label with ID >= (N << 24)
+    label_range_start_indexes: Vec<u32>,
+    #[pack_vec_len(self.num_labels)]
+    #[unpack_vec_len(num_labels)]
+    labels: Vec<Label>,
+}
+
+#[derive(Debug)]
+pub struct YSLBBuilder {}
+
+impl YSLBBuilder {
+    /// Creates a new instance of `YSLBBuilder`
+    pub const fn new() -> Self {
+        YSLBBuilder {}
+    }
+}
+
+impl ScriptBuilder for YSLBBuilder {
+    fn default_encoding(&self) -> Encoding {
+        Encoding::Cp932
+    }
+
+    fn build_script(
+        &self,
+        buf: Vec<u8>,
+        _filename: &str,
+        encoding: Encoding,
+        _archive_encoding: Encoding,
+        config: &ExtraConfig,
+        _archive: Option<&Box<dyn Script>>,
+    ) -> Result<Box<dyn Script + Send + Sync>> {
+        Ok(Box::new(YSLB::new(MemReader::new(buf), encoding, config)?))
+    }
+
+    fn extensions(&self) -> &'static [&'static str] {
+        &["ybn"]
+    }
+
+    fn is_this_format(&self, _filename: &str, buf: &[u8], buf_len: usize) -> Option<u8> {
+        if buf_len >= 4 && buf.starts_with(b"YSLB") {
+            return Some(20);
+        }
+        None
+    }
+
+    fn script_type(&self) -> &'static ScriptType {
+        &ScriptType::YurisYSLB
+    }
+
+    fn can_create_file(&self) -> bool {
+        true
+    }
+
+    fn create_file<'a>(
+        &'a self,
+        filename: &'a str,
+        writer: Box<dyn WriteSeek + 'a>,
+        encoding: Encoding,
+        file_encoding: Encoding,
+        config: &ExtraConfig,
+    ) -> Result<()> {
+        create_file(
+            filename,
+            writer,
+            encoding,
+            file_encoding,
+            config.custom_yaml,
+        )
+    }
+}
+
+#[derive(Debug)]
+pub struct YSLB {
+    data: YSLBData,
+    custom_yaml: bool,
+}
+
+impl YSLB {
+    pub fn new<T: Read + Seek>(
+        mut reader: T,
+        encoding: Encoding,
+        config: &ExtraConfig,
+    ) -> Result<Self> {
+        let mut sig = [0; 4];
+        reader.read_exact(&mut sig)?;
+        if &sig != b"YSLB" {
+            anyhow::bail!("Unsupported YSLB file.");
+        }
+        let data = YSLBData::unpack(&mut reader, false, encoding, &None)?;
+        Ok(Self {
+            data,
+            custom_yaml: config.custom_yaml,
+        })
+    }
+}
+
+impl Script for YSLB {
+    fn default_output_script_type(&self) -> OutputScriptType {
+        OutputScriptType::Custom
+    }
+
+    fn is_output_supported(&self, output: OutputScriptType) -> bool {
+        matches!(output, OutputScriptType::Custom)
+    }
+
+    fn default_format_type(&self) -> FormatOptions {
+        FormatOptions::None
+    }
+
+    fn custom_output_extension(&self) -> &'static str {
+        if self.custom_yaml { "yaml" } else { "json" }
+    }
+
+    fn custom_export(&self, filename: &std::path::Path, encoding: Encoding) -> Result<()> {
+        let s = if self.custom_yaml {
+            serde_yaml_ng::to_string(&self.data)
+                .map_err(|e| anyhow::anyhow!("Failed to serialize to YAML: {}", e))?
+        } else {
+            serde_json::to_string_pretty(&self.data)
+                .map_err(|e| anyhow::anyhow!("Failed to serialize to JSON: {}", e))?
+        };
+        let mut writer = crate::utils::files::write_file(filename)?;
+        let s = encode_string(encoding, &s, false)?;
+        writer.write_all(&s)?;
+        writer.flush()?;
+        Ok(())
+    }
+
+    fn custom_import<'a>(
+        &'a self,
+        custom_filename: &'a str,
+        file: Box<dyn WriteSeek + 'a>,
+        encoding: Encoding,
+        output_encoding: Encoding,
+    ) -> Result<()> {
+        create_file(
+            custom_filename,
+            file,
+            encoding,
+            output_encoding,
+            self.custom_yaml,
+        )
+    }
+}
+
+fn create_file<'a>(
+    custom_filename: &'a str,
+    mut writer: Box<dyn WriteSeek + 'a>,
+    encoding: Encoding,
+    output_encoding: Encoding,
+    yaml: bool,
+) -> Result<()> {
+    let input = crate::utils::files::read_file(custom_filename)?;
+    let s = decode_to_string(output_encoding, &input, true)?;
+    let mut data: YSLBData = if yaml {
+        serde_yaml_ng::from_str(&s).map_err(|e| anyhow::anyhow!("Failed to parse YAML: {}", e))?
+    } else {
+        serde_json::from_str(&s).map_err(|e| anyhow::anyhow!("Failed to parse JSON: {}", e))?
+    };
+    data.num_labels = data.labels.len() as u32;
+    data.label_range_start_indexes.resize(0x100, 0);
+    let max = data.num_labels as usize;
+    let mut i = 0;
+    for j in 0..256 {
+        loop {
+            if i >= max {
+                data.label_range_start_indexes[j] = max as u32;
+                break;
+            } else {
+                let lab = data.labels[i].id >> 24;
+                if lab as usize >= j {
+                    data.label_range_start_indexes[j] = i as u32;
+                    break;
+                }
+                i += 1;
+            }
+        }
+    }
+    writer.write_all(b"YSLB")?;
+    data.pack(&mut writer, false, encoding, &None)?;
+    Ok(())
+}

src/types.rs

@@ -929,8 +929,12 @@ pub enum ScriptType {
     #[cfg(feature = "yuris")]
     /// Yu-Ris scenario text file (.txt)
     YurisTxt,
+    #[cfg(feature = "yuris")]
     /// Yu-Ris YSTL(file list) file (.ybn)
     YurisYSTL,
+    #[cfg(feature = "yuris")]
+    /// Yu-Ris YSLB(labels) file (.ybn)
+    YurisYSLB,
     #[cfg(feature = "yuris-img")]
     /// YU-RIS compressed image file (.ydg)
     YurisYDG,