src/core/Dict.h

   1 /**
   2  * FileName: Dict.h.
   3  * Used to define the class Dict which can handle dictionary.
   4  *
   5  * Copyright (C) 2008 Kermit Mei <kermit.mei@gmail.com>
   6  * All Rights Reserved.
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 3 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation.
  21  *
  22  * Written by Kermit Mei <kermit.mei@gmail.com>
  23  *
  24  * Many of the ideas implemented here are from the author's experiment.
  25  * But the dictionary's format coincide with the other word recite software
  26  * to help the users get more available data. And the review times designed
  27  * by means of the theory named Forgetting Curve which dicoveried by the
  28  * German psychologist named Hermann Ebbinghaus(1850–1909).
  29  *
  30  **/
  31
  32 #ifndef DICT_HPP
  33 #define DICT_HPP
  34
  35 #include <map>
  36 #include <string>
  37
  38 #include "DictItem.h"
  39
  40 namespace freeRecite {
  41
  42 class Dict;
  43 extern Dict dictionary;
  44
  45 class Dict
  46 {
  47 public:
  48   Dict();
  49   ~Dict();
  50   //Initialize the dictionary
  51   bool load();
  52
  53   //Fine the word 'word' in dictionaries
  54   bool lookUp(const std::string &word);
  55
  56   bool isValid() const
  57   { return validFlag; }
  58
  59   //Modify the local dictionary.
  60   bool modify(const std::string &item);
  61
  62   //Merge the local and global dictionaries.
  63   bool merge(const char *newDicName);
  64
  65   //Save the local dictionary when you modified
  66   bool save();
  67
  68   //Get the current word
  69   const std::string &word() const;
  70
  71   //Get the current phonetics
  72   const std::string &phonetics() const;
  73
  74   //Get the current raw phonetics();
  75   const std::string &rawPhonetics() const;
  76
  77   //Get the translation
  78   const std::string &translation() const;
  79
  80   //Get the example
  81   const std::string &example()const;
  82
  83   //Get the plain text of translation
  84   const std::string &plainTranslation() const;
  85
  86 private:
  87   bool findInGlobl(const std::string &swatch);
  88   void setPlainTranslation();
  89   bool validFlag;
  90   DictItem dictItem;
  91   std::string plainTran;
  92   std::ifstream *ifsgdic;
  93   std::map<std::string,std::string> dict;
  94 };
  95
  96 inline
  97 Dict::Dict()
  98   : validFlag(false),ifsgdic(0)
  99 { /* Do nothing! */ }
 100
 101 inline
 102 const std::string &Dict::word() const {
 103   return dictItem.getW();
 104 }
 105
 106 inline
 107 const std::string &Dict::rawPhonetics() const {
 108   return dictItem.getT();
 109 }
 110
 111 inline
 112 const std::string &Dict::translation()const {
 113   return dictItem.getM();
 114 }
 115
 116 inline
 117 const std::string &Dict::example()const {
 118   return dictItem.getE();
 119 }
 120
 121
 122 inline
 123 const std::string &Dict::plainTranslation() const{
 124   return plainTran;
 125 }
 126
 127
 128
 129 } // namespace freeRecite end
 130
 131 #endif