NF: ModelType is an enum

Improve typing
ankidroid · Jan 4, 2025 · a01983b · a01983b
1 parent 9817aeb
commit a01983b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 19 deletions.
diff --git a/AnkiDroid/src/main/java/com/ichi2/libanki/Consts.kt b/AnkiDroid/src/main/java/com/ichi2/libanki/Consts.kt
@@ -94,6 +94,28 @@ sealed class QueueType(
     }
 }
 
+// model types
+sealed class NoteTypeKind(
+    val code: Int,
+) {
+    object Std : NoteTypeKind(0)
+
+    object Cloze : NoteTypeKind(1)
+
+    class Unknown(
+        code: Int,
+    ) : NoteTypeKind(code)
+
+    companion object {
+        fun fromCode(code: Int) =
+            when (code) {
+                0 -> Std
+                1 -> Cloze
+                else -> Unknown(code)
+            }
+    }
+}
+
 object Consts {
     // dynamic deck order
     const val DYN_OLDEST = 0
@@ -111,14 +133,6 @@ object Consts {
     @IntDef(DYN_OLDEST, DYN_RANDOM, DYN_SMALLINT, DYN_BIGINT, DYN_LAPSES, DYN_ADDED, DYN_DUE, DYN_REVADDED, DYN_DUEPRIORITY)
     annotation class DynPriority
 
-    // model types
-    const val MODEL_STD = 0
-    const val MODEL_CLOZE = 1
-
-    @Retention(AnnotationRetention.SOURCE)
-    @IntDef(MODEL_STD, MODEL_CLOZE)
-    annotation class ModelType
-
     const val STARTING_FACTOR = 2500
 
     /** Only used by the dialog shown to user */

diff --git a/AnkiDroid/src/main/java/com/ichi2/libanki/Note.kt b/AnkiDroid/src/main/java/com/ichi2/libanki/Note.kt
@@ -21,7 +21,6 @@ import androidx.annotation.CheckResult
 import androidx.annotation.VisibleForTesting
 import anki.notes.NoteFieldsCheckResponse
 import com.ichi2.libanki.Consts.DEFAULT_DECK_ID
-import com.ichi2.libanki.Consts.MODEL_STD
 import com.ichi2.libanki.backend.model.toBackendNote
 import com.ichi2.libanki.utils.NotInLibAnki
 import com.ichi2.libanki.utils.set
@@ -116,7 +115,7 @@ class Note : Cloneable {
             if (customTemplate != null) {
                 customTemplate.deepClone()
             } else {
-                val index = if (model.type == MODEL_STD) ord else 0
+                val index = if (model.isStd) ord else 0
                 model.tmpls[index]
             }
         // may differ in cloze case

diff --git a/AnkiDroid/src/main/java/com/ichi2/libanki/NotetypeJson.kt b/AnkiDroid/src/main/java/com/ichi2/libanki/NotetypeJson.kt
@@ -71,9 +71,9 @@ class NotetypeJson : JSONObject {
     val templatesNames: List<String>
         get() = getJSONArray("tmpls").toStringList("name")
     val isStd: Boolean
-        get() = getInt("type") == Consts.MODEL_STD
+        get() = type == NoteTypeKind.Std
     val isCloze: Boolean
-        get() = getInt("type") == Consts.MODEL_CLOZE
+        get() = type == NoteTypeKind.Cloze
 
     /**
      * @param sfld Fields of a note of this note type
@@ -129,12 +129,10 @@ class NotetypeJson : JSONObject {
             put("sortf", value)
         }
 
-    // TODO: Not constrained
-    @Consts.ModelType
-    var type: Int
-        get() = getInt("type")
+    var type: NoteTypeKind
+        get() = NoteTypeKind.fromCode(getInt("type"))
         set(value) {
-            put("type", value)
+            put("type", value.code)
         }
 
     /**

diff --git a/AnkiDroid/src/main/java/com/ichi2/libanki/Notetypes.kt b/AnkiDroid/src/main/java/com/ichi2/libanki/Notetypes.kt
@@ -43,7 +43,6 @@ import anki.notetypes.restoreNotetypeToStockRequest
 import com.google.protobuf.ByteString
 import com.ichi2.anki.CrashReportService
 import com.ichi2.annotations.NeedsTest
-import com.ichi2.libanki.Consts.MODEL_CLOZE
 import com.ichi2.libanki.Utils.checksum
 import com.ichi2.libanki.backend.BackendUtils
 import com.ichi2.libanki.backend.BackendUtils.fromJsonBytes
@@ -600,7 +599,7 @@ class Notetypes(
     ): OpChanges {
         val fieldMap = convertLegacyMap(fmap, newModel.fieldsNames.size)
         val templateMap =
-            if (cmap.isEmpty() || noteType.type == MODEL_CLOZE || newModel.type == MODEL_CLOZE) {
+            if (cmap.isEmpty() || noteType.isCloze || newModel.isCloze) {
                 listOf()
             } else {
                 convertLegacyMap(cmap, newModel.templatesNames.size)