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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

use std::fmt;

use serde::{Deserialize, Serialize};

#[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Hash)]
pub enum FeatureCategory {
    Node(NodeKind),
    Feat(FeatKind),
    Supr(SupraKind),
}

impl fmt::Display for FeatureCategory {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            FeatureCategory::Node(x) => write!(f, "{x}"),
            FeatureCategory::Feat(x) => write!(f, "{x}"),
            FeatureCategory::Supr(x) => write!(f, "{x}"),
        }
    }
}

/// Represents a distinctive feature node
#[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Serialize, Hash)]
pub enum NodeKind {
    Root,
    Manner,
    Laryngeal,
    Place,
    Labial,
    Coronal,
    Dorsal,
    Pharyngeal
}

impl NodeKind {
    pub(crate) const fn count() -> usize { 8 }

    pub(crate) fn from_usize(value: usize) -> Self {
        debug_assert!(NodeKind::count() == 8);
        use NodeKind::*;
        match value {
            0 => {debug_assert_eq!(value, Root as usize); Root}
            1 => {debug_assert_eq!(value, Manner as usize); Manner}
            2 => {debug_assert_eq!(value, Laryngeal as usize); Laryngeal}
            3 => {debug_assert_eq!(value, Place as usize); Place}
            4 => {debug_assert_eq!(value, Labial as usize); Labial}
            5 => {debug_assert_eq!(value, Coronal as usize); Coronal}
            6 => {debug_assert_eq!(value, Dorsal as usize); Dorsal}
            7 => {debug_assert_eq!(value, Pharyngeal as usize); Pharyngeal},
            _ => unreachable!("\nOut of Range converting `{value}` to `NodeType`(max: 7) \nThis is a bug!\n")
        }
    }

    pub(crate) fn as_str(&self) -> &'static str {
        match self {
            NodeKind::Root       => "root",
            NodeKind::Manner     => "manner",
            NodeKind::Laryngeal  => "laryngeal",
            NodeKind::Place      => "place",
            NodeKind::Labial     => "labial",
            NodeKind::Coronal    => "coronal",
            NodeKind::Dorsal     => "dorsal",
            NodeKind::Pharyngeal => "pharyngeal",
        }
    }
}

impl fmt::Display for NodeKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Root         => write!(f, "RUT"),
            Self::Manner       => write!(f, "MAN"),
            Self::Laryngeal    => write!(f, "LAR"),
            Self::Place        => write!(f, "PLC"),
            Self::Labial       => write!(f, "LAB"),
            Self::Coronal      => write!(f, "COR"),
            Self::Dorsal       => write!(f, "DOR"),
            Self::Pharyngeal   => write!(f, "PHR")
        }
    }
}

/// Represents a distinctive feature
#[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Hash)]
pub enum FeatKind { 
    /*RUT*/ Consonantal, Sonorant, Syllabic,      
    /*MAN*/ Continuant, Approximant, Lateral, Nasal, DelayedRelease, Strident, Rhotic, Click,          
    /*LAR*/ Voice, SpreadGlottis, ConstrGlottis,   
    // PLACE Node
    /*LAB*/ Labiodental, Round,          
    /*COR*/ Anterior, Distributed,     
    /*DOR*/ Front, Back, High, Low, Tense, Reduced,        
    /*PHR*/ AdvancedTongueRoot, RetractedTongueRoot, 
}

impl fmt::Display for FeatKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

impl FeatKind {
    pub(crate) const fn count() -> usize { 26 }

    pub(crate) fn from_usize(value: usize) -> Self {
        match value {
            // ROOT node
             0 => Self::Consonantal,
             1 => Self::Sonorant,
             2 => Self::Syllabic,
            // MANNER node
             3 => Self::Continuant,
             4 => Self::Approximant,
             5 => Self::Lateral,
             6 => Self::Nasal,
             7 => Self::DelayedRelease,
             8 => Self::Strident,
             9 => Self::Rhotic,
            10 => Self::Click,
            // LAR node
            11 => Self::Voice,
            12 => Self::SpreadGlottis,
            13 => Self::ConstrGlottis,
            // PLACE Node
            // LABIAL subnode
            14 => Self::Labiodental,
            15 => Self::Round,
            // CORONAL subnode
            16 => Self::Anterior,
            17 => Self::Distributed,
            // DORSAL subnode
            18 => Self::Front,
            19 => Self::Back,
            20 => Self::High,
            21 => Self::Low,
            22 => Self::Tense,
            23 => Self::Reduced,
            // PHAR subnode
            24 => Self::AdvancedTongueRoot,
            25 => Self::RetractedTongueRoot,
            _  => unreachable!("\nOut of Range Error converting `usize` to `FeatType`\nThis is a bug!\n")
        }

    }
    
    pub(crate) fn as_str(&self) -> &'static str {
        match self {
            FeatKind::Consonantal         => "consonantal",
            FeatKind::Sonorant            => "sonorant",
            FeatKind::Syllabic            => "syllabic",
            FeatKind::Continuant          => "continuant",
            FeatKind::Approximant         => "approx.",
            FeatKind::Lateral             => "lateral",
            FeatKind::Nasal               => "nasal",
            FeatKind::DelayedRelease      => "del.rel.",
            FeatKind::Strident            => "strident",
            FeatKind::Rhotic              => "rhotic",
            FeatKind::Click               => "click",
            FeatKind::Voice               => "voice",
            FeatKind::SpreadGlottis       => "s.g.",
            FeatKind::ConstrGlottis       => "c.g.",
            FeatKind::Labiodental         => "labiodental",
            FeatKind::Round               => "round",
            FeatKind::Anterior            => "anterior",
            FeatKind::Distributed         => "distributed",
            FeatKind::Front               => "front",
            FeatKind::Back                => "back",
            FeatKind::High                => "high",
            FeatKind::Low                 => "low",
            FeatKind::Tense               => "tense",
            FeatKind::Reduced             => "reduced",
            FeatKind::AdvancedTongueRoot  => "atr",
            FeatKind::RetractedTongueRoot => "rtr",
        }
    }

    /// Returns the node and bitmask of the feature
    pub const fn as_node_mask(&self) -> (NodeKind, u8) {
        match self {
            Self::Consonantal         => (NodeKind::Root, 0b100),
            Self::Sonorant            => (NodeKind::Root, 0b010),
            Self::Syllabic            => (NodeKind::Root, 0b001),
            
            Self::Continuant          => (NodeKind::Manner, 0b10000000),
            Self::Approximant         => (NodeKind::Manner, 0b01000000),
            Self::Lateral             => (NodeKind::Manner, 0b00100000),
            Self::Nasal               => (NodeKind::Manner, 0b00010000),
            Self::DelayedRelease      => (NodeKind::Manner, 0b00001000),
            Self::Strident            => (NodeKind::Manner, 0b00000100),
            Self::Rhotic              => (NodeKind::Manner, 0b00000010),
            Self::Click               => (NodeKind::Manner, 0b00000001),
            
            Self::Voice               => (NodeKind::Laryngeal, 0b100),
            Self::SpreadGlottis       => (NodeKind::Laryngeal, 0b010),
            Self::ConstrGlottis       => (NodeKind::Laryngeal, 0b001),
            
            Self::Labiodental         => (NodeKind::Labial, 0b10),
            Self::Round               => (NodeKind::Labial, 0b01),

            Self::Anterior            => (NodeKind::Coronal, 0b10),
            Self::Distributed         => (NodeKind::Coronal, 0b01),

            Self::Front               => (NodeKind::Dorsal, 0b100000),
            Self::Back                => (NodeKind::Dorsal, 0b010000),
            Self::High                => (NodeKind::Dorsal, 0b001000),
            Self::Low                 => (NodeKind::Dorsal, 0b000100),
            Self::Tense               => (NodeKind::Dorsal, 0b000010),
            Self::Reduced             => (NodeKind::Dorsal, 0b000001),

            Self::AdvancedTongueRoot  => (NodeKind::Pharyngeal, 0b10),
            Self::RetractedTongueRoot => (NodeKind::Pharyngeal, 0b01),
        }
    }
}

/// Represents a suprasegmental feature
#[derive(Debug, Copy, Clone, PartialEq, Eq, Deserialize, Hash)]
pub enum SupraKind {
    Long,       // ±long
    Overlong,   // ±overlong
    Stress,     // ±stress    (+ matches prim and sec, - matches unstressed)
    SecStress,  // ±secstress (+ matches sec, - matches prim and unstressed)
    Tone,       // Can only be used with : notation (e.g. Tone : 213 )
    LengthPair, // Can only be used with alpha notation (e.g. Alength)
    StressPair, // Can only be used with alpha notation (e.g. Astress)
}

impl fmt::Display for SupraKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SupraKind::Long       => write!(f, "long"),
            SupraKind::Overlong   => write!(f, "overlng"),
            SupraKind::Stress     => write!(f, "str"),
            SupraKind::SecStress  => write!(f, "secstr"),
            SupraKind::Tone       => write!(f, "tone"),
            SupraKind::LengthPair => write!(f, "lenpair"),
            SupraKind::StressPair => write!(f, "strpair"),
        }
    }
}