refactor: unify CandidateProto object for paged and bulk candidates

WhiredPlanck · WhiredPlanck · commit e60e2ddd1c86 · 2026-06-04T21:10:35.000+08:00
diff --git a/app/src/main/java/com/osfans/trime/core/Rime.kt b/app/src/main/java/com/osfans/trime/core/Rime.kt
@@ -190,7 +190,7 @@ class Rime :
     override suspend fun getCandidates(
         startIndex: Int,
         limit: Int,
-    ): Array<CandidateItem> = withRimeContext {
+    ): Array<CandidateProto> = withRimeContext {
         getRimeCandidates(startIndex, limit)
     }
 
@@ -490,7 +490,7 @@ class Rime :
         external fun getRimeCandidates(
             startIndex: Int,
             limit: Int,
-        ): Array<CandidateItem>
+        ): Array<CandidateProto>
 
         @JvmStatic
         external fun getRimeBulkCandidates(): Array<Any>
diff --git a/app/src/main/java/com/osfans/trime/core/RimeApi.kt b/app/src/main/java/com/osfans/trime/core/RimeApi.kt
@@ -84,5 +84,5 @@ interface RimeApi {
     suspend fun getCandidates(
         startIndex: Int,
         limit: Int,
-    ): Array<CandidateItem>
+    ): Array<CandidateProto>
 }
diff --git a/app/src/main/java/com/osfans/trime/core/RimeMessage.kt b/app/src/main/java/com/osfans/trime/core/RimeMessage.kt
@@ -106,7 +106,7 @@ sealed class RimeMessage<T>(
         data class Data(
             val total: Int = -1,
             val highlighted: Int = 0,
-            val candidates: Array<CandidateItem> = arrayOf(),
+            val candidates: Array<CandidateProto> = arrayOf(),
         ) {
             override fun equals(other: Any?): Boolean {
                 if (this === other) return true
@@ -196,7 +196,7 @@ sealed class RimeMessage<T>(
                     CandidateListMessage.Data(
                         params[0] as Int,
                         params[1] as Int,
-                        params[2] as Array<CandidateItem>,
+                        params[2] as Array<CandidateProto>,
                     ),
                 )
             MessageType.Key ->
diff --git a/app/src/main/java/com/osfans/trime/core/RimeProto.kt b/app/src/main/java/com/osfans/trime/core/RimeProto.kt
@@ -11,7 +11,7 @@ data class CommitProto(
 
 data class CandidateProto(
     val text: String,
-    val comment: String?,
+    val comment: String,
     val label: String,
 )
 
diff --git a/app/src/main/java/com/osfans/trime/core/SchemaItem.kt b/app/src/main/java/com/osfans/trime/core/SchemaItem.kt
@@ -8,8 +8,3 @@ data class SchemaItem(
     val id: String,
     val name: String = "",
 )
-
-data class CandidateItem(
-    val text: String,
-    val comment: String = "",
-)
diff --git a/app/src/main/java/com/osfans/trime/ime/candidates/CandidateItemUi.kt b/app/src/main/java/com/osfans/trime/ime/candidates/CandidateItemUi.kt
@@ -11,7 +11,7 @@ import android.graphics.Color
 import android.view.View
 import androidx.constraintlayout.widget.ConstraintLayout
 import androidx.core.view.isVisible
-import com.osfans.trime.core.CandidateItem
+import com.osfans.trime.core.CandidateProto
 import com.osfans.trime.data.theme.ColorManager
 import com.osfans.trime.data.theme.FontManager
 import com.osfans.trime.data.theme.Theme
@@ -160,7 +160,7 @@ class CandidateItemUi(
 
     @SuppressLint("UseKtx")
     fun update(
-        item: CandidateItem,
+        item: CandidateProto,
         highlighted: Boolean,
     ) {
         val tColor = if (highlighted) hlTextColor else textColor
diff --git a/app/src/main/java/com/osfans/trime/ime/candidates/compact/CompactCandidateViewAdapter.kt b/app/src/main/java/com/osfans/trime/ime/candidates/compact/CompactCandidateViewAdapter.kt
@@ -10,7 +10,7 @@ import android.view.ViewGroup
 import androidx.core.view.updateLayoutParams
 import com.chad.library.adapter4.BaseQuickAdapter
 import com.google.android.flexbox.FlexboxLayoutManager
-import com.osfans.trime.core.CandidateItem
+import com.osfans.trime.core.CandidateProto
 import com.osfans.trime.data.theme.Theme
 import com.osfans.trime.ime.candidates.CandidateItemUi
 import com.osfans.trime.ime.candidates.CandidateViewHolder
@@ -20,7 +20,7 @@ import splitties.views.dsl.core.wrapContent
 
 open class CompactCandidateViewAdapter(
     val theme: Theme,
-) : BaseQuickAdapter<CandidateItem, CandidateViewHolder>() {
+) : BaseQuickAdapter<CandidateProto, CandidateViewHolder>() {
     init {
         setHasStableIds(true)
     }
@@ -45,7 +45,7 @@ open class CompactCandidateViewAdapter(
     }
 
     fun updateCandidates(
-        data: Array<CandidateItem>,
+        data: Array<CandidateProto>,
         total: Int,
         highlightedIndex: Int,
     ) {
@@ -70,7 +70,7 @@ open class CompactCandidateViewAdapter(
     override fun onBindViewHolder(
         holder: CandidateViewHolder,
         position: Int,
-        item: CandidateItem?,
+        item: CandidateProto?,
     ) {
         item ?: return
         val isHighlighted = position == highlightedIdx
diff --git a/app/src/main/java/com/osfans/trime/ime/candidates/popup/LabeledCandidateItemUi.kt b/app/src/main/java/com/osfans/trime/ime/candidates/popup/LabeledCandidateItemUi.kt
@@ -66,7 +66,7 @@ class LabeledCandidateItemUi(
                 inSpanWith(labelFg, ctx.sp(labelSize), labelFont) { append(candidate.label) }
                 append(" ")
                 inSpanWith(textFg, ctx.sp(textSize), textFont) { append(candidate.text) }
-                if (!candidate.comment.isNullOrBlank()) {
+                if (candidate.comment.isNotBlank()) {
                     append(" ")
                     inSpanWith(commentFg, ctx.sp(commentSize), commentFont) { append(candidate.comment) }
                 }
diff --git a/app/src/main/java/com/osfans/trime/ime/candidates/unrolled/CandidatesPagingSource.kt b/app/src/main/java/com/osfans/trime/ime/candidates/unrolled/CandidatesPagingSource.kt
@@ -7,16 +7,16 @@ package com.osfans.trime.ime.candidates.unrolled
 
 import androidx.paging.PagingSource
 import androidx.paging.PagingState
-import com.osfans.trime.core.CandidateItem
+import com.osfans.trime.core.CandidateProto
 import com.osfans.trime.daemon.RimeSession
 import timber.log.Timber
 
 class CandidatesPagingSource(
     val rime: RimeSession,
     val total: Int,
     val offset: Int,
-) : PagingSource<Int, CandidateItem>() {
-    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, CandidateItem> {
+) : PagingSource<Int, CandidateProto>() {
+    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, CandidateProto> {
         // use candidate index for key, null means load from beginning (including offset)
         val startIndex = params.key ?: offset
         val pageSize = params.loadSize
@@ -35,5 +35,5 @@ class CandidatesPagingSource(
     }
 
     // always reload from beginning
-    override fun getRefreshKey(state: PagingState<Int, CandidateItem>) = null
+    override fun getRefreshKey(state: PagingState<Int, CandidateProto>) = null
 }
diff --git a/app/src/main/java/com/osfans/trime/ime/candidates/unrolled/PagingCandidateViewAdapter.kt b/app/src/main/java/com/osfans/trime/ime/candidates/unrolled/PagingCandidateViewAdapter.kt
@@ -8,25 +8,25 @@ package com.osfans.trime.ime.candidates.unrolled
 import android.view.ViewGroup
 import androidx.paging.PagingDataAdapter
 import androidx.recyclerview.widget.DiffUtil
-import com.osfans.trime.core.CandidateItem
+import com.osfans.trime.core.CandidateProto
 import com.osfans.trime.data.theme.Theme
 import com.osfans.trime.ime.candidates.CandidateItemUi
 import com.osfans.trime.ime.candidates.CandidateViewHolder
 
 open class PagingCandidateViewAdapter(
     val theme: Theme,
-) : PagingDataAdapter<CandidateItem, CandidateViewHolder>(diffCallback) {
+) : PagingDataAdapter<CandidateProto, CandidateViewHolder>(diffCallback) {
     companion object {
         private val diffCallback =
-            object : DiffUtil.ItemCallback<CandidateItem>() {
+            object : DiffUtil.ItemCallback<CandidateProto>() {
                 override fun areItemsTheSame(
-                    oldItem: CandidateItem,
-                    newItem: CandidateItem,
+                    oldItem: CandidateProto,
+                    newItem: CandidateProto,
                 ): Boolean = oldItem === newItem
 
                 override fun areContentsTheSame(
-                    oldItem: CandidateItem,
-                    newItem: CandidateItem,
+                    oldItem: CandidateProto,
+                    newItem: CandidateProto,
                 ): Boolean = oldItem == newItem
             }
     }
diff --git a/app/src/main/jni/librime_jni/helper-types.h b/app/src/main/jni/librime_jni/helper-types.h
@@ -28,18 +28,6 @@ class SchemaItem {
   }
 };
 
-class CandidateItem {
- public:
-  std::string text;
-  std::string comment;
-
-  explicit CandidateItem(const RimeCandidate& candidate)
-      : text(candidate.text),
-        comment(candidate.comment ? candidate.comment : "") {}
-};
-
-using CandidateList = std::vector<CandidateItem>;
-
 class CommitProto {
  public:
   std::optional<std::string> text;
@@ -52,8 +40,12 @@ class CommitProto {
 class CandidateProto {
  public:
   std::string text;
-  std::optional<std::string> comment;
+  std::string comment;
   std::string label;
+
+  CandidateProto() = default;
+  explicit CandidateProto(const RimeCandidate& c)
+      : text(c.text), comment(c.comment ? c.comment : "") {}
 };
 
 class CompositionProto {
diff --git a/app/src/main/jni/librime_jni/jni-utils.h b/app/src/main/jni/librime_jni/jni-utils.h
@@ -103,9 +103,6 @@ class GlobalRefSingleton {
   jclass Rime;
   jmethodID HandleRimeMessage;
 
-  jclass CandidateItem;
-  jmethodID CandidateItemInit;
-
   jclass CandidateProto;
   jmethodID CandidateProtoInit;
 
@@ -153,11 +150,6 @@ class GlobalRefSingleton {
     HandleRimeMessage = env->GetStaticMethodID(Rime, "handleRimeMessage",
                                                "(I[Ljava/lang/Object;)V");
 
-    CandidateItem = reinterpret_cast<jclass>(env->NewGlobalRef(
-        env->FindClass("com/osfans/trime/core/CandidateItem")));
-    CandidateItemInit = env->GetMethodID(
-        CandidateItem, "<init>", "(Ljava/lang/String;Ljava/lang/String;)V");
-
     CandidateProto = reinterpret_cast<jclass>(env->NewGlobalRef(
         env->FindClass("com/osfans/trime/core/CandidateProto")));
     CandidateProtoInit = env->GetMethodID(
diff --git a/app/src/main/jni/librime_jni/objconv.h b/app/src/main/jni/librime_jni/objconv.h
@@ -41,24 +41,6 @@ inline std::vector<std::string> stringArrayToStringVector(JNIEnv* env,
   return std::move(result);
 }
 
-inline jobject rimeCandidateItemToJObject(JNIEnv* env,
-                                          const CandidateItem& item) {
-  return env->NewObject(GlobalRef->CandidateItem, GlobalRef->CandidateItemInit,
-                        *JString(env, item.text), *JString(env, item.comment));
-}
-
-inline jobjectArray rimeCandidateListToJObjectArray(
-    JNIEnv* env, const std::vector<CandidateItem>& list) {
-  jobjectArray array = env->NewObjectArray(static_cast<int>(list.size()),
-                                           GlobalRef->CandidateItem, nullptr);
-  int i = 0;
-  for (const auto& item : list) {
-    auto jItem = JRef(env, rimeCandidateItemToJObject(env, item));
-    env->SetObjectArrayElement(array, i++, jItem);
-  }
-  return array;
-}
-
 inline jobjectArray stringVectorToJStringArray(
     JNIEnv* env, const std::vector<std::string>& strings) {
   jobjectArray array = env->NewObjectArray(static_cast<int>(strings.size()),
@@ -79,11 +61,22 @@ inline jobject rimeCandidateToJObject(JNIEnv* env,
                                       const CandidateProto& candidate) {
   return env->NewObject(
       GlobalRef->CandidateProto, GlobalRef->CandidateProtoInit,
-      *JString(env, candidate.text),
-      candidate.comment ? *JString(env, *candidate.comment) : nullptr,
+      *JString(env, candidate.text), *JString(env, candidate.comment),
       *JString(env, candidate.label));
 }
 
+inline jobjectArray rimeCandidateListToJObjectArray(
+    JNIEnv* env, const std::vector<CandidateProto>& list) {
+  jobjectArray array = env->NewObjectArray(static_cast<int>(list.size()),
+                                           GlobalRef->CandidateProto, nullptr);
+  int i = 0;
+  for (const auto& candidate : list) {
+    auto obj = JRef(env, rimeCandidateToJObject(env, candidate));
+    env->SetObjectArrayElement(array, i++, obj);
+  }
+  return array;
+}
+
 inline jobject rimeCompositionToJObject(JNIEnv* env,
                                         const CompositionProto& composition) {
   return env->NewObject(
diff --git a/app/src/main/jni/librime_jni/rime_jni.cc b/app/src/main/jni/librime_jni/rime_jni.cc
@@ -172,24 +172,23 @@ class Rime {
     return rime->change_page(session(), backward);
   }
 
-  CandidateList getCandidates(int startIndex, int limit) {
-    CandidateList result;
+  std::vector<CandidateProto> getCandidates(int startIndex, int limit) {
+    std::vector<CandidateProto> result;
     result.reserve(limit);
     RimeCandidateListIterator iter{};
     if (rime->candidate_list_from_index(session(), &iter, startIndex)) {
       int count = 0;
       while (rime->candidate_list_next(&iter)) {
         if (count >= limit) break;
-        const CandidateItem item(iter.candidate);
-        result.emplace_back(item);
+        result.emplace_back(iter.candidate);
         ++count;
       }
       rime->candidate_list_end(&iter);
     }
     return std::move(result);
   }
 
-  std::tuple<int, int, CandidateList> getBulkCandidates() {
+  std::tuple<int, int, std::vector<CandidateProto>> getBulkCandidates() {
     constexpr int limit = 16;
     auto list = getCandidates(0, limit);
     // use -1 to indicate it's not sure how many candidates now

Original file line number	Diff line number	Diff line change
`@@ -84,5 +84,5 @@ interface RimeApi {`
`84`	`84`	`suspend fun getCandidates(`
`85`	`85`	`startIndex: Int,`
`86`	`86`	`limit: Int,`
`87`		`- ): Array<CandidateItem>`
	`87`	`+ ): Array<CandidateProto>`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ data class CommitProto(`
`11`	`11`
`12`	`12`	`data class CandidateProto(`
`13`	`13`	`val text: String,`
`14`		`- val comment: String?,`
	`14`	`+ val comment: String,`
`15`	`15`	`val label: String,`
`16`	`16`	`)`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,3 @@ data class SchemaItem(`
`8`	`8`	`val id: String,`
`9`	`9`	`val name: String = "",`
`10`	`10`	`)`
`11`		`-`
`12`		`-data class CandidateItem(`
`13`		`- val text: String,`
`14`		`- val comment: String = "",`
`15`		`-)`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ class LabeledCandidateItemUi(`
`66`	`66`	`inSpanWith(labelFg, ctx.sp(labelSize), labelFont) { append(candidate.label) }`
`67`	`67`	`append(" ")`
`68`	`68`	`inSpanWith(textFg, ctx.sp(textSize), textFont) { append(candidate.text) }`
`69`		`- if (!candidate.comment.isNullOrBlank()) {`
	`69`	`+ if (candidate.comment.isNotBlank()) {`
`70`	`70`	`append(" ")`
`71`	`71`	`inSpanWith(commentFg, ctx.sp(commentSize), commentFont) { append(candidate.comment) }`
`72`	`72`	`}`