🔨 Migrate navigation to event-driven architecture (#3238)

Author: guiyanakuang

app/src/commonMain/kotlin/com/crosspaste/paste/PasteMenuService.kt

@@ -1,13 +1,10 @@
 package com.crosspaste.paste
 
-import androidx.navigation.NavController
-
 interface PasteMenuService {
 
     fun copyPasteData(pasteData: PasteData)
 
     fun openPasteData(
-        navController: NavController,
         pasteData: PasteData,
         index: Int = 0,
     )

app/src/commonMain/kotlin/com/crosspaste/ui/LocalComposition.kt

@@ -2,14 +2,8 @@ package com.crosspaste.ui
 
 import androidx.compose.runtime.staticCompositionLocalOf
 import androidx.navigation.NavHostController
-import com.crosspaste.app.ExitMode
 
-internal val LocalExitApplication =
-    staticCompositionLocalOf<(ExitMode) -> Unit> {
-        error("CompositionLocal ExitApplication not present")
-    }
-
-internal val LocalNavHostController =
+val LocalNavHostController =
     staticCompositionLocalOf<NavHostController> {
         error("CompositionLocal NavController not present")
     }

app/src/commonMain/kotlin/com/crosspaste/ui/NavigationEvent.kt

@@ -0,0 +1,13 @@
+package com.crosspaste.ui
+
+sealed class NavigationEvent {
+    data class Navigate(
+        val route: Route,
+    ) : NavigationEvent()
+
+    data class NavigateAndClearStack(
+        val route: Route,
+    ) : NavigationEvent()
+
+    object NavigateUp : NavigationEvent()
+}

app/src/commonMain/kotlin/com/crosspaste/ui/NavigationManager.kt

@@ -0,0 +1,17 @@
+package com.crosspaste.ui
+
+import androidx.navigation.NavHostController
+
+interface NavigationManager {
+
+    fun navigate(route: Route)
+
+    fun navigateAndClearStack(route: Route)
+
+    fun navigateUp()
+
+    fun navigateAction(
+        event: NavigationEvent,
+        navController: NavHostController,
+    )
+}

app/src/commonMain/kotlin/com/crosspaste/ui/Route.kt

@@ -1,7 +1,5 @@
 package com.crosspaste.ui
 
-import androidx.navigation.NavDestination
-import androidx.navigation.NavDestination.Companion.hasRoute
 import androidx.navigation.NavType
 import androidx.savedstate.SavedState
 import androidx.savedstate.read
@@ -12,8 +10,7 @@ import com.crosspaste.utils.getJsonUtils
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable
 
-@Serializable
-sealed interface Route {
+interface Route {
     val name: String
 }
 
@@ -104,23 +101,6 @@ object ShortcutKeys : Route {
     override val name: String = NAME
 }
 
-fun getRouteName(dest: NavDestination): String? =
-    when {
-        dest.hasRoute<Pasteboard>() -> Pasteboard.NAME
-        dest.hasRoute<Devices>() -> Devices.NAME
-        dest.hasRoute<DeviceDetail>() -> DeviceDetail.NAME
-        dest.hasRoute<Settings>() -> Settings.NAME
-        dest.hasRoute<QrCode>() -> QrCode.NAME
-        dest.hasRoute<Import>() -> Import.NAME
-        dest.hasRoute<Export>() -> Export.NAME
-        dest.hasRoute<ShortcutKeys>() -> ShortcutKeys.NAME
-        dest.hasRoute<About>() -> About.NAME
-        dest.hasRoute<Recommend>() -> Recommend.NAME
-        dest.hasRoute<NearbyDeviceDetail>() -> NearbyDeviceDetail.NAME
-        dest.hasRoute<PasteTextEdit>() -> PasteTextEdit.NAME
-        else -> null
-    }
-
 class JsonNavType<T : Any>(
     private val serializer: KSerializer<T>,
     isNullableAllowed: Boolean = false,

app/src/commonMain/kotlin/com/crosspaste/ui/ScreenProvider.kt

@@ -2,7 +2,7 @@ package com.crosspaste.ui
 
 import androidx.compose.runtime.Composable
 
-interface ScreenProvider {
+interface ScreenProvider : NavigationManager {
 
     @Composable
     fun screen()

app/src/commonMain/kotlin/com/crosspaste/ui/base/UISupport.kt

@@ -1,6 +1,5 @@
 package com.crosspaste.ui.base
 
-import androidx.navigation.NavController
 import com.crosspaste.paste.PasteData
 import okio.Path
 
@@ -27,15 +26,11 @@ interface UISupport {
 
     fun openImage(imagePath: Path)
 
-    fun openText(
-        navController: NavController,
-        pasteData: PasteData,
-    )
+    fun openText(pasteData: PasteData)
 
     fun openRtf(pasteData: PasteData)
 
     fun openPasteData(
-        navController: NavController,
         pasteData: PasteData,
         index: Int = 0,
     )

app/src/desktopMain/kotlin/com/crosspaste/DesktopModule.kt

@@ -188,6 +188,7 @@ import com.crosspaste.task.SyncPasteTaskExecutor
 import com.crosspaste.task.TaskExecutor
 import com.crosspaste.ui.DesktopFontManager
 import com.crosspaste.ui.DesktopScreenProvider
+import com.crosspaste.ui.NavigationManager
 import com.crosspaste.ui.ScreenProvider
 import com.crosspaste.ui.base.DesktopExpandViewProvider
 import com.crosspaste.ui.base.DesktopIconStyle
@@ -512,7 +513,8 @@ class DesktopModule(
             single<GlobalCopywriter> { DesktopGlobalCopywriter(get(), lazy { get() }, get()) }
             single<GlobalListener> { DesktopGlobalListener(get(), get(), get(), get()) }
             single<IconStyle> { DesktopIconStyle(get()) }
-            single<MenuHelper> { MenuHelper(get(), get(), get(), get()) }
+            single<MenuHelper> { MenuHelper(get(), get(), get(), get(), get()) }
+            single<NavigationManager> { get<DesktopScreenProvider>() }
             single<NativeKeyListener> { get<DesktopShortcutKeysListener>() }
             single<NativeMouseListener> { get<DesktopAppSize>() }
             single<NotificationManager> { DesktopNotificationManager(get(), get(), get(), get(), get()) }
@@ -533,7 +535,7 @@ class DesktopModule(
             single<ThemeDetector> { DesktopThemeDetector(get()) }
             single<ToastManager> { ToastManager() }
             single<TokenCache> { TokenCache }
-            single<UISupport> { DesktopUISupport(get(), get(), get(), get(), get(), get(), get()) }
+            single<UISupport> { DesktopUISupport(get(), get(), get(), get(), get(), get(), get(), get()) }
         }
 
     // ViewModelModule.kt

app/src/desktopMain/kotlin/com/crosspaste/paste/DesktopPasteMenuService.kt

@@ -1,7 +1,6 @@
 package com.crosspaste.paste
 
 import androidx.compose.foundation.ContextMenuItem
-import androidx.navigation.NavController
 import com.crosspaste.app.AppWindowManager
 import com.crosspaste.app.DesktopAppWindowManager
 import com.crosspaste.db.paste.PasteDao
@@ -83,11 +82,10 @@ class DesktopPasteMenuService(
     }
 
     override fun openPasteData(
-        navController: NavController,
         pasteData: PasteData,
         index: Int,
     ) {
-        uiSupport.openPasteData(navController, pasteData, index)
+        uiSupport.openPasteData(pasteData, index)
         val pasteType = pasteData.getType()
         if (!pasteType.isText() && !pasteType.isColor()) {
             desktopAppWindowManager.hideMainWindow()
@@ -134,7 +132,6 @@ class DesktopPasteMenuService(
     }
 
     fun fileMenuItemsProvider(
-        navController: NavController,
         pasteData: PasteData,
         pasteItem: PasteItem,
         index: Int = 0,
@@ -148,22 +145,19 @@ class DesktopPasteMenuService(
                     )
                 },
                 ContextMenuItem(copywriter.getText("open")) {
-                    openPasteData(navController, pasteData, index)
+                    openPasteData(pasteData, index)
                 },
             )
         }
 
-    fun pasteMenuItemsProvider(
-        navController: NavController,
-        pasteData: PasteData,
-    ): () -> List<ContextMenuItem> =
+    fun pasteMenuItemsProvider(pasteData: PasteData): () -> List<ContextMenuItem> =
         {
             listOf(
                 ContextMenuItem(copywriter.getText("copy")) {
                     copyPasteData(pasteData)
                 },
                 ContextMenuItem(copywriter.getText("open")) {
-                    openPasteData(navController, pasteData)
+                    openPasteData(pasteData)
                 },
                 ContextMenuItem(copywriter.getText("delete")) {
                     deletePasteData(pasteData)

app/src/desktopMain/kotlin/com/crosspaste/ui/DesktopLocalComposition.kt

@@ -0,0 +1,9 @@
+package com.crosspaste.ui
+
+import androidx.compose.runtime.staticCompositionLocalOf
+import com.crosspaste.app.ExitMode
+
+internal val LocalExitApplication =
+    staticCompositionLocalOf<(ExitMode) -> Unit> {
+        error("CompositionLocal ExitApplication not present")
+    }