blob: 1d88e83f16001570fbcdf73d303d844bf33d01a7 [file] [log] [blame]
Adam Cohen2e6da152015-05-06 11:42:25 -07001/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.launcher3;
18
Hyunyoung Songc55a3502018-12-04 15:43:16 -080019import static com.android.launcher3.Utilities.getDevicePrefs;
Tracy Zhoued5f3082020-04-20 01:13:26 -070020import static com.android.launcher3.Utilities.getPointString;
Sunny Goyal8b0cb412019-04-22 09:01:26 -070021import static com.android.launcher3.config.FeatureFlags.APPLY_CONFIG_AT_RUNTIME;
Jon Miranda73dcc982020-12-11 14:14:46 -080022import static com.android.launcher3.config.FeatureFlags.ENABLE_FOUR_COLUMNS;
Sunny Goyal9c2b9602020-01-07 13:07:55 -080023import static com.android.launcher3.util.Executors.MAIN_EXECUTOR;
Sunny Goyal8b0cb412019-04-22 09:01:26 -070024import static com.android.launcher3.util.PackageManagerHelper.getPackageFilter;
Sunny Goyal87dc48b2018-10-12 11:42:33 -070025
Sunny Goyalc6205602015-05-21 20:46:33 -070026import android.annotation.TargetApi;
Sunny Goyal58fa4b62019-03-22 16:23:25 -070027import android.appwidget.AppWidgetHostView;
Hyunyoung Songe11eb472019-03-19 15:05:21 -070028import android.content.BroadcastReceiver;
Sunny Goyal58fa4b62019-03-22 16:23:25 -070029import android.content.ComponentName;
Adam Cohen2e6da152015-05-06 11:42:25 -070030import android.content.Context;
Hyunyoung Songe11eb472019-03-19 15:05:21 -070031import android.content.Intent;
Sunny Goyal27835952017-01-13 12:15:53 -080032import android.content.res.Configuration;
Hyunyoung Songc55a3502018-12-04 15:43:16 -080033import android.content.res.Resources;
Sunny Goyal819e1932016-07-07 16:43:58 -070034import android.content.res.TypedArray;
35import android.content.res.XmlResourceParser;
Adam Cohen2e6da152015-05-06 11:42:25 -070036import android.graphics.Point;
Sunny Goyal58fa4b62019-03-22 16:23:25 -070037import android.graphics.Rect;
Sunny Goyal415f1732018-11-29 10:33:47 -080038import android.text.TextUtils;
39import android.util.AttributeSet;
Adam Cohen2e6da152015-05-06 11:42:25 -070040import android.util.DisplayMetrics;
Sunny Goyal87dc48b2018-10-12 11:42:33 -070041import android.util.Log;
Sunny Goyal5bc18462019-01-07 15:13:39 -080042import android.util.SparseArray;
43import android.util.TypedValue;
Sunny Goyal819e1932016-07-07 16:43:58 -070044import android.util.Xml;
Sunny Goyal9c2b9602020-01-07 13:07:55 -080045import android.view.Display;
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -070046
Sunny Goyal6fe3eec2019-08-15 14:53:41 -070047import androidx.annotation.Nullable;
48import androidx.annotation.VisibleForTesting;
49
Sunny Goyal905262c2019-05-03 16:50:43 -070050import com.android.launcher3.graphics.IconShape;
Sunny Goyald0e360a2018-06-29 14:40:18 -070051import com.android.launcher3.util.ConfigMonitor;
Sunny Goyalfd58da62020-08-11 12:06:49 -070052import com.android.launcher3.util.DisplayController;
53import com.android.launcher3.util.DisplayController.Info;
Sunny Goyal5bc18462019-01-07 15:13:39 -080054import com.android.launcher3.util.IntArray;
Sunny Goyald0e360a2018-06-29 14:40:18 -070055import com.android.launcher3.util.MainThreadInitializedObject;
Sunny Goyal5bc18462019-01-07 15:13:39 -080056import com.android.launcher3.util.Themes;
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -070057
Sunny Goyal819e1932016-07-07 16:43:58 -070058import org.xmlpull.v1.XmlPullParser;
59import org.xmlpull.v1.XmlPullParserException;
60
61import java.io.IOException;
Adam Cohen2e6da152015-05-06 11:42:25 -070062import java.util.ArrayList;
Sunny Goyal6d55f662019-01-02 12:13:43 -080063import java.util.Collections;
Adam Cohen2e6da152015-05-06 11:42:25 -070064
65public class InvariantDeviceProfile {
Adam Cohen2e6da152015-05-06 11:42:25 -070066
Hyunyoung Songc55a3502018-12-04 15:43:16 -080067 public static final String TAG = "IDP";
Sunny Goyald0e360a2018-06-29 14:40:18 -070068 // We do not need any synchronization for this variable as its only written on UI thread.
69 public static final MainThreadInitializedObject<InvariantDeviceProfile> INSTANCE =
Sunny Goyal87dc48b2018-10-12 11:42:33 -070070 new MainThreadInitializedObject<>(InvariantDeviceProfile::new);
Adam Cohen2e6da152015-05-06 11:42:25 -070071
Tracy Zhoued5f3082020-04-20 01:13:26 -070072 public static final String KEY_MIGRATION_SRC_WORKSPACE_SIZE = "migration_src_workspace_size";
73 public static final String KEY_MIGRATION_SRC_HOTSEAT_COUNT = "migration_src_hotseat_count";
74
Hyunyoung Songc55a3502018-12-04 15:43:16 -080075 private static final String KEY_IDP_GRID_NAME = "idp_grid_name";
Sunny Goyal415f1732018-11-29 10:33:47 -080076
Sunny Goyal53d7ee42015-05-22 12:25:45 -070077 private static final float ICON_SIZE_DEFINED_IN_APP_DP = 48;
78
Sunny Goyal87dc48b2018-10-12 11:42:33 -070079 public static final int CHANGE_FLAG_GRID = 1 << 0;
Hyunyoung Songc55a3502018-12-04 15:43:16 -080080 public static final int CHANGE_FLAG_ICON_PARAMS = 1 << 1;
81
82 public static final String KEY_ICON_PATH_REF = "pref_icon_shape_path";
Sunny Goyal87dc48b2018-10-12 11:42:33 -070083
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -070084 // Constants that affects the interpolation curve between statically defined device profile
85 // buckets.
Hyunyoung Songc55a3502018-12-04 15:43:16 -080086 private static final float KNEARESTNEIGHBOR = 3;
87 private static final float WEIGHT_POWER = 5;
Adam Cohen2e6da152015-05-06 11:42:25 -070088
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -070089 // used to offset float not being able to express extremely small weights in extreme cases.
Hyunyoung Songc55a3502018-12-04 15:43:16 -080090 private static final float WEIGHT_EFFICIENT = 100000f;
91
92 private static final int CONFIG_ICON_MASK_RES_ID = Resources.getSystem().getIdentifier(
93 "config_icon_mask", "string", "android");
Adam Cohen2e6da152015-05-06 11:42:25 -070094
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -070095 /**
96 * Number of icons per row and column in the workspace.
97 */
Adam Cohen2e6da152015-05-06 11:42:25 -070098 public int numRows;
99 public int numColumns;
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700100
101 /**
102 * Number of icons per row and column in the folder.
103 */
Adam Cohen2e6da152015-05-06 11:42:25 -0700104 public int numFolderRows;
105 public int numFolderColumns;
Sunny Goyalfc218302015-09-17 14:59:10 -0700106 public float iconSize;
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800107 public String iconShapePath;
Jon Mirandab28c4fc2017-06-20 10:58:36 -0700108 public float landscapeIconSize;
Sunny Goyalfc218302015-09-17 14:59:10 -0700109 public int iconBitmapSize;
110 public int fillResIconDpi;
111 public float iconTextSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000112 public float allAppsIconSize;
113 public float allAppsIconTextSize;
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700114
Sunny Goyal5bc18462019-01-07 15:13:39 -0800115 private SparseArray<TypedValue> mExtraAttrs;
116
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700117 /**
118 * Number of icons inside the hotseat area.
119 */
Sunny Goyalf862a262015-12-14 14:27:38 -0800120 public int numHotseatIcons;
Adam Cohen27824492017-09-22 17:10:55 -0700121
Jon Miranda6f7e9702019-09-16 14:44:14 -0700122 /**
123 * Number of columns in the all apps list.
124 */
125 public int numAllAppsColumns;
126
Tracy Zhou7df93d22020-01-27 13:44:06 -0800127 public String dbFile;
Sunny Goyal415f1732018-11-29 10:33:47 -0800128 public int defaultLayoutId;
Adam Cohen27824492017-09-22 17:10:55 -0700129 int demoModeLayoutId;
Adam Cohen2e6da152015-05-06 11:42:25 -0700130
cuijiaxingabda8d72017-03-20 09:51:36 -0700131 public DeviceProfile landscapeProfile;
132 public DeviceProfile portraitProfile;
Sunny Goyalc6205602015-05-21 20:46:33 -0700133
Sunny Goyal6f866092016-03-17 17:04:15 -0700134 public Point defaultWallpaperSize;
Sunny Goyal58fa4b62019-03-22 16:23:25 -0700135 public Rect defaultWidgetPadding;
Sunny Goyal6f866092016-03-17 17:04:15 -0700136
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700137 private final ArrayList<OnIDPChangeListener> mChangeListeners = new ArrayList<>();
138 private ConfigMonitor mConfigMonitor;
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700139 private OverlayMonitor mOverlayMonitor;
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700140
Sunny Goyalf633ef52018-03-13 09:57:05 -0700141 @VisibleForTesting
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700142 public InvariantDeviceProfile() {}
Adam Cohen2e6da152015-05-06 11:42:25 -0700143
Sunny Goyalf633ef52018-03-13 09:57:05 -0700144 private InvariantDeviceProfile(InvariantDeviceProfile p) {
Sunny Goyal415f1732018-11-29 10:33:47 -0800145 numRows = p.numRows;
146 numColumns = p.numColumns;
147 numFolderRows = p.numFolderRows;
148 numFolderColumns = p.numFolderColumns;
149 iconSize = p.iconSize;
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800150 iconShapePath = p.iconShapePath;
Sunny Goyal415f1732018-11-29 10:33:47 -0800151 landscapeIconSize = p.landscapeIconSize;
Tony Wickham9459f312020-06-15 13:30:20 -0500152 iconBitmapSize = p.iconBitmapSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800153 iconTextSize = p.iconTextSize;
154 numHotseatIcons = p.numHotseatIcons;
Jon Miranda6f7e9702019-09-16 14:44:14 -0700155 numAllAppsColumns = p.numAllAppsColumns;
Tracy Zhou7df93d22020-01-27 13:44:06 -0800156 dbFile = p.dbFile;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000157 allAppsIconSize = p.allAppsIconSize;
158 allAppsIconTextSize = p.allAppsIconTextSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800159 defaultLayoutId = p.defaultLayoutId;
160 demoModeLayoutId = p.demoModeLayoutId;
Sunny Goyal5bc18462019-01-07 15:13:39 -0800161 mExtraAttrs = p.mExtraAttrs;
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700162 mOverlayMonitor = p.mOverlayMonitor;
Adam Cohen2e6da152015-05-06 11:42:25 -0700163 }
164
Sunny Goyalbbf01842015-10-08 07:41:15 -0700165 @TargetApi(23)
Sunny Goyald0e360a2018-06-29 14:40:18 -0700166 private InvariantDeviceProfile(Context context) {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700167 String gridName = getCurrentGridName(context);
168 String newGridName = initGrid(context, gridName);
169 if (!newGridName.equals(gridName)) {
170 Utilities.getPrefs(context).edit().putString(KEY_IDP_GRID_NAME, newGridName).apply();
171 }
Tracy Zhoued5f3082020-04-20 01:13:26 -0700172 Utilities.getPrefs(context).edit()
173 .putInt(KEY_MIGRATION_SRC_HOTSEAT_COUNT, numHotseatIcons)
174 .putString(KEY_MIGRATION_SRC_WORKSPACE_SIZE, getPointString(numColumns, numRows))
175 .apply();
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700176
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700177 mConfigMonitor = new ConfigMonitor(context,
178 APPLY_CONFIG_AT_RUNTIME.get() ? this::onConfigChanged : this::killProcess);
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700179 mOverlayMonitor = new OverlayMonitor(context);
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700180 }
181
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700182 /**
183 * This constructor should NOT have any monitors by design.
184 */
Sunny Goyaleff44f32019-01-09 17:29:49 -0800185 public InvariantDeviceProfile(Context context, String gridName) {
186 String newName = initGrid(context, gridName);
187 if (newName == null || !newName.equals(gridName)) {
188 throw new IllegalArgumentException("Unknown grid name");
189 }
190 }
191
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700192 /**
Sunny Goyal9c2b9602020-01-07 13:07:55 -0800193 * This constructor should NOT have any monitors by design.
194 */
195 public InvariantDeviceProfile(Context context, Display display) {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700196 // Ensure that the main device profile is initialized
197 InvariantDeviceProfile originalProfile = INSTANCE.get(context);
198 String gridName = getCurrentGridName(context);
199
200 // Get the display info based on default display and interpolate it to existing display
201 DisplayOption defaultDisplayOption = invDistWeightedInterpolate(
Sunny Goyalfd58da62020-08-11 12:06:49 -0700202 DisplayController.getDefaultDisplay(context).getInfo(),
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700203 getPredefinedDeviceProfiles(context, gridName));
204
Alex Chauacfac612020-10-19 18:00:39 +0100205 Info myInfo = new Info(display);
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700206 DisplayOption myDisplayOption = invDistWeightedInterpolate(
207 myInfo, getPredefinedDeviceProfiles(context, gridName));
208
209 DisplayOption result = new DisplayOption(defaultDisplayOption.grid)
210 .add(myDisplayOption);
211 result.iconSize = defaultDisplayOption.iconSize;
212 result.landscapeIconSize = defaultDisplayOption.landscapeIconSize;
213 result.allAppsIconSize = Math.min(
214 defaultDisplayOption.allAppsIconSize, myDisplayOption.allAppsIconSize);
215 initGrid(context, myInfo, result);
Sunny Goyal9c2b9602020-01-07 13:07:55 -0800216 }
217
Tracy Zhou42255d22020-03-13 00:38:11 -0700218 public static String getCurrentGridName(Context context) {
Jon Miranda73dcc982020-12-11 14:14:46 -0800219 if (ENABLE_FOUR_COLUMNS.get()) {
220 return ENABLE_FOUR_COLUMNS.key;
221 }
Tracy Zhouc6060e62020-04-27 13:05:34 -0700222 return Utilities.isGridOptionsEnabled(context)
223 ? Utilities.getPrefs(context).getString(KEY_IDP_GRID_NAME, null) : null;
Tracy Zhou42255d22020-03-13 00:38:11 -0700224 }
225
Sunny Goyal9c2b9602020-01-07 13:07:55 -0800226 /**
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800227 * Retrieve system defined or RRO overriden icon shape.
228 */
229 private static String getIconShapePath(Context context) {
230 if (CONFIG_ICON_MASK_RES_ID == 0) {
231 Log.e(TAG, "Icon mask res identifier failed to retrieve.");
232 return "";
233 }
234 return context.getResources().getString(CONFIG_ICON_MASK_RES_ID);
235 }
236
Sunny Goyaleff44f32019-01-09 17:29:49 -0800237 private String initGrid(Context context, String gridName) {
Sunny Goyalfd58da62020-08-11 12:06:49 -0700238 Info displayInfo = DisplayController.getDefaultDisplay(context).getInfo();
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700239 ArrayList<DisplayOption> allOptions = getPredefinedDeviceProfiles(context, gridName);
240
241 DisplayOption displayOption = invDistWeightedInterpolate(displayInfo, allOptions);
242 initGrid(context, displayInfo, displayOption);
243 return displayOption.grid.name;
Sunny Goyal9c2b9602020-01-07 13:07:55 -0800244 }
Adam Cohen2e6da152015-05-06 11:42:25 -0700245
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700246 private void initGrid(
Sunny Goyalfd58da62020-08-11 12:06:49 -0700247 Context context, Info displayInfo, DisplayOption displayOption) {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700248 GridOption closestProfile = displayOption.grid;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000249 numRows = closestProfile.numRows;
250 numColumns = closestProfile.numColumns;
251 numHotseatIcons = closestProfile.numHotseatIcons;
252 dbFile = closestProfile.dbFile;
253 defaultLayoutId = closestProfile.defaultLayoutId;
254 demoModeLayoutId = closestProfile.demoModeLayoutId;
255 numFolderRows = closestProfile.numFolderRows;
256 numFolderColumns = closestProfile.numFolderColumns;
257 numAllAppsColumns = closestProfile.numAllAppsColumns;
258
259 mExtraAttrs = closestProfile.extraAttrs;
260
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700261 iconSize = displayOption.iconSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000262 iconShapePath = getIconShapePath(context);
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700263 landscapeIconSize = displayOption.landscapeIconSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000264 iconBitmapSize = ResourceUtils.pxFromDp(iconSize, displayInfo.metrics);
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700265 iconTextSize = displayOption.iconTextSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000266 fillResIconDpi = getLauncherIconDensity(iconBitmapSize);
267
Tracy Zhouc6060e62020-04-27 13:05:34 -0700268 if (Utilities.isGridOptionsEnabled(context)) {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700269 allAppsIconSize = displayOption.allAppsIconSize;
270 allAppsIconTextSize = displayOption.allAppsIconTextSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000271 } else {
272 allAppsIconSize = iconSize;
273 allAppsIconTextSize = iconTextSize;
274 }
275
276 // If the partner customization apk contains any grid overrides, apply them
277 // Supported overrides: numRows, numColumns, iconSize
278 applyPartnerDeviceProfileOverrides(context, displayInfo.metrics);
Sunny Goyalc6205602015-05-21 20:46:33 -0700279
Winson Chung13c1c2c2019-09-06 11:46:19 -0700280 Point realSize = new Point(displayInfo.realSize);
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700281 // The real size never changes. smallSide and largeSide will remain the
Sunny Goyalc6205602015-05-21 20:46:33 -0700282 // same in any orientation.
283 int smallSide = Math.min(realSize.x, realSize.y);
284 int largeSide = Math.max(realSize.x, realSize.y);
285
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700286 DeviceProfile.Builder builder = new DeviceProfile.Builder(context, this, displayInfo)
287 .setSizeRange(new Point(displayInfo.smallestSize),
288 new Point(displayInfo.largestSize));
289
290 landscapeProfile = builder.setSize(largeSide, smallSide).build();
291 portraitProfile = builder.setSize(smallSide, largeSide).build();
Sunny Goyal6f866092016-03-17 17:04:15 -0700292
293 // We need to ensure that there is enough extra space in the wallpaper
294 // for the intended parallax effects
295 if (context.getResources().getConfiguration().smallestScreenWidthDp >= 720) {
296 defaultWallpaperSize = new Point(
297 (int) (largeSide * wallpaperTravelToScreenWidthRatio(largeSide, smallSide)),
298 largeSide);
299 } else {
300 defaultWallpaperSize = new Point(Math.max(smallSide * 2, largeSide), largeSide);
301 }
Sunny Goyal58fa4b62019-03-22 16:23:25 -0700302
303 ComponentName cn = new ComponentName(context.getPackageName(), getClass().getName());
304 defaultWidgetPadding = AppWidgetHostView.getDefaultPaddingForWidget(context, cn, null);
Adam Cohen2e6da152015-05-06 11:42:25 -0700305 }
306
Sunny Goyal5bc18462019-01-07 15:13:39 -0800307 @Nullable
308 public TypedValue getAttrValue(int attr) {
309 return mExtraAttrs == null ? null : mExtraAttrs.get(attr);
310 }
311
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700312 public void addOnChangeListener(OnIDPChangeListener listener) {
313 mChangeListeners.add(listener);
314 }
315
Hyunyoung Songb4d1ca42019-01-08 17:15:16 -0800316 public void removeOnChangeListener(OnIDPChangeListener listener) {
317 mChangeListeners.remove(listener);
318 }
319
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700320 private void killProcess(Context context) {
321 Log.e("ConfigMonitor", "restarting launcher");
322 android.os.Process.killProcess(android.os.Process.myPid());
323 }
324
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800325 public void verifyConfigChangedInBackground(final Context context) {
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800326 String savedIconMaskPath = getDevicePrefs(context).getString(KEY_ICON_PATH_REF, "");
327 // Good place to check if grid size changed in themepicker when launcher was dead.
328 if (savedIconMaskPath.isEmpty()) {
329 getDevicePrefs(context).edit().putString(KEY_ICON_PATH_REF, getIconShapePath(context))
330 .apply();
331 } else if (!savedIconMaskPath.equals(getIconShapePath(context))) {
332 getDevicePrefs(context).edit().putString(KEY_ICON_PATH_REF, getIconShapePath(context))
333 .apply();
334 apply(context, CHANGE_FLAG_ICON_PARAMS);
335 }
336 }
337
Sunny Goyal7d892ff2019-01-11 15:08:44 -0800338 public void setCurrentGrid(Context context, String gridName) {
339 Context appContext = context.getApplicationContext();
340 Utilities.getPrefs(appContext).edit().putString(KEY_IDP_GRID_NAME, gridName).apply();
Sunny Goyal6fe3eec2019-08-15 14:53:41 -0700341 MAIN_EXECUTOR.execute(() -> onConfigChanged(appContext));
Sunny Goyal7d892ff2019-01-11 15:08:44 -0800342 }
343
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700344 private void onConfigChanged(Context context) {
345 // Config changes, what shall we do?
346 InvariantDeviceProfile oldProfile = new InvariantDeviceProfile(this);
347
348 // Re-init grid
Tracy Zhouc6060e62020-04-27 13:05:34 -0700349 String gridName = getCurrentGridName(context);
Jon Miranda6f7e9702019-09-16 14:44:14 -0700350 initGrid(context, gridName);
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700351
352 int changeFlags = 0;
353 if (numRows != oldProfile.numRows ||
354 numColumns != oldProfile.numColumns ||
355 numFolderColumns != oldProfile.numFolderColumns ||
356 numFolderRows != oldProfile.numFolderRows ||
357 numHotseatIcons != oldProfile.numHotseatIcons) {
358 changeFlags |= CHANGE_FLAG_GRID;
359 }
360
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800361 if (iconSize != oldProfile.iconSize || iconBitmapSize != oldProfile.iconBitmapSize ||
362 !iconShapePath.equals(oldProfile.iconShapePath)) {
363 changeFlags |= CHANGE_FLAG_ICON_PARAMS;
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700364 }
Sunny Goyal90e3fbc2019-01-23 16:42:43 -0800365 if (!iconShapePath.equals(oldProfile.iconShapePath)) {
Sunny Goyal905262c2019-05-03 16:50:43 -0700366 IconShape.init(context);
Sunny Goyal90e3fbc2019-01-23 16:42:43 -0800367 }
368
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800369 apply(context, changeFlags);
370 }
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700371
Hyunyoung Songc55a3502018-12-04 15:43:16 -0800372 private void apply(Context context, int changeFlags) {
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700373 // Create a new config monitor
374 mConfigMonitor.unregister();
375 mConfigMonitor = new ConfigMonitor(context, this::onConfigChanged);
376
377 for (OnIDPChangeListener listener : mChangeListeners) {
378 listener.onIdpChanged(changeFlags, this);
379 }
380 }
381
Sunny Goyalae190ff2020-04-14 00:19:01 +0000382 static ArrayList<DisplayOption> getPredefinedDeviceProfiles(Context context, String gridName) {
Sunny Goyal415f1732018-11-29 10:33:47 -0800383 ArrayList<DisplayOption> profiles = new ArrayList<>();
Sunny Goyal819e1932016-07-07 16:43:58 -0700384 try (XmlResourceParser parser = context.getResources().getXml(R.xml.device_profiles)) {
385 final int depth = parser.getDepth();
386 int type;
Sunny Goyal819e1932016-07-07 16:43:58 -0700387 while (((type = parser.next()) != XmlPullParser.END_TAG ||
388 parser.getDepth() > depth) && type != XmlPullParser.END_DOCUMENT) {
Sunny Goyal7d892ff2019-01-11 15:08:44 -0800389 if ((type == XmlPullParser.START_TAG)
390 && GridOption.TAG_NAME.equals(parser.getName())) {
Sunny Goyal415f1732018-11-29 10:33:47 -0800391
392 GridOption gridOption = new GridOption(context, Xml.asAttributeSet(parser));
393 final int displayDepth = parser.getDepth();
394 while (((type = parser.next()) != XmlPullParser.END_TAG ||
395 parser.getDepth() > displayDepth)
396 && type != XmlPullParser.END_DOCUMENT) {
397 if ((type == XmlPullParser.START_TAG) && "display-option".equals(
398 parser.getName())) {
399 profiles.add(new DisplayOption(
400 gridOption, context, Xml.asAttributeSet(parser)));
401 }
402 }
Sunny Goyal819e1932016-07-07 16:43:58 -0700403 }
404 }
405 } catch (IOException|XmlPullParserException e) {
406 throw new RuntimeException(e);
407 }
Sunny Goyal415f1732018-11-29 10:33:47 -0800408
Sunny Goyalae190ff2020-04-14 00:19:01 +0000409 ArrayList<DisplayOption> filteredProfiles = new ArrayList<>();
Sunny Goyal415f1732018-11-29 10:33:47 -0800410 if (!TextUtils.isEmpty(gridName)) {
411 for (DisplayOption option : profiles) {
412 if (gridName.equals(option.grid.name)) {
Sunny Goyalae190ff2020-04-14 00:19:01 +0000413 filteredProfiles.add(option);
Sunny Goyal415f1732018-11-29 10:33:47 -0800414 }
415 }
416 }
Sunny Goyalae190ff2020-04-14 00:19:01 +0000417 if (filteredProfiles.isEmpty()) {
418 // No grid found, use the default options
419 for (DisplayOption option : profiles) {
420 if (option.canBeDefault) {
421 filteredProfiles.add(option);
422 }
Sunny Goyal415f1732018-11-29 10:33:47 -0800423 }
424 }
Sunny Goyalae190ff2020-04-14 00:19:01 +0000425 if (filteredProfiles.isEmpty()) {
426 throw new RuntimeException("No display option with canBeDefault=true");
427 }
428 return filteredProfiles;
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700429 }
430
Sunny Goyal53d7ee42015-05-22 12:25:45 -0700431 private int getLauncherIconDensity(int requiredSize) {
432 // Densities typically defined by an app.
433 int[] densityBuckets = new int[] {
434 DisplayMetrics.DENSITY_LOW,
435 DisplayMetrics.DENSITY_MEDIUM,
436 DisplayMetrics.DENSITY_TV,
437 DisplayMetrics.DENSITY_HIGH,
438 DisplayMetrics.DENSITY_XHIGH,
439 DisplayMetrics.DENSITY_XXHIGH,
440 DisplayMetrics.DENSITY_XXXHIGH
441 };
442
443 int density = DisplayMetrics.DENSITY_XXXHIGH;
444 for (int i = densityBuckets.length - 1; i >= 0; i--) {
445 float expectedSize = ICON_SIZE_DEFINED_IN_APP_DP * densityBuckets[i]
446 / DisplayMetrics.DENSITY_DEFAULT;
447 if (expectedSize >= requiredSize) {
448 density = densityBuckets[i];
449 }
450 }
451
452 return density;
453 }
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700454
Adam Cohen2e6da152015-05-06 11:42:25 -0700455 /**
456 * Apply any Partner customization grid overrides.
457 *
458 * Currently we support: all apps row / column count.
459 */
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700460 private void applyPartnerDeviceProfileOverrides(Context context, DisplayMetrics dm) {
461 Partner p = Partner.get(context.getPackageManager());
Adam Cohen2e6da152015-05-06 11:42:25 -0700462 if (p != null) {
463 p.applyInvariantDeviceProfileOverrides(this, dm);
464 }
465 }
466
Sunny Goyal415f1732018-11-29 10:33:47 -0800467 private static float dist(float x0, float y0, float x1, float y1) {
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700468 return (float) Math.hypot(x1 - x0, y1 - y0);
Adam Cohen2e6da152015-05-06 11:42:25 -0700469 }
470
Sunny Goyal415f1732018-11-29 10:33:47 -0800471 @VisibleForTesting
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700472 static DisplayOption invDistWeightedInterpolate(
Sunny Goyalfd58da62020-08-11 12:06:49 -0700473 Info displayInfo, ArrayList<DisplayOption> points) {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700474 Point smallestSize = new Point(displayInfo.smallestSize);
475 Point largestSize = new Point(displayInfo.largestSize);
476
477 // This guarantees that width < height
478 float width = Utilities.dpiFromPx(Math.min(smallestSize.x, smallestSize.y),
479 displayInfo.metrics);
480 float height = Utilities.dpiFromPx(Math.min(largestSize.x, largestSize.y),
481 displayInfo.metrics);
482
483 // Sort the profiles based on the closeness to the device size
484 Collections.sort(points, (a, b) ->
485 Float.compare(dist(width, height, a.minWidthDps, a.minHeightDps),
486 dist(width, height, b.minWidthDps, b.minHeightDps)));
487
488 GridOption closestOption = points.get(0).grid;
489 float weights = 0;
490
491 DisplayOption p = points.get(0);
492 if (dist(width, height, p.minWidthDps, p.minHeightDps) == 0) {
493 return p;
494 }
495
496 DisplayOption out = new DisplayOption(closestOption);
497 for (int i = 0; i < points.size() && i < KNEARESTNEIGHBOR; ++i) {
498 p = points.get(i);
499 float w = weight(width, height, p.minWidthDps, p.minHeightDps, WEIGHT_POWER);
500 weights += w;
501 out.add(new DisplayOption().add(p).multiply(w));
502 }
503 return out.multiply(1.0f / weights);
504 }
505
506 @VisibleForTesting
Sunny Goyal415f1732018-11-29 10:33:47 -0800507 static DisplayOption invDistWeightedInterpolate(float width, float height,
Sunny Goyalae190ff2020-04-14 00:19:01 +0000508 ArrayList<DisplayOption> points) {
Adam Cohen2e6da152015-05-06 11:42:25 -0700509 float weights = 0;
Adam Cohen2e6da152015-05-06 11:42:25 -0700510
Sunny Goyal415f1732018-11-29 10:33:47 -0800511 DisplayOption p = points.get(0);
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700512 if (dist(width, height, p.minWidthDps, p.minHeightDps) == 0) {
513 return p;
Adam Cohen2e6da152015-05-06 11:42:25 -0700514 }
515
Sunny Goyal415f1732018-11-29 10:33:47 -0800516 DisplayOption out = new DisplayOption();
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700517 for (int i = 0; i < points.size() && i < KNEARESTNEIGHBOR; ++i) {
Sunny Goyal415f1732018-11-29 10:33:47 -0800518 p = points.get(i);
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700519 float w = weight(width, height, p.minWidthDps, p.minHeightDps, WEIGHT_POWER);
520 weights += w;
Sunny Goyal415f1732018-11-29 10:33:47 -0800521 out.add(new DisplayOption().add(p).multiply(w));
Adam Cohen2e6da152015-05-06 11:42:25 -0700522 }
Sunny Goyal415f1732018-11-29 10:33:47 -0800523 return out.multiply(1.0f / weights);
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700524 }
525
Sunny Goyal27835952017-01-13 12:15:53 -0800526 public DeviceProfile getDeviceProfile(Context context) {
527 return context.getResources().getConfiguration().orientation
528 == Configuration.ORIENTATION_LANDSCAPE ? landscapeProfile : portraitProfile;
529 }
530
Sunny Goyal415f1732018-11-29 10:33:47 -0800531 private static float weight(float x0, float y0, float x1, float y1, float pow) {
Hyunyoung Song35c3c7f2015-05-28 15:33:40 -0700532 float d = dist(x0, y0, x1, y1);
533 if (Float.compare(d, 0f) == 0) {
534 return Float.POSITIVE_INFINITY;
535 }
536 return (float) (WEIGHT_EFFICIENT / Math.pow(d, pow));
537 }
Sunny Goyal6f866092016-03-17 17:04:15 -0700538
539 /**
540 * As a ratio of screen height, the total distance we want the parallax effect to span
541 * horizontally
542 */
543 private static float wallpaperTravelToScreenWidthRatio(int width, int height) {
544 float aspectRatio = width / (float) height;
545
546 // At an aspect ratio of 16/10, the wallpaper parallax effect should span 1.5 * screen width
547 // At an aspect ratio of 10/16, the wallpaper parallax effect should span 1.2 * screen width
548 // We will use these two data points to extrapolate how much the wallpaper parallax effect
549 // to span (ie travel) at any aspect ratio:
550
551 final float ASPECT_RATIO_LANDSCAPE = 16/10f;
552 final float ASPECT_RATIO_PORTRAIT = 10/16f;
553 final float WALLPAPER_WIDTH_TO_SCREEN_RATIO_LANDSCAPE = 1.5f;
554 final float WALLPAPER_WIDTH_TO_SCREEN_RATIO_PORTRAIT = 1.2f;
555
556 // To find out the desired width at different aspect ratios, we use the following two
557 // formulas, where the coefficient on x is the aspect ratio (width/height):
558 // (16/10)x + y = 1.5
559 // (10/16)x + y = 1.2
560 // We solve for x and y and end up with a final formula:
561 final float x =
562 (WALLPAPER_WIDTH_TO_SCREEN_RATIO_LANDSCAPE - WALLPAPER_WIDTH_TO_SCREEN_RATIO_PORTRAIT) /
563 (ASPECT_RATIO_LANDSCAPE - ASPECT_RATIO_PORTRAIT);
564 final float y = WALLPAPER_WIDTH_TO_SCREEN_RATIO_PORTRAIT - x * ASPECT_RATIO_PORTRAIT;
565 return x * aspectRatio + y;
566 }
567
Sunny Goyal87dc48b2018-10-12 11:42:33 -0700568 public interface OnIDPChangeListener {
569
570 void onIdpChanged(int changeFlags, InvariantDeviceProfile profile);
571 }
Sunny Goyal415f1732018-11-29 10:33:47 -0800572
573
Sunny Goyaleff44f32019-01-09 17:29:49 -0800574 public static final class GridOption {
Sunny Goyal415f1732018-11-29 10:33:47 -0800575
Sunny Goyal7d892ff2019-01-11 15:08:44 -0800576 public static final String TAG_NAME = "grid-option";
577
Sunny Goyaleff44f32019-01-09 17:29:49 -0800578 public final String name;
579 public final int numRows;
580 public final int numColumns;
Sunny Goyal415f1732018-11-29 10:33:47 -0800581
582 private final int numFolderRows;
583 private final int numFolderColumns;
584
585 private final int numHotseatIcons;
586
Tracy Zhou7df93d22020-01-27 13:44:06 -0800587 private final String dbFile;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000588 private final int numAllAppsColumns;
589
Sunny Goyal415f1732018-11-29 10:33:47 -0800590 private final int defaultLayoutId;
591 private final int demoModeLayoutId;
592
Sunny Goyal5bc18462019-01-07 15:13:39 -0800593 private final SparseArray<TypedValue> extraAttrs;
594
Sunny Goyaleff44f32019-01-09 17:29:49 -0800595 public GridOption(Context context, AttributeSet attrs) {
Sunny Goyal415f1732018-11-29 10:33:47 -0800596 TypedArray a = context.obtainStyledAttributes(
597 attrs, R.styleable.GridDisplayOption);
598 name = a.getString(R.styleable.GridDisplayOption_name);
599 numRows = a.getInt(R.styleable.GridDisplayOption_numRows, 0);
600 numColumns = a.getInt(R.styleable.GridDisplayOption_numColumns, 0);
601
Tracy Zhou7df93d22020-01-27 13:44:06 -0800602 dbFile = a.getString(R.styleable.GridDisplayOption_dbFile);
Sunny Goyal415f1732018-11-29 10:33:47 -0800603 defaultLayoutId = a.getResourceId(
604 R.styleable.GridDisplayOption_defaultLayoutId, 0);
605 demoModeLayoutId = a.getResourceId(
606 R.styleable.GridDisplayOption_demoModeLayoutId, defaultLayoutId);
607 numHotseatIcons = a.getInt(
608 R.styleable.GridDisplayOption_numHotseatIcons, numColumns);
609 numFolderRows = a.getInt(
610 R.styleable.GridDisplayOption_numFolderRows, numRows);
611 numFolderColumns = a.getInt(
612 R.styleable.GridDisplayOption_numFolderColumns, numColumns);
Sunny Goyalae190ff2020-04-14 00:19:01 +0000613 numAllAppsColumns = a.getInt(
614 R.styleable.GridDisplayOption_numAllAppsColumns, numColumns);
Jon Miranda6f7e9702019-09-16 14:44:14 -0700615
Sunny Goyal415f1732018-11-29 10:33:47 -0800616 a.recycle();
Sunny Goyal5bc18462019-01-07 15:13:39 -0800617
618 extraAttrs = Themes.createValueMap(context, attrs,
619 IntArray.wrap(R.styleable.GridDisplayOption));
Sunny Goyal415f1732018-11-29 10:33:47 -0800620 }
621 }
622
623 private static final class DisplayOption {
624 private final GridOption grid;
625
Sunny Goyal415f1732018-11-29 10:33:47 -0800626 private final float minWidthDps;
627 private final float minHeightDps;
628 private final boolean canBeDefault;
629
630 private float iconSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800631 private float iconTextSize;
Jon Miranda6f7e9702019-09-16 14:44:14 -0700632 private float landscapeIconSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000633 private float allAppsIconSize;
634 private float allAppsIconTextSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800635
636 DisplayOption(GridOption grid, Context context, AttributeSet attrs) {
637 this.grid = grid;
638
639 TypedArray a = context.obtainStyledAttributes(
640 attrs, R.styleable.ProfileDisplayOption);
641
Sunny Goyal415f1732018-11-29 10:33:47 -0800642 minWidthDps = a.getFloat(R.styleable.ProfileDisplayOption_minWidthDps, 0);
643 minHeightDps = a.getFloat(R.styleable.ProfileDisplayOption_minHeightDps, 0);
644 canBeDefault = a.getBoolean(
645 R.styleable.ProfileDisplayOption_canBeDefault, false);
646
Ryan Mitchell01b8b682019-03-28 17:01:07 -0700647 iconSize = a.getFloat(R.styleable.ProfileDisplayOption_iconImageSize, 0);
Sunny Goyal415f1732018-11-29 10:33:47 -0800648 landscapeIconSize = a.getFloat(R.styleable.ProfileDisplayOption_landscapeIconSize,
649 iconSize);
650 iconTextSize = a.getFloat(R.styleable.ProfileDisplayOption_iconTextSize, 0);
Jon Miranda6f7e9702019-09-16 14:44:14 -0700651
Sunny Goyalae190ff2020-04-14 00:19:01 +0000652 allAppsIconSize = a.getFloat(R.styleable.ProfileDisplayOption_allAppsIconSize,
653 iconSize);
654 allAppsIconTextSize = a.getFloat(R.styleable.ProfileDisplayOption_allAppsIconTextSize,
655 iconTextSize);
Sunny Goyal415f1732018-11-29 10:33:47 -0800656 a.recycle();
657 }
658
659 DisplayOption() {
Sunny Goyal0e7a3382020-04-13 17:15:05 -0700660 this(null);
661 }
662
663 DisplayOption(GridOption grid) {
664 this.grid = grid;
Sunny Goyal415f1732018-11-29 10:33:47 -0800665 minWidthDps = 0;
666 minHeightDps = 0;
667 canBeDefault = false;
668 }
669
670 private DisplayOption multiply(float w) {
671 iconSize *= w;
672 landscapeIconSize *= w;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000673 allAppsIconSize *= w;
Sunny Goyal415f1732018-11-29 10:33:47 -0800674 iconTextSize *= w;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000675 allAppsIconTextSize *= w;
Sunny Goyal415f1732018-11-29 10:33:47 -0800676 return this;
677 }
678
679 private DisplayOption add(DisplayOption p) {
680 iconSize += p.iconSize;
681 landscapeIconSize += p.landscapeIconSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000682 allAppsIconSize += p.allAppsIconSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800683 iconTextSize += p.iconTextSize;
Sunny Goyalae190ff2020-04-14 00:19:01 +0000684 allAppsIconTextSize += p.allAppsIconTextSize;
Sunny Goyal415f1732018-11-29 10:33:47 -0800685 return this;
686 }
687 }
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700688
689 private class OverlayMonitor extends BroadcastReceiver {
690
691 private final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
692
693 OverlayMonitor(Context context) {
Sunny Goyal8b0cb412019-04-22 09:01:26 -0700694 context.registerReceiver(this, getPackageFilter("android", ACTION_OVERLAY_CHANGED));
Hyunyoung Songe11eb472019-03-19 15:05:21 -0700695 }
696
697 @Override
698 public void onReceive(Context context, Intent intent) {
699 onConfigChanged(context);
700 }
701 }
Sunny Goyalae190ff2020-04-14 00:19:01 +0000702}