blob: be5463ec2c02b3be6c74764f85c1b21743c79e60 [file] [log] [blame]
The Android Open Source Project31dd5032009-03-03 19:32:27 -08001/*
2 * Copyright (C) 2008 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
Daniel Sandler325dc232013-06-05 22:57:57 -040017package com.android.launcher3;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080018
Sunny Goyale396abf2020-04-06 15:11:17 -070019import static com.android.launcher3.model.data.ItemInfoWithIcon.FLAG_ICON_BADGED;
Sunny Goyal9dbb27c2019-07-17 15:12:56 -070020
Jon Miranda40285752019-05-14 15:17:30 -070021import android.annotation.TargetApi;
Vadim Tryshev2ce6a132018-06-18 19:14:44 -070022import android.app.ActivityManager;
Pinyao Ting49a3e692019-07-26 12:28:38 -070023import android.app.Person;
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -070024import android.app.WallpaperManager;
Tony573c3e12019-02-22 13:10:59 -080025import android.content.BroadcastReceiver;
Tracy Zhouc6060e62020-04-27 13:05:34 -070026import android.content.ComponentName;
Winson Chungaafa03c2010-06-11 17:34:16 -070027import android.content.Context;
Sunny Goyal53116c62020-08-07 16:32:18 -070028import android.content.Intent;
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070029import android.content.SharedPreferences;
Jon Miranda1a49fb52019-02-19 15:34:41 -080030import android.content.pm.LauncherActivityInfo;
Sunny Goyale7b00122019-10-02 16:13:34 -070031import android.content.pm.LauncherApps;
Tracy Zhouc6060e62020-04-27 13:05:34 -070032import android.content.pm.PackageInfo;
33import android.content.pm.PackageManager;
Sunny Goyalc5c60ad2014-07-14 12:02:01 -070034import android.content.pm.ResolveInfo;
Sunny Goyal6bbf6002019-04-17 18:38:52 -070035import android.content.pm.ShortcutInfo;
Winson Chungaafa03c2010-06-11 17:34:16 -070036import android.content.res.Resources;
Sunny Goyal733e3c62020-09-29 10:32:32 -070037import android.database.ContentObserver;
Jon Miranda40285752019-05-14 15:17:30 -070038import android.graphics.Bitmap;
39import android.graphics.Color;
Zak Cohenec4407b2021-04-01 10:49:12 -070040import android.graphics.ColorFilter;
41import android.graphics.LightingColorFilter;
Winson Chungc763c4e2013-07-19 13:49:06 -070042import android.graphics.Matrix;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080043import android.graphics.Paint;
Sunny Goyal415f1732018-11-29 10:33:47 -080044import android.graphics.Point;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080045import android.graphics.Rect;
Sunny Goyalb1e2e292018-02-21 10:14:30 -080046import android.graphics.RectF;
Jon Miranda40285752019-05-14 15:17:30 -070047import android.graphics.drawable.ColorDrawable;
Jon Miranda1a49fb52019-02-19 15:34:41 -080048import android.graphics.drawable.Drawable;
Jon Miranda40285752019-05-14 15:17:30 -070049import android.graphics.drawable.InsetDrawable;
Sunny Goyal733e3c62020-09-29 10:32:32 -070050import android.net.Uri;
Sandeep Siddhartha2efc7d92014-05-16 17:21:15 -070051import android.os.Build;
Sunny Goyal712ee532016-11-04 10:19:58 -070052import android.os.DeadObjectException;
Sunny Goyal3483c522018-04-12 11:23:33 -070053import android.os.Handler;
54import android.os.Message;
Sunny Goyal712ee532016-11-04 10:19:58 -070055import android.os.TransactionTooLargeException;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070056import android.provider.Settings;
Sunny Goyale78e3d72015-09-24 11:23:31 -070057import android.text.Spannable;
58import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070059import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070060import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070061import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020062import android.util.Log;
Adam Cohen2e6da152015-05-06 11:42:25 -070063import android.util.TypedValue;
Tonyd5a3df72019-03-13 10:12:01 -050064import android.view.MotionEvent;
Winson Chungc763c4e2013-07-19 13:49:06 -070065import android.view.View;
Sunny Goyal878aa332019-05-20 12:40:42 -070066import android.view.ViewConfiguration;
Sunny Goyal0f3af752018-06-08 13:01:04 -070067import android.view.animation.Interpolator;
Vinit Nayak4cc0dbb2021-04-27 17:32:25 -070068import android.widget.LinearLayout;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070069
Zak Cohenec4407b2021-04-01 10:49:12 -070070import androidx.core.graphics.ColorUtils;
Sunny Goyal0addbf02020-04-28 14:17:35 -070071import androidx.core.os.BuildCompat;
72
Jon Miranda1a49fb52019-02-19 15:34:41 -080073import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
Tracy Zhou0455d142021-01-27 14:05:01 -080074import com.android.launcher3.graphics.GridCustomizationsProvider;
Sunny Goyal5b636eb2019-05-29 01:09:06 -070075import com.android.launcher3.graphics.TintedDrawableSpan;
Sunny Goyal572aca42021-03-24 15:21:39 -070076import com.android.launcher3.icons.FastBitmapDrawable;
Jon Miranda40285752019-05-14 15:17:30 -070077import com.android.launcher3.icons.LauncherIcons;
Sunny Goyalfa395362019-12-11 10:00:47 -080078import com.android.launcher3.icons.ShortcutCachingLogic;
Sunny Goyal9ab43772021-04-23 11:40:58 -070079import com.android.launcher3.icons.ThemedIconDrawable.ThemedAdaptiveIcon;
Sunny Goyale396abf2020-04-06 15:11:17 -070080import com.android.launcher3.model.data.ItemInfo;
81import com.android.launcher3.model.data.ItemInfoWithIcon;
Sunny Goyale7b00122019-10-02 16:13:34 -070082import com.android.launcher3.pm.ShortcutConfigActivityInfo;
Jon Miranda1a49fb52019-02-19 15:34:41 -080083import com.android.launcher3.shortcuts.ShortcutKey;
Sunny Goyalfa395362019-12-11 10:00:47 -080084import com.android.launcher3.shortcuts.ShortcutRequest;
Sunny Goyalefb7e842018-10-04 15:11:00 -070085import com.android.launcher3.util.IntArray;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070086import com.android.launcher3.util.PackageManagerHelper;
Jon Miranda1a49fb52019-02-19 15:34:41 -080087import com.android.launcher3.widget.PendingAddShortcutInfo;
Sunny Goyal6c56c682015-07-16 14:09:05 -070088
Sunny Goyal25aba0a2015-07-16 15:07:47 -070089import java.lang.reflect.Method;
Tracy Zhouc6060e62020-04-27 13:05:34 -070090import java.util.Arrays;
Jon Miranda1a49fb52019-02-19 15:34:41 -080091import java.util.List;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070092import java.util.Locale;
Sunny Goyal733e3c62020-09-29 10:32:32 -070093import java.util.function.Consumer;
Winson Chung82b016c2015-05-08 17:00:10 -070094import java.util.regex.Matcher;
95import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080096
97/**
98 * Various utilities shared amongst the Launcher's classes.
99 */
Mathew Inwood72fbec12013-11-19 15:45:07 +0000100public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -0700101
Joe Onorato1291a8c2009-09-15 15:07:25 -0400102 private static final String TAG = "Launcher.Utilities";
103
Winson Chung82b016c2015-05-08 17:00:10 -0700104 private static final Pattern sTrimPattern =
105 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
106
Sunny Goyal53d7ee42015-05-22 12:25:45 -0700107 private static final int[] sLoc0 = new int[2];
108 private static final int[] sLoc1 = new int[2];
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700109 private static final Matrix sMatrix = new Matrix();
110 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +0100111
Pinyao Ting49a3e692019-07-26 12:28:38 -0700112 public static final String[] EMPTY_STRING_ARRAY = new String[0];
113 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0];
114
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000115 public static final boolean ATLEAST_P = Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Sunny Goyal0addbf02020-04-28 14:17:35 -0700116
Sunny Goyal03340472019-05-17 16:57:12 -0700117 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700118
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000119 public static final boolean ATLEAST_R = Build.VERSION.SDK_INT >= Build.VERSION_CODES.R;
120
121 public static final boolean ATLEAST_S = BuildCompat.isAtLeastS();
Tony Mak6eeb0402018-01-03 14:41:31 +0000122
Sunny Goyal49f19f02017-01-05 14:36:02 -0800123 /**
Tonyd5a3df72019-03-13 10:12:01 -0500124 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
125 */
126 public static final int EDGE_NAV_BAR = 1 << 8;
127
128 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800129 * Indicates if the device has a debug build. Should only be used to store additional info or
130 * add extra logging and not for changing the app behavior.
131 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200132 public static final boolean IS_DEBUG_DEVICE =
133 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
134 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800135
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700136 public static boolean isDevelopersOptionsEnabled(Context context) {
137 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
138 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
139 }
140
Sunny Goyal6f866092016-03-17 17:04:15 -0700141 // An intent extra to indicate the horizontal scroll of the wallpaper.
142 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
Hyunyoung Song29e5d442019-02-07 10:33:55 -0800143 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
Sunny Goyal6f866092016-03-17 17:04:15 -0700144
Wesley.CW Wang0f5c9db2020-09-08 16:33:11 +0800145 // An intent extra to indicate the launch source by launcher.
146 public static final String EXTRA_WALLPAPER_LAUNCH_SOURCE =
147 "com.android.wallpaper.LAUNCH_SOURCE";
148
Vadim Tryshevc2950982018-10-04 16:33:45 -0700149 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700150 ActivityManager.isRunningInTestHarness();
151
Vadim Tryshevc2950982018-10-04 16:33:45 -0700152 public static void enableRunningInTestHarnessForTests() {
153 IS_RUNNING_IN_TEST_HARNESS = true;
154 }
155
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800156 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100157 return Log.isLoggable(propertyName, Log.VERBOSE);
158 }
159
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700160 public static boolean existsStyleWallpapers(Context context) {
161 ResolveInfo ri = context.getPackageManager().resolveActivity(
162 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
163 return ri != null;
164 }
165
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800166 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700167 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
168 * coordinates.
169 *
170 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700171 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700172 * @param coord The coordinate that we want mapped.
173 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
174 * sometimes this is relevant as in a child's coordinates within the descendant.
175 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
176 * this scale factor is assumed to be equal in X and Y, and so if at any point this
177 * assumption fails, we will need to return a pair of scale factors.
178 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700179 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700180 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
181 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700182 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700183 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700184
Sunny Goyalae6e3182019-04-30 12:04:37 -0700185 /**
186 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
187 * coordinates.
188 *
189 * @param descendant The descendant to which the passed coordinate is relative.
190 * @param ancestor The root view to make the coordinates relative to.
191 * @param coord The coordinate that we want mapped.
192 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
193 * sometimes this is relevant as in a child's coordinates within the descendant.
194 * @param ignoreTransform If true, view transform is ignored
195 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
196 * this scale factor is assumed to be equal in X and Y, and so if at any point this
197 * assumption fails, we will need to return a pair of scale factors.
198 */
199 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700200 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700201 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700202 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700203 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700204 // For TextViews, scroll has a meaning which relates to the text position
205 // which is very strange... ignore the scroll.
206 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700207 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700208 }
209
Sunny Goyalc4d32012020-04-03 17:10:11 -0700210 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700211 v.getMatrix().mapPoints(coord);
212 }
213 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700214 scale *= v.getScaleX();
215
Winson Chungc763c4e2013-07-19 13:49:06 -0700216 v = (View) v.getParent();
217 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700218 return scale;
219 }
220
221 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700222 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700223 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700224 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700225 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700226 View v = descendant;
227 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700228 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
229 sMatrix.postConcat(v.getMatrix());
230 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700231 v = (View) v.getParent();
232 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700233 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
234 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700235 sInverseMatrix.mapPoints(coord);
236 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700237
Sunny Goyalae6e3182019-04-30 12:04:37 -0700238 /**
239 * Sets {@param out} to be same as {@param in} by rounding individual values
240 */
241 public static void roundArray(float[] in, int[] out) {
242 for (int i = 0; i < in.length; i++) {
243 out[i] = Math.round(in[i]);
244 }
245 }
246
247 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
248 for (int i = 0; i < points.length; i += 2) {
249 points[i] += offsetX;
250 points[i + 1] += offsetY;
251 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700252 }
253
Jason Monk02dd7ae2014-04-15 15:23:31 -0400254 /**
255 * Utility method to determine whether the given point, in local coordinates,
256 * is inside the view, where the area of the view is expanded by the slop factor.
257 * This method is called while processing touch-move events to determine if the event
258 * is still within the view.
259 */
260 public static boolean pointInView(View v, float localX, float localY, float slop) {
261 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
262 localY < (v.getHeight() + slop);
263 }
264
Sunny Goyala52ecb02016-12-16 15:04:51 -0800265 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700266 v0.getLocationInWindow(sLoc0);
267 v1.getLocationInWindow(sLoc1);
268
269 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
270 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
271 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
272 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800273 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700274 }
275
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800276 public static void scaleRectFAboutCenter(RectF r, float scale) {
277 if (scale != 1.0f) {
278 float cx = r.centerX();
279 float cy = r.centerY();
280 r.offset(-cx, -cy);
281 r.left = r.left * scale;
282 r.top = r.top * scale ;
283 r.right = r.right * scale;
284 r.bottom = r.bottom * scale;
285 r.offset(cx, cy);
286 }
287 }
288
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800289 public static void scaleRectAboutCenter(Rect r, float scale) {
290 if (scale != 1.0f) {
291 int cx = r.centerX();
292 int cy = r.centerY();
293 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800294 scaleRect(r, scale);
295 r.offset(cx, cy);
296 }
297 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800298
Winson Chung3e803c72018-01-29 11:16:32 -0800299 public static void scaleRect(Rect r, float scale) {
300 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800301 r.left = (int) (r.left * scale + 0.5f);
302 r.top = (int) (r.top * scale + 0.5f);
303 r.right = (int) (r.right * scale + 0.5f);
304 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800305 }
306 }
307
Winson Chung3e803c72018-01-29 11:16:32 -0800308 public static void insetRect(Rect r, Rect insets) {
309 r.left = Math.min(r.right, r.left + insets.left);
310 r.top = Math.min(r.bottom, r.top + insets.top);
311 r.right = Math.max(r.left, r.right - insets.right);
312 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
313 }
314
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800315 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800316 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
317 if (scale < 1.0f) {
318 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
319 r.left += deltaX;
320 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700321
Jon Mirandae96798e2016-12-07 12:10:44 -0800322 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
323 r.top += deltaY;
324 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700325 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800326 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700327 }
328
Tony Wickhamb45444b2018-05-18 16:57:01 -0700329 /**
330 * Maps t from one range to another range.
331 * @param t The value to map.
332 * @param fromMin The lower bound of the range that t is being mapped from.
333 * @param fromMax The upper bound of the range that t is being mapped from.
334 * @param toMin The lower bound of the range that t is being mapped to.
335 * @param toMax The upper bound of the range that t is being mapped to.
336 * @return The mapped value of t.
337 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700338 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
339 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700340 if (fromMin == fromMax || toMin == toMax) {
341 Log.e(TAG, "mapToRange: range has 0 length");
342 return toMin;
343 }
Tonye4c2e2b2019-03-25 10:23:39 -0500344 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700345 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700346 }
347
Tonye4c2e2b2019-03-25 10:23:39 -0500348 public static float getProgress(float current, float min, float max) {
349 return Math.abs(current - min) / Math.abs(max - min);
350 }
351
Winson Chung3e803c72018-01-29 11:16:32 -0800352 public static float mapRange(float value, float min, float max) {
353 return min + (value * (max - min));
354 }
355
Sunny Goyal594d76d2014-11-06 10:12:54 -0800356 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700357 * Bounds parameter to the range [0, 1]
358 */
359 public static float saturate(float a) {
360 return boundToRange(a, 0, 1.0f);
361 }
362
363 /**
364 * Returns the compliment (1 - a) of the parameter.
365 */
366 public static float comp(float a) {
367 return 1 - a;
368 }
369
370 /**
371 * Returns the "probabilistic or" of a and b. (a + b - ab).
372 * Useful beyond probability, can be used to combine two unit progresses for example.
373 */
374 public static float or(float a, float b) {
375 float satA = saturate(a);
376 float satB = saturate(b);
377 return satA + satB - (satA * satB);
378 }
379
380 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700381 * Trims the string, removing all whitespace at the beginning and end of the string.
382 * Non-breaking whitespaces are also removed.
383 */
384 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700385 if (s == null) {
386 return null;
387 }
388
Winson Chung82b016c2015-05-08 17:00:10 -0700389 // Just strip any sequence of whitespace or java space characters from the beginning and end
390 Matcher m = sTrimPattern.matcher(s);
391 return m.replaceAll("$1");
392 }
Sunny Goyal70660032015-05-14 00:07:08 -0700393
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700394 /**
395 * Calculates the height of a given string at a specific text size.
396 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700397 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700398 Paint p = new Paint();
399 p.setTextSize(textSizePx);
400 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700401 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700402 }
403
Sunny Goyal70660032015-05-14 00:07:08 -0700404 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800405 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700406 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700407
Sunny Goyal35c7b192021-04-20 16:51:10 -0700408 public static float dpiFromPx(float size, int densityDpi) {
409 float densityRatio = (float) densityDpi / DisplayMetrics.DENSITY_DEFAULT;
Adam Cohen2e6da152015-05-06 11:42:25 -0700410 return (size / densityRatio);
411 }
vadimt1b383af2019-05-08 15:29:37 -0700412
Schneider Victor-tulias20bbaa32020-12-15 15:33:25 -0500413 /** Converts a dp value to pixels for the current device. */
414 public static int dpToPx(float dp) {
415 return (int) (dp * Resources.getSystem().getDisplayMetrics().density);
416 }
417
Adam Cohen2e6da152015-05-06 11:42:25 -0700418 public static int pxFromSp(float size, DisplayMetrics metrics) {
419 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
420 size, metrics));
421 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700422
Sunny Goyalefb7e842018-10-04 15:11:00 -0700423 public static String createDbSelectionQuery(String columnName, IntArray values) {
424 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700425 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700426
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700427 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700428 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
429 }
430
431 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700432 try {
433 Class clazz = Class.forName("android.os.SystemProperties");
434 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700435 String value = (String) getter.invoke(null, property);
436 if (!TextUtils.isEmpty(value)) {
437 return value;
438 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700439 } catch (Exception e) {
440 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700441 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700442 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700443 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700444
445 /**
446 * Ensures that a value is within given bounds. Specifically:
447 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
448 * return upperBound; else return value unchanged.
449 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700450 public static int boundToRange(int value, int lowerBound, int upperBound) {
451 return Math.max(lowerBound, Math.min(value, upperBound));
452 }
453
454 /**
455 * @see #boundToRange(int, int, int).
456 */
457 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700458 return Math.max(lowerBound, Math.min(value, upperBound));
459 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700460
Sunny Goyale78e3d72015-09-24 11:23:31 -0700461 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700462 * @see #boundToRange(int, int, int).
463 */
464 public static long boundToRange(long value, long lowerBound, long upperBound) {
465 return Math.max(lowerBound, Math.min(value, upperBound));
466 }
467
468 /**
Sunny Goyal53e3b142021-01-13 16:18:34 -0800469 * Returns an intent for starting the default home activity
470 */
471 public static Intent createHomeIntent() {
472 return new Intent(Intent.ACTION_MAIN)
473 .addCategory(Intent.CATEGORY_HOME)
474 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
475 }
476
477 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700478 * Wraps a message with a TTS span, so that a different message is spoken than
479 * what is getting displayed.
480 * @param msg original message
481 * @param ttsMsg message to be spoken
482 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700483 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800484 SpannableString spanned = new SpannableString(msg);
485 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
486 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
487 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700488 }
Winson12fb9fc2015-10-01 15:34:08 -0700489
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700490 /**
491 * Prefixes a text with the provided icon
492 */
493 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
494 // Update the hint to contain the icon.
495 // Prefix the original hint with two spaces. The first space gets replaced by the icon
496 // using span. The second space is used for a singe space character between the hint
497 // and the icon.
498 SpannableString spanned = new SpannableString(" " + msg);
499 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
500 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
501 return spanned;
502 }
503
Sunny Goyalf7258242015-10-19 16:59:07 -0700504 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800505 // Use application context for shared preferences, so that we use a single cached instance
506 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700507 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
508 }
Tony Wickham112ac952015-11-12 12:31:50 -0800509
Sunny Goyal9d887a22017-06-08 14:00:43 -0700510 public static SharedPreferences getDevicePrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800511 // Use application context for shared preferences, so that we use a single cached instance
512 return context.getApplicationContext().getSharedPreferences(
Sunny Goyal9d887a22017-06-08 14:00:43 -0700513 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
514 }
515
Hyunyoung Song0de01172016-10-05 16:27:48 -0700516 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800517 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700518 }
519
Sunny Goyal712ee532016-11-04 10:19:58 -0700520 public static boolean isBinderSizeError(Exception e) {
521 return e.getCause() instanceof TransactionTooLargeException
522 || e.getCause() instanceof DeadObjectException;
523 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530524
Tracy Zhouc6060e62020-04-27 13:05:34 -0700525 public static boolean isGridOptionsEnabled(Context context) {
526 return isComponentEnabled(context.getPackageManager(),
527 context.getPackageName(),
Tracy Zhou0455d142021-01-27 14:05:01 -0800528 GridCustomizationsProvider.class.getName());
Tracy Zhouc6060e62020-04-27 13:05:34 -0700529 }
530
531 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
532 ComponentName componentName = new ComponentName(pkgName, clsName);
533 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
534
535 switch (componentEnabledSetting) {
536 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
537 return false;
538 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
539 return true;
540 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
541 default:
542 // We need to get the application info to get the component's default state
543 try {
544 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
545 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
546
547 if (packageInfo.providers != null) {
548 return Arrays.stream(packageInfo.providers).anyMatch(
549 pi -> pi.name.equals(clsName) && pi.isEnabled());
550 }
551
552 // the component is not declared in the AndroidManifest
553 return false;
554 } catch (PackageManager.NameNotFoundException e) {
555 // the package isn't installed on the device
556 return false;
557 }
558 }
559 }
560
Tony Wickham580edcf2017-02-09 08:28:52 -0800561 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700562 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
563 */
564 public static void postAsyncCallback(Handler handler, Runnable callback) {
565 Message msg = Message.obtain(handler, callback);
566 msg.setAsynchronous(true);
567 handler.sendMessage(msg);
568 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700569
Sunny Goyal415f1732018-11-29 10:33:47 -0800570 /**
571 * Parses a string encoded using {@link #getPointString(int, int)}
572 */
573 public static Point parsePoint(String point) {
574 String[] split = point.split(",");
575 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
576 }
577
578 /**
579 * Encodes a point to string to that it can be persisted atomically.
580 */
581 public static String getPointString(int x, int y) {
582 return String.format(Locale.ENGLISH, "%d,%d", x, y);
583 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800584
Tony573c3e12019-02-22 13:10:59 -0800585 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
586 try {
587 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800588 } catch (IllegalArgumentException e) {}
589 }
590
591 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700592 * Returns the full drawable for info without any flattening or pre-processing.
593 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800594 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700595 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800596 */
597 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700598 Object[] outObj) {
Sunny Goyal9ab43772021-04-23 11:40:58 -0700599 Drawable icon = loadFullDrawableWithoutTheme(launcher, info, width, height, outObj);
600 if (icon instanceof ThemedAdaptiveIcon) {
601 icon = ((ThemedAdaptiveIcon) icon).getThemedDrawable(launcher);
602 }
603 return icon;
604 }
605
606 private static Drawable loadFullDrawableWithoutTheme(Launcher launcher, ItemInfo info,
607 int width, int height, Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800608 LauncherAppState appState = LauncherAppState.getInstance(launcher);
609 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700610 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800611 .resolveActivity(info.getIntent(), info.user);
612 outObj[0] = activityInfo;
Sunny Goyal9ab43772021-04-23 11:40:58 -0700613 return activityInfo == null ? null : LauncherAppState.getInstance(launcher)
614 .getIconCache().getIconProvider().getIcon(
615 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800616 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
617 if (info instanceof PendingAddShortcutInfo) {
618 ShortcutConfigActivityInfo activityInfo =
619 ((PendingAddShortcutInfo) info).activityInfo;
620 outObj[0] = activityInfo;
621 return activityInfo.getFullResIcon(appState.getIconCache());
622 }
Sunny Goyalfa395362019-12-11 10:00:47 -0800623 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
624 .buildRequest(launcher)
625 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800626 if (si.isEmpty()) {
627 return null;
628 } else {
629 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800630 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800631 appState.getInvariantDeviceProfile().fillResIconDpi);
632 }
633 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
634 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
635 launcher, info.id, new Point(width, height));
636 if (icon == null) {
637 return null;
638 }
639 outObj[0] = icon;
640 return icon;
641 } else {
642 return null;
643 }
Tony573c3e12019-02-22 13:10:59 -0800644 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700645
Jon Miranda40285752019-05-14 15:17:30 -0700646 /**
647 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
648 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
649 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
650 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
651 **/
652 @TargetApi(Build.VERSION_CODES.O)
653 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
654 LauncherAppState appState = LauncherAppState.getInstance(launcher);
655 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
656 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
657 boolean iconBadged = (info instanceof ItemInfoWithIcon)
658 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
659 if ((info.id == ItemInfo.NO_ID && !iconBadged)
660 || !(obj instanceof ShortcutInfo)) {
661 // The item is not yet added on home screen.
662 return new FixedSizeEmptyDrawable(iconSize);
663 }
664 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800665 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
666 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800667 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700668 float insetFraction = (iconSize - badgeSize) / iconSize;
669 return new InsetDrawable(new FastBitmapDrawable(badge),
670 insetFraction, insetFraction, 0, 0);
671 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
672 return ((FolderAdaptiveIcon) obj).getBadge();
673 } else {
674 return launcher.getPackageManager()
675 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
676 }
677 }
678
Sunny Goyal53116c62020-08-07 16:32:18 -0700679 /**
680 * @return true is the extra is either null or is of type {@param type}
681 */
682 public static boolean isValidExtraType(Intent intent, String key, Class type) {
683 Object extra = intent.getParcelableExtra(key);
684 return extra == null || type.isInstance(extra);
685 }
686
Sunny Goyal878aa332019-05-20 12:40:42 -0700687 public static float squaredHypot(float x, float y) {
688 return x * x + y * y;
689 }
690
691 public static float squaredTouchSlop(Context context) {
692 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
693 return slop * slop;
694 }
695
Sunny Goyal733e3c62020-09-29 10:32:32 -0700696 /**
697 * Helper method to create a content provider
698 */
699 public static ContentObserver newContentObserver(Handler handler, Consumer<Uri> command) {
700 return new ContentObserver(handler) {
701 @Override
702 public void onChange(boolean selfChange, Uri uri) {
703 command.accept(uri);
704 }
705 };
706 }
707
Pat Manning0fe73262021-03-09 13:08:06 +0000708 /**
709 * Compares the ratio of two quantities and returns whether that ratio is greater than the
710 * provided bound. Order of quantities does not matter. Bound should be a decimal representation
711 * of a percentage.
712 */
713 public static boolean isRelativePercentDifferenceGreaterThan(float first, float second,
714 float bound) {
715 return (Math.abs(first - second) / Math.abs((first + second) / 2.0f)) > bound;
716 }
717
[1;3Ca608d812021-01-22 13:34:46 -0800718 /**
719 * Rotates `inOutBounds` by `delta` 90-degree increments. Rotation is visually CCW. Parent
720 * sizes represent the "space" that will rotate carrying inOutBounds along with it to determine
721 * the final bounds.
722 */
723 public static void rotateBounds(Rect inOutBounds, int parentWidth, int parentHeight,
724 int delta) {
725 int rdelta = ((delta % 4) + 4) % 4;
726 int origLeft = inOutBounds.left;
727 switch (rdelta) {
728 case 0:
729 return;
730 case 1:
731 inOutBounds.left = inOutBounds.top;
732 inOutBounds.top = parentWidth - inOutBounds.right;
733 inOutBounds.right = inOutBounds.bottom;
734 inOutBounds.bottom = parentWidth - origLeft;
735 return;
736 case 2:
737 inOutBounds.left = parentWidth - inOutBounds.right;
738 inOutBounds.right = parentWidth - origLeft;
739 return;
740 case 3:
741 inOutBounds.left = parentHeight - inOutBounds.bottom;
742 inOutBounds.bottom = inOutBounds.right;
743 inOutBounds.right = parentHeight - inOutBounds.top;
744 inOutBounds.top = origLeft;
745 return;
746 }
747 }
748
Zak Cohenec4407b2021-04-01 10:49:12 -0700749 /**
750 * Make a color filter that blends a color into the destination based on a scalable amout.
751 *
752 * @param color to blend in.
753 * @param tintAmount [0-1] 0 no tinting, 1 full color.
754 * @return ColorFilter for tinting, or {@code null} if no filter is needed.
755 */
756 public static ColorFilter makeColorTintingColorFilter(int color, float tintAmount) {
757 if (tintAmount == 0f) {
758 return null;
759 }
760 return new LightingColorFilter(
761 // This isn't blending in white, its making a multiplication mask for the base color
762 ColorUtils.blendARGB(Color.WHITE, 0, tintAmount),
763 ColorUtils.blendARGB(0, color, tintAmount));
764 }
765
Vinit Nayak4cc0dbb2021-04-27 17:32:25 -0700766 /**
767 * Sets start margin on the provided {@param view} to be {@param margin}.
768 * Assumes {@param view} is a child of {@link LinearLayout}
769 */
770 public static void setStartMarginForView(View view, int margin) {
771 LinearLayout.LayoutParams lp = (LinearLayout.LayoutParams) view.getLayoutParams();
772 lp.setMarginStart(margin);
773 view.setLayoutParams(lp);
774 }
775
Jon Miranda40285752019-05-14 15:17:30 -0700776 private static class FixedSizeEmptyDrawable extends ColorDrawable {
777
778 private final int mSize;
779
780 public FixedSizeEmptyDrawable(int size) {
781 super(Color.TRANSPARENT);
782 mSize = size;
783 }
784
785 @Override
786 public int getIntrinsicHeight() {
787 return mSize;
788 }
789
790 @Override
791 public int getIntrinsicWidth() {
792 return mSize;
793 }
794 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800795}