vocabulary.h

Go to the documentation of this file.

//
// Copyright RIME Developers
// Distributed under the BSD License
//
// 2011-07-10 GONG Chen <chen.sst@gmail.com>
//
 
#ifndef RIME_VOCABULARY_H_
#define RIME_VOCABULARY_H_
 
#include <stdint.h>
#include <rime_api.h>
#include <rime/common.h>
 
namespace rime {
 
using Syllabary = set<string>;
 
using SyllableId = int32_t;
 
class Code : public vector<SyllableId> {
 public:
  Code() = default;
  Code(const Code::const_iterator& begin, const Code::const_iterator& end)
      : vector<SyllableId>(begin, end) {}
 
  static const size_t kIndexCodeMaxLength = 3;
 
  bool operator<(const Code& other) const;
  bool operator==(const Code& other) const;
 
  void CreateIndex(Code* index_code);
 
  string ToString() const;
};
 
struct ShortDictEntry {
  string text;
  Code code;  // multi-syllable code from prism
  double weight = 0.0;
 
  ShortDictEntry() = default;
  bool operator<(const ShortDictEntry& other) const;
};
 
struct DictEntry {
  string text;
  string comment;
  string preedit;
  Code code;           // multi-syllable code from prism
  string custom_code;  // user defined code
  double weight = 0.0;
  // 全碼匹配長度積分，記錄該詞條對應的路徑中，屬於「全拼」部分的字符總長度
  double quality_len = 0.0;
  int commit_count = 0;
  int remaining_code_length = 0;
  int matching_code_size = 0;
 
  DictEntry() = default;
  ShortDictEntry ToShort() const { return {text, code, weight}; }
  bool IsExactMatch() const {
    return matching_code_size == 0 || matching_code_size == code.size();
  }
  bool IsPredictiveMatch() const {
    return matching_code_size != 0 && matching_code_size < code.size();
  }
  bool operator<(const DictEntry& other) const;
};
 
class ShortDictEntryList : public vector<of<ShortDictEntry>> {
 public:
  void Sort();
  void SortRange(size_t start, size_t count);
};
 
class DictEntryList : public vector<of<DictEntry>> {
 public:
  void Sort();
  void SortRange(size_t start, size_t count);
};
 
using DictEntryFilter = function<bool(an<DictEntry> entry)>;
 
class RIME_DLL DictEntryFilterBinder {
 public:
  virtual ~DictEntryFilterBinder() = default;
  virtual void AddFilter(DictEntryFilter filter);
 
 protected:
  DictEntryFilter filter_;
};
 
class Vocabulary;
 
struct VocabularyPage {
  ShortDictEntryList entries;
  an<Vocabulary> next_level;
};
 
class Vocabulary : public map<int, VocabularyPage> {
 public:
  ShortDictEntryList* LocateEntries(const Code& code);
  void SortHomophones();
};
 
// word -> { code, ... }
using ReverseLookupTable = hash_map<string, set<string>>;
 
}  // namespace rime
 
#endif  // RIME_VOCABULARY_H_