refactor: Change Page.State to sealed interface

AwkwardPeak7 · null2264 · commit 370bb62ef93a · 2025-05-28T09:19:42.000+07:00
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadManager.kt b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadManager.kt
@@ -21,8 +21,8 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.merge
 import kotlinx.coroutines.flow.onStart
 import uy.kohesive.injekt.Injekt
-import uy.kohesive.injekt.injectLazy
 import uy.kohesive.injekt.api.get
+import uy.kohesive.injekt.injectLazy
 import yokai.domain.download.DownloadPreferences
 import yokai.i18n.MR
 import yokai.util.lang.getString
@@ -171,7 +171,7 @@ class DownloadManager(
 
         return files.sortedBy { it.name }
             .mapIndexed { i, file ->
-                Page(i, uri = file.uri).apply { status = Page.State.READY }
+                Page(i, uri = file.uri).apply { status = Page.State.Ready }
             }
     }
 
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/download/Downloader.kt b/app/src/main/java/eu/kanade/tachiyomi/data/download/Downloader.kt
@@ -1,7 +1,6 @@
 package eu.kanade.tachiyomi.data.download
 
 import android.content.Context
-import android.os.Looper
 import co.touchlab.kermit.Logger
 import com.hippo.unifile.UniFile
 import eu.kanade.tachiyomi.data.cache.ChapterCache
@@ -55,8 +54,8 @@ import kotlinx.coroutines.supervisorScope
 import nl.adaptivity.xmlutil.serialization.XML
 import okhttp3.Response
 import uy.kohesive.injekt.Injekt
-import uy.kohesive.injekt.injectLazy
 import uy.kohesive.injekt.api.get
+import uy.kohesive.injekt.injectLazy
 import yokai.core.archive.ZipWriter
 import yokai.core.metadata.COMIC_INFO_FILE
 import yokai.core.metadata.ComicInfo
@@ -365,11 +364,11 @@ class Downloader(
 
             // Get all the URLs to the source images, fetch pages if necessary
             pageList.filter { it.imageUrl.isNullOrEmpty() }.forEach { page ->
-                page.status = Page.State.LOAD_PAGE
+                page.status = Page.State.LoadPage
                 try {
                     page.imageUrl = download.source.getImageUrl(page)
                 } catch (e: Throwable) {
-                    page.status = Page.State.ERROR
+                    page.status = Page.State.Error
                 }
             }
 
@@ -494,12 +493,12 @@ class Downloader(
 
             page.uri = file.uri
             page.progress = 100
-            page.status = Page.State.READY
+            page.status = Page.State.Ready
         } catch (e: Throwable) {
             if (e is CancellationException) throw e
             // Mark this page as error and allow to download the remaining
             page.progress = 0
-            page.status = Page.State.ERROR
+            page.status = Page.State.Error
             notifier.onError(e.message, chapName, download.manga.title)
         }
     }
@@ -518,7 +517,7 @@ class Downloader(
         tmpDir: UniFile,
         filename: String,
     ): UniFile {
-        page.status = Page.State.DOWNLOAD_IMAGE
+        page.status = Page.State.DownloadImage
         page.progress = 0
         return flow {
             val response = source.getImage(page)
diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/download/model/Download.kt b/app/src/main/java/eu/kanade/tachiyomi/data/download/model/Download.kt
@@ -22,7 +22,7 @@ class Download(val source: HttpSource, val manga: Manga, val chapter: Chapter) {
         get() = pages?.sumOf(Page::progress) ?: 0
 
     val downloadedImages: Int
-        get() = pages?.count { it.status == Page.State.READY } ?: 0
+        get() = pages?.count { it.status is Page.State.Ready } ?: 0
 
     @Transient
     private val _statusFlow = MutableStateFlow(State.NOT_DOWNLOADED)
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderActivity.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderActivity.kt
@@ -1655,7 +1655,7 @@ class ReaderActivity : BaseActivity<ReaderActivityBinding>() {
     }
 
     private fun showSetCoverPrompt(page: ReaderPage) {
-        if (page.status != Page.State.READY) return
+        if (page.status !is Page.State.Ready) return
 
         materialAlertDialog()
             .setMessage(MR.strings.use_image_as_cover)
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderViewModel.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderViewModel.kt
@@ -613,7 +613,7 @@ class ReaderViewModel(
         }
 
         val shouldTrack = !preferences.incognitoMode().get() || hasTrackers
-        if (shouldTrack && page.status != Page.State.ERROR) {
+        if (shouldTrack && page.status !is Page.State.Error) {
             readerChapter.chapter.last_page_read = page.index
             readerChapter.chapter.pages_left = (readerChapter.pages?.size ?: page.index) - page.index
             // For double pages, check if the second to last page is doubled up
@@ -860,7 +860,7 @@ class ReaderViewModel(
      * There's also a notification to allow sharing the image somewhere else or deleting it.
      */
     fun saveImage(page: ReaderPage) {
-        if (page.status != Page.State.READY) return
+        if (page.status !is Page.State.Ready) return
         val manga = manga ?: return
         val context = Injekt.get<Application>()
 
@@ -891,8 +891,8 @@ class ReaderViewModel(
 
     fun saveImages(firstPage: ReaderPage, secondPage: ReaderPage, isLTR: Boolean, @ColorInt bg: Int) {
         viewModelScope.launch {
-            if (firstPage.status != Page.State.READY) return@launch
-            if (secondPage.status != Page.State.READY) return@launch
+            if (firstPage.status !is Page.State.Ready) return@launch
+            if (secondPage.status !is Page.State.Ready) return@launch
             val manga = manga ?: return@launch
             val context = Injekt.get<Application>()
 
@@ -926,7 +926,7 @@ class ReaderViewModel(
      * image will be kept so it won't be taking lots of internal disk space.
      */
     fun shareImage(page: ReaderPage) {
-        if (page.status != Page.State.READY) return
+        if (page.status !is Page.State.Ready) return
         val manga = manga ?: return
         val context = Injekt.get<Application>()
 
@@ -940,8 +940,8 @@ class ReaderViewModel(
 
     fun shareImages(firstPage: ReaderPage, secondPage: ReaderPage, isLTR: Boolean, @ColorInt bg: Int) {
         viewModelScope.launch {
-            if (firstPage.status != Page.State.READY) return@launch
-            if (secondPage.status != Page.State.READY) return@launch
+            if (firstPage.status !is Page.State.Ready) return@launch
+            if (secondPage.status !is Page.State.Ready) return@launch
             val manga = manga ?: return@launch
             val context = Injekt.get<Application>()
 
@@ -958,7 +958,7 @@ class ReaderViewModel(
      * Sets the image of this [page] as cover and notifies the UI of the result.
      */
     fun setAsCover(page: ReaderPage) {
-        if (page.status != Page.State.READY) return
+        if (page.status !is Page.State.Ready) return
         val manga = manga ?: return
         val stream = page.stream ?: return
 
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/ArchivePageLoader.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/ArchivePageLoader.kt
@@ -31,7 +31,7 @@ internal class ArchivePageLoader(private val reader: ArchiveReader) : PageLoader
             .mapIndexed { i, entry ->
                 ReaderPage(i).apply {
                     stream = { reader.getInputStream(entry.name)!! }
-                    status = Page.State.READY
+                    status = Page.State.Ready
                 }
             }
             .toList()
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/DirectoryPageLoader.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/DirectoryPageLoader.kt
@@ -24,7 +24,7 @@ class DirectoryPageLoader(val file: UniFile) : PageLoader() {
                 val streamFn = { file.openInputStream() }
                 ReaderPage(i).apply {
                     stream = streamFn
-                    status = Page.State.READY
+                    status = Page.State.Ready
                 }
             } ?: emptyList()
     }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/DownloadPageLoader.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/DownloadPageLoader.kt
@@ -60,7 +60,7 @@ class DownloadPageLoader(
             ReaderPage(page.index, page.url, page.imageUrl, stream = {
                 context.contentResolver.openInputStream(page.uri ?: Uri.EMPTY)!!
             },).apply {
-                status = Page.State.READY
+                status = Page.State.Ready
             }
         }
     }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/EpubPageLoader.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/EpubPageLoader.kt
@@ -28,7 +28,7 @@ class EpubPageLoader(private val epub: EpubReader) : PageLoader() {
                 val streamFn = { epub.getInputStream(path)!! }
                 ReaderPage(i).apply {
                     stream = streamFn
-                    status = Page.State.READY
+                    status = Page.State.Ready
                 }
             }
     }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/HttpPageLoader.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/loader/HttpPageLoader.kt
@@ -51,7 +51,7 @@ class HttpPageLoader(
                     emit(runInterruptible { queue.take() }.page)
                 }
             }
-                .filter { it.status == Page.State.QUEUE }
+                .filter { it.status is Page.State.Queue }
                 .collect {
                     _loadPage(it)
                 }
@@ -108,25 +108,25 @@ class HttpPageLoader(
         val imageUrl = page.imageUrl
 
         // Check if the image has been deleted
-        if (page.status == Page.State.READY && imageUrl != null && !chapterCache.isImageInCache(imageUrl)) {
-            page.status = Page.State.QUEUE
+        if (page.status is Page.State.Ready && imageUrl != null && !chapterCache.isImageInCache(imageUrl)) {
+            page.status = Page.State.Queue
         }
 
         // Automatically retry failed pages when subscribed to this page
-        if (page.status == Page.State.ERROR) {
-            page.status = Page.State.QUEUE
+        if (page.status is Page.State.Error) {
+            page.status = Page.State.Queue
         }
 
         val queuedPages = mutableListOf<PriorityPage>()
-        if (page.status == Page.State.QUEUE) {
+        if (page.status is Page.State.Queue) {
             queuedPages += PriorityPage(page, 1).also { queue.offer(it) }
         }
         queuedPages += preloadNextPages(page, preloadSize)
 
         suspendCancellableCoroutine<Nothing> { continuation ->
             continuation.invokeOnCancellation {
                 queuedPages.forEach {
-                    if (it.page.status == Page.State.QUEUE) {
+                    if (it.page.status is Page.State.Queue) {
                         queue.remove(it)
                     }
                 }
@@ -146,7 +146,7 @@ class HttpPageLoader(
         return pages
             .subList(pageIndex + 1, min(pageIndex + 1 + amount, pages.size))
             .mapNotNull {
-                if (it.status == Page.State.QUEUE) {
+                if (it.status is Page.State.Queue) {
                     PriorityPage(it, 0).apply { queue.offer(this) }
                 } else {
                     null
@@ -158,8 +158,8 @@ class HttpPageLoader(
      * Retries a page. This method is only called from user interaction on the viewer.
      */
     override fun retryPage(page: ReaderPage) {
-        if (page.status == Page.State.ERROR) {
-            page.status = Page.State.QUEUE
+        if (page.status is Page.State.Error) {
+            page.status = Page.State.Queue
         }
         queue.offer(PriorityPage(page, 2))
     }
@@ -192,21 +192,21 @@ class HttpPageLoader(
     private suspend fun _loadPage(page: ReaderPage) {
         try {
             if (page.imageUrl.isNullOrEmpty()) {
-                page.status = Page.State.LOAD_PAGE
+                page.status = Page.State.LoadPage
                 page.imageUrl = source.getImageUrl(page)
             }
             val imageUrl = page.imageUrl!!
 
             if (!chapterCache.isImageInCache(imageUrl)) {
-                page.status = Page.State.DOWNLOAD_IMAGE
+                page.status = Page.State.DownloadImage
                 val imageResponse = source.getImage(page)
                 chapterCache.putImageToCache(imageUrl, imageResponse)
             }
 
             page.stream = { chapterCache.getImageFile(imageUrl).inputStream() }
-            page.status = Page.State.READY
+            page.status = Page.State.Ready
         } catch (e: Throwable) {
-            page.status = Page.State.ERROR
+            page.status = Page.State.Error
             if (e is CancellationException) {
                 throw e
             }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/model/InsertPage.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/model/InsertPage.kt
@@ -12,6 +12,6 @@ class InsertPage(parent: ReaderPage) : ReaderPage(
         fullPage = true
         firstHalf = false
         stream = parent.stream
-        status = State.READY
+        status = State.Ready
     }
 }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/viewer/pager/PagerPageHolder.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/viewer/pager/PagerPageHolder.kt
@@ -109,8 +109,8 @@ class PagerPageHolder(
      */
     private var extraProgressJob: Job? = null
 
-    private var status = Page.State.READY
-    private var extraStatus = Page.State.READY
+    private var status = Page.State.Ready
+    private var extraStatus = Page.State.Ready
     private var progress: Int = 0
     private var extraProgress: Int = 0
 
@@ -337,19 +337,19 @@ class PagerPageHolder(
      */
     private suspend fun processStatus(status: Page.State) {
         when (status) {
-            Page.State.QUEUE -> setQueued()
-            Page.State.LOAD_PAGE -> setLoading()
-            Page.State.DOWNLOAD_IMAGE -> {
+            is Page.State.Queue -> setQueued()
+            is Page.State.LoadPage -> setLoading()
+            is Page.State.DownloadImage -> {
                 launchProgressJob()
                 setDownloading()
             }
-            Page.State.READY -> {
-                if (extraStatus == Page.State.READY || extraPage == null) {
+            is Page.State.Ready -> {
+                if (extraPage == null) {
                     setImage()
                 }
                 cancelProgressJob(1)
             }
-            Page.State.ERROR -> {
+            is Page.State.Error -> {
                 setError()
                 cancelProgressJob(1)
             }
@@ -363,19 +363,17 @@ class PagerPageHolder(
      */
     private suspend fun processStatus2(status: Page.State) {
         when (status) {
-            Page.State.QUEUE -> setQueued()
-            Page.State.LOAD_PAGE -> setLoading()
-            Page.State.DOWNLOAD_IMAGE -> {
+            is Page.State.Queue -> setQueued()
+            is Page.State.LoadPage -> setLoading()
+            is Page.State.DownloadImage -> {
                 launchProgressJob2()
                 setDownloading()
             }
-            Page.State.READY -> {
-                if (this.status == Page.State.READY) {
-                    setImage()
-                }
+            is Page.State.Ready -> {
+                setImage()
                 cancelProgressJob(2)
             }
-            Page.State.ERROR -> {
+            is Page.State.Error -> {
                 setError()
                 cancelProgressJob(2)
             }
diff --git a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/viewer/webtoon/WebtoonPageHolder.kt b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/viewer/webtoon/WebtoonPageHolder.kt
@@ -128,18 +128,18 @@ class WebtoonPageHolder(
             launchIO { loader.loadPage(page) }
             page.statusFlow.collectLatest { status ->
                 when (status) {
-                    Page.State.QUEUE -> setQueued()
-                    Page.State.LOAD_PAGE -> setLoading()
-                    Page.State.DOWNLOAD_IMAGE -> {
+                    is Page.State.Queue -> setQueued()
+                    is Page.State.LoadPage -> setLoading()
+                    is Page.State.DownloadImage -> {
                         setDownloading()
                         scope.launch {
                             page.progressFlow.collectLatest { value ->
                                 progressIndicator.setProgress(value)
                             }
                         }
                     }
-                    Page.State.READY -> setImage()
-                    Page.State.ERROR -> setError()
+                    is Page.State.Ready -> setImage()
+                    is Page.State.Error -> setError()
                 }
             }
         }
diff --git a/source/api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/model/Page.kt b/source/api/src/commonMain/kotlin/eu/kanade/tachiyomi/source/model/Page.kt
@@ -19,7 +19,7 @@ open class Page(
         get() = index + 1
 
     @Transient
-    private val _statusFlow = MutableStateFlow(State.QUEUE)
+    private val _statusFlow = MutableStateFlow<State>(State.Queue)
 
     @Transient
     val statusFlow = _statusFlow.asStateFlow()
@@ -48,11 +48,11 @@ open class Page(
         }
     }
 
-    enum class State {
-        QUEUE,
-        LOAD_PAGE,
-        DOWNLOAD_IMAGE,
-        READY,
-        ERROR,
+    sealed interface State {
+        data object Queue : State
+        data object LoadPage : State
+        data object DownloadImage : State
+        data object Ready : State
+        data object Error : State
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1655,7 +1655,7 @@ class ReaderActivity : BaseActivity<ReaderActivityBinding>() {`
`1655`	`1655`	`}`
`1656`	`1656`
`1657`	`1657`	`private fun showSetCoverPrompt(page: ReaderPage) {`
`1658`		`- if (page.status != Page.State.READY) return`
	`1658`	`+ if (page.status !is Page.State.Ready) return`
`1659`	`1659`
`1660`	`1660`	`materialAlertDialog()`
`1661`	`1661`	`.setMessage(MR.strings.use_image_as_cover)`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ internal class ArchivePageLoader(private val reader: ArchiveReader) : PageLoader`
`31`	`31`	`.mapIndexed { i, entry ->`
`32`	`32`	`ReaderPage(i).apply {`
`33`	`33`	`stream = { reader.getInputStream(entry.name)!! }`
`34`		`- status = Page.State.READY`
	`34`	`+ status = Page.State.Ready`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`	`.toList()`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class DirectoryPageLoader(val file: UniFile) : PageLoader() {`
`24`	`24`	`val streamFn = { file.openInputStream() }`
`25`	`25`	`ReaderPage(i).apply {`
`26`	`26`	`stream = streamFn`
`27`		`- status = Page.State.READY`
	`27`	`+ status = Page.State.Ready`
`28`	`28`	`}`
`29`	`29`	`} ?: emptyList()`
`30`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class DownloadPageLoader(`
`60`	`60`	`ReaderPage(page.index, page.url, page.imageUrl, stream = {`
`61`	`61`	`context.contentResolver.openInputStream(page.uri ?: Uri.EMPTY)!!`
`62`	`62`	`},).apply {`
`63`		`- status = Page.State.READY`
	`63`	`+ status = Page.State.Ready`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class EpubPageLoader(private val epub: EpubReader) : PageLoader() {`
`28`	`28`	`val streamFn = { epub.getInputStream(path)!! }`
`29`	`29`	`ReaderPage(i).apply {`
`30`	`30`	`stream = streamFn`
`31`		`- status = Page.State.READY`
	`31`	`+ status = Page.State.Ready`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`	`}`