Merge pull request #254 from epage/perf

perf(dict): Bypass vars when possible

Author: epage

crates/typos-vars/codegen/src/main.rs

@@ -78,6 +78,7 @@ fn generate_variations<W: std::io::Write>(file: &mut W) {
 
     let mut smallest = usize::MAX;
     let mut largest = usize::MIN;
+    let mut no_invalid = true;
 
     writeln!(
         file,
@@ -97,6 +98,8 @@ fn generate_variations<W: std::io::Write>(file: &mut W) {
         builder.entry(unicase::UniCase::new(word), &value);
         smallest = std::cmp::min(smallest, word.len());
         largest = std::cmp::max(largest, word.len());
+
+        no_invalid &= !is_always_invalid(data);
     }
     let codegenned = builder.build();
     writeln!(file, "{}", codegenned).unwrap();
@@ -110,6 +113,10 @@ fn generate_variations<W: std::io::Write>(file: &mut W) {
     )
     .unwrap();
 
+    writeln!(file).unwrap();
+    writeln!(file, "pub const NO_INVALID: bool = {:?};", no_invalid,).unwrap();
+
+    writeln!(file).unwrap();
     for (symbol, entry) in entries.iter() {
         if !referenced_symbols.contains(symbol.as_str()) {
             continue;
@@ -156,6 +163,15 @@ fn is_always_valid(data: &[(&str, varcon::CategorySet)]) -> bool {
     false
 }
 
+fn is_always_invalid(data: &[(&str, varcon::CategorySet)]) -> bool {
+    for (_symbol, set) in data.iter() {
+        if set.is_empty() {
+            return true;
+        }
+    }
+    false
+}
+
 fn entries() -> BTreeMap<String, varcon_core::Entry> {
     varcon::VARCON
         .iter()

crates/typos-vars/src/vars_codegen.rs

@@ -113083,6 +113083,9 @@ pub static VARS_DICTIONARY: phf::Map<
 };
 
 pub const WORD_RANGE: std::ops::RangeInclusive<usize> = 2..=24;
+
+pub const NO_INVALID: bool = true;
+
 pub(crate) static ENTRY_ABETTORS_7043394254318611656: VariantsMap =
     [&["abettors"], &["abetters"], &["abettors"], &["abetters"]];
 

src/dict.rs

@@ -48,8 +48,10 @@ impl BuiltIn {
             .for_each(|mut s| case_correct(&mut s, word_token.case()));
         Some(corrections)
     }
+}
 
-    #[cfg(feature = "dict")]
+#[cfg(feature = "dict")]
+impl BuiltIn {
     // Not using `Status` to avoid the allocations
     fn correct_with_dict(&self, word: &str) -> Option<&'static [&'static str]> {
         if typos_dict::WORD_RANGE.contains(&word.len()) {
@@ -58,53 +60,55 @@ impl BuiltIn {
             None
         }
     }
+}
 
-    #[cfg(not(feature = "dict"))]
+#[cfg(not(feature = "dict"))]
+impl BuiltIn {
     fn correct_with_dict(&self, _word: &str) -> Option<&'static [&'static str]> {
         None
     }
+}
 
-    #[cfg(feature = "vars")]
+#[cfg(feature = "vars")]
+impl BuiltIn {
     fn chain_with_vars(&self, corrections: &'static [&'static str]) -> Status<'static> {
-        let mut chained: Vec<_> = corrections
-            .iter()
-            .flat_map(|c| match self.correct_with_vars(c) {
-                Some(Status::Valid) | None => vec![Cow::Borrowed(*c)],
-                Some(Status::Corrections(vars)) => vars,
-                Some(Status::Invalid) => {
-                    unreachable!("correct_with_vars should always have valid suggestions")
-                }
-            })
-            .collect();
-        if chained.len() != 1 {
-            chained.sort_unstable();
-            chained.dedup();
+        if self.is_vars_enabled() {
+            let mut chained: Vec<_> = corrections
+                .iter()
+                .flat_map(|c| match self.correct_with_vars(c) {
+                    Some(Status::Valid) | None => vec![Cow::Borrowed(*c)],
+                    Some(Status::Corrections(vars)) => vars,
+                    Some(Status::Invalid) => {
+                        unreachable!("correct_with_vars should always have valid suggestions")
+                    }
+                })
+                .collect();
+            if chained.len() != 1 {
+                chained.sort_unstable();
+                chained.dedup();
+            }
+            debug_assert!(!chained.is_empty());
+            Status::Corrections(chained)
+        } else {
+            Status::Corrections(corrections.iter().map(|c| Cow::Borrowed(*c)).collect())
         }
-        debug_assert!(!chained.is_empty());
-        Status::Corrections(chained)
-    }
-
-    #[cfg(not(feature = "vars"))]
-    fn chain_with_vars(&self, corrections: &'static [&'static str]) -> Status<'static> {
-        Status::Corrections(corrections.iter().map(|c| Cow::Borrowed(*c)).collect())
     }
 
-    #[cfg(feature = "vars")]
     fn correct_with_vars(&self, word: &str) -> Option<Status<'static>> {
-        if typos_vars::WORD_RANGE.contains(&word.len()) {
+        if self.is_vars_enabled() && typos_vars::WORD_RANGE.contains(&word.len()) {
             map_lookup(&typos_vars::VARS_DICTIONARY, word)
                 .map(|variants| self.select_variant(variants))
         } else {
             None
         }
     }
 
-    #[cfg(not(feature = "vars"))]
-    fn correct_with_vars(&self, _word: &str) -> Option<Status<'static>> {
-        None
+    fn is_vars_enabled(&self) -> bool {
+        #![allow(clippy::assertions_on_constants)]
+        debug_assert!(typos_vars::NO_INVALID);
+        self.locale.is_some()
     }
 
-    #[cfg(feature = "vars")]
     fn select_variant(
         &self,
         vars: &'static [(u8, &'static typos_vars::VariantsMap)],
@@ -148,6 +152,17 @@ impl BuiltIn {
     }
 }
 
+#[cfg(not(feature = "vars"))]
+impl BuiltIn {
+    fn chain_with_vars(&self, corrections: &'static [&'static str]) -> Status<'static> {
+        Status::Corrections(corrections.iter().map(|c| Cow::Borrowed(*c)).collect())
+    }
+
+    fn correct_with_vars(&self, _word: &str) -> Option<Status<'static>> {
+        None
+    }
+}
+
 impl typos::Dictionary for BuiltIn {
     fn correct_ident<'s, 'w>(&'s self, ident: typos::tokens::Identifier<'w>) -> Option<Status<'s>> {
         BuiltIn::correct_ident(self, ident)
@@ -296,7 +311,7 @@ mod test {
             typos::tokens::Case::Lower,
             0,
         ));
-        assert_eq!(correction, Some(Status::Valid));
+        assert_eq!(correction, None);
     }
 
     #[cfg(feature = "vars")]