Refactor Search and Favorites widget layout calculations to stabilize column and row counts against small size variations.

Author: anikiki

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesGridCalculator.kt

@@ -31,17 +31,20 @@ class SearchAndFavoritesGridCalculator {
         val margins = context.resources.getDimension(CommonR.dimen.searchWidgetFavoriteMargin).toDp()
         val item = context.resources.getDimension(CommonR.dimen.searchWidgetFavoriteItemContainerWidth).toDp()
         val divider = context.resources.getDimension(CommonR.dimen.searchWidgetFavoritesHorizontalSpacing).toDp()
+
+        // Buffer to prevent column count from changing with small size variations.
+        val sizeBuffer = 8
         var n = 2
         var totalSize = (n * item) + ((n - 1) * divider) + (margins * 2)
 
         logcat(INFO) { "SearchAndFavoritesWidget width n:$n $totalSize vs $width" }
-        while (totalSize <= width) {
+        while (totalSize + sizeBuffer <= width) {
             ++n
             totalSize = (n * item) + ((n - 1) * divider) + (margins * 2)
             logcat(INFO) { "SearchAndFavoritesWidget width n:$n $totalSize vs $width" }
         }
 
-        return WIDGET_COLUMNS_MIN.coerceAtLeast(n - 1).coerceAtMost(limitColumns)
+        return (n - 1).coerceIn(WIDGET_COLUMNS_MIN, limitColumns)
     }
 
     fun calculateRows(
@@ -53,20 +56,20 @@ class SearchAndFavoritesGridCalculator {
             (context.resources.getDimension(CommonR.dimen.searchWidgetPadding).toDp() * 2)
         val item = context.resources.getDimension(CommonR.dimen.searchWidgetFavoriteItemContainerHeight).toDp()
         val divider = context.resources.getDimension(CommonR.dimen.searchWidgetFavoritesVerticalSpacing).toDp()
+
+        // Buffer to prevent row count from changing with small size variations.
+        val sizeBuffer = 8
         var n = 1
         var totalSize = searchBar + (n * item) + ((n - 1) * divider) + margins
 
         logcat(INFO) { "SearchAndFavoritesWidget height n:$n $totalSize vs $height" }
-        while (totalSize <= height) {
+        while (totalSize + sizeBuffer <= height) {
             ++n
             totalSize = searchBar + (n * item) + ((n - 1) * divider) + margins
             logcat(INFO) { "SearchAndFavoritesWidget height n:$n $totalSize vs $height" }
         }
 
-        var rows = n - 1
-        rows = WIDGET_ROWS_MIN.coerceAtLeast(rows)
-        rows = WIDGET_ROWS_MAX.coerceAtMost(rows)
-        return rows
+        return (n - 1).coerceIn(WIDGET_ROWS_MIN, WIDGET_ROWS_MAX)
     }
 
     companion object {

app/src/main/java/com/duckduckgo/widget/SearchAndFavoritesWidget.kt

@@ -153,7 +153,7 @@ class SearchAndFavoritesWidget : AppWidgetProvider() {
         logcat(INFO) { "SearchAndFavoritesWidget theme for $appWidgetId is $widgetTheme" }
 
         val (columns, rows) = getCurrentWidgetSize(context, appWidgetManager.getAppWidgetOptions(appWidgetId), newOptions)
-        layoutId = getLayoutThemed(columns, widgetTheme)
+        layoutId = getLayoutThemed(widgetTheme)
 
         withContext(dispatchers.io()) {
             widgetPrefs.storeWidgetSize(appWidgetId, columns, rows)
@@ -177,41 +177,12 @@ class SearchAndFavoritesWidget : AppWidgetProvider() {
     }
 
     private fun getLayoutThemed(
-        numColumns: Int,
         theme: WidgetTheme,
     ): Int {
-        // numcolumns method is not available for remoteViews. We rely on different xml to use different values on that attribute
         return when (theme) {
-            WidgetTheme.LIGHT -> {
-                when (numColumns) {
-                    2 -> R.layout.search_favorites_widget_light_col2
-                    3 -> R.layout.search_favorites_widget_light_col3
-                    4 -> R.layout.search_favorites_widget_light_col4
-                    5 -> R.layout.search_favorites_widget_light_col5
-                    6 -> R.layout.search_favorites_widget_light_col6
-                    else -> R.layout.search_favorites_widget_light_auto
-                }
-            }
-            WidgetTheme.DARK -> {
-                when (numColumns) {
-                    2 -> R.layout.search_favorites_widget_dark_col2
-                    3 -> R.layout.search_favorites_widget_dark_col3
-                    4 -> R.layout.search_favorites_widget_dark_col4
-                    5 -> R.layout.search_favorites_widget_dark_col5
-                    6 -> R.layout.search_favorites_widget_dark_col6
-                    else -> R.layout.search_favorites_widget_dark_auto
-                }
-            }
-            WidgetTheme.SYSTEM_DEFAULT -> {
-                when (numColumns) {
-                    2 -> R.layout.search_favorites_widget_daynight_col2
-                    3 -> R.layout.search_favorites_widget_daynight_col3
-                    4 -> R.layout.search_favorites_widget_daynight_col4
-                    5 -> R.layout.search_favorites_widget_daynight_col5
-                    6 -> R.layout.search_favorites_widget_daynight_col6
-                    else -> R.layout.search_favorites_widget_daynight_auto
-                }
-            }
+            WidgetTheme.LIGHT -> R.layout.search_favorites_widget_light_auto
+            WidgetTheme.DARK -> R.layout.search_favorites_widget_dark_auto
+            WidgetTheme.SYSTEM_DEFAULT -> R.layout.search_favorites_widget_daynight_auto
         }
     }