feat: support user dict management

Author: WhiredPlanck

app/src/main/java/com/osfans/trime/data/userdict/UserDictManager.kt

@@ -0,0 +1,83 @@
+/*
+ * SPDX-FileCopyrightText: 2015 - 2025 Rime community
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.data.userdict
+
+import com.osfans.trime.util.appContext
+import java.io.File
+import java.io.InputStream
+import java.io.OutputStream
+
+object UserDictManager {
+    fun restoreUserDict(stream: InputStream, snapshotFile: String): Result<Unit> {
+        val tempFile = File(appContext.cacheDir, snapshotFile)
+        try {
+            tempFile.outputStream().use {
+                stream.copyTo(it)
+            }
+            val success = restoreUserDict(tempFile.absolutePath)
+            return if (success) {
+                Result.success(Unit)
+            } else {
+                Result.failure(Exception("Failed to restore"))
+            }
+        } finally {
+            tempFile.delete()
+        }
+    }
+
+    fun importUserDict(stream: InputStream, dictName: String, textFile: String): Result<Int> {
+        val tempFile = File(appContext.cacheDir, textFile)
+        try {
+            tempFile.outputStream().use {
+                stream.copyTo(it)
+            }
+            val count = importUserDict(dictName, tempFile.absolutePath)
+            return if (count >= 0) {
+                Result.success(count)
+            } else {
+                Result.failure(
+                    Exception("Failed to import from '$textFile' to '$dictName'"),
+                )
+            }
+        } finally {
+            tempFile.delete()
+        }
+    }
+
+    fun exportUserDict(dest: OutputStream, dictName: String, textFile: String): Result<Int> {
+        val tempFile = File(appContext.cacheDir, textFile)
+        try {
+            val count = exportUserDict(dictName, tempFile.absolutePath)
+            tempFile.inputStream().use {
+                it.copyTo(dest)
+            }
+            return if (count >= 0) {
+                Result.success(count)
+            } else {
+                Result.failure(
+                    Exception("Failed to export '$dictName' to '$textFile'"),
+                )
+            }
+        } finally {
+            tempFile.delete()
+        }
+    }
+
+    @JvmStatic
+    external fun getUserDictList(): Array<String>
+
+    @JvmStatic
+    external fun backupUserDict(dictName: String): Boolean
+
+    @JvmStatic
+    external fun restoreUserDict(snapshotFile: String): Boolean
+
+    @JvmStatic
+    external fun exportUserDict(dictName: String, textFile: String): Int
+
+    @JvmStatic
+    external fun importUserDict(dictName: String, textFile: String): Int
+}

app/src/main/java/com/osfans/trime/ui/fragments/PrefFragment.kt

@@ -36,6 +36,10 @@ class PrefFragment : PaddingPreferenceFragment() {
                 findNavController().navigate(R.id.action_prefFragment_to_schemaListFragment)
                 true
             }
+            get<Preference>("pref_user_dict")?.setOnPreferenceClickListener {
+                findNavController().navigate(R.id.action_prefFragment_to_userDictionaryFragment)
+                true
+            }
             get<Preference>("pref_user_data")?.setOnPreferenceClickListener {
                 findNavController().navigate(R.id.action_prefFragment_to_profileFragment)
                 true

app/src/main/java/com/osfans/trime/ui/main/settings/userdict/UserDictListAdapter.kt

@@ -0,0 +1,41 @@
+/*
+ * SPDX-FileCopyrightText: 2015 - 2025 Rime community
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.ui.main.settings.userdict
+
+import android.content.Context
+import android.view.ViewGroup
+import android.widget.ImageButton
+import androidx.recyclerview.widget.RecyclerView
+import com.chad.library.adapter4.BaseQuickAdapter
+
+class UserDictListAdapter(
+    override var items: List<String>,
+    val initMoreButton: (ImageButton.(String) -> Unit) = {},
+) : BaseQuickAdapter<String, UserDictListAdapter.ViewHolder>() {
+
+    inner class ViewHolder(
+        ui: UserDictListEntryUi,
+    ) : RecyclerView.ViewHolder(ui.root) {
+        val nameText = ui.nameText
+        val moreButton = ui.moreButton
+    }
+
+    override fun onCreateViewHolder(
+        context: Context,
+        parent: ViewGroup,
+        viewType: Int,
+    ): ViewHolder = ViewHolder(UserDictListEntryUi(context))
+
+    override fun onBindViewHolder(
+        holder: ViewHolder,
+        position: Int,
+        item: String?,
+    ) {
+        val name = item ?: return
+        holder.nameText.text = name
+        initMoreButton(holder.moreButton, name)
+    }
+}

app/src/main/java/com/osfans/trime/ui/main/settings/userdict/UserDictListEntryUi.kt

@@ -0,0 +1,74 @@
+/*
+ * SPDX-FileCopyrightText: 2015 - 2025 Rime community
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.ui.main.settings.userdict
+
+import android.content.Context
+import android.view.ViewGroup
+import com.osfans.trime.R
+import splitties.dimensions.dp
+import splitties.resources.drawable
+import splitties.resources.resolveThemeAttribute
+import splitties.resources.styledColor
+import splitties.resources.styledDimenPxSize
+import splitties.resources.styledDrawable
+import splitties.views.backgroundColor
+import splitties.views.dsl.constraintlayout.before
+import splitties.views.dsl.constraintlayout.centerVertically
+import splitties.views.dsl.constraintlayout.constraintLayout
+import splitties.views.dsl.constraintlayout.endOfParent
+import splitties.views.dsl.constraintlayout.lParams
+import splitties.views.dsl.constraintlayout.matchConstraints
+import splitties.views.dsl.constraintlayout.startOfParent
+import splitties.views.dsl.core.Ui
+import splitties.views.dsl.core.add
+import splitties.views.dsl.core.imageButton
+import splitties.views.dsl.core.matchParent
+import splitties.views.dsl.core.textView
+import splitties.views.dsl.core.wrapContent
+import splitties.views.imageDrawable
+import splitties.views.setPaddingDp
+import splitties.views.textAppearance
+
+class UserDictListEntryUi(
+    override val ctx: Context,
+) : Ui {
+    val nameText = textView {
+        setPaddingDp(0, 16, 0, 16)
+        textAppearance = ctx.resolveThemeAttribute(android.R.attr.textAppearanceListItem)
+    }
+
+    val moreButton = imageButton {
+        background = styledDrawable(android.R.attr.selectableItemBackground)
+        imageDrawable = drawable(R.drawable.ic_baseline_more_horiz_24)
+    }
+
+    override val root = constraintLayout {
+        layoutParams = ViewGroup.LayoutParams(matchParent, wrapContent)
+        backgroundColor = styledColor(android.R.attr.colorBackground)
+        minHeight = styledDimenPxSize(android.R.attr.listPreferredItemHeightSmall)
+
+        val paddingStart = styledDimenPxSize(android.R.attr.listPreferredItemPaddingStart)
+        add(
+            nameText,
+            lParams {
+                width = matchConstraints
+                height = wrapContent
+                centerVertically()
+                startOfParent(paddingStart)
+                before(moreButton)
+            },
+        )
+        add(
+            moreButton,
+            lParams {
+                width = dp(53)
+                height = matchConstraints
+                centerVertically()
+                endOfParent()
+            },
+        )
+    }
+}

app/src/main/java/com/osfans/trime/ui/main/settings/userdict/UserDictListUi.kt

@@ -0,0 +1,142 @@
+/*
+ * SPDX-FileCopyrightText: 2015 - 2025 Rime community
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+package com.osfans.trime.ui.main.settings.userdict
+
+import android.annotation.SuppressLint
+import android.content.Context
+import android.view.View
+import android.view.ViewGroup
+import android.widget.ImageButton
+import androidx.coordinatorlayout.widget.CoordinatorLayout
+import androidx.core.content.ContextCompat
+import androidx.core.view.ViewCompat
+import androidx.core.view.WindowInsetsCompat
+import androidx.core.view.doOnAttach
+import androidx.core.view.isVisible
+import androidx.core.view.updateLayoutParams
+import com.google.android.material.behavior.HideBottomViewOnScrollBehavior
+import com.google.android.material.floatingactionbutton.FloatingActionButton
+import com.google.android.material.snackbar.BaseTransientBottomBar
+import com.google.android.material.snackbar.Snackbar
+import com.osfans.trime.R
+import splitties.dimensions.dp
+import splitties.resources.drawable
+import splitties.resources.styledColor
+import splitties.views.backgroundColor
+import splitties.views.bottomPadding
+import splitties.views.dsl.coordinatorlayout.coordinatorLayout
+import splitties.views.dsl.coordinatorlayout.defaultLParams
+import splitties.views.dsl.core.Ui
+import splitties.views.dsl.core.add
+import splitties.views.dsl.core.margin
+import splitties.views.dsl.core.matchParent
+import splitties.views.dsl.core.view
+import splitties.views.dsl.recyclerview.recyclerView
+import splitties.views.gravityEndBottom
+import splitties.views.imageDrawable
+import splitties.views.recyclerview.verticalLayoutManager
+import kotlin.math.min
+
+class UserDictListUi(
+    override val ctx: Context,
+    entries: Array<String>,
+    initMoreButton: (ImageButton.(String) -> Unit) = {},
+) : Ui {
+    val fab =
+        view(::FloatingActionButton) {
+            imageDrawable =
+                drawable(R.drawable.ic_baseline_add_24)!!.apply {
+                    setTint(styledColor(android.R.attr.colorForegroundInverse))
+                }
+        }
+
+    fun showSnackBar(text: String) {
+        Snackbar.make(root, text, Snackbar.LENGTH_SHORT)
+            .addCallback(
+                object : BaseTransientBottomBar.BaseCallback<Snackbar>() {
+                    override fun onShown(transientBottomBar: Snackbar) {
+                        // snackbar is invisible when it attached to parent,
+                        // but change visibility won't trigger `onDependentViewChanged`.
+                        // so we need to update fab position when snackbar fully shown
+                        // see [^1]
+                        fab.translationY = -transientBottomBar.view.height.toFloat()
+                    }
+                },
+            )
+            .show()
+    }
+
+    val adapter by lazy { UserDictListAdapter(entries.toList(), initMoreButton) }
+
+    private val list = recyclerView {
+        layoutManager = verticalLayoutManager()
+        adapter = this@UserDictListUi.adapter
+        clipToPadding = false
+    }
+
+    private fun updateViewMargin(insets: WindowInsetsCompat? = null) {
+        val windowInsets = (insets ?: ViewCompat.getRootWindowInsets(root)) ?: return
+        val navBars = windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars())
+        fab.updateLayoutParams<ViewGroup.MarginLayoutParams> {
+            bottomMargin = navBars.bottom + ctx.dp(16)
+        }
+        list.bottomPadding = navBars.bottom
+    }
+
+    override val root = coordinatorLayout {
+        backgroundColor = styledColor(android.R.attr.colorBackground)
+        add(
+            list,
+            defaultLParams {
+                height = matchParent
+                width = matchParent
+            },
+        )
+        add(
+            fab,
+            defaultLParams {
+                gravity = gravityEndBottom
+                margin = dp(16)
+                behavior =
+                    object : HideBottomViewOnScrollBehavior<FloatingActionButton>() {
+                        @SuppressLint("RestrictedApi")
+                        override fun layoutDependsOn(
+                            parent: CoordinatorLayout,
+                            child: FloatingActionButton,
+                            dependency: View,
+                        ): Boolean = dependency is Snackbar.SnackbarLayout
+
+                        override fun onDependentViewChanged(
+                            parent: CoordinatorLayout,
+                            child: FloatingActionButton,
+                            dependency: View,
+                        ): Boolean {
+                            // [^1]: snackbar is invisible when it attached to parent
+                            // update fab position only when snackbar is visible
+                            if (dependency.isVisible) {
+                                child.translationY = min(0f, dependency.translationY - dependency.height)
+                                return true
+                            }
+                            return false
+                        }
+
+                        override fun onDependentViewRemoved(
+                            parent: CoordinatorLayout,
+                            child: FloatingActionButton,
+                            dependency: View,
+                        ) {
+                            child.translationY = 0f
+                        }
+                    }
+            },
+        )
+        doOnAttach { updateViewMargin() }
+        ViewCompat.setOnApplyWindowInsetsListener(this) { _, windowInsets ->
+            updateViewMargin(windowInsets)
+            windowInsets
+        }
+    }
+}