add comment property to CandidateWord

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.6.0)
-project(fcitx VERSION 5.1.8)
+project(fcitx VERSION 5.1.9)
 set(FCITX_VERSION ${PROJECT_VERSION})
 
 find_package(ECM REQUIRED 1.0.0)

src/frontend/dbusfrontend/dbusfrontend.cpp

@@ -194,11 +194,10 @@ class DBusInputContext1 : public InputContext,
     }
 
     void updateClientSideUIImpl() override {
-        auto preedit =
-            im_->instance()->outputFilter(this, inputPanel().preedit());
-        auto auxUp = im_->instance()->outputFilter(this, inputPanel().auxUp());
-        auto auxDown =
-            im_->instance()->outputFilter(this, inputPanel().auxDown());
+        auto instance = im_->instance();
+        auto preedit = instance->outputFilter(this, inputPanel().preedit());
+        auto auxUp = instance->outputFilter(this, inputPanel().auxUp());
+        auto auxDown = instance->outputFilter(this, inputPanel().auxDown());
         auto candidateList = inputPanel().candidateList();
         int cursorIndex = 0;
 
@@ -220,9 +219,9 @@ class DBusInputContext1 : public InputContext,
                 Text labelText = candidate.hasCustomLabel()
                                      ? candidate.customLabel()
                                      : candidateList->label(i);
-                labelText = im_->instance()->outputFilter(this, labelText);
+                labelText = instance->outputFilter(this, labelText);
                 Text candidateText =
-                    im_->instance()->outputFilter(this, candidate.text());
+                    instance->outputFilter(this, candidate.textWithComment());
                 candidates.emplace_back(std::make_tuple(
                     labelText.toString(), candidateText.toString()));
             }

src/lib/fcitx/candidatelist.cpp

@@ -93,6 +93,7 @@ class CandidateWordPrivate {
     bool isPlaceHolder_ = false;
     Text customLabel_;
     bool hasCustomLabel_ = false;
+    Text comment_;
 };
 
 CandidateWord::CandidateWord(Text text)
@@ -110,6 +111,26 @@ void CandidateWord::setText(Text text) {
     d->text_ = std::move(text);
 }
 
+const Text &CandidateWord::comment() const {
+    FCITX_D();
+    return d->comment_;
+}
+
+void CandidateWord::setComment(Text comment) {
+    FCITX_D();
+    d->comment_ = std::move(comment);
+}
+
+Text CandidateWord::textWithComment(std::string separator) const {
+    FCITX_D();
+    auto text = d->text_;
+    if (!d->comment_.empty()) {
+        text.append(std::move(separator));
+        text.append(d->comment_);
+    }
+    return text;
+}
+
 bool CandidateWord::isPlaceHolder() const {
     FCITX_D();
     return d->isPlaceHolder_;

src/lib/fcitx/candidatelist.h

@@ -46,12 +46,28 @@ class FCITXCORE_EXPORT CandidateWord {
     bool isPlaceHolder() const;
     bool hasCustomLabel() const;
     const Text &customLabel() const;
+    /**
+     * Return comment corresponding to the candidate.
+     *
+     * @return value of comment.
+     * @since 5.1.9
+     */
+    const Text &comment() const;
+    /**
+     * Return text with comment.
+     *
+     * @param separator separator between text and comment.
+     * @return value of comment.
+     * @since 5.1.9
+     */
+    Text textWithComment(std::string separator = " ") const;
 
 protected:
     void setText(Text text);
     void setPlaceHolder(bool placeHolder);
     void resetCustomLabel();
     void setCustomLabel(Text text);
+    void setComment(Text comment);
 
 private:
     std::unique_ptr<CandidateWordPrivate> d_ptr;

src/lib/fcitx/text.cpp

@@ -6,6 +6,7 @@
  */
 
 #include "text.h"
+#include <iterator>
 #include <stdexcept>
 #include <tuple>
 #include <vector>
@@ -55,6 +56,13 @@ void Text::append(std::string str, TextFormatFlags flag) {
     d->texts_.emplace_back(std::move(str), flag);
 }
 
+void Text::append(Text text) {
+    FCITX_D();
+    std::copy(std::make_move_iterator(text.d_ptr->texts_.begin()),
+              std::make_move_iterator(text.d_ptr->texts_.end()),
+              std::back_inserter(d->texts_));
+}
+
 const std::string &Text::stringAt(int idx) const {
     FCITX_D();
     return std::get<std::string>(d->texts_[idx]);

src/lib/fcitx/text.h

@@ -37,6 +37,13 @@ class FCITXCORE_EXPORT Text {
     void setCursor(int pos = -1);
     void clear();
     void append(std::string str, TextFormatFlags flag = TextFormatFlag::NoFlag);
+    /**
+     * Append another text.
+     *
+     * @param text text to append
+     * @since 5.1.9
+     */
+    void append(Text text);
     const std::string &stringAt(int idx) const;
     TextFormatFlags formatAt(int idx) const;
     size_t size() const;

src/ui/classic/inputwindow.cpp

@@ -339,8 +339,8 @@ std::pair<int, int> InputWindow::update(InputContext *inputContext) {
             labelText = instance->outputFilter(inputContext, labelText);
             setTextToMultilineLayout(inputContext, labelLayouts_[localIndex],
                                      labelText);
-            auto candidateText =
-                instance->outputFilter(inputContext, candidate.text());
+            auto candidateText = instance->outputFilter(
+                inputContext, candidate.textWithComment());
             setTextToMultilineLayout(
                 inputContext, candidateLayouts_[localIndex], candidateText);
             localIndex++;

src/ui/kimpanel/kimpanel.cpp

@@ -359,8 +359,8 @@ void Kimpanel::updateInputPanel(InputContext *inputContext) {
 
                 labelText = instance->outputFilter(inputContext, labelText);
                 labels.push_back(labelText.toString());
-                auto candidateText =
-                    instance->outputFilter(inputContext, candidate.text());
+                auto candidateText = instance->outputFilter(
+                    inputContext, candidate.textWithComment());
                 texts.push_back(candidateText.toString());
                 attrs.emplace_back("");
             }

src/ui/virtualkeyboard/virtualkeyboard.cpp

@@ -420,7 +420,7 @@ std::vector<std::string> VirtualKeyboard::makeCandidateTextList(
         }
 
         auto candidateText =
-            instance_->outputFilter(inputContext, candidate.text());
+            instance_->outputFilter(inputContext, candidate.textWithComment());
         candidateTextList.push_back(candidateText.toString());
     }
 
@@ -446,7 +446,7 @@ std::vector<std::string> VirtualKeyboard::makeBulkCandidateTextList(
                 continue;
             }
 
-            candidateText = candidate.text();
+            candidateText = candidate.textWithComment();
         } catch (...) {
             break;
         }

test/testcandidatelist.cpp

@@ -14,8 +14,10 @@ int selected = 0;
 
 class TestCandidateWord : public CandidateWord {
 public:
-    TestCandidateWord(int number)
-        : CandidateWord(Text(std::to_string(number))), number_(number) {}
+    TestCandidateWord(int number, Text comment = {})
+        : CandidateWord(Text(std::to_string(number))), number_(number) {
+        setComment(std::move(comment));
+    }
     void select(InputContext *) const override { selected = number_; }
 
 private:
@@ -303,9 +305,17 @@ void test_label() {
     FCITX_ASSERT(candidatelist.label(9).toString() == ",. ");
 }
 
+void test_comment() {
+    TestCandidateWord candidate(1, Text("comment"));
+    FCITX_ASSERT(candidate.text().toString() == "1");
+    FCITX_ASSERT(candidate.comment().toString() == "comment");
+    FCITX_ASSERT(candidate.textWithComment().toString() == "1 comment");
+}
+
 int main() {
     test_basic();
     test_faulty_placeholder();
     test_label();
+    test_comment();
     return 0;
 }

test/testtext.cpp

@@ -6,6 +6,7 @@
  */
 #include <fcitx-utils/log.h>
 #include <fcitx/text.h>
+#include <fcitx-utils/textformatflags.h>
 using namespace fcitx;
 
 void test_basic() {
@@ -33,6 +34,14 @@ void test_basic() {
     FCITX_ASSERT(lines[2].toStringForCommit() == "");
     FCITX_ASSERT(lines[3].toStringForCommit() == "Z");
     FCITX_ASSERT(lines[4].toStringForCommit() == "1");
+
+    text = Text("ABC");
+    Text another = Text("DEF", TextFormatFlag::Bold);
+    another.append("GHI", TextFormatFlag::Italic);
+    text.append(another);
+    FCITX_ASSERT(text.toString() == "ABCDEFGHI");
+    FCITX_ASSERT(text.formatAt(1) == TextFormatFlag::Bold);
+    FCITX_ASSERT(text.formatAt(2) == TextFormatFlag::Italic);
 }
 
 void test_normalize() {