esp_extractor 0.8.1

/// 本地化插件上下文
///
/// 该模块提供本地化插件（带 STRING 文件）的便捷处理接口。
/// 将 Plugin 和 StringFileSet 组合在一起，遵循组合模式。
use std::path::{Path, PathBuf};
use crate::Plugin;
use crate::StringFileSet;

/// 本地化插件上下文
///
/// 组合 Plugin 和 StringFileSet，提供统一的本地化插件操作接口。
///
/// # 使用场景
/// - 处理设置了 LOCALIZED 标志的 ESP/ESM 文件
/// - 需要同时访问 ESP 文件和 STRING 文件
///
/// # 示例
/// ```rust,ignore
/// use esp_extractor::LocalizedPluginContext;
///
/// // 加载本地化插件
/// let context = LocalizedPluginContext::load(
///     "DismemberingFramework.esm".into(),
///     "english",
/// )?;
///
/// // 访问插件
/// println!("插件名: {}", context.plugin().get_name());
///
/// // 访问 STRING 文件
/// println!("STRING 文件数: {}", context.string_files().files.len());
///
/// // 提取字符串（从 STRING 文件读取）
/// let strings = context.plugin().extract_strings();
/// ```
#[derive(Debug)]
pub struct LocalizedPluginContext {
    /// ESP/ESM/ESL 插件实例
    plugin: Plugin,
    /// STRING 文件集合
    string_files: StringFileSet,
    /// 语言标识
    language: String,
}

impl LocalizedPluginContext {
    /// 加载本地化插件及其 STRING 文件
    ///
    /// # 参数
    /// * `path` - ESP/ESM/ESL 文件路径
    /// * `language` - 语言标识（如 "english", "chinese" 等）
    ///
    /// # 返回
    /// 返回包含插件和 STRING 文件的上下文
    ///
    /// # 错误
    /// - 如果插件文件不存在或无效
    /// - 如果 STRING 文件加载失败
    /// - 如果插件未设置 LOCALIZED 标志（警告但不报错）
    pub fn load(path: PathBuf, language: &str) -> Result<Self, Box<dyn std::error::Error>> {
        // 加载插件
        let mut plugin = Plugin::load(path.clone())?;

        // 检查是否为本地化插件
        if !plugin.is_localized() {
            eprintln!(
                "警告: 插件 {} 未设置 LOCALIZED 标志，可能不包含 STRING 文件",
                plugin.get_name()
            );
        }

        // 加载 STRING 文件
        let string_files = Self::load_string_files(&path, &plugin, language)?;

        // 🔧 关键修复：将 STRING 文件设置到 Plugin 对象中
        // 这样 plugin.extract_strings() 就可以访问 STRING 文件了
        plugin.set_string_files(string_files.clone());

        Ok(Self {
            plugin,
            string_files,
            language: language.to_string(),
        })
    }

    /// 使用已加载的 Plugin 创建本地化上下文
    ///
    /// ⚡ 性能优化：避免重复加载 ESP 文件
    ///
    /// # 参数
    /// * `plugin` - 已经加载好的 Plugin 实例
    /// * `plugin_path` - 插件文件路径（用于定位 STRING 文件）
    /// * `language` - 语言标识（如 "english", "chinese" 等）
    ///
    /// # 返回
    /// 返回包含插件和 STRING 文件的上下文
    ///
    /// # 错误
    /// - 如果 STRING 文件加载失败
    ///
    /// # 示例
    /// ```rust,ignore
    /// // 先加载 Plugin
    /// let plugin = Plugin::load("DismemberingFramework.esm".into())?;
    ///
    /// // 检查是否为本地化插件
    /// if plugin.is_localized() {
    ///     // 使用已加载的 Plugin 创建上下文（避免重复加载）
    ///     let context = LocalizedPluginContext::new_with_plugin(
    ///         plugin,
    ///         "DismemberingFramework.esm".into(),
    ///         "english",
    ///     )?;
    /// }
    /// ```
    pub fn new_with_plugin(
        mut plugin: Plugin,
        plugin_path: PathBuf,
        language: &str,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        // 检查是否为本地化插件
        if !plugin.is_localized() {
            eprintln!(
                "警告: 插件 {} 未设置 LOCALIZED 标志，可能不包含 STRING 文件",
                plugin.get_name()
            );
        }

        // 加载 STRING 文件
        let string_files = Self::load_string_files(&plugin_path, &plugin, language)?;

        // 将 STRING 文件设置到 Plugin 对象中
        plugin.set_string_files(string_files.clone());

        Ok(Self {
            plugin,
            string_files,
            language: language.to_string(),
        })
    }

    /// 加载 STRING 文件（内部辅助方法）
    fn load_string_files(
        path: &Path,
        _plugin: &Plugin,
        language: &str,
    ) -> Result<StringFileSet, Box<dyn std::error::Error>> {
        let plugin_name = path
            .file_stem()
            .and_then(|s| s.to_str())
            .ok_or("无法获取插件名称")?;

        StringFileSet::load_auto_for_plugin(path, plugin_name, language)
    }

    /// 获取插件的不可变引用
    pub fn plugin(&self) -> &Plugin {
        &self.plugin
    }

    /// 获取插件的可变引用
    pub fn plugin_mut(&mut self) -> &mut Plugin {
        &mut self.plugin
    }

    /// 获取 STRING 文件集的不可变引用
    pub fn string_files(&self) -> &StringFileSet {
        &self.string_files
    }

    /// 获取 STRING 文件集的可变引用
    pub fn string_files_mut(&mut self) -> &mut StringFileSet {
        &mut self.string_files
    }

    /// 获取语言标识
    pub fn language(&self) -> &str {
        &self.language
    }

    /// 解构上下文，获取所有权
    ///
    /// # 返回
    /// 返回 (Plugin, StringFileSet, String) 元组
    pub fn into_parts(self) -> (Plugin, StringFileSet, String) {
        (self.plugin, self.string_files, self.language)
    }

    /// 保存 STRING 文件到指定目录
    ///
    /// # 参数
    /// * `output_dir` - 输出目录路径（STRING 文件将写入 output_dir/strings/）
    pub fn save_string_files(
        &self,
        output_dir: &Path,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let string_dir = output_dir.join("strings");
        std::fs::create_dir_all(&string_dir)?;
        self.string_files.write_all(&string_dir)
    }

    /// 生成上下文摘要
    pub fn summary(&self) -> String {
        format!(
            "本地化插件: {}, 语言: {}, STRING 文件数: {}",
            self.plugin.get_name(),
            self.language,
            self.string_files.files.len()
        )
    }
}

#[cfg(test)]
mod tests {
    // use super::*;

    #[test]
    fn test_localized_context_creation() {
        // 注意：这个测试需要一个有效的本地化 ESP 文件和 STRING 文件
        // 在实际项目中，应该使用测试 fixture
        // 这里只是演示 API 用法

        // let context = LocalizedPluginContext::load(
        //     "test.esm".into(),
        //     "english",
        // ).unwrap();
        //
        // assert!(context.plugin().is_localized());
        // assert!(!context.string_files().files.is_empty());
    }
}