don't panic when context failed to setup (#51)

* don't panic when context failed to setup

Author: naokiri

cmake/DebPack.cmake

@@ -20,6 +20,7 @@ set(CPACK_PACKAGE_CONTACT "[email protected]")
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Naoaki Iwakiri")
 
 set(CPACK_DEBIAN_PACKAGE_DEPENDS "libcskk (>= 0.8.0), fcitx5 (>=5.0.6)")
+set(CPACK_DEBIAN_PACKAGE_SUGGESTS "skkdic, skkdic-extra")
 
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
 set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")

src/cskk.cpp

@@ -59,20 +59,17 @@ void FcitxCskkEngine::save() {
   if (factory_.registered()) {
     instance_->inputContextManager().foreach ([this](InputContext *ic) {
       auto context = ic->propertyFor(&factory_);
-      skk_context_save_dictionaries(context->context());
-      return true;
+      return context->saveDictionary();
     });
   }
 }
 void FcitxCskkEngine::activate(const InputMethodEntry &, InputContextEvent &) {}
 void FcitxCskkEngine::deactivate(const InputMethodEntry &entry,
                                  InputContextEvent &event) {
-  FCITX_UNUSED(entry);
   reset(entry, event);
 }
-void FcitxCskkEngine::reset(const InputMethodEntry &entry,
+void FcitxCskkEngine::reset(const InputMethodEntry &,
                             InputContextEvent &event) {
-  FCITX_UNUSED(entry);
   CSKK_DEBUG() << "Reset";
   auto ic = event.inputContext();
   auto context = ic->propertyFor(&factory_);
@@ -229,7 +226,7 @@ KeyList FcitxCskkEngine::getSelectionKeys(
 std::string FcitxCskkEngine::subModeIconImpl(const InputMethodEntry &,
                                              InputContext &ic) {
   auto context = ic.propertyFor(&factory_);
-  auto current_input_mode = skk_context_get_input_mode(context->context());
+  auto current_input_mode = context->getInputMode();
   switch (current_input_mode) {
   case InputMode::Ascii:
     return "cskk-ascii";
@@ -241,9 +238,11 @@ std::string FcitxCskkEngine::subModeIconImpl(const InputMethodEntry &,
     return "cskk-katakana";
   case InputMode::Zenkaku:
     return "cskk-zenei";
+  default:
+    return "";
   }
-  return "";
 }
+bool FcitxCskkEngine::isEngineReady() { return factory_.registered(); }
 
 /*******************************************************************************
  * CskkContext
@@ -252,10 +251,17 @@ std::string FcitxCskkEngine::subModeIconImpl(const InputMethodEntry &,
 FcitxCskkContext::FcitxCskkContext(FcitxCskkEngine *engine, InputContext *ic)
     : context_(skk_context_new(nullptr, 0)), ic_(ic), engine_(engine) {
   CSKK_DEBUG() << "Cskk context new";
-  skk_context_set_input_mode(context_, *engine_->config().inputMode);
+  if (!context_) {
+    // new context wasn't created
+    CSKK_ERROR() << "Failed to create new cskk context";
+  }
 }
-FcitxCskkContext::~FcitxCskkContext() = default;
+FcitxCskkContext::~FcitxCskkContext() { skk_free_context(context_); }
 void FcitxCskkContext::keyEvent(KeyEvent &keyEvent) {
+  if (!context_) {
+    CSKK_ERROR() << "CSKK Context is not setup. Ignored key.";
+    return;
+  }
   auto candidateList = std::dynamic_pointer_cast<FcitxCskkCandidateList>(
       ic_->inputPanel().candidateList());
   if (candidateList != nullptr && !candidateList->empty()) {
@@ -329,6 +335,10 @@ void FcitxCskkContext::reset() {
   updateUI();
 }
 void FcitxCskkContext::updateUI() {
+  if (!context_) {
+    CSKK_WARN() << "No context setup";
+    return;
+  }
   auto &inputPanel = ic_->inputPanel();
 
   // Output
@@ -385,6 +395,10 @@ void FcitxCskkContext::updateUI() {
 }
 void FcitxCskkContext::applyConfig() {
   CSKK_DEBUG() << "apply config";
+  if (!context_) {
+    CSKK_WARN() << "No context setup. Ignoring config.";
+    return;
+  }
   auto &config = engine_->config();
 
   skk_context_set_rule(context_, config.cskkRule->c_str());
@@ -398,6 +412,22 @@ void FcitxCskkContext::copyTo(InputContextProperty *context) {
   skk_context_set_input_mode(otherContext->context(),
                              skk_context_get_input_mode(context_));
 }
+bool FcitxCskkContext::saveDictionary() {
+  if (!context_) {
+    CSKK_WARN() << "No cskk context setup. Ignored dictionary save.";
+    return false;
+  }
+  skk_context_save_dictionaries(context_);
+  // cskk v0.8 doesn't return value on save dict, return true for now.
+  return true;
+}
+int FcitxCskkContext::getInputMode() {
+  if (!context_) {
+    CSKK_WARN() << "No cskk context setup. No inputmode.";
+    return -1;
+  }
+  return skk_context_get_input_mode(context_);
+}
 
 /*******************************************************************************
  * FcitxCskkFactory
@@ -408,7 +438,11 @@ AddonInstance *FcitxCskkFactory::create(AddonManager *manager) {
     CSKK_DEBUG() << "**** CSKK FcitxCskkFactory Create ****";
     registerDomain("fcitx5-cskk", FCITX_INSTALL_LOCALEDIR);
     auto engine = new FcitxCskkEngine(manager->instance());
-    return engine;
+    if (engine->isEngineReady()) {
+      return engine;
+    } else {
+      return nullptr;
+    }
   }
 }
 } // namespace fcitx

src/cskk.h

@@ -59,6 +59,8 @@ class FcitxCskkEngine final : public InputMethodEngineV2 {
   static KeyList
   getSelectionKeys(CandidateSelectionKeys candidateSelectionKeys);
 
+  bool isEngineReady();
+
 private:
   Instance *instance_;
   FactoryFor<FcitxCskkContext> factory_;
@@ -69,9 +71,6 @@ class FcitxCskkEngine final : public InputMethodEngineV2 {
   static const std::string config_file_path;
 
   void loadDictionary();
-  static std::string getXDGDataHome();
-  static std::vector<std::string> getXDGDataDirs();
-
   void freeDictionaries();
 };
 
@@ -86,6 +85,13 @@ class FcitxCskkContext final : public InputContextProperty {
   void reset();
   void updateUI();
   void applyConfig();
+
+  bool saveDictionary();
+  // value castable to InputMode
+  int getInputMode();
+
+  // FIXME: Ideally, don't use this context() and prepare public function for
+  // each usage to separate the responsibility.
   auto &context() { return context_; }
 
 private:

src/log.h

@@ -19,5 +19,6 @@
 FCITX_DECLARE_LOG_CATEGORY(cskk_log);
 #define CSKK_DEBUG() FCITX_LOGC(cskk_log, Debug) << "\t**CSKK** "
 #define CSKK_WARN() FCITX_LOGC(cskk_log, Warn) << "\t**CSKK** "
+#define CSKK_ERROR() FCITX_LOGC(cskk_log, Error) << "\t**CSKK** "
 
 #endif // FCITX5_CSKK_LOG_H