Add card browser chip filtering for flags #17355
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * 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, or (at your option) any later | ||
| * version. | ||
| * | ||
| * 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 <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.ichi2.anki.browser | ||
|
|
||
| import android.os.Parcelable | ||
| import com.ichi2.anki.Flag | ||
| import com.ichi2.libanki.DeckId | ||
| import kotlinx.parcelize.Parcelize | ||
|
|
||
| @Parcelize | ||
| data class SearchParameters( | ||
|
There was a problem hiding this comment. I'd really appreciate some documentation. I admit I find it very clear, but I'm not certain it would be the case for a new contributor. In particular, every parameters comes from user input, whether they tap or type. I admit that I don't have a better value name. Still, it'd be nice to explain this corresponds to what the user typed in the search bar. It's expected to be a query but can actually be badly formed There was a problem hiding this comment. Subject: [PATCH] [PATCH]
---
Index: AnkiDroid/src/main/java/com/ichi2/anki/browser/SearchParameters.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/browser/SearchParameters.kt b/AnkiDroid/src/main/java/com/ichi2/anki/browser/SearchParameters.kt
--- a/AnkiDroid/src/main/java/com/ichi2/anki/browser/SearchParameters.kt (revision c45fdd7d1dd576b6a9438ceb5721055a079140c8)
+++ b/AnkiDroid/src/main/java/com/ichi2/anki/browser/SearchParameters.kt (date 1736379407730)
@@ -20,11 +20,24 @@
import com.ichi2.libanki.DeckId
import kotlinx.parcelize.Parcelize
+/**
+ * Represents the parameters displayed to the user in the card browser search UI. The search UI contains both the search text field where the user can type any query, and the chips.
+ * The result of this search consist in all cards satisfying all of the criteria below.
+ */
@Parcelize
data class SearchParameters(
val userInput: String,
+ /**
+ * Limit the search to cards belonging to any deck of [deckIds]. Note that it does not include any subdeck.
+ */
val deckIds: Set<DeckId>,
+ /**
+ * Limit the search to any note containing at least one tag in [tags].
+ */
val tags: Set<String>,
+ /**
+ * Limit the search to cards whose flag belong to [flags].
+ */
val flags: Set<Flag>,
) : Parcelable {
val isEmpty get() = userInput.isEmpty() && deckIds.isEmpty() && tags.isEmpty() && flags.isEmpty()
@@ -33,9 +46,8 @@
companion object {
val EMPTY = SearchParameters("", emptySet(), emptySet(), emptySet())
}
-}
-suspend fun SearchParameters.toQuery(): String {
+suspend fun toQuery(): String {
val targetDecksNames =
withCol {
deckIds.map { deckId -> decks.name(deckId) }
@@ -48,3 +60,4 @@
).filter { it.isNotEmpty() }
.joinToString(" ") { "($it)" }
}
+}
\ No newline at end of file |
||
| val userInput: String, | ||
| val deckIds: Set<DeckId>, | ||
|
There was a problem hiding this comment. I assume the reason why it's a set and not an arbitrary collection/iterable is that it ensures that it's parcelizable. If so, I'd suggest maybe adding a comment somewhere, because intuitively, it seems strange to me to restrict it to being a set specifically. |
||
| val tags: Set<String>, | ||
| val flags: Set<Flag>, | ||
| ) : Parcelable { | ||
| val isEmpty get() = userInput.isEmpty() && deckIds.isEmpty() && tags.isEmpty() && flags.isEmpty() | ||
| val isNotEmpty get() = !isEmpty | ||
|
|
||
| companion object { | ||
| val EMPTY = SearchParameters("", emptySet(), emptySet(), emptySet()) | ||
| } | ||
| } | ||
|
|
||
| fun SearchParameters.toQuery() = | ||
|
There was a problem hiding this comment. Why define it as an extension instead of putting it into the class itself? |
||
| listOf( | ||
| userInput, | ||
| deckIds.joinToString(" OR ") { "did:$it" }, | ||
| tags.joinToString(" OR ") { """"tag:$it"""" }, | ||
| flags.joinToString(" OR ") { "flag:${it.code}" }, | ||
| ).filter { it.isNotEmpty() } | ||
| .joinToString(" ") { "($it)" } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's worth adding a comment explaining that we're resetting only the text entered by the user, but keeping all chips as-is