asca 0.10.0

A linguistic sound change applier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use crate :: {
    error :: {ASCAError, RuleSyntaxError}, 
    word  :: Phrase
};
use super::{trace::Change, Rule};

/// The unparsed ASCA Rule Group
#[derive(Default, Debug, Clone, serde::Deserialize, serde::Serialize)]
pub struct RuleGroup {
    pub name: String,
    pub rule: Vec<String>,
    pub description: String, 
}

impl RuleGroup {
    pub fn new() -> Self {
        Self { name: String::new(), rule: Vec::new(), description: String::new() }
    }

    pub fn is_empty(&self) -> bool {
        self.name.is_empty() && self.rule.is_empty() && self.description.is_empty()
    }
}


#[derive(Default, Debug)]
pub struct RuleGroupBuilder {
    name: String,
    rule: Vec<String>,
    description: String, 
}

impl RuleGroupBuilder {
    pub fn new() -> Self {
        Self { name: String::new(), rule: Vec::new(), description: String::new() }
    }

    pub fn name<T: Into<String>>(mut self, name: T) -> Self {
        self.name = name.into();
        self
    }

    pub fn desc<T: Into<String>>(mut self, desc: T) -> Self {
        self.description = desc.into();
        self
    }

    pub fn rules<T: Into<String>>(mut self, rule: Vec<T>) -> Self {
        rule.into_iter().for_each(| r| {
            self.rule.push(r.into());
        });
        self
    }

    pub fn rule<T: Into<String>>(mut self, rule: T) -> Self {
        self.rule.push(rule.into());
        self
    }

    pub fn build(self) -> RuleGroup {
        RuleGroup { name: self.name, rule: self.rule, description: self.description }
    }
}

/// SOA of the parsed ASCA Rule Group
#[derive(Default, Debug, Clone)]
pub struct ParsedRules {
    pub names: Vec<String>,
    pub rules: Vec<Vec<Rule>>,
    pub descs: Vec<String>,
}

impl TryFrom<Vec<RuleGroup>> for ParsedRules {    
    type Error = RuleSyntaxError;
    
    fn try_from(rgs: Vec<RuleGroup>) -> Result<Self, Self::Error> {
        let names: Vec<String> = rgs.iter().map(|v| v.name.clone()).collect();
        let rules = crate::parse_rule_groups(&rgs)?;
        let descs: Vec<String> = rgs.iter().map(|v| v.description.clone()).collect();

        Ok(Self { names, rules, descs })
    }
}

impl<'a>  IntoIterator for &'a ParsedRules {
    type Item = (&'a str, &'a [Rule], &'a str);

    type IntoIter = ParsedRulesIter<'a>;

    fn into_iter(self) -> Self::IntoIter {
        ParsedRulesIter {
            pr: self,
            index: 0,
        }
    }
}

impl ParsedRules {

    pub fn new() -> Self {
        Self { names: Vec::new(), rules: Vec::new(), descs: Vec::new() }
    }

    /// Applies self to the input phrases
    pub fn apply(&self, phrases: &[Phrase]) -> Result<Vec<Phrase>, ASCAError> {        
        crate::apply_rule_groups(&self.rules, phrases)
    }

    /// Returns the changes that affect the input phrase
    pub fn trace(&self, phrase: &Phrase) -> Result<Vec<Change>, ASCAError> {        
        crate::apply_rules_trace(&self.rules, phrase)
    }

    /// Returns an array of references to the traced rules or None if out of bounds.
    pub fn get_traced_rules(&self, changes: &[Change]) -> Option<Vec<(&String, &Vec<Rule>, &String)>> {
        changes.iter().map(|Change { rule_index: i, .. }| {
            match (self.names.get(*i), self.rules.get(*i), self.descs.get(*i)) {
                (Some(n), Some(r), Some(d)) => Some((n, r, d)),
                _ => None,
            }
        }).collect()
    }
}

pub struct ParsedRulesIter<'a> {
    pr: &'a ParsedRules,
    index: usize
}

impl<'a> Iterator for ParsedRulesIter<'a> {
    type Item = (&'a str, &'a [Rule], &'a str);

    fn next(&mut self) -> Option<Self::Item> {

        let n = self.pr.names.get(self.index);
        let r = self.pr.rules.get(self.index);
        let d = self.pr.descs.get(self.index);

        if n.is_some() && r.is_some() && d.is_some() {
            self.index += 1;
            Some((
                unsafe { n.unwrap_unchecked() }, 
                unsafe { r.unwrap_unchecked() }, 
                unsafe { d.unwrap_unchecked() }
            ))
        } else {
            None
        }

    }
}