rsword_chirho 0.3.0

// For God so loved the world that he gave his only begotten Son,
// that whoever believes in him should not perish but have eternal life.
// John 3:16

//! # rsword_chirho
//!
//! Pure Rust port of the SWORD Bible software library.
//!
//! This crate provides full compatibility with SWORD module binary formats,
//! including reading and writing Bible texts, commentaries, lexicons, and
//! general books.
//!
//! ## Quick Start
//!
//! Load installed SWORD modules and look up a verse:
//!
//! ```rust,ignore
//! use rsword_chirho::{SwMgrChirho, VerseKeyChirho};
//!
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Load modules from system paths (~/.sword, /usr/share/sword, etc.)
//!     let mgr_chirho = SwMgrChirho::with_system_paths_chirho()?;
//!
//!     // List available modules
//!     for name_chirho in mgr_chirho.get_module_names_chirho() {
//!         println!("Found module: {}", name_chirho);
//!     }
//!
//!     // Get a Bible module and look up a verse
//!     if let Some(mut module_chirho) = mgr_chirho.get_module_driver_chirho("KJV")? {
//!         let key_chirho = VerseKeyChirho::from_str_chirho("John 3:16")?;
//!         module_chirho.set_key_chirho(&key_chirho)?;
//!         let text_chirho = module_chirho.get_raw_entry_chirho()?;
//!         println!("{}: {}", key_chirho, text_chirho);
//!     }
//!
//!     Ok(())
//! }
//! ```
//!
//! ## Verse Navigation
//!
//! Use [`VerseKeyChirho`] for Bible verse references:
//!
//! ```rust,ignore
//! use rsword_chirho::VerseKeyChirho;
//!
//! // Parse verse references
//! let mut key_chirho = VerseKeyChirho::from_str_chirho("Genesis 1:1").unwrap();
//!
//! // Navigate forward
//! key_chirho.increment_chirho(1);
//! println!("Now at: {}", key_chirho); // Genesis 1:2
//!
//! // Parse various formats
//! let _ = VerseKeyChirho::from_str_chirho("Gen 1:1").unwrap();    // Abbreviation
//! let _ = VerseKeyChirho::from_str_chirho("1 John 3:16").unwrap(); // Numbered book
//! let _ = VerseKeyChirho::from_str_chirho("Rev 22:21").unwrap();   // Last verse
//! ```
//!
//! ## Versification Systems
//!
//! Different Bible traditions use different verse numbering systems:
//!
//! ```rust,ignore
//! use rsword_chirho::versification_chirho::{get_versification_chirho, VersificationManagerChirho};
//!
//! // Get versification by name
//! let kjv_v11n_chirho = get_versification_chirho("KJV").unwrap();
//! let catholic_v11n_chirho = get_versification_chirho("Catholic").unwrap();
//! let lxx_v11n_chirho = get_versification_chirho("LXX").unwrap();
//!
//! // Available systems: KJV, Catholic, LXX, Synodal, Luther, Vulgate, NRSV, Leningrad, Ethiopian
//! let manager_chirho = VersificationManagerChirho::new_chirho();
//! for v11n_name_chirho in manager_chirho.list_available_chirho() {
//!     println!("Available: {}", v11n_name_chirho);
//! }
//! ```
//!
//! ## Search
//!
//! Search module content using regex or indexed search:
//!
//! ```rust,ignore
//! use rsword_chirho::{SearchOptionsChirho, SearchTypeChirho};
//!
//! // Create search options
//! let options_chirho = SearchOptionsChirho::new_chirho()
//!     .with_type_chirho(SearchTypeChirho::PhraseChirho)
//!     .case_insensitive_chirho(true)
//!     .with_max_results_chirho(100);
//! ```
//!
//! ## Module Types
//!
//! Supported SWORD module formats:
//!
//! | Type | Description | Storage Formats |
//! |------|-------------|-----------------|
//! | Biblical Texts | Bible translations | RawText, zText |
//! | Commentaries | Verse-keyed commentary | RawCom, zCom |
//! | Lexicons | Dictionaries/lexicons | RawLD, zLD |
//! | General Books | Tree-structured content | RawGenBook |
//! | Daily Devotional | Date-keyed devotions | RawCom |
//! | Images | Maps and images | - |
//!
//! ## Filters
//!
//! Convert between markup formats:
//!
//! ```rust,ignore
//! use rsword_chirho::{FilterChirho, OsisToHtmlFilterChirho, FilterOptionsChirho};
//!
//! let filter_chirho = OsisToHtmlFilterChirho::new_chirho();
//! let options_chirho = FilterOptionsChirho::default();
//!
//! // Convert OSIS markup to HTML
//! let osis_chirho = r#"<verse osisID="John.3.16">For God so loved...</verse>"#;
//! let html_chirho = filter_chirho.process_chirho(osis_chirho, &options_chirho);
//! ```
//!
//! ## Feature Flags
//!
//! Optional features controlled via Cargo.toml:
//!
//! - `bzip2` - bzip2 compression support (default)
//! - `xz` - xz/lzma compression support (default)
//! - `search` - Tantivy full-text search (default)
//! - `parallel` - Parallel processing with rayon

#![warn(missing_docs)]

pub mod error_chirho;
pub mod byte_order_chirho;
pub mod config_chirho;
pub mod keys_chirho;
pub mod versification_chirho;
pub mod storage_chirho;
pub mod compression_chirho;
pub mod cipher_chirho;
pub mod cache_chirho;
pub mod modules_chirho;
pub mod filters_chirho;
pub mod search_chirho;
pub mod manager_chirho;
pub mod transport_chirho;
pub mod import_chirho;
pub mod locale_chirho;
pub mod parallels_chirho;

// Re-exports
pub use error_chirho::{ErrorChirho, ResultChirho};
pub use keys_chirho::sw_key_chirho::SwKeyChirho;
pub use keys_chirho::verse_key_chirho::VerseKeyChirho;
pub use keys_chirho::list_key_chirho::ListKeyChirho;
pub use modules_chirho::sw_module_chirho::SwModuleChirho;
pub use modules_chirho::texts_chirho::RawTextChirho;
pub use manager_chirho::sw_mgr_chirho::SwMgrChirho;
#[cfg(feature = "native")]
pub use manager_chirho::install_mgr_chirho::InstallMgrChirho;
pub use config_chirho::InstallSourceChirho;
pub use versification_chirho::{
    VersificationChirho, TestamentChirho, BookInfoChirho,
    kjv_chirho, catholic_chirho, lxx_chirho, synodal_chirho, get_versification_chirho,
};
pub use search_chirho::{
    SearchEngineChirho, SearchOptionsChirho, SearchTypeChirho,
    RegexSearchChirho,
};
#[cfg(feature = "native")]
pub use search_chirho::TantivySearchChirho;
pub use filters_chirho::{
    FilterChirho, FilterOptionsChirho, FilterChainChirho,
    OsisToHtmlFilterChirho, OsisToPlainFilterChirho,
    ThmlToHtmlFilterChirho, ThmlToPlainFilterChirho,
    GbfToHtmlFilterChirho, GbfToPlainFilterChirho,
    InterlinearWordDataChirho, extract_interlinear_words_chirho,
};
pub use locale_chirho::{
    LocaleChirho, LocaleBookChirho, LocaleManagerChirho,
    english_locale_chirho, get_locale_chirho, DEFAULT_LOCALE_CHIRHO,
};
pub use cipher_chirho::{
    CipherChirho, CipherTypeChirho, SwCipherChirho,
    SapphireCipherChirho, XorCipherChirho, NullCipherChirho,
    create_cipher_chirho,
};
pub use parallels_chirho::{
    ParallelPassageChirho, ParallelSetChirho, ParallelTypeChirho,
    ParallelManagerChirho,
};

/// Library version
pub const VERSION_CHIRHO: &str = env!("CARGO_PKG_VERSION");

/// Default versification system
pub const DEFAULT_V11N_CHIRHO: &str = "KJV";

/// Module types
pub mod module_type_chirho {
    /// Biblical text module
    pub const BIBLICAL_TEXT_CHIRHO: &str = "Biblical Texts";
    /// Commentary module
    pub const COMMENTARY_CHIRHO: &str = "Commentaries";
    /// Lexicon/dictionary module
    pub const LEXICON_CHIRHO: &str = "Lexicons / Dictionaries";
    /// General book module
    pub const GENBOOK_CHIRHO: &str = "Generic Books";
    /// Daily devotional module
    pub const DAILY_DEVOTIONAL_CHIRHO: &str = "Daily Devotional";
    /// Glossary module
    pub const GLOSSARY_CHIRHO: &str = "Glossaries";
    /// Image/map module
    pub const IMAGES_CHIRHO: &str = "Images";
}

/// Text direction
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum DirectionChirho {
    /// Left to right (default)
    #[default]
    LeftToRightChirho,
    /// Right to left (Hebrew, Arabic)
    RightToLeftChirho,
    /// Bidirectional
    BidirectionalChirho,
}

/// Text encoding
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum EncodingChirho {
    /// Unknown encoding
    UnknownChirho,
    /// Latin-1 (ISO-8859-1)
    Latin1Chirho,
    /// UTF-8 (default)
    #[default]
    Utf8Chirho,
    /// SCSU (Standard Compression Scheme for Unicode)
    ScsuChirho,
    /// UTF-16
    Utf16Chirho,
}

/// Source markup format
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum MarkupChirho {
    /// Unknown markup
    #[default]
    UnknownChirho,
    /// Plain text
    PlainChirho,
    /// ThML (Theological Markup Language)
    ThmlChirho,
    /// GBF (General Bible Format)
    GbfChirho,
    /// HTML
    HtmlChirho,
    /// OSIS (Open Scripture Information Standard)
    OsisChirho,
    /// TEI (Text Encoding Initiative)
    TeiChirho,
}

/// Block types for compressed modules
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum BlockTypeChirho {
    /// Each verse compressed separately (value: 2)
    VerseBlocksChirho = 2,
    /// Each chapter compressed together (value: 3)
    #[default]
    ChapterBlocksChirho = 3,
    /// Each book compressed together (value: 4)
    BookBlocksChirho = 4,
}

/// Compression types
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum CompressionTypeChirho {
    /// No compression
    #[default]
    NoneChirho,
    /// ZIP/zlib compression
    ZipChirho,
    /// LZSS compression (legacy)
    LzssChirho,
    /// bzip2 compression
    Bzip2Chirho,
    /// XZ/LZMA compression
    XzChirho,
}

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

    #[test]
    fn test_version_chirho() {
        assert!(!VERSION_CHIRHO.is_empty());
    }

    #[test]
    fn test_block_type_values_chirho() {
        assert_eq!(BlockTypeChirho::VerseBlocksChirho as u8, 2);
        assert_eq!(BlockTypeChirho::ChapterBlocksChirho as u8, 3);
        assert_eq!(BlockTypeChirho::BookBlocksChirho as u8, 4);
    }
}

#[cfg(test)]
mod test_indices_chirho;