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 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
use std::fmt;
use std::fs::{read, File};
use std::io::{BufWriter, LineWriter, Write};
use std::path::Path;
use anyhow::{Context, Result};
use itertools::Itertools;
use crate::parsers::bin_symt::nom_parser::{parse_symbol_table_bin, write_bin_symt};
use crate::parsers::nom_utils::NomCustomError;
use crate::parsers::text_symt::parsed_text_symt::ParsedTextSymt;
use crate::{Label, EPS_SYMBOL};
use std::collections::hash_map::{Entry, RandomState};
use std::collections::HashMap;
use std::hash::BuildHasher;
/// A symbol table stores a bidirectional mapping between transition labels and "symbols" (strings).
#[derive(Debug, Clone)]
pub struct SymbolTable<H: BuildHasher = RandomState> {
bimap: BiHashMapString<H>,
}
impl Default for SymbolTable {
fn default() -> Self {
Self::new()
}
}
impl SymbolTable {
/// Creates a `SymbolTable` with a single element in it: the pair (`EPS_LABEL`, `EPS_SYMBOL`).
///
/// # Examples
/// ```rust
/// # use rustfst::SymbolTable;
/// let mut symt = SymbolTable::new();
/// ```
pub fn new() -> Self {
let mut symt = SymbolTable::empty();
symt.add_symbol(EPS_SYMBOL.to_string());
symt
}
pub fn empty() -> Self {
SymbolTable {
bimap: BiHashMapString::new(),
}
}
fn from_parsed_symt_text(parsed_symt_text: ParsedTextSymt) -> Result<Self> {
let mut bimap = BiHashMapString::new();
for (symbol, label) in parsed_symt_text.pairs.into_iter() {
let inserted_label = bimap.get_id_or_insert(symbol);
if inserted_label as Label != label {
bail!("The SymbolTable should contain labels with increasing ids and no hole. Expected {} and got {}", inserted_label, label)
}
}
Ok(SymbolTable { bimap })
}
pub fn from_text_string(symt_string: &str) -> Result<Self> {
let parsed_symt = ParsedTextSymt::from_string(symt_string)?;
Self::from_parsed_symt_text(parsed_symt)
}
pub fn read_text<P: AsRef<Path>>(path_text_symt: P) -> Result<Self> {
let parsed_symt = ParsedTextSymt::from_path(path_text_symt)?;
Self::from_parsed_symt_text(parsed_symt)
}
pub fn read<P: AsRef<Path>>(path_bin_symt: P) -> Result<Self> {
let data = read(path_bin_symt.as_ref()).with_context(|| {
format!(
"Can't open SymbolTable binary file : {:?}",
path_bin_symt.as_ref()
)
})?;
let (_, symt) = parse_symbol_table_bin(&data).map_err(|e| {
e.map(|e_inner| match e_inner {
NomCustomError::Nom(_, k) => {
format_err!("Error while parsing binary SymbolTable. Error kind {:?}", k)
}
NomCustomError::SymbolTableError(e) => {
format_err!("Error while parsing symbolTable from binary : {}", e)
}
})
})?;
Ok(symt)
}
}
impl<H: BuildHasher> SymbolTable<H> {
pub fn with_hasher(hasher_builder: H) -> Self {
let mut bimap = BiHashMapString::with_hasher(hasher_builder);
bimap.get_id_or_insert(EPS_SYMBOL);
Self { bimap }
}
pub fn is_empty(&self) -> bool {
self.len() == 0
}
/// Adds a symbol to the symbol table. The corresponding label is returned.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let mut symt = symt!["a", "b"];
///
/// // Elements in the table : `<eps>`, `a`, `b`
/// assert_eq!(symt.len(), 3);
///
/// // Add a single symbol
/// symt.add_symbol("c");
///
/// // Elements in the table : `<eps>`, `a`, `b`, `c`
/// assert_eq!(symt.len(), 4);
/// # }
/// ```
pub fn add_symbol(&mut self, sym: impl Into<String>) -> Label {
self.bimap.get_id_or_insert(sym.into()) as Label
}
pub fn add_symbols<S: Into<String>, P: IntoIterator<Item = S>>(&mut self, symbols: P) {
for symbol in symbols.into_iter() {
self.add_symbol(symbol.into());
}
}
/// Returns the number of symbols stored in the symbol table.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let mut symt = symt!["a", "b"];
/// assert_eq!(symt.len(), 3);
/// # }
/// ```
pub fn len(&self) -> usize {
self.bimap.len()
}
/// Given a symbol, returns the label corresponding.
/// If the symbol is not stored in the table then `None` is returned.
///
/// # Examples
/// ```
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let mut symt = symt!["a", "b"];
/// let label = symt.add_symbol("c");
/// assert_eq!(symt.get_label("c"), Some(label));
/// assert_eq!(symt.get_label("d"), None);
/// # }
/// ```
pub fn get_label(&self, sym: impl AsRef<str>) -> Option<Label> {
self.bimap.get_id(sym).map(|it| it as Label)
}
/// Given a label, returns the symbol corresponding.
/// If no there is no symbol with this label in the table then `None` is returned.
///
/// # Examples
/// ```
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let mut symt = symt!["a", "b"];
/// let label = symt.add_symbol("c");
/// assert_eq!(symt.get_symbol(label), Some("c"));
/// assert_eq!(symt.get_symbol(label + 1), None);
/// # }
/// ```
pub fn get_symbol(&self, label: Label) -> Option<&str> {
self.bimap.get_string(label as usize)
}
/// Given a symbol, returns whether it is present in the table.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let symt = symt!["a", "b"];
/// assert!(symt.contains_symbol("a"));
/// # }
/// ```
pub fn contains_symbol(&self, sym: impl AsRef<str>) -> bool {
self.get_label(sym).is_some()
}
/// Given a label, returns whether it is present in the table.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let mut symt = symt!["a", "b"];
/// let label = symt.add_symbol("c");
/// assert!(symt.contains_label(label));
/// assert!(!symt.contains_label(label+1));
/// # }
pub fn contains_label(&self, label: Label) -> bool {
self.get_symbol(label).is_some()
}
/// Reserves capacity for at least additional more elements to be inserted in the `SymbolTable`.
/// The collection may reserve more space to avoid frequent reallocations.
pub fn reserve(&mut self, additional: usize) {
self.bimap.reserve(additional)
}
/// An iterator on all the labels stored in the `SymbolTable`.
/// The iterator element is `&'a Label`.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let symt = symt!["a", "b"];
/// let mut iterator = symt.labels();
///
/// # }
/// ```
pub fn labels(&self) -> impl Iterator<Item = Label> {
self.bimap.iter_ids().map(|it| it as Label)
}
/// An iterator on all the symbols stored in the `SymbolTable`.
/// The iterator element is `&'a Symbol`.
///
/// # Examples
/// ```rust
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::SymbolTable;
/// let symt = symt!["a", "b"];
/// let mut iterator = symt.symbols();
///
/// for symbol in symt.symbols() {
/// println!("Symbol : {:?}", symbol);
/// }
/// # }
/// ```
pub fn symbols(&self) -> impl Iterator<Item = &str> {
self.bimap.iter_strings()
}
/// An iterator on all the labels stored in the `SymbolTable`.
/// The iterator element is `(&'a Label, &'a Symbol)`.
pub fn iter(&self) -> impl Iterator<Item = (Label, &str)> {
self.bimap.iter().map(|(label, sym)| (label as Label, sym))
}
/// Adds another SymbolTable to this table.
pub fn add_table(&mut self, other: &SymbolTable) {
for symbol in other.symbols() {
self.add_symbol(symbol);
}
}
pub fn write_text<P: AsRef<Path>>(&self, path_output: P) -> Result<()> {
let buffer = File::create(path_output.as_ref())?;
let mut writer = BufWriter::new(LineWriter::new(buffer));
write!(writer, "{}", self)?;
Ok(())
}
pub fn write<P: AsRef<Path>>(&self, path_bin_symt: P) -> Result<()> {
let buffer = File::create(path_bin_symt.as_ref())?;
let mut writer = BufWriter::new(LineWriter::new(buffer));
write_bin_symt(&mut writer, self)?;
Ok(())
}
/// Writes the text_fst representation of the symbol table into a String.
pub fn text(&self) -> Result<String> {
let buffer = Vec::<u8>::new();
let mut writer = BufWriter::new(LineWriter::new(buffer));
write!(writer, "{}", self)?;
Ok(String::from_utf8(writer.into_inner()?.into_inner()?)?)
}
}
impl<H: BuildHasher> fmt::Display for SymbolTable<H> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
for (label, symbol) in self.iter().sorted_by_key(|k| k.0) {
writeln!(f, "{}\t{}", symbol, label)?;
}
Ok(())
}
}
impl<H: BuildHasher> PartialEq for SymbolTable<H> {
fn eq(&self, other: &Self) -> bool {
self.bimap.eq(&other.bimap)
}
}
/// Creates a `SymbolTable` containing the arguments.
/// ```
/// # #[macro_use] extern crate rustfst; fn main() {
/// # use rustfst::{SymbolTable, EPS_SYMBOL};
/// let symt = symt!["a", "b"];
/// assert_eq!(symt.len(), 3);
/// assert_eq!(symt.get_symbol(0).unwrap(), EPS_SYMBOL);
/// assert_eq!(symt.get_symbol(1).unwrap(), "a");
/// assert_eq!(symt.get_symbol(2).unwrap(), "b");
/// # }
/// ```
#[macro_export]
macro_rules! symt {
( $( $x:expr ),* ) => {
{
let mut temp_vec = SymbolTable::new();
$(
temp_vec.add_symbol($x.to_string());
)*
temp_vec
}
};
}
#[derive(Clone, Debug, Default)]
pub(crate) struct BiHashMapString<H: BuildHasher = RandomState> {
string_to_id: HashMap<String, usize, H>,
id_to_string: Vec<String>,
}
impl<H: BuildHasher> PartialEq for BiHashMapString<H> {
fn eq(&self, other: &Self) -> bool {
self.string_to_id.eq(&other.string_to_id) && self.id_to_string.eq(&other.id_to_string)
}
}
impl BiHashMapString {
pub fn new() -> Self {
Self {
string_to_id: HashMap::new(),
id_to_string: Vec::new(),
}
}
}
impl<H: BuildHasher> BiHashMapString<H> {
pub fn with_hasher(hash_builder: H) -> Self {
Self {
string_to_id: HashMap::with_hasher(hash_builder),
id_to_string: Vec::new(),
}
}
pub fn len(&self) -> usize {
self.id_to_string.len()
}
pub fn reserve(&mut self, additional: usize) {
self.string_to_id.reserve(additional);
self.id_to_string.reserve(additional);
}
pub fn get_id_or_insert(&mut self, v: impl Into<String>) -> usize {
match self.string_to_id.entry(v.into()) {
Entry::Occupied(e) => *e.get(),
Entry::Vacant(e) => {
let n = self.id_to_string.len();
self.id_to_string.push(e.key().clone());
e.insert(n);
n
}
}
}
pub fn get_id(&self, v: impl AsRef<str>) -> Option<usize> {
self.string_to_id.get(v.as_ref()).cloned()
}
pub fn get_string(&self, id: usize) -> Option<&str> {
self.id_to_string.get(id).map(|s| s.as_str())
}
pub fn iter_ids(&self) -> impl Iterator<Item = usize> {
0..self.id_to_string.len()
}
pub fn iter_strings(&self) -> impl Iterator<Item = &str> {
self.id_to_string.iter().map(|s| s.as_str())
}
pub fn iter(&self) -> impl Iterator<Item = (usize, &str)> {
self.id_to_string.iter().map(|s| s.as_str()).enumerate()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_symt() {
let mut symt = SymbolTable::new();
symt.add_symbol("a");
symt.add_symbol("b");
assert_eq!(symt.len(), 3);
assert_eq!(symt.is_empty(), false);
assert_eq!(symt.get_label(EPS_SYMBOL), Some(0));
assert_eq!(symt.get_label("a"), Some(1));
assert_eq!(symt.get_label("b"), Some(2));
assert_eq!(symt.contains_symbol(EPS_SYMBOL), true);
assert_eq!(symt.contains_symbol("a"), true);
assert_eq!(symt.contains_symbol("b"), true);
assert_eq!(symt.contains_symbol("c"), false);
assert_eq!(symt.get_symbol(0), Some(EPS_SYMBOL));
assert_eq!(symt.get_symbol(1), Some("a"));
assert_eq!(symt.get_symbol(2), Some("b"));
assert_eq!(symt.contains_label(0), true);
assert_eq!(symt.contains_label(1), true);
assert_eq!(symt.contains_label(2), true);
assert_eq!(symt.contains_label(3), false);
}
#[test]
fn test_symt_add_twice_symbol() {
let mut symt = SymbolTable::new();
symt.add_symbol("a");
symt.add_symbol("a");
assert_eq!(symt.len(), 2);
assert_eq!(symt.get_label("a"), Some(1));
}
#[test]
fn test_add_table() {
let mut symt1 = SymbolTable::new();
symt1.add_symbol("a");
symt1.add_symbol("b");
let mut symt2 = SymbolTable::new();
symt2.add_symbol("c");
symt2.add_symbol("b");
symt1.add_table(&symt2);
assert_eq!(symt1.len(), 4);
assert_eq!(symt1.get_label(EPS_SYMBOL), Some(0));
assert_eq!(symt1.get_label("a"), Some(1));
assert_eq!(symt1.get_label("b"), Some(2));
assert_eq!(symt1.get_label("c"), Some(3));
}
}