lint: enforce layout naming conventions

(activity_, fragment_, view_, dialog_)

Add email to copyright headers

Refactor layout prefix detectors: extract shared utils, use Kotlin tests

lint: enforce dialog_ prefix for Dialog layouts

lint: enforce view_ prefix for View layouts

lint: enforce fragment_ prefix for Fragment layouts

lint: enforce activity_ prefix for Activity layouts

Author: sonalyadav1

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

@@ -68,7 +68,7 @@ import com.ichi2.anki.browser.registerFindReplaceHandler
 import com.ichi2.anki.browser.toCardBrowserLaunchOptions
 import com.ichi2.anki.common.annotations.NeedsTest
 import com.ichi2.anki.common.utils.annotation.KotlinCleanup
-import com.ichi2.anki.databinding.CardBrowserBinding
+import com.ichi2.anki.databinding.ActivityCardBrowserBinding
 import com.ichi2.anki.dialogs.DeckSelectionDialog.DeckSelectionListener
 import com.ichi2.anki.dialogs.DiscardChangesDialog
 import com.ichi2.anki.dialogs.GradeNowDialog
@@ -143,7 +143,7 @@ open class CardBrowser :
 
     lateinit var viewModel: CardBrowserViewModel
 
-    private lateinit var binding: CardBrowserBinding
+    private lateinit var binding: ActivityCardBrowserBinding
 
     lateinit var cardBrowserFragment: CardBrowserFragment
 
@@ -165,14 +165,14 @@ open class CardBrowser :
         }
 
     // Dev option for Issue 18709
-    // TODO: Broken currently; needs R.layout.card_browser_searchview
+    // TODO: Broken currently; needs R.layout.activity_card_browser_searchview
     val useSearchView: Boolean
         get() = Prefs.devUsingCardBrowserSearchView
 
     @Suppress("unused")
     @get:LayoutRes
     private val layout: Int
-        get() = if (useSearchView) R.layout.card_browser_searchview else R.layout.card_browser
+        get() = if (useSearchView) R.layout.activity_card_browser_searchview else R.layout.activity_card_browser
 
     private var onEditCardActivityResult =
         registerForActivityResult(StartActivityForResult()) { result: ActivityResult ->
@@ -295,7 +295,7 @@ open class CardBrowser :
         }
         tagsDialogFactory = TagsDialogFactory(this).attachToActivity<TagsDialogFactory>(this)
         super.onCreate(savedInstanceState)
-        binding = CardBrowserBinding.inflate(layoutInflater)
+        binding = ActivityCardBrowserBinding.inflate(layoutInflater)
         if (!ensureStoragePermissions()) {
             return
         }

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

@@ -101,9 +101,9 @@ import com.ichi2.anki.common.time.TimeManager
 import com.ichi2.anki.common.utils.annotation.KotlinCleanup
 import com.ichi2.anki.contextmenu.DeckPickerMenuContentProvider
 import com.ichi2.anki.contextmenu.MouseContextMenuHandler
+import com.ichi2.anki.databinding.ActivityHomescreenBinding
 import com.ichi2.anki.databinding.DeckPickerBinding
 import com.ichi2.anki.databinding.FloatingAddButtonBinding
-import com.ichi2.anki.databinding.HomescreenBinding
 import com.ichi2.anki.deckpicker.BITMAP_BYTES_PER_PIXEL
 import com.ichi2.anki.deckpicker.BackgroundImage
 import com.ichi2.anki.deckpicker.DeckDeletionResult
@@ -253,7 +253,7 @@ open class DeckPicker :
     CollectionPermissionScreenLauncher {
     val viewModel: DeckPickerViewModel by viewModels()
 
-    private lateinit var binding: HomescreenBinding
+    private lateinit var binding: ActivityHomescreenBinding
 
     @VisibleForTesting
     internal val deckPickerBinding: DeckPickerBinding
@@ -519,7 +519,7 @@ open class DeckPicker :
         // Then set theme and content view
         super.onCreate(savedInstanceState)
 
-        binding = HomescreenBinding.inflate(layoutInflater)
+        binding = ActivityHomescreenBinding.inflate(layoutInflater)
 
         // handle the first load: display the app introduction
         // This screen is currently better equipped to handle errors than IntroductionActivity
@@ -2073,7 +2073,7 @@ open class DeckPicker :
     /**
      * Displays [StudyOptionsFragment] in a side panel on larger devices
      *
-     * @see [HomescreenBinding.studyoptionsFragment]
+     * @see [ActivityHomescreenBinding.studyoptionsFragment]
      *
      * @return whether the panel was shown
      */
@@ -2539,5 +2539,5 @@ private fun AnkiActivity.launchCatchingRequiringOneWaySync(block: suspend () ->
         }
     }
 
-val HomescreenBinding.studyoptionsFrame: FragmentContainerView?
+val ActivityHomescreenBinding.studyoptionsFrame: FragmentContainerView?
     get() = studyoptionsFragment

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

@@ -32,15 +32,15 @@ import androidx.constraintlayout.widget.ConstraintSet
 import androidx.core.os.ParcelCompat
 import androidx.vectordrawable.graphics.drawable.VectorDrawableCompat
 import com.ichi2.anki.common.utils.annotation.KotlinCleanup
-import com.ichi2.anki.databinding.CardMultimediaEditlineBinding
+import com.ichi2.anki.databinding.ViewCardMultimediaEditlineBinding
 import com.ichi2.compat.setTooltipTextCompat
 import com.ichi2.ui.AnimationUtil.collapseView
 import com.ichi2.ui.AnimationUtil.expandView
 import java.util.Locale
 
 @KotlinCleanup("replace _name with `field`")
 class FieldEditLine : FrameLayout {
-    val binding = CardMultimediaEditlineBinding.inflate(LayoutInflater.from(context), this, true)
+    val binding = ViewCardMultimediaEditlineBinding.inflate(LayoutInflater.from(context), this, true)
     private var _name: String? = null
     private var expansionState = ExpansionState.EXPANDED
 

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

@@ -27,7 +27,7 @@ import com.ichi2.anki.NoteEditorActivity.Companion.FRAGMENT_ARGS_EXTRA
 import com.ichi2.anki.NoteEditorActivity.Companion.FRAGMENT_NAME_EXTRA
 import com.ichi2.anki.android.input.ShortcutGroup
 import com.ichi2.anki.android.input.ShortcutGroupProvider
-import com.ichi2.anki.databinding.NoteEditorBinding
+import com.ichi2.anki.databinding.ActivityNoteEditorBinding
 import com.ichi2.anki.libanki.Collection
 import com.ichi2.anki.noteeditor.NoteEditorFragmentDelegate
 import com.ichi2.anki.noteeditor.NoteEditorLauncher
@@ -85,7 +85,7 @@ class NoteEditorActivity :
     val fragmented: Boolean
         get() = previewerFrame?.isVisible == true
 
-    private lateinit var binding: NoteEditorBinding
+    private lateinit var binding: ActivityNoteEditorBinding
 
     override fun onCreate(savedInstanceState: Bundle?) {
         if (showedActivityFailedScreen(savedInstanceState)) {
@@ -96,7 +96,7 @@ class NoteEditorActivity :
             return
         }
 
-        binding = NoteEditorBinding.inflate(layoutInflater)
+        binding = ActivityNoteEditorBinding.inflate(layoutInflater)
         setContentView(binding.root)
 
         previewerFrame = binding.previewerFrame

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

@@ -26,17 +26,17 @@ import com.ichi2.anki.CollectionManager.TR
 import com.ichi2.anki.R
 import com.ichi2.anki.browser.BrowserColumnSelectionFragment
 import com.ichi2.anki.browser.CardBrowserViewModel
-import com.ichi2.anki.databinding.BrowserOptionsDialogBinding
+import com.ichi2.anki.databinding.DialogBrowserOptionsBinding
 import com.ichi2.anki.model.CardsOrNotes
 import com.ichi2.utils.create
 import com.ichi2.utils.negativeButton
 import com.ichi2.utils.positiveButton
 import timber.log.Timber
 
-class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.browser_options_dialog) {
+class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.dialog_browser_options) {
     private val viewModel: CardBrowserViewModel by activityViewModels()
 
-    private lateinit var binding: BrowserOptionsDialogBinding
+    private lateinit var binding: DialogBrowserOptionsBinding
 
     /** The unsaved value of [CardsOrNotes] */
     private val dialogCardsOrNotes: CardsOrNotes
@@ -84,7 +84,7 @@ class BrowserOptionsDialog : AppCompatDialogFragment(R.layout.browser_options_di
     }
 
     override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
-        binding = BrowserOptionsDialogBinding.inflate(layoutInflater)
+        binding = DialogBrowserOptionsBinding.inflate(layoutInflater)
 
         if (cardsOrNotes == CardsOrNotes.CARDS) {
             binding.selectCardsMode.isChecked = true

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/tags/TagsDialog.kt

@@ -35,7 +35,7 @@ import com.ichi2.anki.R
 import com.ichi2.anki.analytics.AnalyticsDialogFragment
 import com.ichi2.anki.browser.IdsFile
 import com.ichi2.anki.common.annotations.NeedsTest
-import com.ichi2.anki.databinding.TagsDialogBinding
+import com.ichi2.anki.databinding.DialogTagsBinding
 import com.ichi2.anki.launchCatchingTask
 import com.ichi2.anki.libanki.NoteId
 import com.ichi2.anki.libanki.withCollapsedWhitespace
@@ -80,7 +80,7 @@ class TagsDialog : AnalyticsDialogFragment {
         CUSTOM_STUDY,
     }
 
-    private lateinit var binding: TagsDialogBinding
+    private lateinit var binding: DialogTagsBinding
     private var type: DialogType? = null
     private var tagsArrayAdapter: TagsArrayAdapter? = null
     private var toolbarSearchView: AccessibleSearchView? = null
@@ -175,7 +175,7 @@ class TagsDialog : AnalyticsDialogFragment {
             "filled as prefix properly. In other dialog types, long-clicking a tag behaves like a short click.",
     )
     override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
-        binding = TagsDialogBinding.inflate(layoutInflater)
+        binding = DialogTagsBinding.inflate(layoutInflater)
 
         val positiveText =
             if (type == DialogType.EDIT_TAGS) {

AnkiDroid/src/main/java/com/ichi2/anki/previewer/TemplatePreviewerFragment.kt

@@ -22,7 +22,7 @@ import androidx.fragment.app.viewModels
 import androidx.lifecycle.lifecycleScope
 import com.google.android.material.tabs.TabLayout
 import com.ichi2.anki.R
-import com.ichi2.anki.databinding.TemplatePreviewerBinding
+import com.ichi2.anki.databinding.FragmentTemplatePreviewerBinding
 import com.ichi2.anki.launchCatchingTask
 import com.ichi2.anki.snackbar.BaseSnackbarBuilderProvider
 import com.ichi2.anki.snackbar.SnackbarBuilder
@@ -36,11 +36,11 @@ import kotlinx.coroutines.flow.onEach
 import timber.log.Timber
 
 class TemplatePreviewerFragment :
-    CardViewerFragment(R.layout.template_previewer),
+    CardViewerFragment(R.layout.fragment_template_previewer),
     BaseSnackbarBuilderProvider {
     override val viewModel: TemplatePreviewerViewModel by viewModels()
 
-    lateinit var binding: TemplatePreviewerBinding
+    lateinit var binding: FragmentTemplatePreviewerBinding
 
     override val webViewLayout: SafeWebViewLayout get() = binding.webViewLayout
 
@@ -53,7 +53,7 @@ class TemplatePreviewerFragment :
     ) {
         // binding must be set before super.onViewCreated
         // as super.onViewCreated depends on webViewLayout, which depends on the binding
-        binding = TemplatePreviewerBinding.bind(view)
+        binding = FragmentTemplatePreviewerBinding.bind(view)
 
         super.onViewCreated(view, savedInstanceState)
 

AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/permissions/PermissionsItem.kt

@@ -23,7 +23,7 @@ import android.widget.FrameLayout
 import androidx.core.content.withStyledAttributes
 import com.google.android.material.color.MaterialColors
 import com.ichi2.anki.R
-import com.ichi2.anki.databinding.PermissionsItemBinding
+import com.ichi2.anki.databinding.ViewPermissionsItemBinding
 import com.ichi2.anki.utils.ext.usingStyledAttributes
 import com.ichi2.utils.Permissions
 import timber.log.Timber
@@ -54,7 +54,7 @@ class PermissionsItem(
     context: Context,
     attrs: AttributeSet,
 ) : FrameLayout(context, attrs) {
-    val binding = PermissionsItemBinding.inflate(LayoutInflater.from(context), this, true)
+    val binding = ViewPermissionsItemBinding.inflate(LayoutInflater.from(context), this, true)
 
     /**
      * The value of either app:permissions or app:permission.

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

@@ -21,13 +21,13 @@ import android.view.LayoutInflater
 import android.view.animation.DecelerateInterpolator
 import androidx.annotation.DrawableRes
 import androidx.constraintlayout.widget.ConstraintLayout
-import com.ichi2.anki.databinding.AudioPlayViewBinding
+import com.ichi2.anki.databinding.ViewAudioPlayBinding
 
 /**
  * Simple player with a progress bar, a play button and a cancel button
  */
 class AudioPlayView : ConstraintLayout {
-    private val binding = AudioPlayViewBinding.inflate(LayoutInflater.from(context), this, true)
+    private val binding = ViewAudioPlayBinding.inflate(LayoutInflater.from(context), this, true)
 
     constructor(context: Context) : this(context, null, 0, 0)
     constructor(context: Context, attrs: AttributeSet?) : this(context, attrs, 0, 0)

AnkiDroid/src/main/java/com/ichi2/ui/AxisSelector.kt

@@ -21,7 +21,7 @@ import android.util.AttributeSet
 import android.view.LayoutInflater
 import android.widget.LinearLayout
 import com.ichi2.anki.R
-import com.ichi2.anki.databinding.AxisDisplayBinding
+import com.ichi2.anki.databinding.ViewAxisDisplayBinding
 import com.ichi2.anki.reviewer.Axis
 import com.ichi2.anki.reviewer.Binding
 import timber.log.Timber
@@ -30,13 +30,13 @@ import timber.log.Timber
  * Displays live values of an [Axis] (joystick/trigger), and allows selection of a binding if an
  * [extremity][AxisValueDisplay.isExtremity] has been received
  *
- * The [axisName][AxisDisplayBinding.axisName] of the Axis (AXIS_X)
+ * The [axisName][ViewAxisDisplayBinding.axisName] of the Axis (AXIS_X)
  *
  * The [value] of the Axis [-1, 1]
  *   - If a value hits an extremity, the display changes color. See [AxisValueDisplay]
  *
- * Two buttons: [selectMinExtremity][AxisDisplayBinding.selectMinExtremity] and
- *  [selectMaxExtremity][AxisDisplayBinding.selectMaxExtremity]
+ * Two buttons: [selectMinExtremity][ViewAxisDisplayBinding.selectMinExtremity] and
+ *  [selectMaxExtremity][ViewAxisDisplayBinding.selectMaxExtremity]
  *   - If an [extremity][AxisValueDisplay.isExtremity] is reached, these are activated
  *   - Calls [onExtremitySelectedListener] if tapped
  *
@@ -52,7 +52,7 @@ class AxisSelector : LinearLayout {
         defStyle,
     )
 
-    private val binding = AxisDisplayBinding.inflate(LayoutInflater.from(context), this, true)
+    private val binding = ViewAxisDisplayBinding.inflate(LayoutInflater.from(context), this, true)
 
     private var onExtremitySelectedListener: ((Binding.AxisButtonBinding) -> Unit)? = null