Implement experimental Sindarin (Mode of Gondor) support

Yaulendil · Mar 30, 2021 · d1fa25f · d1fa25f
1 parent cb5a091
commit d1fa25f
Show file tree

Hide file tree

Showing 7 changed files with 591 additions and 34 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "tengwar"
 description = "Transcribe romanized text into J.R.R. Tolkien's Tengwar."
-version = "0.1.0"
+version = "0.2.0"
 
 authors = ["Yaulendil <davarice@protonmail.com>"]
 repository = "https://github.com/yaulendil/tengwar-rs"

diff --git a/src/characters.rs b/src/characters.rs
@@ -68,6 +68,7 @@ mod _vowels {
     pub const TEHTA_I: Tehta = Tehta::basic('');
     pub const TEHTA_O: Tehta = Tehta::basic('');
     pub const TEHTA_U: Tehta = Tehta::basic('');
+    pub const TEHTA_Y: Tehta = Tehta::basic('');
 }
 
 
@@ -80,6 +81,7 @@ mod _vowels {
     pub const TEHTA_I: Tehta = Tehta::with_double('');
     pub const TEHTA_O: Tehta = Tehta::with_double('');
     pub const TEHTA_U: Tehta = Tehta::with_double('');
+    pub const TEHTA_Y: Tehta = Tehta::basic('');
 }
 
 
@@ -92,6 +94,7 @@ mod _vowels {
     pub const TEHTA_I: Tehta = Tehta::with_variant('', '');
     pub const TEHTA_O: Tehta = Tehta::with_variant('', '');
     pub const TEHTA_U: Tehta = Tehta::with_variant('', '');
+    pub const TEHTA_Y: Tehta = Tehta::basic('');
 }
 
 
@@ -263,6 +266,12 @@ impl Tehta {
             f.write_char(self.base)
         }
     }
+
+    /// Returns true if the long variant of this Tehta would be written with the
+    ///     extended "Ára" Telco.
+    pub const fn uses_ara(&self) -> bool {
+        !self.double && self.long.is_none()
+    }
 }
 
 
@@ -320,10 +329,17 @@ pub struct Glyph {
     /// If Silmë follows another tengwa, the base character may be modified by
     ///     a sa-rincë instead.
     pub silme: bool,
+    /// A labialized consonant is represented by an additional diacritic.
+    pub nasal: bool,
+    /// A labialized consonant is represented by an additional diacritic.
+    pub labial: bool,
     /// A palatalized vowel is represented by an additional diacritic.
     pub palatal: bool,
     pub long_cons: bool,
     pub long_vowel: bool,
+    /// Indicates whether a long vowel using the extended "Ára" Telco should be
+    ///     placed before this glyph.
+    pub long_first: bool,
 }
 
 
@@ -333,9 +349,12 @@ impl Glyph {
             cons: None,
             vowel: None,
             silme: false,
+            nasal: false,
+            labial: false,
             palatal: false,
             long_cons: false,
             long_vowel: false,
+            long_first: false,
         }
     }
 
@@ -363,6 +382,16 @@ impl Glyph {
         }
     }
 
+    pub const fn with_labial(mut self) -> Self {
+        self.labial = true;
+        self
+    }
+
+    pub const fn with_nasal(mut self) -> Self {
+        self.nasal = true;
+        self
+    }
+
     pub const fn with_palatal(mut self) -> Self {
         self.palatal = true;
         self
@@ -403,30 +432,84 @@ impl Glyph {
 
 impl fmt::Display for Glyph {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
-        let Glyph { cons, vowel, silme, palatal, long_cons, long_vowel } = self;
-        let (base, rince): (char, bool) = match cons {
-            Some(ch) => self.get_base(*ch),
-            None => (carrier(*long_vowel), *silme),
-        };
+        let Glyph {
+            cons, vowel, silme,
+            nasal, labial, palatal,
+            long_cons, long_vowel, long_first,
+        } = self;
+
+        let vowel_first: bool = *long_first
+            && (*long_vowel || *labial)
+            && cons.is_some();
+
+        if vowel_first {
+            if let Some(vowel) = vowel {
+                if vowel.uses_ara() && *long_vowel {
+                    vowel.write(f, true)?;
+                } else {
+                    f.write_char(carrier(*long_vowel))?;
+                    vowel.write(f, false)?;
+                }
+            }
 
-        f.write_char(base)?;
+            let (base, rince) = self.get_base(cons.unwrap());
 
-        if *long_cons {
-            f.write_char(MOD_LONG_CONS)?;
-        }
+            f.write_char(base)?;
 
-        if *palatal {
-            f.write_char(MOD_PALATAL)?;
-        }
+            if *nasal {
+                f.write_char(MOD_NASAL)?;
+            }
 
-        if let Some(vowel) = vowel {
-            vowel.write(f, *long_vowel && cons.is_some())?;
-        }
+            if *long_cons {
+                f.write_char(MOD_LONG_CONS)?;
+            }
 
-        if rince {
-            f.write_char(mod_rince(base))?;
-        }
+            if *labial {
+                f.write_char(MOD_LABIAL)?;
+            }
+
+            if *palatal {
+                f.write_char(MOD_PALATAL)?;
+            }
 
-        Ok(())
+            if rince {
+                f.write_char(mod_rince(base))?;
+            }
+
+            Ok(())
+        } else {
+            let (base, rince): (char, bool) = match cons {
+                Some(ch) => self.get_base(*ch),
+                None => (carrier(*long_vowel), *silme),
+            };
+
+            f.write_char(base)?;
+
+            if *nasal {
+                f.write_char(MOD_NASAL)?;
+            }
+
+            if *long_cons {
+                f.write_char(MOD_LONG_CONS)?;
+            }
+
+            if *labial {
+                f.write_char(MOD_LABIAL)?;
+            }
+
+            if *palatal {
+                f.write_char(MOD_PALATAL)?;
+            }
+
+            if let Some(vowel) = vowel {
+                vowel.write(f, *long_vowel && cons.is_some())?;
+            }
+
+            if rince {
+                f.write_char(mod_rince(base))?;
+            }
+
+            Ok(())
+        }
     }
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,9 +1,11 @@
 pub mod characters;
 pub mod etc;
 pub mod quenya;
+pub mod sindarin;
 
 pub use characters::{int_10, int_12};
 pub use quenya::Quenya;
+pub use sindarin::Sindarin;
 use std::{borrow::Cow, fmt::{self, Write}};
 
 

diff --git a/src/main.rs b/src/main.rs
@@ -3,13 +3,13 @@ use std::{
     io::{BufRead, stdin, stdout, Write},
     process::exit,
 };
-use tengwar::{Quenya, Rules};
+use tengwar::{Quenya, Rules, Sindarin};
 
 
 #[derive(Debug)]
 enum Mode {
     Quenya,
-    /*Sindarin,*/
+    Sindarin,
     /*Beleriand,*/
     /*English,*/
 }
@@ -20,12 +20,12 @@ impl Mode {
 
     const fn new(
         quenya: bool,
-        /*sindarin: bool,*/
+        sindarin: bool,
         /*beleriand: bool,*/
         /*english: bool,*/
     ) -> Result<Mode, u32> {
         let n = quenya as u32
-            /*+ sindarin as u32*/
+            + sindarin as u32
             /*+ beleriand as u32*/
             /*+ english as u32*/;
 
@@ -35,8 +35,8 @@ impl Mode {
             Err(n)
         } else if quenya {
             Ok(Mode::Quenya)
-        /*} else if sindarin {
-            Ok(Mode::Sindarin)*/
+        } else if sindarin {
+            Ok(Mode::Sindarin)
         /*} else if beleriand {
             Ok(Mode::Beleriand)*/
         /*} else if english {
@@ -49,7 +49,7 @@ impl Mode {
     fn rules<T: AsRef<str>>(&self) -> fn(T) -> String {
         match self {
             Mode::Quenya => { Quenya::transcribe }
-            /*Mode::Sindarin => { Sindarin::transcribe }*/
+            Mode::Sindarin => { Sindarin::transcribe }
             /*Mode::Beleriand => { Beleriand::transcribe }*/
             /*Mode::English => { English::transcribe }*/
         }
@@ -77,9 +77,9 @@ struct Command {
     #[argh(switch, short = 'q')]
     quenya: bool,
 
-    /*/// transliterate in the Sindarin mode
+    /// transliterate in the Sindarin mode (experimental)
     #[argh(switch, short = 's')]
-    sindarin: bool,*/
+    sindarin: bool,
 
     /*/// transliterate in the Mode of Beleriand
     #[argh(switch, short = 'b')]
@@ -99,7 +99,7 @@ impl Command {
     const fn mode(&self) -> Result<Mode, u32> {
         Mode::new(
             self.quenya,
-            /*self.sindarin,*/
+            self.sindarin,
             /*self.beleriand,*/
             /*self.english,*/
         )