cskk v3.0 with completion

Author: naokiri

CMakeLists.txt

@@ -22,7 +22,7 @@ find_package(Fcitx5Core 5.0.6 REQUIRED)
 find_package(Fcitx5Utils 5.0.6 REQUIRED)
 
 # GITHUB_ACTION_BUILD_CSKK_VERSION=2.0.0
-pkg_check_modules(LIBCSKK REQUIRED IMPORTED_TARGET "cskk>=2.0")
+pkg_check_modules(LIBCSKK REQUIRED IMPORTED_TARGET "cskk>=3.0")
 
 option(ENABLE_QT "Enable Qt for GUI configuration" On)
 

development.org

@@ -31,6 +31,10 @@ Should update these files and then create a deploy on github
 Following semver rule but with tweak same as rust lang's cargo.
 Initial development releases starting with "0.y.z" can treat changes in "y" as a major release, and "z" as a minor release.
 
+** Shared lib places
+Fcitx5 finds addon from FCITX_ADDON_DIRS env var, a colon (':') separated dir list. fallbacks to FCITX_INSTALL_ADDONDIR configured on build.
+e.g. FCITX_ADDON_DIRS=build/src:/usr/lib/x86_64-linux-gnu/fcitx5 fcitx5 --verbose=*=5
+
 * Q
 ** How config works?
 Create Option class.

gui/adddictdialog.cpp

@@ -32,6 +32,7 @@ AddDictDialog::AddDictDialog(QWidget *parent)
   m_ui->typeComboBox->addItem(_("System"));
   m_ui->typeComboBox->addItem(_("User"));
   m_ui->typeComboBox->setCurrentIndex(1);
+  // m_ui->completeNoRadio
 
   indexChanged();
 
@@ -57,6 +58,11 @@ QMap<QString, QString> AddDictDialog::dictionary() {
   dict["file"] = m_ui->urlLineEdit->text();
   dict["mode"] = mode_type[idx];
   dict["encoding"] = m_ui->encodingEdit->text();
+  if (m_ui->completeYesRadio->isChecked()) {
+    dict["complete"] = "true";
+  } else {
+    dict["complete"] = "false";
+  }
 
   return dict;
 }
@@ -120,6 +126,7 @@ void AddDictDialog::browseClicked() {
   }
   validate();
 }
+
 void AddDictDialog::setDictionary(QMap<QString, QString> &dict) {
   m_ui->urlLineEdit->setText(dict["file"]);
 
@@ -130,6 +137,9 @@ void AddDictDialog::setDictionary(QMap<QString, QString> &dict) {
     }
   }
   m_ui->encodingEdit->setText(dict["encoding"]);
+  if (dict["complete"] == "complete") {
+    m_ui->completeYesRadio->setChecked(true);
+  }
 }
 
 } // namespace fcitx

gui/adddictdialog.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>361</width>
-    <height>153</height>
+    <width>507</width>
+    <height>202</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -84,18 +84,33 @@
        </property>
       </widget>
      </item>
-     <item row="3" column="1">
-      <spacer name="verticalSpacer">
-       <property name="orientation">
-        <enum>Qt::Vertical</enum>
-       </property>
-       <property name="sizeHint" stdset="0">
-        <size>
-         <width>20</width>
-         <height>40</height>
-        </size>
+     <item row="3" column="0">
+      <widget class="QLabel" name="completeLabel">
+       <property name="text">
+        <string>TextLabel</string>
        </property>
-      </spacer>
+      </widget>
+     </item>
+     <item row="3" column="1">
+      <layout class="QHBoxLayout" name="horizontalLayout_5">
+       <item>
+        <widget class="QRadioButton" name="completeNoRadio">
+         <property name="text">
+          <string>Do not complete</string>
+         </property>
+         <property name="checked">
+          <bool>true</bool>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <widget class="QRadioButton" name="completeYesRadio">
+         <property name="text">
+          <string>Use for complete</string>
+         </property>
+        </widget>
+       </item>
+      </layout>
      </item>
     </layout>
    </item>

gui/dictmodel.cpp

@@ -1,6 +1,6 @@
 /*
- * SPDX-FileCopyrightText: <text>2013~2022 CSSlayer <[email protected]>, Naoaki Iwakiri
- * <[email protected]></text>
+ * SPDX-FileCopyrightText: <text>2013~2022 CSSlayer <[email protected]>, Naoaki
+ * Iwakiri <[email protected]></text>
  *
  * SPDX-License-Identifier: GPL-3.0-or-later
  *

gui/dictmodel.h

@@ -38,7 +38,7 @@ class SkkDictModel : public QAbstractListModel {
   static QMap<QString, QString> parseLine(const QString &line);
   static QString serialize(const QMap<QString, QString> &dict);
   inline static QSet<QString> m_knownKeys =
-      QSet<QString>({"file", "type", "mode", "encoding"});
+      QSet<QString>({"file", "type", "mode", "encoding", "complete"});
 
 private:
   QList<QMap<QString, QString>> m_dicts;

src/cskk.cpp

@@ -22,6 +22,7 @@
 #include <filesystem>
 #include <string>
 #include <vector>
+
 extern "C" {
 #include <fcntl.h>
 }
@@ -46,7 +47,9 @@ FcitxCskkEngine::FcitxCskkEngine(Instance *instance)
   reloadConfig();
   instance_->inputContextManager().registerProperty("cskkcontext", &factory_);
 }
+
 FcitxCskkEngine::~FcitxCskkEngine() = default;
+
 void FcitxCskkEngine::keyEvent(const InputMethodEntry &, KeyEvent &keyEvent) {
   CSKK_DEBUG() << "Engine keyEvent start: " << keyEvent.rawKey();
   // delegate to context
@@ -55,6 +58,7 @@ void FcitxCskkEngine::keyEvent(const InputMethodEntry &, KeyEvent &keyEvent) {
   context->keyEvent(keyEvent);
   CSKK_DEBUG() << "Engine keyEvent end";
 }
+
 void FcitxCskkEngine::save() {
   if (factory_.registered()) {
     instance_->inputContextManager().foreach ([this](InputContext *ic) {
@@ -63,24 +67,29 @@ void FcitxCskkEngine::save() {
     });
   }
 }
+
 void FcitxCskkEngine::activate(const InputMethodEntry &, InputContextEvent &) {}
+
 void FcitxCskkEngine::deactivate(const InputMethodEntry &entry,
                                  InputContextEvent &event) {
   reset(entry, event);
 }
+
 void FcitxCskkEngine::reset(const InputMethodEntry &,
                             InputContextEvent &event) {
   CSKK_DEBUG() << "Reset";
   auto ic = event.inputContext();
   auto context = ic->propertyFor(&factory_);
   context->reset();
 }
+
 void FcitxCskkEngine::setConfig(const RawConfig &config) {
   CSKK_DEBUG() << "Cskk setconfig";
   config_.load(config, true);
   safeSaveAsIni(config_, FcitxCskkEngine::config_file_path);
   reloadConfig();
 }
+
 void FcitxCskkEngine::reloadConfig() {
   CSKK_DEBUG() << "Cskkengine reload config";
   readAsIni(config_, FcitxCskkEngine::config_file_path);
@@ -96,6 +105,7 @@ void FcitxCskkEngine::reloadConfig() {
 }
 
 typedef enum _FcitxSkkDictType { FSDT_Invalid, FSDT_File } FcitxSkkDictType;
+
 void FcitxCskkEngine::loadDictionary() {
   freeDictionaries();
 
@@ -124,6 +134,8 @@ void FcitxCskkEngine::loadDictionary() {
     int mode = 0;
     std::string path;
     std::string encoding;
+    bool complete = false;
+
     for (auto &token : tokens) {
       auto equal = token.find('=');
       if (equal == std::string::npos) {
@@ -149,6 +161,10 @@ void FcitxCskkEngine::loadDictionary() {
         }
       } else if (key == "encoding") {
         encoding = value;
+      } else if (key == "complete") {
+        if (value == "true") {
+          complete = true;
+        }
       }
     }
 
@@ -165,9 +181,11 @@ void FcitxCskkEngine::loadDictionary() {
       }
       if (mode == 1) {
         // readonly mode
-        auto *dict = skk_file_dict_new(path.c_str(), encoding.c_str());
+        auto *dict =
+            skk_file_dict_new(path.c_str(), encoding.c_str(), complete);
         if (dict) {
-          CSKK_DEBUG() << "Adding file dict: " << path;
+          CSKK_DEBUG() << "Adding file dict: " << path
+                       << " complete:" << complete;
           dictionaries_.emplace_back(dict);
         } else {
           CSKK_WARN() << "Static dictionary load error. Ignored: " << path;
@@ -182,7 +200,8 @@ void FcitxCskkEngine::loadDictionary() {
               StandardPath::global().userDirectory(StandardPath::Type::PkgData),
               path.substr(var_len));
         }
-        auto *userdict = skk_user_dict_new(realpath.c_str(), encoding.c_str());
+        auto *userdict =
+            skk_user_dict_new(realpath.c_str(), encoding.c_str(), complete);
         if (userdict) {
           CSKK_DEBUG() << "Adding user dict: " << realpath;
           dictionaries_.emplace_back(userdict);
@@ -201,6 +220,7 @@ void FcitxCskkEngine::freeDictionaries() {
   }
   dictionaries_.clear();
 }
+
 KeyList FcitxCskkEngine::getSelectionKeys(
     CandidateSelectionKeys candidateSelectionKeys) {
   switch (candidateSelectionKeys) {
@@ -223,6 +243,7 @@ KeyList FcitxCskkEngine::getSelectionKeys(
                           Key(FcitxKey_0)};
   }
 }
+
 std::string FcitxCskkEngine::subModeIconImpl(const InputMethodEntry &,
                                              InputContext &ic) {
   auto context = ic.propertyFor(&factory_);
@@ -242,6 +263,7 @@ std::string FcitxCskkEngine::subModeIconImpl(const InputMethodEntry &,
     return "";
   }
 }
+
 bool FcitxCskkEngine::isEngineReady() { return factory_.registered(); }
 
 /*******************************************************************************
@@ -256,7 +278,9 @@ FcitxCskkContext::FcitxCskkContext(FcitxCskkEngine *engine, InputContext *ic)
     CSKK_ERROR() << "Failed to create new cskk context";
   }
 }
+
 FcitxCskkContext::~FcitxCskkContext() { skk_free_context(context_); }
+
 void FcitxCskkContext::keyEvent(KeyEvent &keyEvent) {
   if (!context_) {
     CSKK_ERROR() << "CSKK Context is not setup. Ignored key.";
@@ -291,6 +315,7 @@ void FcitxCskkContext::keyEvent(KeyEvent &keyEvent) {
     updateUI();
   }
 }
+
 bool FcitxCskkContext::handleCandidateSelection(
     const std::shared_ptr<FcitxCskkCandidateList> &candidateList,
     KeyEvent &keyEvent) {
@@ -331,9 +356,12 @@ bool FcitxCskkContext::handleCandidateSelection(
 }
 
 void FcitxCskkContext::reset() {
-  skk_context_reset(context_);
+  if (context_) {
+    skk_context_reset(context_);
+  }
   updateUI();
 }
+
 void FcitxCskkContext::updateUI() {
   if (!context_) {
     CSKK_WARN() << "No context setup";
@@ -403,6 +431,7 @@ void FcitxCskkContext::updateUI() {
   ic_->updateUserInterface(UserInterfaceComponent::StatusArea);
   ic_->updateUserInterface(UserInterfaceComponent::InputPanel);
 }
+
 void FcitxCskkContext::applyConfig() {
   CSKK_DEBUG() << "apply config";
   if (!context_) {
@@ -418,6 +447,7 @@ void FcitxCskkContext::applyConfig() {
   skk_context_set_period_style(context_, *config.periodStyle);
   skk_context_set_comma_style(context_, *config.commaStyle);
 }
+
 void FcitxCskkContext::copyTo(InputContextProperty *) {
   // auto otherContext = dynamic_cast<FcitxCskkContext *>(context);
   // Ignored.
@@ -426,6 +456,7 @@ void FcitxCskkContext::copyTo(InputContextProperty *) {
   // fcitx5-cskk will just hold each cskkcontext in each input context's
   // property and shares nothing.
 }
+
 bool FcitxCskkContext::saveDictionary() {
   if (!context_) {
     CSKK_WARN() << "No cskk context setup. Ignored dictionary save.";
@@ -435,13 +466,15 @@ bool FcitxCskkContext::saveDictionary() {
   // 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_);
 }
+
 /**
  * format preedit state into Text.
  * Returns tuple of <Main content Text, Supplement content Text>
@@ -453,6 +486,7 @@ FcitxCskkContext::formatPreedit(CskkStateInfoFfi *cskkStateInfoArray,
                                 uint32_t stateLen) {
   std::string precomposition_marker = "▽";
   std::string selection_marker = "▼";
+  std::string completion_marker = "■";
   Text mainContent = Text(""), supplementContent = Text("");
   mainContent.clear();
   supplementContent.clear();
@@ -564,11 +598,25 @@ FcitxCskkContext::formatPreedit(CskkStateInfoFfi *cskkStateInfoArray,
       mainCursorIdx += strlen("【");
       mainContent.append("【", TextFormatFlag::DontCommit);
     } break;
+    case CompleteStateInfo: {
+      auto completeStateInfo = cskkStateInfo.complete_state_info;
+      mainContent.append(completion_marker, TextFormatFlag::DontCommit);
+      if (completeStateInfo.completed) {
+        mainCursorIdx += strlen(completeStateInfo.completed);
+        mainContent.append(completeStateInfo.completed,
+                           TextFormatFlag::Underline);
+      }
+      if (completeStateInfo.completed_midashi) {
+        supplementContent.append(completeStateInfo.completed_midashi,
+                                 TextFormatFlag::DontCommit);
+      }
+    } break;
     }
   }
   // FIXME: Silently assuming length is less than int_max here. May fail when
   // length is over UINT_MAX. very unlikely, not high priority.
   mainContent.setCursor((int)mainCursorIdx);
+  // Starting from 1 on purpose. No paren for submodes on top of the stack.
   for (uint32_t i = 1; i < stateLen; i++) {
     mainContent.append("】", TextFormatFlag::DontCommit);
   }