blob: 3312915fd391afaf5f3687ebd2ee56eb21b2f511 [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;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070068
Zak Cohenec4407b2021-04-01 10:49:12 -070069import androidx.core.graphics.ColorUtils;
Sunny Goyal0addbf02020-04-28 14:17:35 -070070import androidx.core.os.BuildCompat;
71
Jon Miranda1a49fb52019-02-19 15:34:41 -080072import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
Tracy Zhou0455d142021-01-27 14:05:01 -080073import com.android.launcher3.graphics.GridCustomizationsProvider;
Sunny Goyal5b636eb2019-05-29 01:09:06 -070074import com.android.launcher3.graphics.TintedDrawableSpan;
Sunny Goyal572aca42021-03-24 15:21:39 -070075import com.android.launcher3.icons.FastBitmapDrawable;
Sunny Goyal14168432019-10-24 15:59:49 -070076import com.android.launcher3.icons.IconProvider;
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 Goyale396abf2020-04-06 15:11:17 -070079import com.android.launcher3.model.data.ItemInfo;
80import com.android.launcher3.model.data.ItemInfoWithIcon;
Sunny Goyale7b00122019-10-02 16:13:34 -070081import com.android.launcher3.pm.ShortcutConfigActivityInfo;
Jon Miranda1a49fb52019-02-19 15:34:41 -080082import com.android.launcher3.shortcuts.ShortcutKey;
Sunny Goyalfa395362019-12-11 10:00:47 -080083import com.android.launcher3.shortcuts.ShortcutRequest;
Sunny Goyalefb7e842018-10-04 15:11:00 -070084import com.android.launcher3.util.IntArray;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070085import com.android.launcher3.util.PackageManagerHelper;
Jon Miranda1a49fb52019-02-19 15:34:41 -080086import com.android.launcher3.widget.PendingAddShortcutInfo;
Sunny Goyal6c56c682015-07-16 14:09:05 -070087
Sunny Goyal25aba0a2015-07-16 15:07:47 -070088import java.lang.reflect.Method;
Tracy Zhouc6060e62020-04-27 13:05:34 -070089import java.util.Arrays;
Jon Miranda1a49fb52019-02-19 15:34:41 -080090import java.util.List;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070091import java.util.Locale;
Sunny Goyal733e3c62020-09-29 10:32:32 -070092import java.util.function.Consumer;
Winson Chung82b016c2015-05-08 17:00:10 -070093import java.util.regex.Matcher;
94import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080095
96/**
97 * Various utilities shared amongst the Launcher's classes.
98 */
Mathew Inwood72fbec12013-11-19 15:45:07 +000099public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -0700100
Joe Onorato1291a8c2009-09-15 15:07:25 -0400101 private static final String TAG = "Launcher.Utilities";
102
Winson Chung82b016c2015-05-08 17:00:10 -0700103 private static final Pattern sTrimPattern =
104 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
105
Sunny Goyal53d7ee42015-05-22 12:25:45 -0700106 private static final int[] sLoc0 = new int[2];
107 private static final int[] sLoc1 = new int[2];
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700108 private static final Matrix sMatrix = new Matrix();
109 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +0100110
Pinyao Ting49a3e692019-07-26 12:28:38 -0700111 public static final String[] EMPTY_STRING_ARRAY = new String[0];
112 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0];
113
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000114 public static final boolean ATLEAST_P = Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Sunny Goyal0addbf02020-04-28 14:17:35 -0700115
Sunny Goyal03340472019-05-17 16:57:12 -0700116 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700117
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000118 public static final boolean ATLEAST_R = Build.VERSION.SDK_INT >= Build.VERSION_CODES.R;
119
120 public static final boolean ATLEAST_S = BuildCompat.isAtLeastS();
Tony Mak6eeb0402018-01-03 14:41:31 +0000121
Sunny Goyal49f19f02017-01-05 14:36:02 -0800122 /**
Tonyd5a3df72019-03-13 10:12:01 -0500123 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
124 */
125 public static final int EDGE_NAV_BAR = 1 << 8;
126
127 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800128 * Indicates if the device has a debug build. Should only be used to store additional info or
129 * add extra logging and not for changing the app behavior.
130 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200131 public static final boolean IS_DEBUG_DEVICE =
132 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
133 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800134
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700135 public static boolean isDevelopersOptionsEnabled(Context context) {
136 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
137 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
138 }
139
Sunny Goyal6f866092016-03-17 17:04:15 -0700140 // An intent extra to indicate the horizontal scroll of the wallpaper.
141 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
Hyunyoung Song29e5d442019-02-07 10:33:55 -0800142 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
Sunny Goyal6f866092016-03-17 17:04:15 -0700143
Wesley.CW Wang0f5c9db2020-09-08 16:33:11 +0800144 // An intent extra to indicate the launch source by launcher.
145 public static final String EXTRA_WALLPAPER_LAUNCH_SOURCE =
146 "com.android.wallpaper.LAUNCH_SOURCE";
147
Vadim Tryshevc2950982018-10-04 16:33:45 -0700148 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700149 ActivityManager.isRunningInTestHarness();
150
Vadim Tryshevc2950982018-10-04 16:33:45 -0700151 public static void enableRunningInTestHarnessForTests() {
152 IS_RUNNING_IN_TEST_HARNESS = true;
153 }
154
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800155 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100156 return Log.isLoggable(propertyName, Log.VERBOSE);
157 }
158
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700159 public static boolean existsStyleWallpapers(Context context) {
160 ResolveInfo ri = context.getPackageManager().resolveActivity(
161 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
162 return ri != null;
163 }
164
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800165 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700166 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
167 * coordinates.
168 *
169 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700170 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700171 * @param coord The coordinate that we want mapped.
172 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
173 * sometimes this is relevant as in a child's coordinates within the descendant.
174 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
175 * this scale factor is assumed to be equal in X and Y, and so if at any point this
176 * assumption fails, we will need to return a pair of scale factors.
177 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700178 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700179 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
180 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700181 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700182 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700183
Sunny Goyalae6e3182019-04-30 12:04:37 -0700184 /**
185 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
186 * coordinates.
187 *
188 * @param descendant The descendant to which the passed coordinate is relative.
189 * @param ancestor The root view to make the coordinates relative to.
190 * @param coord The coordinate that we want mapped.
191 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
192 * sometimes this is relevant as in a child's coordinates within the descendant.
193 * @param ignoreTransform If true, view transform is ignored
194 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
195 * this scale factor is assumed to be equal in X and Y, and so if at any point this
196 * assumption fails, we will need to return a pair of scale factors.
197 */
198 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700199 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700200 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700201 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700202 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700203 // For TextViews, scroll has a meaning which relates to the text position
204 // which is very strange... ignore the scroll.
205 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700206 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700207 }
208
Sunny Goyalc4d32012020-04-03 17:10:11 -0700209 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700210 v.getMatrix().mapPoints(coord);
211 }
212 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700213 scale *= v.getScaleX();
214
Winson Chungc763c4e2013-07-19 13:49:06 -0700215 v = (View) v.getParent();
216 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700217 return scale;
218 }
219
220 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700221 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700222 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700223 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700224 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700225 View v = descendant;
226 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700227 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
228 sMatrix.postConcat(v.getMatrix());
229 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700230 v = (View) v.getParent();
231 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700232 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
233 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700234 sInverseMatrix.mapPoints(coord);
235 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700236
Sunny Goyalae6e3182019-04-30 12:04:37 -0700237 /**
238 * Sets {@param out} to be same as {@param in} by rounding individual values
239 */
240 public static void roundArray(float[] in, int[] out) {
241 for (int i = 0; i < in.length; i++) {
242 out[i] = Math.round(in[i]);
243 }
244 }
245
246 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
247 for (int i = 0; i < points.length; i += 2) {
248 points[i] += offsetX;
249 points[i + 1] += offsetY;
250 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700251 }
252
Jason Monk02dd7ae2014-04-15 15:23:31 -0400253 /**
254 * Utility method to determine whether the given point, in local coordinates,
255 * is inside the view, where the area of the view is expanded by the slop factor.
256 * This method is called while processing touch-move events to determine if the event
257 * is still within the view.
258 */
259 public static boolean pointInView(View v, float localX, float localY, float slop) {
260 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
261 localY < (v.getHeight() + slop);
262 }
263
Sunny Goyala52ecb02016-12-16 15:04:51 -0800264 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700265 v0.getLocationInWindow(sLoc0);
266 v1.getLocationInWindow(sLoc1);
267
268 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
269 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
270 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
271 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800272 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700273 }
274
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800275 public static void scaleRectFAboutCenter(RectF r, float scale) {
276 if (scale != 1.0f) {
277 float cx = r.centerX();
278 float cy = r.centerY();
279 r.offset(-cx, -cy);
280 r.left = r.left * scale;
281 r.top = r.top * scale ;
282 r.right = r.right * scale;
283 r.bottom = r.bottom * scale;
284 r.offset(cx, cy);
285 }
286 }
287
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800288 public static void scaleRectAboutCenter(Rect r, float scale) {
289 if (scale != 1.0f) {
290 int cx = r.centerX();
291 int cy = r.centerY();
292 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800293 scaleRect(r, scale);
294 r.offset(cx, cy);
295 }
296 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800297
Winson Chung3e803c72018-01-29 11:16:32 -0800298 public static void scaleRect(Rect r, float scale) {
299 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800300 r.left = (int) (r.left * scale + 0.5f);
301 r.top = (int) (r.top * scale + 0.5f);
302 r.right = (int) (r.right * scale + 0.5f);
303 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800304 }
305 }
306
Winson Chung3e803c72018-01-29 11:16:32 -0800307 public static void insetRect(Rect r, Rect insets) {
308 r.left = Math.min(r.right, r.left + insets.left);
309 r.top = Math.min(r.bottom, r.top + insets.top);
310 r.right = Math.max(r.left, r.right - insets.right);
311 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
312 }
313
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800314 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800315 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
316 if (scale < 1.0f) {
317 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
318 r.left += deltaX;
319 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700320
Jon Mirandae96798e2016-12-07 12:10:44 -0800321 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
322 r.top += deltaY;
323 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700324 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800325 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700326 }
327
Tony Wickhamb45444b2018-05-18 16:57:01 -0700328 /**
329 * Maps t from one range to another range.
330 * @param t The value to map.
331 * @param fromMin The lower bound of the range that t is being mapped from.
332 * @param fromMax The upper bound of the range that t is being mapped from.
333 * @param toMin The lower bound of the range that t is being mapped to.
334 * @param toMax The upper bound of the range that t is being mapped to.
335 * @return The mapped value of t.
336 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700337 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
338 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700339 if (fromMin == fromMax || toMin == toMax) {
340 Log.e(TAG, "mapToRange: range has 0 length");
341 return toMin;
342 }
Tonye4c2e2b2019-03-25 10:23:39 -0500343 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700344 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700345 }
346
Tonye4c2e2b2019-03-25 10:23:39 -0500347 public static float getProgress(float current, float min, float max) {
348 return Math.abs(current - min) / Math.abs(max - min);
349 }
350
Winson Chung3e803c72018-01-29 11:16:32 -0800351 public static float mapRange(float value, float min, float max) {
352 return min + (value * (max - min));
353 }
354
Sunny Goyal594d76d2014-11-06 10:12:54 -0800355 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700356 * Bounds parameter to the range [0, 1]
357 */
358 public static float saturate(float a) {
359 return boundToRange(a, 0, 1.0f);
360 }
361
362 /**
363 * Returns the compliment (1 - a) of the parameter.
364 */
365 public static float comp(float a) {
366 return 1 - a;
367 }
368
369 /**
370 * Returns the "probabilistic or" of a and b. (a + b - ab).
371 * Useful beyond probability, can be used to combine two unit progresses for example.
372 */
373 public static float or(float a, float b) {
374 float satA = saturate(a);
375 float satB = saturate(b);
376 return satA + satB - (satA * satB);
377 }
378
379 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700380 * Trims the string, removing all whitespace at the beginning and end of the string.
381 * Non-breaking whitespaces are also removed.
382 */
383 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700384 if (s == null) {
385 return null;
386 }
387
Winson Chung82b016c2015-05-08 17:00:10 -0700388 // Just strip any sequence of whitespace or java space characters from the beginning and end
389 Matcher m = sTrimPattern.matcher(s);
390 return m.replaceAll("$1");
391 }
Sunny Goyal70660032015-05-14 00:07:08 -0700392
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700393 /**
394 * Calculates the height of a given string at a specific text size.
395 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700396 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700397 Paint p = new Paint();
398 p.setTextSize(textSizePx);
399 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700400 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700401 }
402
Sunny Goyal70660032015-05-14 00:07:08 -0700403 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800404 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700405 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700406
Sunny Goyal35c7b192021-04-20 16:51:10 -0700407 public static float dpiFromPx(float size, int densityDpi) {
408 float densityRatio = (float) densityDpi / DisplayMetrics.DENSITY_DEFAULT;
Adam Cohen2e6da152015-05-06 11:42:25 -0700409 return (size / densityRatio);
410 }
vadimt1b383af2019-05-08 15:29:37 -0700411
Schneider Victor-tulias20bbaa32020-12-15 15:33:25 -0500412 /** Converts a dp value to pixels for the current device. */
413 public static int dpToPx(float dp) {
414 return (int) (dp * Resources.getSystem().getDisplayMetrics().density);
415 }
416
Adam Cohen2e6da152015-05-06 11:42:25 -0700417 public static int pxFromSp(float size, DisplayMetrics metrics) {
418 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
419 size, metrics));
420 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700421
Sunny Goyalefb7e842018-10-04 15:11:00 -0700422 public static String createDbSelectionQuery(String columnName, IntArray values) {
423 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700424 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700425
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700426 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700427 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
428 }
429
430 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700431 try {
432 Class clazz = Class.forName("android.os.SystemProperties");
433 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700434 String value = (String) getter.invoke(null, property);
435 if (!TextUtils.isEmpty(value)) {
436 return value;
437 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700438 } catch (Exception e) {
439 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700440 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700441 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700442 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700443
444 /**
445 * Ensures that a value is within given bounds. Specifically:
446 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
447 * return upperBound; else return value unchanged.
448 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700449 public static int boundToRange(int value, int lowerBound, int upperBound) {
450 return Math.max(lowerBound, Math.min(value, upperBound));
451 }
452
453 /**
454 * @see #boundToRange(int, int, int).
455 */
456 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700457 return Math.max(lowerBound, Math.min(value, upperBound));
458 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700459
Sunny Goyale78e3d72015-09-24 11:23:31 -0700460 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700461 * @see #boundToRange(int, int, int).
462 */
463 public static long boundToRange(long value, long lowerBound, long upperBound) {
464 return Math.max(lowerBound, Math.min(value, upperBound));
465 }
466
467 /**
Sunny Goyal53e3b142021-01-13 16:18:34 -0800468 * Returns an intent for starting the default home activity
469 */
470 public static Intent createHomeIntent() {
471 return new Intent(Intent.ACTION_MAIN)
472 .addCategory(Intent.CATEGORY_HOME)
473 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
474 }
475
476 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700477 * Wraps a message with a TTS span, so that a different message is spoken than
478 * what is getting displayed.
479 * @param msg original message
480 * @param ttsMsg message to be spoken
481 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700482 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800483 SpannableString spanned = new SpannableString(msg);
484 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
485 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
486 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700487 }
Winson12fb9fc2015-10-01 15:34:08 -0700488
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700489 /**
490 * Prefixes a text with the provided icon
491 */
492 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
493 // Update the hint to contain the icon.
494 // Prefix the original hint with two spaces. The first space gets replaced by the icon
495 // using span. The second space is used for a singe space character between the hint
496 // and the icon.
497 SpannableString spanned = new SpannableString(" " + msg);
498 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
499 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
500 return spanned;
501 }
502
Sunny Goyalf7258242015-10-19 16:59:07 -0700503 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800504 // Use application context for shared preferences, so that we use a single cached instance
505 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700506 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
507 }
Tony Wickham112ac952015-11-12 12:31:50 -0800508
Sunny Goyal9d887a22017-06-08 14:00:43 -0700509 public static SharedPreferences getDevicePrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800510 // Use application context for shared preferences, so that we use a single cached instance
511 return context.getApplicationContext().getSharedPreferences(
Sunny Goyal9d887a22017-06-08 14:00:43 -0700512 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
513 }
514
Hyunyoung Song0de01172016-10-05 16:27:48 -0700515 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800516 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700517 }
518
Sunny Goyal712ee532016-11-04 10:19:58 -0700519 public static boolean isBinderSizeError(Exception e) {
520 return e.getCause() instanceof TransactionTooLargeException
521 || e.getCause() instanceof DeadObjectException;
522 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530523
Tracy Zhouc6060e62020-04-27 13:05:34 -0700524 public static boolean isGridOptionsEnabled(Context context) {
525 return isComponentEnabled(context.getPackageManager(),
526 context.getPackageName(),
Tracy Zhou0455d142021-01-27 14:05:01 -0800527 GridCustomizationsProvider.class.getName());
Tracy Zhouc6060e62020-04-27 13:05:34 -0700528 }
529
530 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
531 ComponentName componentName = new ComponentName(pkgName, clsName);
532 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
533
534 switch (componentEnabledSetting) {
535 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
536 return false;
537 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
538 return true;
539 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
540 default:
541 // We need to get the application info to get the component's default state
542 try {
543 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
544 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
545
546 if (packageInfo.providers != null) {
547 return Arrays.stream(packageInfo.providers).anyMatch(
548 pi -> pi.name.equals(clsName) && pi.isEnabled());
549 }
550
551 // the component is not declared in the AndroidManifest
552 return false;
553 } catch (PackageManager.NameNotFoundException e) {
554 // the package isn't installed on the device
555 return false;
556 }
557 }
558 }
559
Tony Wickham580edcf2017-02-09 08:28:52 -0800560 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700561 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
562 */
563 public static void postAsyncCallback(Handler handler, Runnable callback) {
564 Message msg = Message.obtain(handler, callback);
565 msg.setAsynchronous(true);
566 handler.sendMessage(msg);
567 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700568
Sunny Goyal415f1732018-11-29 10:33:47 -0800569 /**
570 * Parses a string encoded using {@link #getPointString(int, int)}
571 */
572 public static Point parsePoint(String point) {
573 String[] split = point.split(",");
574 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
575 }
576
577 /**
578 * Encodes a point to string to that it can be persisted atomically.
579 */
580 public static String getPointString(int x, int y) {
581 return String.format(Locale.ENGLISH, "%d,%d", x, y);
582 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800583
Tony573c3e12019-02-22 13:10:59 -0800584 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
585 try {
586 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800587 } catch (IllegalArgumentException e) {}
588 }
589
590 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700591 * Returns the full drawable for info without any flattening or pre-processing.
592 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800593 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700594 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800595 */
596 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700597 Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800598 LauncherAppState appState = LauncherAppState.getInstance(launcher);
599 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700600 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800601 .resolveActivity(info.getIntent(), info.user);
602 outObj[0] = activityInfo;
Sunny Goyal9f2acdd2021-04-15 16:47:47 -0700603 return activityInfo == null ? null : new IconProvider(launcher).getIcon(
Sunny Goyal14168432019-10-24 15:59:49 -0700604 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800605 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
606 if (info instanceof PendingAddShortcutInfo) {
607 ShortcutConfigActivityInfo activityInfo =
608 ((PendingAddShortcutInfo) info).activityInfo;
609 outObj[0] = activityInfo;
610 return activityInfo.getFullResIcon(appState.getIconCache());
611 }
Sunny Goyalfa395362019-12-11 10:00:47 -0800612 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
613 .buildRequest(launcher)
614 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800615 if (si.isEmpty()) {
616 return null;
617 } else {
618 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800619 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800620 appState.getInvariantDeviceProfile().fillResIconDpi);
621 }
622 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
623 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
624 launcher, info.id, new Point(width, height));
625 if (icon == null) {
626 return null;
627 }
628 outObj[0] = icon;
629 return icon;
630 } else {
631 return null;
632 }
Tony573c3e12019-02-22 13:10:59 -0800633 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700634
Jon Miranda40285752019-05-14 15:17:30 -0700635 /**
636 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
637 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
638 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
639 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
640 **/
641 @TargetApi(Build.VERSION_CODES.O)
642 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
643 LauncherAppState appState = LauncherAppState.getInstance(launcher);
644 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
645 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
646 boolean iconBadged = (info instanceof ItemInfoWithIcon)
647 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
648 if ((info.id == ItemInfo.NO_ID && !iconBadged)
649 || !(obj instanceof ShortcutInfo)) {
650 // The item is not yet added on home screen.
651 return new FixedSizeEmptyDrawable(iconSize);
652 }
653 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800654 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
655 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800656 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700657 float insetFraction = (iconSize - badgeSize) / iconSize;
658 return new InsetDrawable(new FastBitmapDrawable(badge),
659 insetFraction, insetFraction, 0, 0);
660 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
661 return ((FolderAdaptiveIcon) obj).getBadge();
662 } else {
663 return launcher.getPackageManager()
664 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
665 }
666 }
667
Sunny Goyal53116c62020-08-07 16:32:18 -0700668 /**
669 * @return true is the extra is either null or is of type {@param type}
670 */
671 public static boolean isValidExtraType(Intent intent, String key, Class type) {
672 Object extra = intent.getParcelableExtra(key);
673 return extra == null || type.isInstance(extra);
674 }
675
Sunny Goyal878aa332019-05-20 12:40:42 -0700676 public static float squaredHypot(float x, float y) {
677 return x * x + y * y;
678 }
679
680 public static float squaredTouchSlop(Context context) {
681 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
682 return slop * slop;
683 }
684
Sunny Goyal733e3c62020-09-29 10:32:32 -0700685 /**
686 * Helper method to create a content provider
687 */
688 public static ContentObserver newContentObserver(Handler handler, Consumer<Uri> command) {
689 return new ContentObserver(handler) {
690 @Override
691 public void onChange(boolean selfChange, Uri uri) {
692 command.accept(uri);
693 }
694 };
695 }
696
Pat Manning0fe73262021-03-09 13:08:06 +0000697 /**
698 * Compares the ratio of two quantities and returns whether that ratio is greater than the
699 * provided bound. Order of quantities does not matter. Bound should be a decimal representation
700 * of a percentage.
701 */
702 public static boolean isRelativePercentDifferenceGreaterThan(float first, float second,
703 float bound) {
704 return (Math.abs(first - second) / Math.abs((first + second) / 2.0f)) > bound;
705 }
706
[1;3Ca608d812021-01-22 13:34:46 -0800707 /**
708 * Rotates `inOutBounds` by `delta` 90-degree increments. Rotation is visually CCW. Parent
709 * sizes represent the "space" that will rotate carrying inOutBounds along with it to determine
710 * the final bounds.
711 */
712 public static void rotateBounds(Rect inOutBounds, int parentWidth, int parentHeight,
713 int delta) {
714 int rdelta = ((delta % 4) + 4) % 4;
715 int origLeft = inOutBounds.left;
716 switch (rdelta) {
717 case 0:
718 return;
719 case 1:
720 inOutBounds.left = inOutBounds.top;
721 inOutBounds.top = parentWidth - inOutBounds.right;
722 inOutBounds.right = inOutBounds.bottom;
723 inOutBounds.bottom = parentWidth - origLeft;
724 return;
725 case 2:
726 inOutBounds.left = parentWidth - inOutBounds.right;
727 inOutBounds.right = parentWidth - origLeft;
728 return;
729 case 3:
730 inOutBounds.left = parentHeight - inOutBounds.bottom;
731 inOutBounds.bottom = inOutBounds.right;
732 inOutBounds.right = parentHeight - inOutBounds.top;
733 inOutBounds.top = origLeft;
734 return;
735 }
736 }
737
Zak Cohenec4407b2021-04-01 10:49:12 -0700738 /**
739 * Make a color filter that blends a color into the destination based on a scalable amout.
740 *
741 * @param color to blend in.
742 * @param tintAmount [0-1] 0 no tinting, 1 full color.
743 * @return ColorFilter for tinting, or {@code null} if no filter is needed.
744 */
745 public static ColorFilter makeColorTintingColorFilter(int color, float tintAmount) {
746 if (tintAmount == 0f) {
747 return null;
748 }
749 return new LightingColorFilter(
750 // This isn't blending in white, its making a multiplication mask for the base color
751 ColorUtils.blendARGB(Color.WHITE, 0, tintAmount),
752 ColorUtils.blendARGB(0, color, tintAmount));
753 }
754
Jon Miranda40285752019-05-14 15:17:30 -0700755 private static class FixedSizeEmptyDrawable extends ColorDrawable {
756
757 private final int mSize;
758
759 public FixedSizeEmptyDrawable(int size) {
760 super(Color.TRANSPARENT);
761 mSize = size;
762 }
763
764 @Override
765 public int getIntrinsicHeight() {
766 return mSize;
767 }
768
769 @Override
770 public int getIntrinsicWidth() {
771 return mSize;
772 }
773 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800774}