naming convention warnings refactor

Local variable naming convention refactor

Private property naming convention refactor

Class naming convention refactor

last naming convention warnings resolved

revert unwanted changes in naming refactor

correction asked for the mistakes in naming refactor

AnkiDroid/src/main/java/com/ichi2/anki/AbstractFlashcardViewer.kt

@@ -132,7 +132,7 @@ import com.ichi2.libanki.CardId
 import com.ichi2.libanki.ChangeManager
 import com.ichi2.libanki.Collection
 import com.ichi2.libanki.Consts
-import com.ichi2.libanki.Consts.BUTTON_TYPE
+import com.ichi2.libanki.Consts.ButtonType
 import com.ichi2.libanki.DeckId
 import com.ichi2.libanki.Decks
 import com.ichi2.libanki.Sound.getAvTag
@@ -856,7 +856,7 @@ abstract class AbstractFlashcardViewer :
         }
     }
 
-    open fun answerCard(@BUTTON_TYPE ease: Int) = preventSimultaneousExecutions(ANSWER_CARD) {
+    open fun answerCard(@ButtonType ease: Int) = preventSimultaneousExecutions(ANSWER_CARD) {
         launchCatchingTask {
             if (inAnswer) {
                 return@launchCatchingTask
@@ -876,7 +876,7 @@ abstract class AbstractFlashcardViewer :
         }
     }
 
-    open suspend fun answerCardInner(@BUTTON_TYPE ease: Int) {
+    open suspend fun answerCardInner(@ButtonType ease: Int) {
         // Legacy tests assume they can call answerCard() even outside of Reviewer
         withCol {
             sched.answerCard(currentCard!!, ease)

AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt

@@ -25,14 +25,14 @@ import android.net.Uri
 import androidx.lifecycle.lifecycleScope
 import com.github.zafarkhaja.semver.Version
 import com.google.android.material.snackbar.Snackbar
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeBuryCard
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeBuryNote
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeError
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeFlagCard
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeMarkCard
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeSetDue
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeSuspendCard
-import com.ichi2.anki.AnkiDroidJsAPIConstants.ankiJsErrorCodeSuspendNote
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_BURT_NOTE
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_BURY_CARD
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_ERROR
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_FLAG_CARD
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_MARK_CARD
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_SET_DUE
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_SUSPEND_CARD
+import com.ichi2.anki.AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_SUSPEND_NOTE
 import com.ichi2.anki.AnkiDroidJsAPIConstants.flagCommands
 import com.ichi2.anki.cardviewer.ViewerCommand
 import com.ichi2.anki.model.CardsOrNotes
@@ -144,7 +144,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
                 }
                 return false
             }
-            val versionCurrent = Version.parse(AnkiDroidJsAPIConstants.currentJsApiVersion)
+            val versionCurrent = Version.parse(AnkiDroidJsAPIConstants.CURRENT_JS_API_VERSION)
             val versionSupplied = Version.parse(apiVer)
 
             /*
@@ -160,7 +160,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
                     activity.runOnUiThread {
                         activity.showSnackbar(context.getString(R.string.update_js_api_version, apiDevContact))
                     }
-                    versionSupplied.isHigherThanOrEquivalentTo(Version.parse(AnkiDroidJsAPIConstants.minimumJsApiVersion))
+                    versionSupplied.isHigherThanOrEquivalentTo(Version.parse(AnkiDroidJsAPIConstants.MINIMUM_JS_API_VERSION))
                 }
                 else -> {
                     activity.runOnUiThread {
@@ -207,29 +207,29 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
             "nextTime4" -> convertToByteArray(apiContract, cardDataForJsAPI.nextTime4)
             "toggleFlag" -> {
                 if (apiParams !in flagCommands) {
-                    showDeveloperContact(ankiJsErrorCodeFlagCard, apiContract.cardSuppliedDeveloperContact)
+                    showDeveloperContact(ANKI_JS_ERROR_CODE_FLAG_CARD, apiContract.cardSuppliedDeveloperContact)
                     return@withContext convertToByteArray(apiContract, false)
                 }
                 convertToByteArray(apiContract, activity.executeCommand(flagCommands[apiParams]!!))
             }
-            "markCard" -> processAction({ activity.executeCommand(ViewerCommand.MARK) }, apiContract, ankiJsErrorCodeMarkCard, ::convertToByteArray)
-            "buryCard" -> processAction(activity::buryCard, apiContract, ankiJsErrorCodeBuryCard, ::convertToByteArray)
-            "buryNote" -> processAction(activity::buryNote, apiContract, ankiJsErrorCodeBuryNote, ::convertToByteArray)
-            "suspendCard" -> processAction(activity::suspendCard, apiContract, ankiJsErrorCodeSuspendCard, ::convertToByteArray)
-            "suspendNote" -> processAction(activity::suspendNote, apiContract, ankiJsErrorCodeSuspendNote, ::convertToByteArray)
+            "markCard" -> processAction({ activity.executeCommand(ViewerCommand.MARK) }, apiContract, ANKI_JS_ERROR_CODE_MARK_CARD, ::convertToByteArray)
+            "buryCard" -> processAction(activity::buryCard, apiContract, ANKI_JS_ERROR_CODE_BURY_CARD, ::convertToByteArray)
+            "buryNote" -> processAction(activity::buryNote, apiContract, ANKI_JS_ERROR_CODE_BURT_NOTE, ::convertToByteArray)
+            "suspendCard" -> processAction(activity::suspendCard, apiContract, ANKI_JS_ERROR_CODE_SUSPEND_CARD, ::convertToByteArray)
+            "suspendNote" -> processAction(activity::suspendNote, apiContract, ANKI_JS_ERROR_CODE_SUSPEND_NOTE, ::convertToByteArray)
             "setCardDue" -> {
                 try {
                     val days = apiParams.toInt()
                     if (days < 0 || days > 9999) {
-                        showDeveloperContact(ankiJsErrorCodeSetDue, apiContract.cardSuppliedDeveloperContact)
+                        showDeveloperContact(ANKI_JS_ERROR_CODE_SET_DUE, apiContract.cardSuppliedDeveloperContact)
                         return@withContext convertToByteArray(apiContract, false)
                     }
                     activity.launchCatchingTask {
                         activity.rescheduleCards(listOf(currentCard.id), days)
                     }
                     return@withContext convertToByteArray(apiContract, true)
                 } catch (e: NumberFormatException) {
-                    showDeveloperContact(ankiJsErrorCodeSetDue, apiContract.cardSuppliedDeveloperContact)
+                    showDeveloperContact(ANKI_JS_ERROR_CODE_SET_DUE, apiContract.cardSuppliedDeveloperContact)
                     return@withContext convertToByteArray(apiContract, false)
                 }
             }
@@ -367,7 +367,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
             }
             "sttStop" -> convertToByteArray(apiContract, speechRecognizer.stop())
             else -> {
-                showDeveloperContact(ankiJsErrorCodeError, apiContract.cardSuppliedDeveloperContact)
+                showDeveloperContact(ANKI_JS_ERROR_CODE_ERROR, apiContract.cardSuppliedDeveloperContact)
                 throw Exception("unhandled request: $methodName")
             }
         }
@@ -394,7 +394,7 @@ open class AnkiDroidJsAPI(private val activity: AbstractFlashcardViewer) {
                 "console.log('${context.getString(R.string.search_card_js_api_no_results)}')",
                 null
             )
-            showDeveloperContact(AnkiDroidJsAPIConstants.ankiJsErrorCodeSearchCard, apiContract.cardSuppliedDeveloperContact)
+            showDeveloperContact(AnkiDroidJsAPIConstants.ANKI_JS_ERROR_CODE_SEARCH_CARD, apiContract.cardSuppliedDeveloperContact)
             return@withContext convertToByteArray(apiContract, false)
         }
         val searchResult: MutableList<String> = ArrayList()

AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPIConstants.kt

@@ -22,21 +22,21 @@ import com.ichi2.anki.cardviewer.ViewerCommand
 
 object AnkiDroidJsAPIConstants {
     // JS API ERROR CODE
-    const val ankiJsErrorCodeError: Int = -1
-    const val ankiJsErrorCodeDefault: Int = 0
-    const val ankiJsErrorCodeMarkCard: Int = 1
-    const val ankiJsErrorCodeFlagCard: Int = 2
+    const val ANKI_JS_ERROR_CODE_ERROR: Int = -1
+    const val ANKI_JS_ERROR_CODE_DEFAULT: Int = 0
+    const val ANKI_JS_ERROR_CODE_MARK_CARD: Int = 1
+    const val ANKI_JS_ERROR_CODE_FLAG_CARD: Int = 2
 
-    const val ankiJsErrorCodeBuryCard: Int = 3
-    const val ankiJsErrorCodeSuspendCard: Int = 4
-    const val ankiJsErrorCodeBuryNote: Int = 5
-    const val ankiJsErrorCodeSuspendNote: Int = 6
-    const val ankiJsErrorCodeSetDue: Int = 7
-    const val ankiJsErrorCodeSearchCard: Int = 8
+    const val ANKI_JS_ERROR_CODE_BURY_CARD: Int = 3
+    const val ANKI_JS_ERROR_CODE_SUSPEND_CARD: Int = 4
+    const val ANKI_JS_ERROR_CODE_BURT_NOTE: Int = 5
+    const val ANKI_JS_ERROR_CODE_SUSPEND_NOTE: Int = 6
+    const val ANKI_JS_ERROR_CODE_SET_DUE: Int = 7
+    const val ANKI_JS_ERROR_CODE_SEARCH_CARD: Int = 8
 
     // js api developer contact
-    const val currentJsApiVersion = "0.0.3"
-    const val minimumJsApiVersion = "0.0.3"
+    const val CURRENT_JS_API_VERSION = "0.0.3"
+    const val MINIMUM_JS_API_VERSION = "0.0.3"
 
     val flagCommands = mapOf(
         "none" to ViewerCommand.UNSET_FLAG,

AnkiDroid/src/main/java/com/ichi2/anki/CardTemplateEditor.kt

@@ -187,7 +187,7 @@ open class CardTemplateEditor : AnkiActivity(), DeckSelectionListener {
     }
 
     /**
-     *  Loads or reloads [tempModel] in [R.id.template_previewer_fragment] if the view is fragmented. Do nothing otherwise.
+     *  Loads or reloads [tempModel] in [R.id.fragment_container] if the view is fragmented. Do nothing otherwise.
      */
     private fun loadTemplatePreviewerFragmentIfFragmented() {
         if (!fragmented) {

AnkiDroid/src/main/java/com/ichi2/anki/ModelFieldEditor.kt

@@ -165,14 +165,14 @@ class ModelFieldEditor : AnkiActivity(), LocaleSelectionDialogHandler {
         fieldNameInput = FixedEditText(this).apply {
             focusWithKeyboard()
         }
-        fieldNameInput?.let { _fieldNameInput ->
-            _fieldNameInput.isSingleLine = true
+        fieldNameInput?.let { fieldNameInput ->
+            fieldNameInput.isSingleLine = true
             AlertDialog.Builder(this).show {
-                customView(view = _fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
+                customView(view = fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
                 title(R.string.model_field_editor_add)
                 positiveButton(R.string.dialog_ok) {
                     // Name is valid, now field is added
-                    val fieldName = uniqueName(_fieldNameInput)
+                    val fieldName = uniqueName(fieldNameInput)
                     try {
                         addField(fieldName, true)
                     } catch (e: ConfirmModSchemaException) {
@@ -284,15 +284,15 @@ class ModelFieldEditor : AnkiActivity(), LocaleSelectionDialogHandler {
      */
     private fun renameFieldDialog() {
         fieldNameInput = FixedEditText(this).apply { focusWithKeyboard() }
-        fieldNameInput?.let { _fieldNameInput ->
-            _fieldNameInput.isSingleLine = true
-            _fieldNameInput.setText(fieldsLabels[currentPos])
-            _fieldNameInput.setSelection(_fieldNameInput.text!!.length)
+        fieldNameInput?.let { fieldNameInput ->
+            fieldNameInput.isSingleLine = true
+            fieldNameInput.setText(fieldsLabels[currentPos])
+            fieldNameInput.setSelection(fieldNameInput.text!!.length)
             AlertDialog.Builder(this).show {
-                customView(view = _fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
+                customView(view = fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
                 title(R.string.model_field_editor_rename)
                 positiveButton(R.string.rename) {
-                    if (uniqueName(_fieldNameInput) == null) {
+                    if (uniqueName(fieldNameInput) == null) {
                         return@positiveButton
                     }
                     // Field is valid, now rename
@@ -329,22 +329,22 @@ class ModelFieldEditor : AnkiActivity(), LocaleSelectionDialogHandler {
      */
     private fun repositionFieldDialog() {
         fieldNameInput = FixedEditText(this).apply { focusWithKeyboard() }
-        fieldNameInput?.let { _fieldNameInput ->
-            _fieldNameInput.setRawInputType(InputType.TYPE_CLASS_NUMBER)
+        fieldNameInput?.let { fieldNameInput ->
+            fieldNameInput.setRawInputType(InputType.TYPE_CLASS_NUMBER)
             AlertDialog.Builder(this).show {
-                customView(view = _fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
+                customView(view = fieldNameInput, paddingLeft = 64, paddingRight = 64, paddingTop = 32)
                 title(text = String.format(resources.getString(R.string.model_field_editor_reposition), 1, fieldsLabels.size))
                 positiveButton(R.string.dialog_ok) {
-                    val newPosition = _fieldNameInput.text.toString()
+                    val newPosition = fieldNameInput.text.toString()
                     val pos: Int = try {
                         newPosition.toInt()
                     } catch (n: NumberFormatException) {
                         Timber.w(n)
-                        _fieldNameInput.error = resources.getString(R.string.toast_out_of_range)
+                        fieldNameInput.error = resources.getString(R.string.toast_out_of_range)
                         return@positiveButton
                     }
                     if (pos < 1 || pos > fieldsLabels.size) {
-                        _fieldNameInput.error = resources.getString(R.string.toast_out_of_range)
+                        fieldNameInput.error = resources.getString(R.string.toast_out_of_range)
                     } else {
                         // Input is valid, now attempt to modify
                         try {

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/CardSideSelectionDialog.kt

@@ -23,7 +23,7 @@ import com.ichi2.anki.reviewer.CardSide
 import com.ichi2.utils.show
 import com.ichi2.utils.title
 
-/** Allows selecting between [CardSide.QUESTION], [CardSide.ANSWER] or [CardSide.BOTH0] */
+/** Allows selecting between [CardSide.QUESTION], [CardSide.ANSWER] or [CardSide.BOTH] */
 class CardSideSelectionDialog {
 
     companion object {

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/customstudy/CustomStudyDialog.kt

@@ -57,7 +57,7 @@ import com.ichi2.anki.showThemedToast
 import com.ichi2.annotations.NeedsTest
 import com.ichi2.libanki.Collection
 import com.ichi2.libanki.Consts
-import com.ichi2.libanki.Consts.DYN_PRIORITY
+import com.ichi2.libanki.Consts.DynPriority
 import com.ichi2.libanki.Deck
 import com.ichi2.libanki.DeckId
 import com.ichi2.utils.HashUtil.hashMapInit
@@ -493,7 +493,7 @@ class CustomStudyDialog(private val collection: Collection, private val customSt
         val ar = dyn.getJSONArray("terms")
         ar.getJSONArray(0).put(0, "deck:\"" + deckToStudyName + "\" " + terms[0])
         ar.getJSONArray(0).put(1, terms[1])
-        @DYN_PRIORITY val priority = terms[2] as Int
+        @DynPriority val priority = terms[2] as Int
         ar.getJSONArray(0).put(2, priority)
         dyn.put("resched", resched)
         // Rebuild the filtered deck

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonData.kt

@@ -16,7 +16,7 @@
 
 package com.ichi2.anki.jsaddons
 
-import com.ichi2.anki.AnkiDroidJsAPIConstants.currentJsApiVersion
+import com.ichi2.anki.AnkiDroidJsAPIConstants.CURRENT_JS_API_VERSION
 import com.ichi2.anki.jsaddons.AddonsConst.ANKIDROID_JS_ADDON_KEYWORDS
 import com.ichi2.anki.jsaddons.AddonsConst.NOTE_EDITOR_ADDON
 import com.ichi2.anki.jsaddons.AddonsConst.REVIEWER_ADDON
@@ -123,8 +123,8 @@ fun getAddonModelFromAddonData(addonData: AddonData): Pair<AddonModel?, List<Str
     }
 
     // Check supplied api and current api
-    if (addonData.ankidroidJsApi != currentJsApiVersion) {
-        errorStr = "Invalid addon package: supplied js api version ${addonData.ankidroidJsApi} must be equal to current js api version $currentJsApiVersion"
+    if (addonData.ankidroidJsApi != CURRENT_JS_API_VERSION) {
+        errorStr = "Invalid addon package: supplied js api version ${addonData.ankidroidJsApi} must be equal to current js api version $CURRENT_JS_API_VERSION"
         errorList.add(errorStr)
     }
 

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/TgzPackageExtract.kt

@@ -88,7 +88,7 @@ import java.util.zip.GZIPInputStream
 typealias AddonsPackageDir = File
 
 class TgzPackageExtract(private val context: Context) {
-    private val GZIP_SIGNATURE = byteArrayOf(0x1f, 0x8b.toByte())
+    private val _gzipSignature = byteArrayOf(0x1f, 0x8b.toByte())
     private var requiredMinSpace: Long = 0
     private var availableSpace: Long = 0
 
@@ -109,13 +109,13 @@ class TgzPackageExtract(private val context: Context) {
      */
     @Throws(IOException::class)
     fun isGzip(file: File?): Boolean {
-        val signature = ByteArray(GZIP_SIGNATURE.size)
+        val signature = ByteArray(_gzipSignature.size)
         FileInputStream(file).use { stream ->
             if (stream.read(signature) != signature.size) {
                 return false
             }
         }
-        return GZIP_SIGNATURE.contentEquals(signature)
+        return _gzipSignature.contentEquals(signature)
     }
 
     /**

AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/AudioRecordingField.kt

@@ -14,6 +14,6 @@ class AudioRecordingField : AudioField() {
     override var name: String? = null
 
     companion object {
-        private const val serialVersionUID = 5033819217738174719L
+        private const val SERIAL_VERSION_UID = 5033819217738174719L
     }
 }

AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/ImageField.kt

@@ -71,7 +71,7 @@ class ImageField : FieldBase(), IField {
     }
 
     companion object {
-        private const val serialVersionUID = 4431611060655809687L
+        private const val SERIAL_VERSION_UID = 4431611060655809687L
 
         @VisibleForTesting
         @NeedsTest("files with HTML illegal chars can be imported and rendered")

AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/MediaClipField.kt

@@ -13,6 +13,6 @@ class MediaClipField : AudioField() {
     override var name: String? = null
 
     companion object {
-        private const val serialVersionUID = 2937641017832762987L
+        private const val SERIAL_VERSION_UID = 2937641017832762987L
     }
 }

AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/fields/TextField.kt

@@ -58,6 +58,6 @@ class TextField : FieldBase(), IField {
     }
 
     companion object {
-        private const val serialVersionUID = -6508967905716947525L
+        private const val SERIAL_VERSION_UID = -6508967905716947525L
     }
 }

AnkiDroid/src/main/java/com/ichi2/anki/multimediacard/impl/MultimediaEditableNote.kt

@@ -109,6 +109,6 @@ class MultimediaEditableNote : IMultimediaEditableNote {
         get() = fields.isNullOrEmpty()
 
     companion object {
-        private const val serialVersionUID = -6161821367135636659L
+        private const val SERIAL_VERSION_UID = -6161821367135636659L
     }
 }

AnkiDroid/src/main/java/com/ichi2/anki/noteeditor/FieldState.kt

@@ -69,12 +69,12 @@ class FieldState private constructor(private val editor: NoteEditor) {
     private fun recreateFieldsFromState(): List<FieldEditLine> {
         val editLines: MutableList<FieldEditLine> = ArrayList(savedFieldData!!.size)
         for (state in savedFieldData!!) {
-            val edit_line_view = FieldEditLine(editor.requireContext())
-            if (edit_line_view.id == 0) {
-                edit_line_view.id = View.generateViewId()
+            val editLineView = FieldEditLine(editor.requireContext())
+            if (editLineView.id == 0) {
+                editLineView.id = View.generateViewId()
             }
-            edit_line_view.loadState(state)
-            editLines.add(edit_line_view)
+            editLineView.loadState(state)
+            editLines.add(editLineView)
         }
         return editLines
     }
@@ -83,11 +83,11 @@ class FieldState private constructor(private val editor: NoteEditor) {
         val fields = getFields(type)
         val editLines: MutableList<FieldEditLine> = ArrayList(fields.size)
         for (i in fields.indices) {
-            val edit_line_view = FieldEditLine(editor.requireContext())
-            editLines.add(edit_line_view)
-            edit_line_view.name = fields[i][0]
-            edit_line_view.setContent(fields[i][1], type.replaceNewlines)
-            edit_line_view.setOrd(i)
+            val editLineView = FieldEditLine(editor.requireContext())
+            editLines.add(editLineView)
+            editLineView.name = fields[i][0]
+            editLineView.setContent(fields[i][1], type.replaceNewlines)
+            editLineView.setOrd(i)
         }
         return editLines
     }