Merge pull request #71 from fcitx/Issue#70_configurable_annotation

Configurable when to show annotation

Author: naokiri

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.13)
 cmake_policy(SET CMP0063 NEW)
-project(fcitx5-cskk VERSION 1.0.0)
+project(fcitx5-cskk VERSION 1.1.0)
 set(CMAKE_CXX_FLAGS "-Wall")
 set(CMAKE_CXX_STANDARD 17)
 IF(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)

src/cskk.cpp

@@ -339,7 +339,9 @@ void FcitxCskkContext::updateUI() {
     CSKK_WARN() << "No context setup";
     return;
   }
+  auto &config = engine_->config();
   auto &inputPanel = ic_->inputPanel();
+  inputPanel.reset();
 
   // Output
   if (auto output = skk_context_poll_output(context_)) {
@@ -359,7 +361,9 @@ void FcitxCskkContext::updateUI() {
   // CandidateList
   int currentCursorPosition =
       skk_context_get_current_candidate_cursor_position(context_);
-  if (currentCursorPosition > engine_->config().pageStartIdx.value() - 1) {
+  bool showCandidateList =
+      currentCursorPosition > engine_->config().pageStartIdx.value() - 1;
+  if (showCandidateList) {
     char *current_to_composite = skk_context_get_current_to_composite(context_);
     auto currentCandidateList =
         std::dynamic_pointer_cast<FcitxCskkCandidateList>(
@@ -383,7 +387,13 @@ void FcitxCskkContext::updateUI() {
 
   if (ic_->capabilityFlags().test(CapabilityFlag::Preedit)) {
     inputPanel.setClientPreedit(mainPreedit);
-    inputPanel.setPreedit(supplementPreedit);
+    if ((config.showAnnotationCondition.value() ==
+         ShowAnnotationCondition::Always) ||
+        (config.showAnnotationCondition.value() ==
+             ShowAnnotationCondition::SingleCandidate &&
+         !showCandidateList)) {
+      inputPanel.setPreedit(supplementPreedit);
+    }
     ic_->updatePreedit();
   } else {
     inputPanel.setPreedit(mainPreedit);
@@ -444,6 +454,8 @@ FcitxCskkContext::formatPreedit(CskkStateInfoFfi *cskkStateInfoArray,
   std::string precomposition_marker = "▽";
   std::string selection_marker = "▼";
   Text mainContent = Text(""), supplementContent = Text("");
+  mainContent.clear();
+  supplementContent.clear();
   size_t mainCursorIdx = 0;
   for (uint32_t i = 0; i < stateLen; i++) {
     auto cskkStateInfo = cskkStateInfoArray[i];
@@ -522,7 +534,6 @@ FcitxCskkContext::formatPreedit(CskkStateInfoFfi *cskkStateInfoArray,
       mainContent.append(tmpContentString, TextFormatFlag::Underline);
 
       if (compositionSelectionStateInfo.annotation) {
-        supplementContent.clear();
         supplementContent.append(compositionSelectionStateInfo.annotation,
                                  TextFormatFlag::DontCommit);
       }

src/cskkconfig.h

@@ -36,10 +36,14 @@ FCITX_CONFIG_ENUM_NAME_WITH_I18N(CandidateLayoutHint, N_("Not set"),
                                  N_("Vertical"), N_("Horizontal"));
 
 FCITX_CONFIG_ENUM(CandidateSelectionKeys, Number, ABCD, QwertyCenter)
+
+enum class ShowAnnotationCondition { Always, SingleCandidate, Never };
+FCITX_CONFIG_ENUM_NAME_WITH_I18N(ShowAnnotationCondition, N_("Always"),
+                                 N_("SingleCandidate"), N_("Never"));
+
 static constexpr const char *CandidateSelectionKeys_Annotations[] = {
     "Number (1,2,3,...)", "ABCD (a,b,c,d,...)",
     "Qwerty Center row (a,s,d,f,...)"};
-
 struct CandidateSelectionKeysAnnotation : public EnumAnnotation {
   void dumpDescription(RawConfig &config) const {
     EnumAnnotation::dumpDescription(config);
@@ -132,10 +136,13 @@ FCITX_CONFIGURATION(
         candidateSelectionKeys{this, "Candidate selection keys",
                                _("Candidate selection keys"),
                                CandidateSelectionKeys::Number};
-    ExternalOption dictionary{this, "Dictionary", _("Dictionary"),
-                              "fcitx://config/addon/cskk/dictionary_list"};
-    //    Option<bool> showAnnotation{this, "ShowAnnotation",
-    //                                _("Show Annotation. Fake yet."), true};);
-    ) // FCITX_CONFIGURATION
+    OptionWithAnnotation<ShowAnnotationCondition,
+                         ShowAnnotationConditionI18NAnnotation>
+        showAnnotationCondition{this, "Show Annotation when",
+                                _("Show Annotation when"),
+                                ShowAnnotationCondition::Always};
+    ExternalOption dictionary{
+        this, "Dictionary", _("Dictionary"),
+        "fcitx://config/addon/cskk/dictionary_list"};) // FCITX_CONFIGURATION
 } // namespace fcitx
 #endif // FCITX5_CSKK_CSKKCONFIG_H