/usr/include/fst/fst.h is in libfst-dev 1.5.3+r3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 | // See www.openfst.org for extensive documentation on this weighted
// finite-state transducer library.
//
// FST abstract base class definition, state and arc iterator interface, and
// suggested base implementation.
#ifndef FST_LIB_FST_H_
#define FST_LIB_FST_H_
#include <stddef.h>
#include <sys/types.h>
#include <cmath>
#include <iostream>
#include <sstream>
#include <string>
#include <fst/compat.h>
#include <fst/types.h>
#include <fstream>
#include <fst/arc.h>
#include <fst/memory.h>
#include <fst/properties.h>
#include <fst/register.h>
#include <fst/symbol-table.h>
#include <fst/util.h>
DECLARE_bool(fst_align);
namespace fst {
bool IsFstHeader(std::istream &, const string &);
class FstHeader;
template <class A>
struct StateIteratorData;
template <class A>
struct ArcIteratorData;
template <class A>
class MatcherBase;
struct FstReadOptions {
// FileReadMode(s) are advisory, there are many conditions than prevent a
// file from being mapped, READ mode will be selected in these cases with
// a warning indicating why it was chosen.
enum FileReadMode { READ, MAP };
string source; // Where you're reading from
const FstHeader *header; // Pointer to Fst header. If non-zero, use
// this info (don't read a stream header)
const SymbolTable *isymbols; // Pointer to input symbols. If non-zero, use
// this info (read and skip stream isymbols)
const SymbolTable *osymbols; // Pointer to output symbols. If non-zero, use
// this info (read and skip stream osymbols)
FileReadMode mode; // Read or map files (advisory, if possible)
bool read_isymbols; // Read isymbols, if any, default true
bool read_osymbols; // Read osymbols, if any, default true
explicit FstReadOptions(const string &src = "<unspecified>",
const FstHeader *hdr = 0, const SymbolTable *isym = 0,
const SymbolTable *osym = 0);
explicit FstReadOptions(const string &src, const SymbolTable *isym,
const SymbolTable *osym = 0);
// Helper function to convert strings FileReadModes into their enum value.
static FileReadMode ReadMode(const string &mode);
// Outputs a debug string for the FstReadOptions object.
string DebugString() const;
};
struct FstWriteOptions {
string source; // Where you're writing to
bool write_header; // Write the header?
bool write_isymbols; // Write input symbols?
bool write_osymbols; // Write output symbols?
bool align; // Write data aligned where appropriate;
// this may fail on pipes
bool stream_write; // Avoid seek operations in writing.
explicit FstWriteOptions(const string &src = "<unspecifed>", bool hdr = true,
bool isym = true, bool osym = true,
bool alig = FLAGS_fst_align, bool stm = false)
: source(src),
write_header(hdr),
write_isymbols(isym),
write_osymbols(osym),
align(alig),
stream_write(stm) {}
};
//
// Fst HEADER CLASS
//
// This is the recommended Fst file header representation.
//
class FstHeader {
public:
enum {
HAS_ISYMBOLS = 0x1, // Has input symbol table
HAS_OSYMBOLS = 0x2, // Has output symbol table
IS_ALIGNED = 0x4, // Memory-aligned (where appropriate)
} Flags;
FstHeader()
: version_(0),
flags_(0),
properties_(0),
start_(-1),
numstates_(0),
numarcs_(0) {}
const string &FstType() const { return fsttype_; }
const string &ArcType() const { return arctype_; }
int32 Version() const { return version_; }
int32 GetFlags() const { return flags_; }
uint64 Properties() const { return properties_; }
int64 Start() const { return start_; }
int64 NumStates() const { return numstates_; }
int64 NumArcs() const { return numarcs_; }
void SetFstType(const string &type) { fsttype_ = type; }
void SetArcType(const string &type) { arctype_ = type; }
void SetVersion(int32 version) { version_ = version; }
void SetFlags(int32 flags) { flags_ = flags; }
void SetProperties(uint64 properties) { properties_ = properties; }
void SetStart(int64 start) { start_ = start; }
void SetNumStates(int64 numstates) { numstates_ = numstates; }
void SetNumArcs(int64 numarcs) { numarcs_ = numarcs; }
bool Read(std::istream &strm, const string &source, // NOLINT
bool rewind = false);
bool Write(std::ostream &strm, const string &source) const; // NOLINT
// Outputs a debug string for the FstHeader object.
string DebugString() const;
private:
string fsttype_; // E.g. "vector"
string arctype_; // E.g. "standard"
int32 version_; // Type version #
int32 flags_; // File format bits
uint64 properties_; // FST property bits
int64 start_; // Start state
int64 numstates_; // # of states
int64 numarcs_; // # of arcs
};
// Specifies matcher action.
enum MatchType {
MATCH_INPUT, // Match input label.
MATCH_OUTPUT, // Match output label.
MATCH_BOTH, // Match input or output label.
MATCH_NONE, // Match nothing.
MATCH_UNKNOWN
}; // Match type unknown.
//
// Fst INTERFACE CLASS DEFINITION
//
// A generic FST, templated on the arc definition, with
// common-demoninator methods (use StateIterator and ArcIterator to
// iterate over its states and arcs).
template <class A>
class Fst {
public:
typedef A Arc;
typedef typename A::Weight Weight;
typedef typename A::StateId StateId;
virtual ~Fst() {}
virtual StateId Start() const = 0; // Initial state
virtual Weight Final(StateId) const = 0; // State's final weight
virtual size_t NumArcs(StateId) const = 0; // State's arc count
virtual size_t NumInputEpsilons(
StateId) const = 0; // State's input epsilon count
virtual size_t NumOutputEpsilons(
StateId) const = 0; // State's output epsilon count
// If test=false, return stored properties bits for mask (some poss. unknown)
// If test=true, return property bits for mask (computing o.w. unknown)
virtual uint64 Properties(uint64 mask, bool test) const = 0; // Property bits
virtual const string &Type() const = 0; // Fst type name
// Get a copy of this Fst. The copying behaves as follows:
//
// (1) The copying is constant time if safe = false or if safe = true
// and is on an otherwise unaccessed Fst.
//
// (2) If safe = true, the copy is thread-safe in that the original
// and copy can be safely accessed (but not necessarily mutated) by
// separate threads. For some Fst types, 'Copy(true)' should only be
// called on an Fst that has not otherwise been accessed. Its behavior
// is undefined otherwise.
//
// (3) If a MutableFst is copied and then mutated, then the original is
// unmodified and vice versa (often by a copy-on-write on the initial
// mutation, which may not be constant time).
virtual Fst<A> *Copy(bool safe = false) const = 0;
// Read an Fst from an input stream; returns NULL on error
static Fst<A> *Read(std::istream &strm, // NOLINT
const FstReadOptions &opts) {
FstReadOptions ropts(opts);
FstHeader hdr;
if (ropts.header)
hdr = *opts.header;
else {
if (!hdr.Read(strm, opts.source)) return nullptr;
ropts.header = &hdr;
}
FstRegister<A> *registr = FstRegister<A>::GetRegister();
const typename FstRegister<A>::Reader reader =
registr->GetReader(hdr.FstType());
if (!reader) {
LOG(ERROR) << "Fst::Read: Unknown Fst type " << hdr.FstType()
<< " (arc type = " << A::Type() << "): " << ropts.source;
return nullptr;
}
return reader(strm, ropts);
}
// Read an Fst from a file; return NULL on error
// Empty filename reads from standard input
static Fst<A> *Read(const string &filename) {
if (!filename.empty()) {
std::ifstream strm(filename.c_str(),
std::ios_base::in | std::ios_base::binary);
if (!strm) {
LOG(ERROR) << "Fst::Read: Can't open file: " << filename;
return nullptr;
}
return Read(strm, FstReadOptions(filename));
} else {
return Read(std::cin, FstReadOptions("standard input"));
}
}
// Write an Fst to an output stream; return false on error
virtual bool Write(std::ostream &strm, // NOLINT
const FstWriteOptions &opts) const {
LOG(ERROR) << "Fst::Write: No write stream method for " << Type()
<< " Fst type";
return false;
}
// Write an Fst to a file; return false on error
// Empty filename writes to standard output
virtual bool Write(const string &filename) const {
LOG(ERROR) << "Fst::Write: No write filename method for " << Type()
<< " Fst type";
return false;
}
// Return input label symbol table; return NULL if not specified
virtual const SymbolTable *InputSymbols() const = 0;
// Return output label symbol table; return NULL if not specified
virtual const SymbolTable *OutputSymbols() const = 0;
// For generic state iterator construction; not normally called
// directly by users.
virtual void InitStateIterator(StateIteratorData<A> *) const = 0;
// For generic arc iterator construction; not normally called
// directly by users.
virtual void InitArcIterator(StateId s, ArcIteratorData<A> *) const = 0;
// For generic matcher construction; not normally called
// directly by users.
virtual MatcherBase<A> *InitMatcher(MatchType match_type) const;
protected:
bool WriteFile(const string &filename) const {
if (!filename.empty()) {
std::ofstream strm(filename.c_str(),
std::ios_base::out | std::ios_base::binary);
if (!strm) {
LOG(ERROR) << "Fst::Write: Can't open file: " << filename;
return false;
}
bool val = Write(strm, FstWriteOptions(filename));
if (!val) LOG(ERROR) << "Fst::Write failed: " << filename;
return val;
} else {
return Write(std::cout, FstWriteOptions("standard output"));
}
}
};
//
// STATE and ARC ITERATOR DEFINITIONS
//
// State iterator interface templated on the Arc definition; used
// for StateIterator specializations returned by the InitStateIterator
// Fst method.
template <class A>
class StateIteratorBase {
public:
typedef A Arc;
typedef typename A::StateId StateId;
virtual ~StateIteratorBase() {}
bool Done() const { return Done_(); } // End of iterator?
StateId Value() const { return Value_(); } // Current state (when !Done)
void Next() { Next_(); } // Advance to next state (when !Done)
void Reset() { Reset_(); } // Return to initial condition
private:
// This allows base class virtual access to non-virtual derived-
// class members of the same name. It makes the derived class more
// efficient to use but unsafe to further derive.
virtual bool Done_() const = 0;
virtual StateId Value_() const = 0;
virtual void Next_() = 0;
virtual void Reset_() = 0;
};
// StateIterator initialization data
template <class A>
struct StateIteratorData {
StateIteratorBase<A> *base; // Specialized iterator if non-zero
typename A::StateId nstates; // O.w. total # of states
};
// Generic state iterator, templated on the FST definition
// - a wrapper around pointer to specific one.
// Here is a typical use: \code
// for (StateIterator<StdFst> siter(fst);
// !siter.Done();
// siter.Next()) {
// StateId s = siter.Value();
// ...
// } \endcode
template <class F>
class StateIterator {
public:
typedef F FST;
typedef typename F::Arc Arc;
typedef typename Arc::StateId StateId;
explicit StateIterator(const F &fst) : s_(0) {
fst.InitStateIterator(&data_);
}
~StateIterator() {
if (data_.base) delete data_.base;
}
bool Done() const {
return data_.base ? data_.base->Done() : s_ >= data_.nstates;
}
StateId Value() const { return data_.base ? data_.base->Value() : s_; }
void Next() {
if (data_.base)
data_.base->Next();
else
++s_;
}
void Reset() {
if (data_.base)
data_.base->Reset();
else
s_ = 0;
}
private:
StateIteratorData<Arc> data_;
StateId s_;
DISALLOW_COPY_AND_ASSIGN(StateIterator);
};
// Flags to control the behavior on an arc iterator:
static const uint32 kArcILabelValue = 0x0001; // Value() gives valid ilabel
static const uint32 kArcOLabelValue = 0x0002; // " " " olabel
static const uint32 kArcWeightValue = 0x0004; // " " " weight
static const uint32 kArcNextStateValue = 0x0008; // " " " nextstate
static const uint32 kArcNoCache = 0x0010; // No need to cache arcs
static const uint32 kArcValueFlags =
kArcILabelValue | kArcOLabelValue | kArcWeightValue | kArcNextStateValue;
static const uint32 kArcFlags = kArcValueFlags | kArcNoCache;
// Arc iterator interface, templated on the Arc definition; used
// for Arc iterator specializations that are returned by the InitArcIterator
// Fst method.
template <class A>
class ArcIteratorBase {
public:
typedef A Arc;
typedef typename A::StateId StateId;
virtual ~ArcIteratorBase() {}
bool Done() const { return Done_(); } // End of iterator?
const A &Value() const { return Value_(); } // Current arc (when !Done)
void Next() { Next_(); } // Advance to next arc (when !Done)
size_t Position() const { return Position_(); } // Return current position
void Reset() { Reset_(); } // Return to initial condition
void Seek(size_t a) { Seek_(a); } // Random arc access by position
uint32 Flags() const { return Flags_(); } // Return current behavorial flags
void SetFlags(uint32 flags, uint32 mask) { // Set behavorial flags
SetFlags_(flags, mask);
}
private:
// This allows base class virtual access to non-virtual derived-
// class members of the same name. It makes the derived class more
// efficient to use but unsafe to further derive.
virtual bool Done_() const = 0;
virtual const A &Value_() const = 0;
virtual void Next_() = 0;
virtual size_t Position_() const = 0;
virtual void Reset_() = 0;
virtual void Seek_(size_t a) = 0;
virtual uint32 Flags_() const = 0;
virtual void SetFlags_(uint32 flags, uint32 mask) = 0;
};
// ArcIterator initialization data
template <class A>
struct ArcIteratorData {
ArcIteratorBase<A> *base; // Specialized iterator if non-zero
const A *arcs; // O.w. arcs pointer
size_t narcs; // ... and arc count
int *ref_count; // ... and reference count if non-zero
};
// Generic arc iterator, templated on the FST definition
// - a wrapper around pointer to specific one.
// Here is a typical use: \code
// for (ArcIterator<StdFst> aiter(fst, s);
// !aiter.Done();
// aiter.Next()) {
// StdArc &arc = aiter.Value();
// ...
// } \endcode
template <class F>
class ArcIterator {
public:
typedef F FST;
typedef typename F::Arc Arc;
typedef typename Arc::StateId StateId;
ArcIterator(const F &fst, StateId s) : i_(0) {
fst.InitArcIterator(s, &data_);
}
explicit ArcIterator(const ArcIteratorData<Arc> &data) : data_(data), i_(0) {
if (data_.ref_count) ++(*data_.ref_count);
}
~ArcIterator() {
if (data_.base)
delete data_.base;
else if (data_.ref_count)
--(*data_.ref_count);
}
bool Done() const {
return data_.base ? data_.base->Done() : i_ >= data_.narcs;
}
const Arc &Value() const {
return data_.base ? data_.base->Value() : data_.arcs[i_];
}
void Next() {
if (data_.base)
data_.base->Next();
else
++i_;
}
void Reset() {
if (data_.base)
data_.base->Reset();
else
i_ = 0;
}
void Seek(size_t a) {
if (data_.base)
data_.base->Seek(a);
else
i_ = a;
}
size_t Position() const { return data_.base ? data_.base->Position() : i_; }
uint32 Flags() const {
if (data_.base)
return data_.base->Flags();
else
return kArcValueFlags;
}
void SetFlags(uint32 flags, uint32 mask) {
if (data_.base) data_.base->SetFlags(flags, mask);
}
private:
ArcIteratorData<Arc> data_;
size_t i_;
DISALLOW_COPY_AND_ASSIGN(ArcIterator);
};
} // namespace fst
// ArcIterator placement operator new and destroy function.
// new needs to be in the global namespace
template <class F>
void *operator new(size_t size,
fst::MemoryPool<fst::ArcIterator<F>> *pool) {
return pool->Allocate();
}
namespace fst {
template <class F>
inline void Destroy(fst::ArcIterator<F> *aiter,
fst::MemoryPool<fst::ArcIterator<F>> *pool) {
if (aiter) {
aiter->~ArcIterator<F>();
pool->Free(aiter);
}
}
//
// MATCHER DEFINITIONS
//
template <class A>
MatcherBase<A> *Fst<A>::InitMatcher(MatchType match_type) const {
return 0; // Use the default matcher
}
//
// FST ACCESSORS - Useful functions in high-performance cases.
//
namespace internal {
// General case - requires non-abstract, 'final' methods. Use for inlining.
template <class F>
inline typename F::Arc::Weight Final(const F &fst, typename F::Arc::StateId s) {
return fst.F::Final(s);
}
template <class F>
inline ssize_t NumArcs(const F &fst, typename F::Arc::StateId s) {
return fst.F::NumArcs(s);
}
template <class F>
inline ssize_t NumInputEpsilons(const F &fst, typename F::Arc::StateId s) {
return fst.F::NumInputEpsilons(s);
}
template <class F>
inline ssize_t NumOutputEpsilons(const F &fst, typename F::Arc::StateId s) {
return fst.F::NumOutputEpsilons(s);
}
// Fst<A> case - abstract methods.
template <class A>
inline typename A::Weight Final(const Fst<A> &fst, typename A::StateId s) {
return fst.Final(s);
}
template <class A>
inline ssize_t NumArcs(const Fst<A> &fst, typename A::StateId s) {
return fst.NumArcs(s);
}
template <class A>
inline ssize_t NumInputEpsilons(const Fst<A> &fst, typename A::StateId s) {
return fst.NumInputEpsilons(s);
}
template <class A>
inline ssize_t NumOutputEpsilons(const Fst<A> &fst, typename A::StateId s) {
return fst.NumOutputEpsilons(s);
}
} // namespace internal
// A useful alias when using StdArc.
typedef Fst<StdArc> StdFst;
//
// CONSTANT DEFINITIONS
//
const int kNoStateId = -1; // Not a valid state ID
const int kNoLabel = -1; // Not a valid label
//
// Fst IMPLEMENTATION BASE
//
// This is the recommended Fst implementation base class. It will
// handle reference counts, property bits, type information and symbols.
//
template <class A>
class FstImpl {
public:
typedef typename A::Weight Weight;
typedef typename A::StateId StateId;
FstImpl() : properties_(0), type_("null"), isymbols_(0), osymbols_(0) {}
FstImpl(const FstImpl<A> &impl)
: properties_(impl.properties_),
type_(impl.type_),
isymbols_(impl.isymbols_ ? impl.isymbols_->Copy() : 0),
osymbols_(impl.osymbols_ ? impl.osymbols_->Copy() : 0) {}
virtual ~FstImpl() {
delete isymbols_;
delete osymbols_;
}
const string &Type() const { return type_; }
void SetType(const string &type) { type_ = type; }
virtual uint64 Properties() const { return properties_; }
virtual uint64 Properties(uint64 mask) const { return properties_ & mask; }
void SetProperties(uint64 props) {
properties_ &= kError; // kError can't be cleared
properties_ |= props;
}
void SetProperties(uint64 props, uint64 mask) {
properties_ &= ~mask | kError; // kError can't be cleared
properties_ |= props & mask;
}
// Allows (only) setting error bit on const FST impls
void SetProperties(uint64 props, uint64 mask) const {
if (mask != kError)
FSTERROR() << "FstImpl::SetProperties() const: Can only set kError";
properties_ |= kError;
}
const SymbolTable *InputSymbols() const { return isymbols_; }
const SymbolTable *OutputSymbols() const { return osymbols_; }
SymbolTable *InputSymbols() { return isymbols_; }
SymbolTable *OutputSymbols() { return osymbols_; }
void SetInputSymbols(const SymbolTable *isyms) {
if (isymbols_) delete isymbols_;
isymbols_ = isyms ? isyms->Copy() : 0;
}
void SetOutputSymbols(const SymbolTable *osyms) {
if (osymbols_) delete osymbols_;
osymbols_ = osyms ? osyms->Copy() : 0;
}
// Read-in header and symbols from input stream, initialize Fst, and
// return the header. If opts.header is non-null, skip read-in and
// use the option value. If opts.[io]symbols is non-null, read-in
// (if present), but use the option value.
bool ReadHeader(std::istream &strm, const FstReadOptions &opts, // NOLINT
int min_version, FstHeader *hdr);
// Write-out header and symbols from output stream.
// If a opts.header is false, skip writing header.
// If opts.[io]symbols is false, skip writing those symbols.
// This method is needed for Impl's that implement Write methods.
void WriteHeader(std::ostream &strm, const FstWriteOptions &opts, // NOLINT
int version, FstHeader *hdr) const {
if (opts.write_header) {
hdr->SetFstType(type_);
hdr->SetArcType(A::Type());
hdr->SetVersion(version);
hdr->SetProperties(properties_);
int32 file_flags = 0;
if (isymbols_ && opts.write_isymbols)
file_flags |= FstHeader::HAS_ISYMBOLS;
if (osymbols_ && opts.write_osymbols)
file_flags |= FstHeader::HAS_OSYMBOLS;
if (opts.align) file_flags |= FstHeader::IS_ALIGNED;
hdr->SetFlags(file_flags);
hdr->Write(strm, opts.source);
}
if (isymbols_ && opts.write_isymbols) isymbols_->Write(strm);
if (osymbols_ && opts.write_osymbols) osymbols_->Write(strm);
}
// Write-out header and symbols to output stream.
// If a opts.header is false, skip writing header.
// If opts.[io]symbols is false, skip writing those symbols.
// type is the Fst type being written.
// This method is used in the cross-type serialization methods Fst::WriteFst.
static void WriteFstHeader(const Fst<A> &fst, std::ostream &strm, // NOLINT
const FstWriteOptions &opts, int version,
const string &type, uint64 properties,
FstHeader *hdr) {
if (opts.write_header) {
hdr->SetFstType(type);
hdr->SetArcType(A::Type());
hdr->SetVersion(version);
hdr->SetProperties(properties);
int32 file_flags = 0;
if (fst.InputSymbols() && opts.write_isymbols)
file_flags |= FstHeader::HAS_ISYMBOLS;
if (fst.OutputSymbols() && opts.write_osymbols)
file_flags |= FstHeader::HAS_OSYMBOLS;
if (opts.align) file_flags |= FstHeader::IS_ALIGNED;
hdr->SetFlags(file_flags);
hdr->Write(strm, opts.source);
}
if (fst.InputSymbols() && opts.write_isymbols) {
fst.InputSymbols()->Write(strm);
}
if (fst.OutputSymbols() && opts.write_osymbols) {
fst.OutputSymbols()->Write(strm);
}
}
// In serialization routines where the header cannot be written until after
// the machine has been serialized, this routine can be called to seek to
// the beginning of the file an rewrite the header with updated fields.
// It repositions the file pointer back at the end of the file.
// returns true on success, false on failure.
static bool UpdateFstHeader(const Fst<A> &fst, std::ostream &strm, // NOLINT
const FstWriteOptions &opts, int version,
const string &type, uint64 properties,
FstHeader *hdr, size_t header_offset) {
strm.seekp(header_offset);
if (!strm) {
LOG(ERROR) << "Fst::UpdateFstHeader: Write failed: " << opts.source;
return false;
}
WriteFstHeader(fst, strm, opts, version, type, properties, hdr);
if (!strm) {
LOG(ERROR) << "Fst::UpdateFstHeader: Write failed: " << opts.source;
return false;
}
strm.seekp(0, std::ios_base::end);
if (!strm) {
LOG(ERROR) << "Fst::UpdateFstHeader: Write failed: " << opts.source;
return false;
}
return true;
}
protected:
mutable uint64 properties_; // Property bits
private:
string type_; // Unique name of Fst class
SymbolTable *isymbols_; // Ilabel symbol table
SymbolTable *osymbols_; // Olabel symbol table
void operator=(const FstImpl<A> &impl); // disallow
};
template <class A>
inline bool FstImpl<A>::ReadHeader(std::istream &strm, // NOLINT
const FstReadOptions &opts, int min_version,
FstHeader *hdr) {
if (opts.header)
*hdr = *opts.header;
else if (!hdr->Read(strm, opts.source))
return false;
if (FLAGS_v >= 2) {
LOG(INFO) << "FstImpl::ReadHeader: source: " << opts.source
<< ", fst_type: " << hdr->FstType() << ", arc_type: " << A::Type()
<< ", version: " << hdr->Version()
<< ", flags: " << hdr->GetFlags();
}
if (hdr->FstType() != type_) {
LOG(ERROR) << "FstImpl::ReadHeader: Fst not of type " << type_
<< ": " << opts.source;
return false;
}
if (hdr->ArcType() != A::Type()) {
LOG(ERROR) << "FstImpl::ReadHeader: Arc not of type " << A::Type()
<< ": " << opts.source;
return false;
}
if (hdr->Version() < min_version) {
LOG(ERROR) << "FstImpl::ReadHeader: Obsolete " << type_
<< " Fst version: " << opts.source;
return false;
}
properties_ = hdr->Properties();
if (hdr->GetFlags() & FstHeader::HAS_ISYMBOLS)
isymbols_ = SymbolTable::Read(strm, opts.source);
// Input symbol table not wanted; delete
if (!opts.read_isymbols) SetInputSymbols(0);
if (hdr->GetFlags() & FstHeader::HAS_OSYMBOLS)
osymbols_ = SymbolTable::Read(strm, opts.source);
// Output symbol table not wanted; delete
if (!opts.read_osymbols) SetOutputSymbols(0);
if (opts.isymbols) {
delete isymbols_;
isymbols_ = opts.isymbols->Copy();
}
if (opts.osymbols) {
delete osymbols_;
osymbols_ = opts.osymbols->Copy();
}
return true;
}
template <class Arc>
uint64 TestProperties(const Fst<Arc> &fst, uint64 mask, uint64 *known);
// This is a helper class template useful for attaching an Fst interface to
// its implementation, handling reference counting.
template <class I, class F = Fst<typename I::Arc>>
class ImplToFst : public F {
public:
typedef typename I::Arc Arc;
typedef typename Arc::Weight Weight;
typedef typename Arc::StateId StateId;
StateId Start() const override { return impl_->Start(); }
Weight Final(StateId s) const override { return impl_->Final(s); }
size_t NumArcs(StateId s) const override { return impl_->NumArcs(s); }
size_t NumInputEpsilons(StateId s) const override {
return impl_->NumInputEpsilons(s);
}
size_t NumOutputEpsilons(StateId s) const override {
return impl_->NumOutputEpsilons(s);
}
uint64 Properties(uint64 mask, bool test) const override {
if (test) {
uint64 knownprops, testprops = TestProperties(*this, mask, &knownprops);
impl_->SetProperties(testprops, knownprops);
return testprops & mask;
} else {
return impl_->Properties(mask);
}
}
const string &Type() const override { return impl_->Type(); }
const SymbolTable *InputSymbols() const override {
return impl_->InputSymbols();
}
const SymbolTable *OutputSymbols() const override {
return impl_->OutputSymbols();
}
protected:
explicit ImplToFst(std::shared_ptr<I> impl) : impl_(impl) {}
// This constructor presumes there is a copy constructor for the
// implementation.
ImplToFst(const ImplToFst<I, F> &fst, bool safe) {
if (safe) {
impl_ = std::make_shared<I>(*(fst.impl_));
} else {
impl_ = fst.impl_;
}
}
// GetImpl and GetMutableImpl return raw pointers to the shared object.
const I *GetImpl() const { return impl_.get(); }
I *GetMutableImpl() const { return impl_.get(); }
// GetSharedImpl returns a refcounted smart poiner to the fst implementation.
std::shared_ptr<I> GetSharedImpl() const { return impl_; }
// Unique returns the refcount for the owned smartpointer.
bool Unique() const { return impl_.unique(); }
void SetImpl(std::shared_ptr<I> impl) { impl_ = impl; }
private:
template <class U, class G>
friend void Cast(const U &ifst, G *ofst);
std::shared_ptr<I> impl_;
};
// Converts FSTs by casting their implementations, where this makes
// sense (which excludes implementations with weight-dependent virtual
// methods). Must be a friend of the Fst classes involved (currently
// the concrete Fsts: VectorFst, ConstFst, CompactFst).
template <class F, class G>
void Cast(const F &ifst, G *ofst) {
// Uses an aliasing constructor, based on static_pointer_cast, can only
// be safely used for arc types that have identical storage characteristics.
ofst->impl_ = std::shared_ptr<typename G::Impl>(
ifst.impl_, reinterpret_cast<typename G::Impl *>(ifst.impl_.get()));
}
// Fst Serialization
template <class A>
void FstToString(const Fst<A> &fst, string *result) {
std::ostringstream ostrm;
fst.Write(ostrm, FstWriteOptions("FstToString"));
*result = ostrm.str();
}
template <class A>
void FstToString(const Fst<A> &fst, string *result,
const FstWriteOptions &options) {
std::ostringstream ostrm;
fst.Write(ostrm, options);
*result = ostrm.str();
}
template <class A>
Fst<A> *StringToFst(const string &s) {
std::istringstream istrm(s);
return Fst<A>::Read(istrm, FstReadOptions("StringToFst"));
}
} // namespace fst
#endif // FST_LIB_FST_H_
|