user_dict_manager.h

Go to the documentation of this file.

//
// Copyright RIME Developers
// Distributed under the BSD License
//
// 2012-03-23 GONG Chen <chen.sst@gmail.com>
//
#ifndef RIME_USER_DICT_MANAGER_H_
#define RIME_USER_DICT_MANAGER_H_
 
#include <rime/common.h>
#include <rime/dict/user_db.h>
 
namespace rime {
 
class Deployer;
 
using UserDictList = vector<string>;
 
class RIME_DLL UserDictManager {
 public:
  UserDictManager(Deployer* deployer);
 
  // If component is null, the current userdb component is used.
  void GetUserDictList(UserDictList* user_dict_list,
                       UserDb::Component* component = nullptr);
 
  // CAVEAT: the user dict should be closed before the following operations
  bool Backup(const string& dict_name);
  bool Restore(const path& snapshot_file);
  bool UpgradeUserDict(const string& dict_name);
  // returns num of exported entries, -1 denotes failure
  int Export(const string& dict_name, const path& text_file);
  // returns num of imported entries, -1 denotes failure
  int Import(const string& dict_name, const path& text_file);
 
  bool Synchronize(const string& dict_name);
  bool SynchronizeAll();
 
 protected:
  Deployer* deployer_;
  path path_;
  UserDb::Component* user_db_component_;
};
 
}  // namespace rime
 
#endif  // RIME_USER_DICT_MANAGER_H_