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 429 430 431 432 433 434 435 436 437 438 439 440
/*!
# Word Dictionary
This crate provides a data structure for word mapping. It can be used for language translation.
## Examples
```rust
use word_dictionary::Dictionary;
let mut dictionary = Dictionary::new("tests/data/dictionary.txt"); // input a dictionary file
// dictionary.read_data().unwrap(); // if the dictionary file already exists
dictionary.add_edit("Althasol", "阿爾瑟索").unwrap();
dictionary.add_edit("Aldun", "奧爾敦").unwrap();
dictionary.add_edit("Alduin", "阿爾杜因").unwrap();
dictionary.add_edit("Alduin", "奥杜因").unwrap();
assert_eq!("阿爾瑟索", dictionary.get_right(dictionary.find_left_strictly("Althasol", 0).unwrap()).unwrap());
assert_eq!("奧爾敦", dictionary.get_right(dictionary.find_left("dun", 0).unwrap()).unwrap());
assert_eq!("奥杜因", dictionary.get_right(dictionary.find_left("Alduin", 0).unwrap()).unwrap());
assert_eq!("阿爾杜因 --> 奥杜因", dictionary.get_all_right_to_string(dictionary.find_left("Alduin", 0).unwrap()).unwrap());
// The dictionary file now would be
/*
Alduin = 阿爾杜因 --> 奥杜因
Aldun = 奧爾敦
Althasol = 阿爾瑟索
*/
```
*/
use std::{
fs::File,
io::{BufRead, BufReader, ErrorKind, Write},
path::PathBuf,
};
mod errors;
pub use errors::*;
use trim_in_place::TrimInPlace;
#[derive(Debug)]
pub struct Dictionary {
/// The path of the dictionary file.
path: PathBuf,
/// Left data.
left: Vec<String>,
/// Right data.
right: Vec<Vec<String>>,
}
impl Dictionary {
/// Create a new `Dictionary` instance. But not read the file data. Use the `read_data` method to read data file the input file.
#[inline]
pub fn new<P: Into<PathBuf>>(path: P) -> Dictionary {
Dictionary {
path: path.into(), left: Vec::new(), right: Vec::new()
}
}
}
impl Dictionary {
/// Get the count of words.
#[inline]
pub fn count(&self) -> usize {
debug_assert_eq!(self.left.len(), self.right.len());
self.left.len()
}
/// Get the all right words.
#[inline]
pub fn get_all_right(&self, index: usize) -> Option<&[String]> {
self.right.get(index).map(|v| v.as_slice())
}
/// Get the all right words.
#[inline]
pub fn get_all_right_to_string(&self, index: usize) -> Option<String> {
self.right.get(index).map(|v| v.join(" --> "))
}
/// Get the last right word at a specific index.
#[inline]
pub fn get_right(&self, index: usize) -> Option<&str> {
match self.right.get(index) {
Some(v) => v.last().map(|s| s.as_str()),
None => None,
}
}
/// Get the left word at a specific index
#[inline]
pub fn get_left(&self, index: usize) -> Option<&str> {
self.left.get(index).map(|s| s.as_str())
}
}
impl Dictionary {
/// Find a word by a keyword.
#[inline]
pub fn find_left_strictly<S: AsRef<str>>(&self, s: S, mut start_index: usize) -> Option<usize> {
let size = self.count();
if size == 0 {
return None;
}
start_index %= size;
let s = s.as_ref();
for _ in 0..size {
let tmp = &self.left[start_index];
if tmp.eq_ignore_ascii_case(s) {
return Some(start_index);
}
start_index += 1;
if start_index == size {
start_index = 0;
}
}
None
}
/// Find a word by a keyword.
#[inline]
pub fn find_left<S: AsRef<str>>(&self, s: S, mut start_index: usize) -> Option<usize> {
let size = self.count();
if size == 0 {
return None;
}
start_index %= size;
let s = s.as_ref();
let s_upper_case = s.to_uppercase();
let s_lower_case = s.to_lowercase();
for _ in 0..size {
let tmp = &self.left[start_index];
let tmp_upper_case = tmp.to_uppercase();
if tmp_upper_case.contains(&s_upper_case) {
return Some(start_index);
}
let tmp_lower_case = tmp.to_lowercase();
if tmp_lower_case.contains(&s_lower_case) {
return Some(start_index);
}
start_index += 1;
if start_index == size {
start_index = 0;
}
}
None
}
/// Find a word by a keyword.
#[inline]
pub fn find_right_strictly<S: AsRef<str>>(
&self,
s: S,
mut start_index: usize,
) -> Option<usize> {
let size = self.count();
if size == 0 {
return None;
}
start_index %= size;
let s = s.as_ref();
for _ in 0..size {
for tmp in self.right[start_index].iter().rev() {
if tmp.eq_ignore_ascii_case(s) {
return Some(start_index);
}
}
start_index += 1;
if start_index == size {
start_index = 0;
}
}
None
}
/// Find a word by a keyword.
#[inline]
pub fn find_right<S: AsRef<str>>(&self, s: S, mut start_index: usize) -> Option<usize> {
let size = self.count();
if size == 0 {
return None;
}
start_index %= size;
let s = s.as_ref();
let s_upper_case = s.to_uppercase();
let s_lower_case = s.to_lowercase();
for _ in 0..size {
for tmp in self.right[start_index].iter().rev() {
let tmp_upper_case = tmp.to_uppercase();
if tmp_upper_case.contains(&s_upper_case) {
return Some(start_index);
}
let tmp_lower_case = tmp.to_lowercase();
if tmp_lower_case.contains(&s_lower_case) {
return Some(start_index);
}
}
start_index += 1;
if start_index == size {
start_index = 0;
}
}
None
}
}
impl Dictionary {
/// Read the dictionary from the dictionary file.
pub fn read_data(&mut self) -> Result<(), ReadError> {
let file = match File::open(&self.path) {
Ok(file) => file,
Err(err) if err.kind() == ErrorKind::NotFound => {
// it is okay with a file not found error
return Ok(());
},
Err(err) => return Err(err.into()),
};
let mut reader = BufReader::new(file);
let mut buffer = String::new();
let mut line_counter = 1;
loop {
buffer.clear();
let c = reader.read_line(&mut buffer)?;
if c == 0 {
break;
}
buffer.trim_in_place();
if buffer.is_empty() {
continue;
}
let mut tokenizer = buffer.split('=');
let left_string = tokenizer.next().unwrap();
if left_string.contains("-->") {
return Err(ReadError::Broken {
line: line_counter,
left_string: String::from(left_string),
reason: BrokenReason::BadLeftString,
});
}
let left_string = left_string.trim_end();
// the format of the left string has been checked
if let Some(index) = self.find_left_strictly(left_string, 0) {
return Err(ReadError::Broken {
line: line_counter,
left_string: String::from(left_string),
reason: BrokenReason::Duplicated {
another_left_string: String::from(self.left[index].as_str()),
},
});
}
let right_string = match tokenizer.next() {
Some(right_string) => right_string,
None => {
return Err(ReadError::Broken {
line: line_counter,
left_string: String::from(left_string),
reason: BrokenReason::NoRightString,
})
},
};
if tokenizer.next().is_some() {
return Err(ReadError::Broken {
line: line_counter,
left_string: String::from(left_string),
reason: BrokenReason::BadRightString {
right_string: String::from(right_string),
},
});
}
let mut right_strings: Vec<String> = Vec::with_capacity(1);
for s in right_string.split("-->").map(|s| s.trim()) {
if s.is_empty() {
return Err(ReadError::Broken {
line: line_counter,
left_string: String::from(left_string),
reason: BrokenReason::BadRightString {
right_string: String::from(right_string),
},
});
}
right_strings.push(String::from(s));
}
self.left.push(String::from(left_string));
self.right.push(right_strings);
line_counter += 1;
}
Ok(())
}
}
impl Dictionary {
/// Write this dictionary to its dictionary file.
pub fn write_data(&mut self) -> Result<(), WriteError> {
let mut file = File::create(&self.path)?;
let size = self.count();
if size > 0 {
let size_dec = size - 1;
// When doing exchange sort, it also writes data to file.
for i in 0..size_dec {
let mut left = self.left[i].to_uppercase();
for j in (i + 1)..size {
let left_2 = self.left[j].to_uppercase();
if left > left_2 {
self.left.swap(i, j);
self.right.swap(i, j);
left = left_2;
}
}
writeln!(file, "{} = {}", self.left[i], self.right[i].join(" --> "))?;
}
write!(file, "{} = {}", self.left[size_dec], self.right[size_dec].join(" --> "))?;
}
Ok(())
}
/// Delete a word.
#[inline]
pub fn delete(&mut self, index: usize) -> Result<bool, WriteError> {
if index < self.count() {
self.left.remove(index);
self.right.remove(index);
self.write_data()?;
Ok(true)
} else {
Ok(false)
}
}
/// Add or edit a word. If the left word exists, then update it, and return `Ok(false)`.
pub fn add_edit<L: AsRef<str>, R: AsRef<str>>(
&mut self,
left: L,
right: R,
) -> Result<bool, WriteError> {
let left = left.as_ref().trim();
let right = right.as_ref().trim();
if left.contains("-->") || left.contains('=') {
Err(WriteError::BadLeftString)
} else if right.contains("-->") || right.contains('=') {
Err(WriteError::BadRightString)
} else if left == right {
Err(WriteError::Same)
} else if let Some(index) = self.find_left_strictly(left, 0) {
if self.get_right(index).unwrap() == right {
Err(WriteError::Duplicated)
} else {
self.right.get_mut(index).unwrap().push(String::from(right));
self.write_data()?;
Ok(false)
}
} else {
self.left.push(String::from(left));
self.right.push(vec![String::from(right)]);
self.write_data()?;
Ok(true)
}
}
}