auto_correct 0.1.9

A library to provide auto correct suggestions. Currently supporting EN-US.
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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
#![allow(unreachable_patterns)]

use std::fs::File;
use std::io::{BufRead, BufReader};
use std::path::PathBuf;
use std::str::Chars;
use std::cmp::Ordering;

use crossbeam_channel as channel;
use crate::AutoCorrect;
use crate::candidate::Candidate;
use crate::config::Config;
use crate::stores;
use crate::SupportedLocale;
use crate::support::en_us;
use crate::trie::{check_bitmap, Node};

pub static DELIM: &'static str = ",";
pub static DEFAULT_LOCALE: &'static str = "en-us";

pub(crate) fn ins_repl(
    word: &str,
    current_edit: u8,
    tx_curr: channel::Sender<Candidate>,
    tx_next: Option<channel::Sender<(String, u32)>>,
    marker: u32,
) {
    let size = word.len();
    if size == 0 {
        return;
    }

    let len = en_us::ALPHABET.len();

    for idx in 0..len {
        let rune = en_us::ALPHABET[idx];
        let rune_code = get_char_code(rune, 0);

        for pos in 0..=size {
            if check_bit(marker, pos) || !check_bitmap(rune_code, pos) {
                // early termination for duplicate or unrealistic cases
                continue;
            }

            if pos > 0 {
                let (left, right) = {
                    if pos < size {
                        // 0 < pos < size
                        (&word[0..pos], &word[pos..size])
                    } else {
                        // pos == size
                        (word, "")
                    }
                };

                if pos == 1 && rune.cmp(left) == Ordering::Equal {
                    // insert at pos 0 has already handled this case
                    continue;
                }

                if size > 2 && pos == size - 1 && rune.cmp(right) == Ordering::Equal {
                    // insert at pos (size - 1) has already handled this case
                    continue;
                }

                // insert
                send_one([left, rune, right].join(""),
                         current_edit, &tx_curr, &tx_next, mark_bit(marker, pos, true));

                // replace
                if rune_code != get_char_code(word, pos - 1) {
                    send_one([&left[..pos - 1], rune, right].join(""),
                             current_edit, &tx_curr, &tx_next, mark_bit(marker, pos, false));
                }
            } else {
                // if pos == 0, just insert
                send_one([rune, word].join(""),
                         current_edit, &tx_curr, &tx_next, mark_bit(marker, pos, true));
            }
        }
    }
}

pub(crate) fn del_tran(
    word: &str,
    current_edit: u8,
    tx_curr: channel::Sender<Candidate>,
    tx_next: Option<channel::Sender<(String, u32)>>,
    marker: u32
) {
    let size = word.len();
    if size <= 1 {
        return;
    }

    for pos in 1..=size {
        let (left, del, right) =
            if pos < size {
                (&word[..pos - 1], &word[pos - 1..pos], &word[pos..])
            } else {
                (&word[..size - 1], &word[size - 1..size], "")
            };

        if pos < size && del.cmp(&right[..1]) == Ordering::Equal{
            continue;
        }

        // delete
        send_one([left, right].join(""),
                 current_edit, &tx_curr, &tx_next, marker);

        // transpose
        if pos < size {
            send_one([left, &right[..1], del, &right[1..]].join(""),
                     current_edit, &tx_curr, &tx_next, marker);
        }
    }
}

fn send_one(
    target: String,
    edit: u8,
    chan: &channel::Sender<Candidate>,
    tx_next: &Option<channel::Sender<(String, u32)>>,
    marker: u32
) {
    if let Some(next_chan) = tx_next {
        if !stores::contains(&target) {
            next_chan
                .send((target.clone(), marker))
                .unwrap_or_else(|err| {
                    eprintln!("Failed to search the string: {:?}", err);
                });
        }
    }

    if let Some(score) = Node::check(&target) {
        chan
            .send(Candidate::new(target, score, edit))
            .unwrap_or_else(|err| {
                eprintln!("Failed to search the string: {:?}", err);
            });
    }
}

pub(crate) fn find_variations(
    word: String,
    locale: SupportedLocale,
) -> channel::Receiver<String>
{
    let (tx, rx) = channel::unbounded();

    AutoCorrect::run_job(move || {
        let len = word.len() + 1;
        for pos in 0..len {
            variations_at_pos(word.clone(), pos, len, locale, &tx);
        }
    });

    rx
}

pub(crate) fn load_dict_async(dict_path: String, tx: channel::Sender<String>) {
    if dict_path.is_empty() {
        eprintln!("No dictionary path is given");
        return;
    }

    let file_loc = PathBuf::from(dict_path);
    if !file_loc.exists() || !file_loc.is_file() {
        eprintln!("Given dictionary path is invalid: {:?}", file_loc);
        return;
    }

    let file = File::open(file_loc).expect("file not found");
    let reader = BufReader::new(file);

    for raw_line in reader.lines() {
        if let Ok(line) = raw_line {
            if let Err(_) = tx.send(line) {
                return;
            }
        }
    }
}

fn get_char_code(word: &str, pos: usize) -> &u8 {
    match word.as_bytes().get(pos) {
        Some(res) => res,
        None => &0u8,
    }
}

fn variations_at_pos(
    word: String,
    pos: usize,
    len: usize,
    locale: SupportedLocale,
    tx: &channel::Sender<String>
)
{
    if pos >= len {
        return;
    }

    let mut remove_base = word.clone();
    let mut removed = '\u{0000}';

    if pos < len - 1 && remove_base.len() > 1 {
        // deletes
        removed = remove_base.remove(pos);
        tx.send(remove_base.clone()).expect("Failed to send the search result...");
    }

    for rune in get_char_set(locale) {
        // inserts
        let mut base = word.clone();
        base.insert(pos, rune);
        tx.send(base).expect("Failed to send the search result...");

        // replaces if we've actually removed a char
        if removed != '\u{0000}' && rune != removed {
            let mut replace = remove_base.clone();
            replace.insert(pos, rune);
            tx.send(replace).expect("Failed to send the search result...");
        }
    }

    // transpose: if we've removed
    if removed != '\u{0000}' && pos > 0 {
        remove_base.insert(pos - 1, removed);
        tx.send(remove_base.clone()).expect("Failed to send the search result...");
    }
}

fn get_char_set(locale: SupportedLocale) -> Chars<'static> {
    match locale {
        SupportedLocale::EnUs => en_us::ALPHABET_EN.chars(),
    }
}

fn mark_bit(source: u32, pos: usize, insert: bool) -> u32 {
    if pos >= 32 {
        return source;
    }

    if insert {
        // an insert, shift the bits
        if pos == 31 {
            source | (1 << 31)
        } else if pos == 0 {
            source | 1
        } else {
            (source >> pos << (pos + 1))                // upper portions
                | (1 << pos)                            // insert 1 to the pos
                | (source << (32 - pos) >> (32 - pos))  // lower portions
        }
    } else {
        // a replace, just mask
        source | (1 << pos)
    }
}

fn check_bit(source: u32, pos: usize) -> bool {
    source & (1 << pos) > 0
}

pub(crate) mod deprecated {
    use crossbeam_channel as channel;
    use hashbrown::HashMap;
    use crate::AutoCorrect;
    use crate::candidate::Candidate;
    use crate::config::AutoCorrectConfig;
    use crate::support::en_us;
    use super::*;

    pub(crate) fn delete_n_replace(
        word: String,
        set: &HashMap<String, u32>,
        current_edit: u8,
        tx_curr: channel::Sender<Candidate>,
        tx_next: Option<channel::Sender<String>>,
    )
    {
        let mut base: String;
        let mut replace: String;
        let mut removed: char = '\u{0001}';
        let mut last_removed: char;

        // deletes
        for pos in 0..word.len() {
            base = word.clone();

            last_removed = removed;
            removed = base.remove(pos);

            if tx_next.is_some() && last_removed != removed {
                send_next_string(base.clone(), &tx_next);
            }

            // replaces
            for rune in en_us::ALPHABET_EN.chars() {
                if rune == removed {
                    continue;
                }

                replace = base.clone();
                replace.insert(pos, rune);

                if tx_next.is_some() {
                    send_next_string(replace.clone(), &tx_next);
                }

                if set.contains_key(&replace) {
                    let score = set[&replace];
                    send_candidate(Candidate::new(replace, score, current_edit), &tx_curr);
                }
            }

            if set.contains_key(&base) {
                let score = set[&base];
                send_candidate(Candidate::new(base, score, current_edit), &tx_curr);
            }
        }
    }

    pub(crate) fn transpose_n_insert(
        word: String,
        set: &HashMap<String, u32>,
        current_edit: u8,
        tx_curr: channel::Sender<Candidate>,
        tx_next: Option<channel::Sender<String>>,
    )
    {
        let edit_two = tx_next.is_some();

        let mut base: String;
        let mut removed: char = '\u{0001}';
        let mut last_removed: char;

        // transposes
        let len = word.len() + 1;
        for pos in 0..len {
            if pos > 0 && pos < len - 1 {
                base = word.clone();

                last_removed = removed;
                removed = base.remove(pos);

                if last_removed == removed {
                    continue;
                }

                base.insert(pos - 1, removed);

                if edit_two && !base.is_empty() {
                    send_next_string(base.clone(), &tx_next);
                }

                if set.contains_key(&base) {
                    let score = set[&base];
                    send_candidate(Candidate::new(base, score, current_edit), &tx_curr);
                }
            }

            // inserts
            for rune in en_us::ALPHABET_EN.chars() {
                base = word.clone();
                base.insert(pos, rune);

                if edit_two {
                    send_next_string(base.clone(), &tx_next);
                }

                if set.contains_key(&base) {
                    let score = set[&base];
                    send_candidate(Candidate::new(base, score, current_edit), &tx_curr);
                }
            }
        }
    }

    fn send_candidate(candidate: Candidate, tx: &channel::Sender<Candidate>,) {
        tx.send(candidate).expect("Failed to return a candidate");
    }

    fn send_next_string(word: String, tx: &Option<channel::Sender<String>>) {
        if let Some(tx_next) = tx {
            tx_next.send(word).unwrap_or_else(|err| {
                eprintln!("Failed to search the string: {:?}", err);
            });
        }
    }

    fn generate_reverse_dict(config: &Config) -> HashMap<String, Vec<String>> {
        let mut result: HashMap<String, Vec<String>> = HashMap::new();

        // one worker to read from file
        let (tx, rx) = channel::unbounded();
        let dict_path = config.get_dict_path();
        let locale = config.get_locale();

        AutoCorrect::run_job(move || {
            load_dict_async(dict_path, tx);
        });

        // one worker to write to memory
        for word in rx {
            for variation in find_variations(word.clone(), locale) {
                update_reverse_dict(word.clone(), variation, &mut result);
            }
        }

        result
    }

    fn update_reverse_dict(word: String, variation: String, dict: &mut HashMap<String, Vec<String>>) {
        if let Some(vec) = dict.get_mut(&variation) {
            if !vec.contains(&word) {
                vec.push(word);
            }

            return;
        }

        dict.insert(variation, vec![word]);
    }
}