asca 0.10.0

A linguistic sound change applier
Documentation
mod trie;
pub mod word;
pub mod rule;
pub mod error;
mod alias;

use indexmap::IndexMap;
use rayon::iter::{IndexedParallelIterator, IntoParallelRefIterator, ParallelIterator};
use serde::Deserialize;
use std::collections::HashMap;
use lazy_static::lazy_static;
use wasm_bindgen::prelude::*;

use alias :: Transformation;
use trie  :: *;
use word  :: { DiaMods, Diacritic, * };
use error :: { ASCAError,  * };
use rule  :: { trace::Change, BinMod, ModKind, Rule, RuleGroup };

const CARDINALS_FILE: &str = include_str!("cardinals.json");
const DIACRITIC_FILE: &str = include_str!("diacritics.json");
lazy_static! {
    static ref CARDINALS_MAP: IndexMap<String, Segment> = serde_json::from_str(CARDINALS_FILE).unwrap();
    static ref DIACRITS: Vec<Diacritic> = {
        // this seems very unnecessary, but I don't know enough about serde
        // at least it works
        #[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Hash)]
        pub enum DiaFeatType {
            Root, Manner, Laryngeal, Place, Labial, Coronal, Dorsal, Pharyngeal, 
            /*RUT*/ Consonantal, Sonorant, Syllabic,      
            /*MAN*/ Continuant, Approximant, Lateral, Nasal, DelayedRelease, Strident, Rhotic, Click,          
            /*LAR*/ Voice, SpreadGlottis, ConstrGlottis,   
            /*LAB*/ Labiodental, Round,          
            /*COR*/ Anterior, Distributed,     
            /*DOR*/ Front, Back, High, Low, Tense, Reduced,        
            /*PHR*/ AdvancedTongueRoot, RetractedTongueRoot, 
        }
        
        #[derive(Deserialize)]
        struct DT {
            pub name: String,
            pub diacrit: char,
            pub prereqs: Option<HashMap<DiaFeatType, bool>>,
            pub payload: Option<HashMap<DiaFeatType, bool>>,
        }

        impl DT {
            pub fn hm_to_mod(&self, hm: &Option<HashMap<DiaFeatType, bool>>) -> DiaMods {
                let mut args = DiaMods::new();
                // if hm.is_none() {return args};
                let Some(s) = hm else {return args};
                for (key, value) in s.iter() {
                    let x = *key as usize;
                    match value {
                        true =>{
                            if x > 7 { args.feats[x - 8] = Some(ModKind::Binary(BinMod::Positive)) }
                            else { args.nodes[x] = Some(ModKind::Binary(BinMod::Positive)) };
                        },
                        false => {
                            if x > 7 { args.feats[x - 8] = Some(ModKind::Binary(BinMod::Negative)) } 
                            else { args.nodes[x] = Some(ModKind::Binary(BinMod::Negative)) };
                        }
                    }
                }
                args
            }

            pub fn to_diacritic(&self) ->  Diacritic {
                Diacritic { 
                    name: self.name.clone(), 
                    diacrit: self.diacrit, 
                    prereqs: self.hm_to_mod(&self.prereqs), 
                    payload: self.hm_to_mod(&self.payload)
                }
            }
        }

        let dt: Vec<DT> = serde_json::from_str(DIACRITIC_FILE).unwrap();

        dt.iter().map(|x| x.to_diacritic()).collect()
    };
    static ref CARDINALS_TRIE: Trie = {
        let mut m = Trie::new();
        CARDINALS_MAP.keys().for_each(|k| m.insert(k.as_str()));
        m
    };    
}

fn apply_rule_groups(rules: &[Vec<Rule>], phrases: &[Phrase]) -> Result<Vec<Phrase>, ASCAError> {
    let mut transformed_phrases: Vec<Phrase> = Vec::with_capacity(phrases.len());

    for phrase in phrases {
        transformed_phrases.push(phrase.apply_all(rules)?);
    }

    Ok(transformed_phrases)
}

fn apply_rules_trace(rules: &[Vec<Rule>], phrase: &Phrase) -> Result<Vec<Change>, ASCAError> {   
    let mut changes: Vec<Change> = Vec::new();

    let mut res_phrase = phrase.clone();
    for (i, rule_group) in rules.iter().enumerate() {
        let res_before = res_phrase.clone();
        for rule in rule_group {
            res_phrase = rule.apply(res_phrase)?;
        }
        if res_phrase != res_before {
            changes.push(Change { rule_index: i, after: res_phrase.clone() });
        }
    }

    Ok(changes)
}

fn phrases_to_string(phrases: Vec<Phrase>, alias_from: Vec<Transformation>) -> Result<(Vec<String>, Vec<Segment>), ASCAError> {
    let mut res = Vec::with_capacity(phrases.len());
    let mut unknowns = Vec::new();

    let mut phr_res = String::with_capacity(1);
    for phrase in phrases {
        phr_res.clear();
        // let mut phr_res = String::with_capacity(phrase.len());
        for word in phrase.iter() {
            let (w, u) = word.render_debug(&alias_from)?;
            phr_res.push(' ');
            phr_res.push_str(&w);
            unknowns.extend(u);
        }
        res.push(phr_res.trim().to_string());
    }

    Ok((res, unknowns))
}

fn parse_rule_groups(unparsed_rule_groups: &[RuleGroup]) -> Result<Vec<Vec<Rule>>, RuleSyntaxError> {
    unparsed_rule_groups.iter().enumerate().map(|(rgi, rg)| {
        rg.rule.iter().enumerate().filter_map(|(ri, r)| {
            match rule::Lexer::new(&r.chars().collect::<Vec<_>>(), rgi, ri).get_line() {
                Ok(tokens) => {
                    match rule::Parser::new(tokens, rgi, ri).parse() {
                        Ok(rule) => rule.map(Ok),
                        Err(e) => Some(Err(e)),
                    }
                }
                Err(e) => Some(Err(e)),
            }
        }).collect::<Result<Vec<Rule>, RuleSyntaxError>>()
    }).collect::<Result<Vec<Vec<Rule>>, RuleSyntaxError>>()
}

pub fn run_unparsed(unparsed_rules: &[RuleGroup], unparsed_phrases: &[String], unparsed_into: &[String], unparsed_from: &[String]) -> Result<Vec<String>, ASCAError> {
    let rules = parse_rule_groups(unparsed_rules)?;
    let alias_into = alias::parse_into(unparsed_into)?;
    let alias_from = alias::parse_from(unparsed_from)?;

    unparsed_phrases.iter().map(|up| {
        let phrase = match up.split(' ').map(|w| Word::with(w, &alias_into)).collect::<Result<Phrase, _>>() {
            Ok(ph) => ph,
            Err(e) => return Err(e),
        };

        let applied = match phrase.apply_all(&rules) {
            Ok(ap) => ap,
            Err(e) => return Err(e),
        };

        match applied.iter().map(|word| { word.render_with(&alias_from) }).collect::<Result<Vec<_>, _>>() {
            Ok(y) => Ok(y.join(" ")),
            Err(e) => Err(e),
        }
    }).collect()
}

type ParsedPhrases = Vec<String>;
type OutputPhrases = Vec<String>;
type UnknownSegments = Vec<String>;

pub fn run_unparsed_debug(unparsed_rules: &[RuleGroup], unparsed_phrases: &[String], unparsed_into: &[String], unparsed_from: &[String]) -> Result<(ParsedPhrases, OutputPhrases, UnknownSegments), ASCAError> {
    let rules = parallel_parse_rule_groups(unparsed_rules)?;
    let alias_into = alias::parse_into(unparsed_into)?;
    let alias_from = alias::parse_from(unparsed_from)?;
    
    let (input, applied) = unparsed_phrases.par_iter().map(|up| {
        let phrase = match up.trim_end().split(' ').map(|w| Word::with(w, &alias_into)).collect::<Result<Phrase, _>>() {
            Ok(ph) => ph,
            Err(e) => return Err(e),
        };

        let rendered_input = match phrase.iter().map(|word| word.render_with(&[])).collect::<Result<Vec<_>, _>>() {
            Ok(ri) => ri.join(" "),
            Err(e) => return Err(e),
        };

        let applied = match phrase.apply_all(&rules) {
            Ok(ap) => ap,
            Err(e) => return Err(e),
        };

        Ok((rendered_input, applied))
    }).collect::<Result<(Vec<String>, Vec<Phrase>), ASCAError>>()?;

    let (output, unknowns) = phrases_to_string(applied, alias_from)?;

    let unknowns = unknowns.iter().map(|seg| format!("{seg:?}")).collect();

    Ok((input, output, unknowns))
}

pub fn par_run_unparsed(unparsed_rules: &[RuleGroup], unparsed_phrases: &[String], unparsed_into: &[String], unparsed_from: &[String]) -> Result<Vec<String>, ASCAError> {
    let rules = parallel_parse_rule_groups(unparsed_rules)?;
    let alias_into = alias::parse_into(unparsed_into)?;
    let alias_from = alias::parse_from(unparsed_from)?;

    unparsed_phrases.par_iter().map(|up| {
        let phrase = match up.trim_end().split(' ').map(|w| Word::with(w, &alias_into)).collect::<Result<Phrase, _>>() {
            Ok(ph) => ph,
            Err(e) => return Err(e),
        };

        let applied = match phrase.apply_all(&rules) {
            Ok(ap) => ap,
            Err(e) => return Err(e),
        };

        match applied.iter().map(|word| { word.render_with(&alias_from) }).collect::<Result<Vec<_>, _>>() {
            Ok(y) => Ok(y.join(" ")),
            Err(e) => Err(e),
        }
    }).collect()
}

fn parallel_parse_rule_groups(unparsed_rule_groups: &[RuleGroup]) -> Result<Vec<Vec<Rule>>, RuleSyntaxError> {
    unparsed_rule_groups.par_iter().enumerate().map(|(rgi, rg)| {
        rg.rule.par_iter().enumerate().filter_map(|(ri, r): (usize, &String)| {
            match rule::Lexer::new(&r.chars().collect::<Vec<_>>(), rgi, ri).get_line() {
                Ok(tokens) => {
                    match rule::Parser::new(tokens, rgi, ri).parse() {
                        Ok(rule) => rule.map(Ok),
                        Err(e) => Some(Err(e)),
                    }
                }
                Err(e) => Some(Err(e)),
            }
        }).collect::<Result<Vec<Rule>, RuleSyntaxError>>()
    }).collect::<Result<Vec<Vec<Rule>>, RuleSyntaxError>>()
}

// For interop with WebASCA

#[doc(hidden)]
#[wasm_bindgen]
pub struct WasmResult {
    input: Vec<String>,         // parsed input
    output: Vec<String>,
    unknowns: Vec<String>,      // Any segments that were unable to be parsed
    trace_rules: Vec<usize>,    // Indices of rules which were applied
    was_ok: bool                // Did we error, or succeed?
}

#[wasm_bindgen]
impl WasmResult {
    pub fn get_input(&self) -> Vec<String> {
        self.input.clone()
    }

    pub fn get_output(&self) -> Vec<String> {
        self.output.clone()
    }

    pub fn get_unknowns(&self) -> Vec<String> {
        self.unknowns.clone()
    }

    pub fn get_traces(&self) -> Vec<usize> {
        self.trace_rules.clone()
    }

    pub fn was_ok(&self) -> bool {
        self.was_ok
    }
}

#[doc(hidden)]
#[wasm_bindgen]
pub fn run_wasm(val: JsValue, unparsed_phrases: Vec<String>, unparsed_into: Vec<String>, unparsed_from: Vec<String>, trace_index: Option<usize>) -> WasmResult {
    let unparsed_rules: Vec<RuleGroup> = serde_wasm_bindgen::from_value(val).expect("Rules are in valid JSObject format");
    
    match trace_index {
        Some(ti) => match run_trace_wasm(&unparsed_rules, &unparsed_phrases, &unparsed_into, ti) {
            Ok((input, output, unknowns, trace_rules)) => WasmResult { input: vec![input], output, unknowns, trace_rules, was_ok: true },
            Err(e) => parse_error_web(&e, &unparsed_rules, &unparsed_into, &unparsed_from, &unparsed_phrases),
        }
        None => match run_unparsed_debug(&unparsed_rules, &unparsed_phrases, &unparsed_into, &unparsed_from) {
            Ok((input, output, unknowns)) => WasmResult { input, output, unknowns, trace_rules: vec![], was_ok: true },
            Err(e) => parse_error_web(&e, &unparsed_rules, &unparsed_into, &unparsed_from, &unparsed_phrases),
        }
    }
}

#[inline]
fn get_trace_phrase(unparsed_phrases: &[String], alias_into: &[String], trace_index: usize) -> Result<Option<Phrase>, ASCAError> {
    match unparsed_phrases.get(trace_index) {
        Some(phrase) => Ok(Some(Phrase::try_from(phrase, alias_into)?)),
        None => Ok(None),
    }
}


type RuleIndices = Vec<usize>;

fn run_trace_wasm(unparsed_rules: &[RuleGroup], unparsed_phrase: &[String], alias_into: &[String], trace_index: usize) -> Result<(String, Vec<String>, UnknownSegments, RuleIndices), ASCAError> {
    let rules = parallel_parse_rule_groups(unparsed_rules)?;
    let phrase = get_trace_phrase(unparsed_phrase, alias_into, trace_index)?.unwrap_or_default();
    let res = apply_rules_trace(&rules, &phrase)?;
    
    let rendered_input = match phrase.iter().map(|word| word.render_with(&[])).collect::<Result<Vec<_>, _>>() {
        Ok(ri) => ri.join(" "),
        Err(e) => return Err(e),
    };
    
    let (output, unknowns, rule_indices) = rule::trace::to_string_wasm(&phrase, res, unparsed_rules)?;

    Ok((rendered_input, output, unknowns, rule_indices))
}

fn parse_error_web(err: &ASCAError, unparsed_rules: &[RuleGroup], unparsed_into: &[String], unparsed_from: &[String], unparsed_phrases: &[String]) -> WasmResult {
    let output = match err {
        ASCAError::WordSyn(e) => e.format(),
        ASCAError::AliasSyn(e) => e.format(unparsed_into, unparsed_from),
        ASCAError::AliasRun(e) => e.format(unparsed_into, unparsed_from),
        ASCAError::RuleSyn(e) => e.format(unparsed_rules),
        ASCAError::RuleRun(e) => e.format(unparsed_rules),
    };

    WasmResult { input: unparsed_phrases.to_vec(), output: vec![output], unknowns: vec![], trace_rules: vec![], was_ok: false }
}