feat(study screen): scroll to card with the Browser command

Author: BrayanDSO

AnkiDroid/src/main/java/com/ichi2/anki/browser/BrowserDestination.kt

@@ -20,6 +20,7 @@ import android.content.Context
 import android.content.Intent
 import com.ichi2.anki.AnkiDroidApp
 import com.ichi2.anki.CardBrowser
+import com.ichi2.anki.libanki.CardId
 import com.ichi2.anki.libanki.DeckId
 import com.ichi2.anki.utils.Destination
 
@@ -35,4 +36,24 @@ sealed interface BrowserDestination : Destination {
             return Intent(context, CardBrowser::class.java)
         }
     }
+
+    /**
+     * Opens the [CardBrowser] with the specified deck selected,
+     * and automatically scrolls to [cardId] if the card is present on the deck.
+     */
+    data class ToCard(
+        val deckId: DeckId,
+        val cardId: CardId,
+    ) : BrowserDestination {
+        override fun toIntent(context: Context): Intent {
+            AnkiDroidApp.instance.sharedPrefsLastDeckIdRepository.lastDeckId = deckId
+            return Intent(context, CardBrowser::class.java).apply {
+                putExtra(EXTRA_CARD_ID_KEY, cardId)
+            }
+        }
+
+        companion object {
+            const val EXTRA_CARD_ID_KEY = "cardId"
+        }
+    }
 }

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt

@@ -465,6 +465,7 @@ class CardBrowserFragment :
         activityViewModel.flowOfToggleSelectionState.launchCollectionInLifecycleScope(::onToggleSelectionStateUpdated)
         viewModel.flowOfSearchForDecks.launchCollectionInLifecycleScope(::onSearchForDecks)
         activityViewModel.flowOfDeckSelection.launchCollectionInLifecycleScope(::onDeckChanged)
+        activityViewModel.flowOfScrollRequest.launchCollectionInLifecycleScope(::autoScrollTo)
     }
 
     private fun setupFragmentResultListeners() {

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserLaunchOptions.kt

@@ -18,6 +18,8 @@ package com.ichi2.anki.browser
 
 import android.content.Intent
 import androidx.annotation.CheckResult
+import com.ichi2.anki.common.utils.ext.getLongExtra
+import com.ichi2.anki.libanki.CardId
 
 /** How the [com.ichi2.anki.CardBrowser] can be launched */
 sealed interface CardBrowserLaunchOptions {
@@ -34,6 +36,10 @@ sealed interface CardBrowserLaunchOptions {
     data class SystemContextMenu(
         val search: CharSequence,
     ) : CardBrowserLaunchOptions
+
+    data class ScrollToCard(
+        val cardId: CardId,
+    ) : CardBrowserLaunchOptions
 }
 
 @CheckResult
@@ -48,6 +54,10 @@ fun Intent.toCardBrowserLaunchOptions(): CardBrowserLaunchOptions? {
         return CardBrowserLaunchOptions.SearchQueryJs(it, getBooleanExtra("all_decks", false))
     }
 
+    getLongExtra(BrowserDestination.ToCard.EXTRA_CARD_ID_KEY)?.let { cardId ->
+        return CardBrowserLaunchOptions.ScrollToCard(cardId)
+    }
+
     // Maybe we were called from ACTION_PROCESS_TEXT
     if (Intent.ACTION_PROCESS_TEXT == action) {
         val search = getCharSequenceExtra(Intent.EXTRA_PROCESS_TEXT)

AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserViewModel.kt

@@ -168,6 +168,11 @@ class CardBrowserViewModel(
     // card that was clicked (not marked)
     var currentCardId: CardId = 0
 
+    var cardIdToBeScrolledTo: CardId? = null
+        private set
+
+    val flowOfScrollRequest = MutableSharedFlow<RowSelection>()
+
     private val sortTypeFlow = MutableStateFlow(SortType.NO_SORTING)
     val order get() = sortTypeFlow.value
 
@@ -402,6 +407,9 @@ class CardBrowserViewModel(
             is CardBrowserLaunchOptions.DeepLink -> {
                 flowOfSearchTerms.value = options.search
             }
+            is CardBrowserLaunchOptions.ScrollToCard -> {
+                cardIdToBeScrolledTo = options.cardId
+            }
             null -> {}
         }
 
@@ -1175,6 +1183,7 @@ class CardBrowserViewModel(
      * @see com.ichi2.anki.searchForRows
      */
     @NeedsTest("Invalid searches are handled. For instance: 'and'")
+    @NeedsTest("card id is scrolled")
     fun launchSearchForCards(cardOrNoteIdsToSelect: List<CardOrNoteId> = emptyList()) {
         if (!initCompleted) return
 
@@ -1204,6 +1213,20 @@ class CardBrowserViewModel(
                     flowOfSearchState.emit(SearchState.Completed)
                     selectUnvalidatedRowIds(cardOrNoteIdsToSelect)
                 }
+
+            viewModelScope.launch {
+                searchJob?.join()
+                cardIdToBeScrolledTo?.let { targetId ->
+                    val rowId =
+                        if (cardsOrNotes == CARDS) {
+                            CardOrNoteId(targetId)
+                        } else {
+                            val nid = withCol { getCard(targetId) }.nid
+                            CardOrNoteId(nid)
+                        }
+                    flowOfScrollRequest.emit(RowSelection(rowId, topOffset = 0))
+                }
+            }
         }
     }
 

AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerViewModel.kt

@@ -291,7 +291,8 @@ class ReviewerViewModel(
 
     private suspend fun emitBrowseDestination() {
         val deckId = withCol { decks.getCurrentId() }
-        val destination = BrowserDestination.ToDeck(deckId)
+        val cardId = currentCard.await().id
+        val destination = BrowserDestination.ToCard(deckId, cardId)
         Timber.i("Launching 'browse options' for deck %d", deckId)
         destinationFlow.emit(destination)
     }