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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// This file is part of pyphen-rs
//
// Copyright 2008 - Wilbert Berendsen <info@wilbertberendsen.nl>
// Copyright 2012-2013 - Guillaume Ayoub <guillaume.ayoub@kozea.fr>
// Copyright 2019 - Naresh Ganduri <gandurinaresh@gmail.com>
//
// This library is free software.  It is released under the
// GPL 2.0+/LGPL 2.1+/MPL 1.1 tri-license.  See COPYING.GPL, COPYING.LGPL and
// COPYING.MPL for more details.
//
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.

//! A pure Rust port of Python's [Pyphen][1].
//!
//! [1]: https://pyphen.org/

#![warn(clippy::all)]
#![warn(missing_docs)]

mod alternative_parser;
mod data_int;
mod hyph_dict;
mod pyphen;

use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;
use std::thread_local;

use alternative_parser::AlternativeParser;
use data_int::DataInt;
use hyph_dict::HyphDict;
pub use pyphen::{builder::Builder, iter::Iter, Pyphen};

#[macro_use]
extern crate lazy_static;

use regex::Regex;

// precompile some stuff
lazy_static! {
    static ref PARSE_HEX: Regex = Regex::new(r"\^{2}([0-9a-f]{2})").unwrap();
    static ref PARSE: Regex = Regex::new(r"(\d?)(\D?)").unwrap();
}

thread_local! {
    // cache of per-file HyphDict objects
    static HD_CACHE: RefCell<HashMap<String, Rc<HyphDict>>> = RefCell::new(HashMap::new());

    /// A thread-local copy of all available languages
    pub static LANGUAGES: RefCell<HashMap<String, Rc<String>>> = {
        let mut dict = HashMap::new();
        let dir = format!("{}/dictionaries", env!("CARGO_MANIFEST_DIR"));

        if let Ok(read_dir) = std::fs::read_dir(dir) {
            for entry in read_dir {
                if let Ok(entry) = entry {
                    if let Some(filepath) = entry.path().to_str() {
                        let filename = entry.file_name();
                        let filename = filename
                            .to_str()
                            .unwrap()
                            .trim_start_matches("hyph_")
                            .trim_end_matches(".dic");
                        dict.insert(filename.to_string(), Rc::new(filepath.to_string()));
                    }
                }
            }
        }

        RefCell::new(dict)
    }
}

/// Get a fallback language if one is available in our dictionaries.
///
/// <http://www.unicode.org/reports/tr35/#Locale_Inheritance>
///
/// We use the normal truncation inheritance. This function needs aliases
/// including scripts for languages with multiple regions available.
pub fn language_fallback(language: &str) -> Option<String> {
    let language = language.replace('-', "_");
    let mut parts: Vec<_> = language.split('_').collect();

    while !parts.is_empty() {
        let language = parts.join("_");
        let mut flag = false;
        LANGUAGES.with(|l| {
            if l.borrow().contains_key(&language) {
                flag = true;
            }
        });
        if flag {
            return Some(language);
        }

        parts.pop();
    }

    None
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::ops::Deref;

    fn match_tuple<T, U>(tup1: (T, U), s1: &str, s2: &str)
    where
        T: Deref<Target = str>,
        U: Deref<Target = str>,
    {
        let (a, b) = tup1;

        assert_eq!(&*a, s1);
        assert_eq!(&*b, s2);
    }

    fn match_iter<T>(iter: Option<(T, T)>, s1: &str, s2: &str)
    where
        T: Deref<Target = str>,
    {
        assert!(iter.is_some());
        let x = iter.unwrap();
        match_tuple(x, s1, s2);
    }

    fn test_lang(a: Option<String>, b: &str) {
        assert!(a.is_some());
        assert_eq!(a.unwrap(), b);
    }

    ///Test the ``inserted`` method.
    #[test]
    fn test_inserted() {
        let dic = Builder::lang("nl_NL").build().unwrap();
        assert_eq!(dic.inserted("lettergrepen"), "let-ter-gre-pen");
    }

    /// Test the ``wrap`` method.
    #[test]
    fn test_wrap() {
        let dic = Builder::lang("nl_NL").build().unwrap();
        match_tuple(
            dic.wrap("autobandventieldopje", 11).unwrap(),
            "autoband-",
            "ventieldopje",
        );
    }

    /// Test the ``iterate`` method.
    #[test]
    fn test_iterate() {
        let dic = Builder::lang("nl_NL").build().unwrap();
        let mut iter = dic.iterate("Amsterdam");
        match_iter(iter.next(), "Amster", "dam");
        match_iter(iter.next(), "Am", "sterdam");
        assert_eq!(iter.next(), None);
    }

    /// Test the ``iterate`` method with a fallback dict.
    #[test]
    fn test_fallback_dict() {
        let dic = Builder::lang("nl_NL-variant").build().unwrap();
        let mut iter = dic.iterate("Amsterdam");
        match_iter(iter.next(), "Amster", "dam");
        match_iter(iter.next(), "Am", "sterdam");
        assert_eq!(iter.next(), None);
    }

    /// Test a missing dict.
    #[test]
    fn test_missing_dict() {
        assert!(Builder::lang("mi_SS").build().is_err());
    }

    /// Test a personal dict.
    #[test]
    fn test_personal_dict() {
        let dic = Builder::lang("fr").build().unwrap();
        assert_ne!(
            dic.inserted("autobandventieldopje"),
            "au-to-band-ven-tiel-dop-je"
        );
        LANGUAGES.with(|l| {
            let nl = {
                let l = l.borrow();
                l["nl_NL"].clone()
            };
            let mut l = l.borrow_mut();
            let fr = l.get_mut("fr").unwrap();
            *fr = nl;
        });
        let dic = Builder::lang("fr").build().unwrap();
        assert_eq!(
            dic.inserted("autobandventieldopje"),
            "au-to-band-ven-tiel-dop-je"
        );
    }

    /// Test the ``left`` and ``right`` parameters.
    #[test]
    fn test_left_right() {
        let dic = Builder::lang("nl_NL").build().unwrap();
        assert_eq!(dic.inserted("lettergrepen"), "let-ter-gre-pen");
        let dic = Builder::lang("nl_NL").left(4).build().unwrap();
        assert_eq!(dic.inserted("lettergrepen"), "letter-gre-pen");
        let dic = Builder::lang("nl_NL").right(4).build().unwrap();
        assert_eq!(dic.inserted("lettergrepen"), "let-ter-grepen");
        let dic = Builder::lang("nl_NL").left(4).right(4).build().unwrap();
        assert_eq!(dic.inserted("lettergrepen"), "letter-grepen");
    }

    /// Test the ``filename`` parameter.
    #[test]
    fn test_filename() {
        LANGUAGES.with(|l| {
            let l = l.borrow();
            let filename = l["nl_NL"].clone();

            let dic = Builder::filename(filename).build().unwrap();
            assert_eq!(dic.inserted("lettergrepen"), "let-ter-gre-pen");
        });
    }

    /// Test the alternative Parser.
    #[test]
    fn test_alternative() {
        let dic = Builder::lang("hu").left(1).right(1).build().unwrap();
        let mut iter = dic.iterate("kulissza");
        match_iter(iter.next(), "kulisz", "sza");
        match_iter(iter.next(), "ku", "lissza");
        assert_eq!(iter.next(), None);
        assert_eq!(dic.inserted("kulissza"), "ku-lisz-sza");
    }

    /// Test uppercase.
    #[test]
    fn test_upper() {
        let dic = Builder::lang("nl_NL").build().unwrap();
        assert_eq!(dic.inserted("LETTERGREPEN"), "LET-TER-GRE-PEN");
    }

    /// Test uppercase with alternative Parser.
    #[test]
    fn test_upper_alternative() {
        let dic = Builder::lang("hu").left(1).right(1).build().unwrap();
        let mut iter = dic.iterate("KULISSZA");
        match_iter(iter.next(), "KULISZ", "SZA");
        match_iter(iter.next(), "KU", "LISSZA");
        assert_eq!(iter.next(), None);
        assert_eq!(dic.inserted("KULISSZA"), "KU-LISZ-SZA");
    }

    /// Test that all included dictionaries can be parsed.
    #[test]
    fn test_all_dictionaries() {
        LANGUAGES.with(|l| {
            for lang in l.borrow().keys() {
                Builder::lang(lang).build().unwrap();
            }
        });
    }

    /// Test the language fallback algorithm.
    #[test]
    fn test_fallback() {
        test_lang(language_fallback("en"), "en");
        test_lang(language_fallback("en_US"), "en_US");
        test_lang(language_fallback("en_FR"), "en");
        test_lang(language_fallback("en-Latn-US"), "en_Latn_US");
        test_lang(language_fallback("en-Cyrl-US"), "en");
        test_lang(language_fallback("fr-Latn-FR"), "fr");
        test_lang(language_fallback("en-US_variant1-x"), "en_US");
    }
}