From f1e2efcb37e2c623b769e979fa1c7e9e5ad7117d Mon Sep 17 00:00:00 2001 From: AwkwardPeak7 <48650614+AwkwardPeak7@users.noreply.github.com> Date: Sun, 13 Apr 2025 15:32:20 +0500 Subject: [PATCH] Change `Page.State` to sealed interface (#1988) --- .../data/download/DownloadManager.kt | 2 +- .../tachiyomi/data/download/Downloader.kt | 10 +++---- .../tachiyomi/data/download/model/Download.kt | 2 +- .../tachiyomi/ui/reader/ReaderViewModel.kt | 8 +++--- .../ui/reader/loader/ArchivePageLoader.kt | 2 +- .../ui/reader/loader/DirectoryPageLoader.kt | 2 +- .../ui/reader/loader/DownloadPageLoader.kt | 2 +- .../ui/reader/loader/EpubPageLoader.kt | 2 +- .../ui/reader/loader/HttpPageLoader.kt | 28 +++++++++---------- .../tachiyomi/ui/reader/model/InsertPage.kt | 2 +- .../ui/reader/viewer/pager/PagerPageHolder.kt | 10 +++---- .../viewer/webtoon/WebtoonPageHolder.kt | 10 +++---- .../eu/kanade/tachiyomi/source/model/Page.kt | 14 +++++----- 13 files changed, 47 insertions(+), 47 deletions(-) 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 index 5fba899ca..2dc5df8ae 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadManager.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadManager.kt @@ -169,7 +169,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 index 0ca27494d..5f05f7f54 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/download/Downloader.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/download/Downloader.kt @@ -361,11 +361,11 @@ class Downloader( flow { // Fetch image URL if necessary if (page.imageUrl.isNullOrEmpty()) { - 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 } } @@ -452,12 +452,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, download.chapter.name, download.manga.title, download.manga.id) } } @@ -471,7 +471,7 @@ class Downloader( * @param filename the filename of the image. */ private suspend fun downloadImage(page: Page, source: HttpSource, 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 index 564a33633..1b14b0827 100644 --- 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 @@ -29,7 +29,7 @@ data class Download( get() = pages?.sumOf(Page::progress) ?: 0 val downloadedImages: Int - get() = pages?.count { it.status == Page.State.READY } ?: 0 + get() = pages?.count { it.status == Page.State.Ready } ?: 0 @Transient private val _statusFlow = MutableStateFlow(State.NOT_DOWNLOADED) 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 index 21edcdd8c..7654c0102 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderViewModel.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/ui/reader/ReaderViewModel.kt @@ -537,7 +537,7 @@ class ReaderViewModel @JvmOverloads constructor( readerChapter.requestedPage = pageIndex chapterPageIndex = pageIndex - if (!incognitoMode && page.status != Page.State.ERROR) { + if (!incognitoMode && page.status != Page.State.Error) { readerChapter.chapter.last_page_read = pageIndex if (readerChapter.pages?.lastIndex == pageIndex) { @@ -799,7 +799,7 @@ class ReaderViewModel @JvmOverloads constructor( */ fun saveImage() { val page = (state.value.dialog as? Dialog.PageActions)?.page - if (page?.status != Page.State.READY) return + if (page?.status != Page.State.Ready) return val manga = manga ?: return val context = Injekt.get() @@ -847,7 +847,7 @@ class ReaderViewModel @JvmOverloads constructor( */ fun shareImage(copyToClipboard: Boolean) { val page = (state.value.dialog as? Dialog.PageActions)?.page - if (page?.status != Page.State.READY) return + if (page?.status != Page.State.Ready) return val manga = manga ?: return val context = Injekt.get() @@ -877,7 +877,7 @@ class ReaderViewModel @JvmOverloads constructor( */ fun setAsCover() { val page = (state.value.dialog as? Dialog.PageActions)?.page - if (page?.status != Page.State.READY) return + if (page?.status != 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 index 656d1c797..9332c8a0c 100644 --- 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 @@ -19,7 +19,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 index 8817b0682..adb92c1b4 100644 --- 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 @@ -21,7 +21,7 @@ internal class DirectoryPageLoader(val file: UniFile) : PageLoader() { val streamFn = { file.openInputStream() } ReaderPage(i).apply { stream = streamFn - status = Page.State.READY + status = Page.State.Ready } } .orEmpty() 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 index d85bb4f75..59d7f21e5 100644 --- 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 @@ -57,7 +57,7 @@ internal class DownloadPageLoader( ReaderPage(page.index, page.url, page.imageUrl) { 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 index cc43487a8..5139fe2b7 100644 --- 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 @@ -15,7 +15,7 @@ internal class EpubPageLoader(private val reader: EpubReader) : PageLoader() { return reader.getImagesFromPages().mapIndexed { i, path -> ReaderPage(i).apply { stream = { reader.getInputStream(path)!! } - 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 index 5b62b78e3..4ceb9ae22 100644 --- 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 @@ -50,7 +50,7 @@ internal class HttpPageLoader( emit(runInterruptible { queue.take() }.page) } } - .filter { it.status == Page.State.QUEUE } + .filter { it.status == Page.State.Queue } .collect(::internalLoadPage) } } @@ -83,17 +83,17 @@ internal 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 == 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 == Page.State.Error) { + page.status = Page.State.Queue } val queuedPages = mutableListOf() - if (page.status == Page.State.QUEUE) { + if (page.status == Page.State.Queue) { queuedPages += PriorityPage(page, 1).also { queue.offer(it) } } queuedPages += preloadNextPages(page, preloadSize) @@ -101,7 +101,7 @@ internal class HttpPageLoader( suspendCancellableCoroutine { continuation -> continuation.invokeOnCancellation { queuedPages.forEach { - if (it.page.status == Page.State.QUEUE) { + if (it.page.status == Page.State.Queue) { queue.remove(it) } } @@ -113,8 +113,8 @@ internal 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 == Page.State.Error) { + page.status = Page.State.Queue } queue.offer(PriorityPage(page, 2)) } @@ -153,7 +153,7 @@ internal class HttpPageLoader( return pages .subList(pageIndex + 1, min(pageIndex + 1 + amount, pages.size)) .mapNotNull { - if (it.status == Page.State.QUEUE) { + if (it.status == Page.State.Queue) { PriorityPage(it, 0).apply { queue.offer(this) } } else { null @@ -170,21 +170,21 @@ internal class HttpPageLoader( private suspend fun internalLoadPage(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 index c605d6e65..40bb702f1 100644 --- 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 @@ -5,7 +5,7 @@ class InsertPage(val parent: ReaderPage) : ReaderPage(parent.index, parent.url, override var chapter: ReaderChapter = parent.chapter init { - status = State.READY + status = State.Ready stream = parent.stream } } 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 index 59b20c095..47d22c273 100644 --- 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 @@ -96,16 +96,16 @@ class PagerPageHolder( } page.statusFlow.collectLatest { state -> when (state) { - Page.State.QUEUE -> setQueued() - Page.State.LOAD_PAGE -> setLoading() - Page.State.DOWNLOAD_IMAGE -> { + Page.State.Queue -> setQueued() + Page.State.LoadPage -> setLoading() + Page.State.DownloadImage -> { setDownloading() page.progressFlow.collectLatest { value -> progressIndicator?.setProgress(value) } } - Page.State.READY -> setImage() - Page.State.ERROR -> setError() + Page.State.Ready -> setImage() + Page.State.Error -> setError() } } } 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 index 488db7bb6..402926d16 100644 --- 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 @@ -136,16 +136,16 @@ class WebtoonPageHolder( } page.statusFlow.collectLatest { state -> when (state) { - Page.State.QUEUE -> setQueued() - Page.State.LOAD_PAGE -> setLoading() - Page.State.DOWNLOAD_IMAGE -> { + Page.State.Queue -> setQueued() + Page.State.LoadPage -> setLoading() + Page.State.DownloadImage -> { setDownloading() page.progressFlow.collectLatest { value -> progressIndicator.setProgress(value) } } - Page.State.READY -> setImage() - Page.State.ERROR -> setError() + Page.State.Ready -> setImage() + 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 index 7ce18934f..ce350c615 100644 --- 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.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 } }