feat(desktop): persistent window state

Author: Irineu333

application/build.gradle.kts

@@ -54,6 +54,9 @@ kotlin {
             implementation(catalog.voyager.navigator)
             implementation(catalog.voyager.transitions)
 
+            // lifecycle
+            implementation(catalog.androidx.multplatform.lifecycle.runtime.compose)
+
             // compose
             implementation(compose.runtime)
             implementation(compose.foundation)
@@ -62,6 +65,7 @@ kotlin {
             implementation(compose.materialIconsExtended)
             implementation(compose.components.resources)
 
+            // koin
             implementation(libs.koin.core)
             implementation(libs.koin.compose)
         }

application/src/desktopMain/kotlin/com/neoutils/neoregex/DesktopApp.kt

@@ -30,6 +30,7 @@ import androidx.compose.material3.Icon
 import androidx.compose.material3.MaterialTheme.colorScheme
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
 import androidx.compose.ui.Alignment
@@ -39,12 +40,14 @@ import androidx.compose.ui.draw.clip
 import androidx.compose.ui.platform.LocalUriHandler
 import androidx.compose.ui.window.ApplicationScope
 import androidx.compose.ui.window.FrameWindowScope
-import androidx.compose.ui.window.WindowPosition
-import androidx.compose.ui.window.rememberWindowState
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import com.neoutils.neoregex.core.common.util.ColorTheme
 import com.neoutils.neoregex.core.common.util.rememberColorTheme
 import com.neoutils.neoregex.core.datasource.PreferencesDataSource
+import com.neoutils.neoregex.core.datasource.WindowStateDataSource
+import com.neoutils.neoregex.core.datasource.extension.observe
 import com.neoutils.neoregex.core.datasource.model.Preferences
+import com.neoutils.neoregex.core.datasource.remember.rememberWindowState
 import com.neoutils.neoregex.core.designsystem.theme.NeoTheme
 import com.neoutils.neoregex.core.designsystem.theme.NeoTheme.dimensions
 import com.neoutils.neoregex.core.resources.*
@@ -60,6 +63,9 @@ fun ApplicationScope.DesktopApp() = WithKoin {
     val preferencesDataSource = koinInject<PreferencesDataSource>()
     val preferences by preferencesDataSource.flow.collectAsState()
 
+    val windowStateDataSource = koinInject<WindowStateDataSource>()
+    val windowState by windowStateDataSource.flow.collectAsState()
+
     NeoTheme(
         colorTheme = when (preferences.colorTheme) {
             Preferences.ColorTheme.SYSTEM -> rememberColorTheme()
@@ -69,10 +75,11 @@ fun ApplicationScope.DesktopApp() = WithKoin {
     ) {
         NeoWindow(
             header = { HeaderImpl() },
-            windowState = rememberWindowState(
-                position = WindowPosition.Aligned(Alignment.Center)
-            )
+            windowState = rememberWindowState(windowState)
         ) {
+
+            windowStateDataSource.observe(window)
+
             App()
         }
     }
@@ -82,7 +89,7 @@ fun ApplicationScope.DesktopApp() = WithKoin {
 private fun FrameWindowScope.HeaderImpl() = NeoHeader { padding ->
 
     val preferencesDataSource = koinInject<PreferencesDataSource>()
-    val preferences by preferencesDataSource.flow.collectAsState()
+    val preferences by preferencesDataSource.flow.collectAsStateWithLifecycle()
 
     Text(
         text = stringResource(Res.string.app_name),

build-logic/src/main/kotlin/com.neoutils.neoregex.core.gradle.kts

@@ -63,6 +63,7 @@ kotlin {
             implementation(compose.materialIconsExtended)
             implementation(compose.components.resources)
 
+            // koin
             implementation(catalog.koin.core)
             implementation(catalog.koin.compose)
         }

core/datasource/src/commonMain/kotlin/com/neoutils/neoregex/core/datasource/di/PreferencesModule.kt renamed to core/datasource/src/androidMain/kotlin/com/neoutils/neoregex/core/datasource/di/DataSourceModule.android.kt

@@ -19,10 +19,10 @@
 package com.neoutils.neoregex.core.datasource.di
 
 import com.neoutils.neoregex.core.datasource.PreferencesDataSource
-import com.neoutils.neoregex.core.datasource.settings.MultiplatformSettings
+import com.neoutils.neoregex.core.datasource.settings.PreferencesSettings
 import org.koin.dsl.bind
 import org.koin.dsl.module
 
-val preferencesModule = module {
-    single { MultiplatformSettings() } bind PreferencesDataSource::class
+actual val dataSourceModule = module {
+    single { PreferencesSettings() } bind PreferencesDataSource::class
 }

core/datasource/src/commonMain/kotlin/com/neoutils/neoregex/core/datasource/di/DataSourceModule.kt

@@ -0,0 +1,23 @@
+/*
+ * NeoRegex.
+ *
+ * Copyright (C) 2024 Irineu A. Silva.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.neoutils.neoregex.core.datasource.di
+
+import org.koin.core.module.Module
+
+expect val dataSourceModule: Module

core/datasource/src/commonMain/kotlin/com/neoutils/neoregex/core/datasource/model/Preferences.kt

@@ -22,8 +22,8 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class Preferences(
-    val performanceLabelAlign: Alignment = Alignment.BOTTOM_END,
-    val colorTheme: ColorTheme = ColorTheme.SYSTEM
+    val performanceLabelAlign: Alignment,
+    val colorTheme: ColorTheme
 ) {
     @Serializable
     enum class Alignment {
@@ -37,5 +37,12 @@ data class Preferences(
         LIGHT,
         DARK
     }
+
+    companion object {
+        val Default = Preferences(
+            performanceLabelAlign = Alignment.BOTTOM_END,
+            colorTheme = ColorTheme.SYSTEM
+        )
+    }
 }
 

core/datasource/src/commonMain/kotlin/com/neoutils/neoregex/core/datasource/settings/MultiplatformSettings.kt renamed to core/datasource/src/commonMain/kotlin/com/neoutils/neoregex/core/datasource/settings/PreferencesSettings.kt

@@ -29,16 +29,20 @@ import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.serialization.ExperimentalSerializationApi
 
 @OptIn(ExperimentalSerializationApi::class, ExperimentalSettingsApi::class)
-internal class MultiplatformSettings(
+internal class PreferencesSettings(
     private val settings: Settings = Settings()
 ) : PreferencesDataSource {
 
-    private val _preferences = MutableStateFlow(
-        settings.decodeValue(Preferences.serializer(), KEY, Preferences())
+    private val _flow = MutableStateFlow(
+        settings.decodeValue(
+            serializer = Preferences.serializer(),
+            defaultValue = Preferences.Default,
+            key = KEY,
+        )
     )
 
-    override val flow = _preferences.asStateFlow()
-    override val current: Preferences get() = flow.value
+    override val flow = _flow.asStateFlow()
+    override val current get() = flow.value
 
     override fun update(
         block: (Preferences) -> Preferences
@@ -47,7 +51,7 @@ internal class MultiplatformSettings(
         val preferences = block(flow.value)
 
         settings.encodeValue(Preferences.serializer(), KEY, preferences)
-        _preferences.value = preferences
+        _flow.value = preferences
 
         return preferences
     }

core/datasource/src/desktopMain/kotlin/com/neoutils/neoregex/core/datasource/WindowStateDataSource.kt

@@ -0,0 +1,29 @@
+/*
+ * NeoRegex.
+ *
+ * Copyright (C) 2024 Irineu A. Silva.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.neoutils.neoregex.core.datasource
+
+import com.neoutils.neoregex.core.datasource.model.WindowStateData
+import kotlinx.coroutines.flow.StateFlow
+
+interface WindowStateDataSource {
+    val flow: StateFlow<WindowStateData>
+    val current: WindowStateData
+
+    fun update(block: (WindowStateData) -> WindowStateData): WindowStateData
+}

core/datasource/src/desktopMain/kotlin/com/neoutils/neoregex/core/datasource/di/DataSourceModule.desktop.kt

@@ -0,0 +1,31 @@
+/*
+ * NeoRegex.
+ *
+ * Copyright (C) 2024 Irineu A. Silva.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.neoutils.neoregex.core.datasource.di
+
+import com.neoutils.neoregex.core.datasource.PreferencesDataSource
+import com.neoutils.neoregex.core.datasource.WindowStateDataSource
+import com.neoutils.neoregex.core.datasource.settings.PreferencesSettings
+import com.neoutils.neoregex.core.datasource.settings.WindowStateSettings
+import org.koin.dsl.bind
+import org.koin.dsl.module
+
+actual val dataSourceModule = module {
+    single { PreferencesSettings() } bind PreferencesDataSource::class
+    single { WindowStateSettings() } bind WindowStateDataSource::class
+}

core/datasource/src/desktopMain/kotlin/com/neoutils/neoregex/core/datasource/extension/WindowStateDataSource.kt

@@ -0,0 +1,83 @@
+/*
+ * NeoRegex.
+ *
+ * Copyright (C) 2024 Irineu A. Silva.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.neoutils.neoregex.core.datasource.extension
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.DisposableEffect
+import androidx.compose.ui.awt.ComposeWindow
+import androidx.compose.ui.window.WindowPlacement
+import com.neoutils.neoregex.core.datasource.WindowStateDataSource
+import com.neoutils.neoregex.core.datasource.model.WindowStateData
+import java.awt.event.ComponentAdapter
+import java.awt.event.ComponentEvent
+import java.awt.event.WindowStateListener
+
+@Composable
+fun WindowStateDataSource.observe(window: ComposeWindow) {
+
+    DisposableEffect(window) {
+        val componentListener = object : ComponentAdapter() {
+            override fun componentMoved(e: ComponentEvent) {
+                if (window.placement == WindowPlacement.Floating) {
+                    update {
+                        it.copy(
+                            position = WindowStateData.Position(
+                                x = window.x,
+                                y = window.y
+                            )
+                        )
+                    }
+                }
+            }
+
+            override fun componentResized(e: ComponentEvent) {
+                if (window.placement == WindowPlacement.Floating) {
+                    update {
+                        it.copy(
+                            size = WindowStateData.Size(
+                                width = window.width,
+                                height = window.height
+                            )
+                        )
+                    }
+                }
+            }
+        }
+
+        val windowListener = WindowStateListener {
+            update {
+                it.copy(
+                    placement = when (window.placement) {
+                        WindowPlacement.Floating -> WindowStateData.Placement.FLOATING
+                        WindowPlacement.Maximized -> WindowStateData.Placement.MAXIMIZED
+                        WindowPlacement.Fullscreen -> WindowStateData.Placement.FULLSCREEN
+                    }
+                )
+            }
+        }
+
+        window.addComponentListener(componentListener)
+        window.addWindowStateListener(windowListener)
+
+        onDispose {
+            window.removeComponentListener(componentListener)
+            window.removeWindowStateListener(windowListener)
+        }
+    }
+}