blob: 51d8e665d022f76dd9b444f6b02bac4536e63a7a [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;
Winson Chungc763c4e2013-07-19 13:49:06 -070040import android.graphics.Matrix;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080041import android.graphics.Paint;
Sunny Goyal415f1732018-11-29 10:33:47 -080042import android.graphics.Point;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080043import android.graphics.Rect;
Sunny Goyalb1e2e292018-02-21 10:14:30 -080044import android.graphics.RectF;
Jon Miranda40285752019-05-14 15:17:30 -070045import android.graphics.drawable.ColorDrawable;
Jon Miranda1a49fb52019-02-19 15:34:41 -080046import android.graphics.drawable.Drawable;
Jon Miranda40285752019-05-14 15:17:30 -070047import android.graphics.drawable.InsetDrawable;
Sunny Goyal733e3c62020-09-29 10:32:32 -070048import android.net.Uri;
Sandeep Siddhartha2efc7d92014-05-16 17:21:15 -070049import android.os.Build;
Sunny Goyal712ee532016-11-04 10:19:58 -070050import android.os.DeadObjectException;
Sunny Goyal3483c522018-04-12 11:23:33 -070051import android.os.Handler;
52import android.os.Message;
Sunny Goyal712ee532016-11-04 10:19:58 -070053import android.os.TransactionTooLargeException;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070054import android.provider.Settings;
Sunny Goyale78e3d72015-09-24 11:23:31 -070055import android.text.Spannable;
56import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070057import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070058import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070059import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020060import android.util.Log;
Adam Cohen2e6da152015-05-06 11:42:25 -070061import android.util.TypedValue;
Tonyd5a3df72019-03-13 10:12:01 -050062import android.view.MotionEvent;
Winson Chungc763c4e2013-07-19 13:49:06 -070063import android.view.View;
Sunny Goyal878aa332019-05-20 12:40:42 -070064import android.view.ViewConfiguration;
Sunny Goyal0f3af752018-06-08 13:01:04 -070065import android.view.animation.Interpolator;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070066
Sunny Goyal0addbf02020-04-28 14:17:35 -070067import androidx.core.os.BuildCompat;
68
Jon Miranda1a49fb52019-02-19 15:34:41 -080069import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
Tracy Zhou0455d142021-01-27 14:05:01 -080070import com.android.launcher3.graphics.GridCustomizationsProvider;
Sunny Goyal5b636eb2019-05-29 01:09:06 -070071import com.android.launcher3.graphics.TintedDrawableSpan;
Sunny Goyal14168432019-10-24 15:59:49 -070072import com.android.launcher3.icons.IconProvider;
Jon Miranda40285752019-05-14 15:17:30 -070073import com.android.launcher3.icons.LauncherIcons;
Sunny Goyalfa395362019-12-11 10:00:47 -080074import com.android.launcher3.icons.ShortcutCachingLogic;
Sunny Goyale396abf2020-04-06 15:11:17 -070075import com.android.launcher3.model.data.ItemInfo;
76import com.android.launcher3.model.data.ItemInfoWithIcon;
Sunny Goyale7b00122019-10-02 16:13:34 -070077import com.android.launcher3.pm.ShortcutConfigActivityInfo;
Jon Miranda1a49fb52019-02-19 15:34:41 -080078import com.android.launcher3.shortcuts.ShortcutKey;
Sunny Goyalfa395362019-12-11 10:00:47 -080079import com.android.launcher3.shortcuts.ShortcutRequest;
Sunny Goyalefb7e842018-10-04 15:11:00 -070080import com.android.launcher3.util.IntArray;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070081import com.android.launcher3.util.PackageManagerHelper;
Jon Miranda1a49fb52019-02-19 15:34:41 -080082import com.android.launcher3.widget.PendingAddShortcutInfo;
Sunny Goyal6c56c682015-07-16 14:09:05 -070083
Sunny Goyal25aba0a2015-07-16 15:07:47 -070084import java.lang.reflect.Method;
Tracy Zhouc6060e62020-04-27 13:05:34 -070085import java.util.Arrays;
Jon Miranda1a49fb52019-02-19 15:34:41 -080086import java.util.List;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070087import java.util.Locale;
Sunny Goyal733e3c62020-09-29 10:32:32 -070088import java.util.function.Consumer;
Winson Chung82b016c2015-05-08 17:00:10 -070089import java.util.regex.Matcher;
90import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080091
92/**
93 * Various utilities shared amongst the Launcher's classes.
94 */
Mathew Inwood72fbec12013-11-19 15:45:07 +000095public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070096
Joe Onorato1291a8c2009-09-15 15:07:25 -040097 private static final String TAG = "Launcher.Utilities";
98
Winson Chung82b016c2015-05-08 17:00:10 -070099 private static final Pattern sTrimPattern =
100 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
101
Sunny Goyal53d7ee42015-05-22 12:25:45 -0700102 private static final int[] sLoc0 = new int[2];
103 private static final int[] sLoc1 = new int[2];
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700104 private static final Matrix sMatrix = new Matrix();
105 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +0100106
Pinyao Ting49a3e692019-07-26 12:28:38 -0700107 public static final String[] EMPTY_STRING_ARRAY = new String[0];
108 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0];
109
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000110 public static final boolean ATLEAST_P = Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Sunny Goyal0addbf02020-04-28 14:17:35 -0700111
Sunny Goyal03340472019-05-17 16:57:12 -0700112 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700113
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000114 public static final boolean ATLEAST_R = Build.VERSION.SDK_INT >= Build.VERSION_CODES.R;
115
116 public static final boolean ATLEAST_S = BuildCompat.isAtLeastS();
Tony Mak6eeb0402018-01-03 14:41:31 +0000117
Sunny Goyal49f19f02017-01-05 14:36:02 -0800118 /**
Tonyd5a3df72019-03-13 10:12:01 -0500119 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
120 */
121 public static final int EDGE_NAV_BAR = 1 << 8;
122
123 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800124 * Indicates if the device has a debug build. Should only be used to store additional info or
125 * add extra logging and not for changing the app behavior.
126 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200127 public static final boolean IS_DEBUG_DEVICE =
128 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
129 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800130
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700131 public static boolean isDevelopersOptionsEnabled(Context context) {
132 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
133 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
134 }
135
Sunny Goyal6f866092016-03-17 17:04:15 -0700136 // An intent extra to indicate the horizontal scroll of the wallpaper.
137 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
Hyunyoung Song29e5d442019-02-07 10:33:55 -0800138 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
Sunny Goyal6f866092016-03-17 17:04:15 -0700139
Wesley.CW Wang0f5c9db2020-09-08 16:33:11 +0800140 // An intent extra to indicate the launch source by launcher.
141 public static final String EXTRA_WALLPAPER_LAUNCH_SOURCE =
142 "com.android.wallpaper.LAUNCH_SOURCE";
143
Vadim Tryshevc2950982018-10-04 16:33:45 -0700144 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700145 ActivityManager.isRunningInTestHarness();
146
Vadim Tryshevc2950982018-10-04 16:33:45 -0700147 public static void enableRunningInTestHarnessForTests() {
148 IS_RUNNING_IN_TEST_HARNESS = true;
149 }
150
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800151 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100152 return Log.isLoggable(propertyName, Log.VERBOSE);
153 }
154
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700155 public static boolean existsStyleWallpapers(Context context) {
156 ResolveInfo ri = context.getPackageManager().resolveActivity(
157 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
158 return ri != null;
159 }
160
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800161 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700162 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
163 * coordinates.
164 *
165 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700166 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700167 * @param coord The coordinate that we want mapped.
168 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
169 * sometimes this is relevant as in a child's coordinates within the descendant.
170 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
171 * this scale factor is assumed to be equal in X and Y, and so if at any point this
172 * assumption fails, we will need to return a pair of scale factors.
173 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700174 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700175 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
176 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700177 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700178 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700179
Sunny Goyalae6e3182019-04-30 12:04:37 -0700180 /**
181 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
182 * coordinates.
183 *
184 * @param descendant The descendant to which the passed coordinate is relative.
185 * @param ancestor The root view to make the coordinates relative to.
186 * @param coord The coordinate that we want mapped.
187 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
188 * sometimes this is relevant as in a child's coordinates within the descendant.
189 * @param ignoreTransform If true, view transform is ignored
190 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
191 * this scale factor is assumed to be equal in X and Y, and so if at any point this
192 * assumption fails, we will need to return a pair of scale factors.
193 */
194 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700195 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700196 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700197 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700198 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700199 // For TextViews, scroll has a meaning which relates to the text position
200 // which is very strange... ignore the scroll.
201 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700202 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700203 }
204
Sunny Goyalc4d32012020-04-03 17:10:11 -0700205 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700206 v.getMatrix().mapPoints(coord);
207 }
208 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700209 scale *= v.getScaleX();
210
Winson Chungc763c4e2013-07-19 13:49:06 -0700211 v = (View) v.getParent();
212 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700213 return scale;
214 }
215
216 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700217 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700218 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700219 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700220 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700221 View v = descendant;
222 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700223 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
224 sMatrix.postConcat(v.getMatrix());
225 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700226 v = (View) v.getParent();
227 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700228 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
229 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700230 sInverseMatrix.mapPoints(coord);
231 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700232
Sunny Goyalae6e3182019-04-30 12:04:37 -0700233 /**
234 * Sets {@param out} to be same as {@param in} by rounding individual values
235 */
236 public static void roundArray(float[] in, int[] out) {
237 for (int i = 0; i < in.length; i++) {
238 out[i] = Math.round(in[i]);
239 }
240 }
241
242 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
243 for (int i = 0; i < points.length; i += 2) {
244 points[i] += offsetX;
245 points[i + 1] += offsetY;
246 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700247 }
248
Jason Monk02dd7ae2014-04-15 15:23:31 -0400249 /**
250 * Utility method to determine whether the given point, in local coordinates,
251 * is inside the view, where the area of the view is expanded by the slop factor.
252 * This method is called while processing touch-move events to determine if the event
253 * is still within the view.
254 */
255 public static boolean pointInView(View v, float localX, float localY, float slop) {
256 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
257 localY < (v.getHeight() + slop);
258 }
259
Sunny Goyala52ecb02016-12-16 15:04:51 -0800260 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700261 v0.getLocationInWindow(sLoc0);
262 v1.getLocationInWindow(sLoc1);
263
264 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
265 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
266 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
267 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800268 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700269 }
270
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800271 public static void scaleRectFAboutCenter(RectF r, float scale) {
272 if (scale != 1.0f) {
273 float cx = r.centerX();
274 float cy = r.centerY();
275 r.offset(-cx, -cy);
276 r.left = r.left * scale;
277 r.top = r.top * scale ;
278 r.right = r.right * scale;
279 r.bottom = r.bottom * scale;
280 r.offset(cx, cy);
281 }
282 }
283
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800284 public static void scaleRectAboutCenter(Rect r, float scale) {
285 if (scale != 1.0f) {
286 int cx = r.centerX();
287 int cy = r.centerY();
288 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800289 scaleRect(r, scale);
290 r.offset(cx, cy);
291 }
292 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800293
Winson Chung3e803c72018-01-29 11:16:32 -0800294 public static void scaleRect(Rect r, float scale) {
295 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800296 r.left = (int) (r.left * scale + 0.5f);
297 r.top = (int) (r.top * scale + 0.5f);
298 r.right = (int) (r.right * scale + 0.5f);
299 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800300 }
301 }
302
Winson Chung3e803c72018-01-29 11:16:32 -0800303 public static void insetRect(Rect r, Rect insets) {
304 r.left = Math.min(r.right, r.left + insets.left);
305 r.top = Math.min(r.bottom, r.top + insets.top);
306 r.right = Math.max(r.left, r.right - insets.right);
307 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
308 }
309
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800310 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800311 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
312 if (scale < 1.0f) {
313 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
314 r.left += deltaX;
315 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700316
Jon Mirandae96798e2016-12-07 12:10:44 -0800317 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
318 r.top += deltaY;
319 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700320 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800321 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700322 }
323
Tony Wickhamb45444b2018-05-18 16:57:01 -0700324 /**
325 * Maps t from one range to another range.
326 * @param t The value to map.
327 * @param fromMin The lower bound of the range that t is being mapped from.
328 * @param fromMax The upper bound of the range that t is being mapped from.
329 * @param toMin The lower bound of the range that t is being mapped to.
330 * @param toMax The upper bound of the range that t is being mapped to.
331 * @return The mapped value of t.
332 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700333 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
334 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700335 if (fromMin == fromMax || toMin == toMax) {
336 Log.e(TAG, "mapToRange: range has 0 length");
337 return toMin;
338 }
Tonye4c2e2b2019-03-25 10:23:39 -0500339 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700340 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700341 }
342
Tonye4c2e2b2019-03-25 10:23:39 -0500343 public static float getProgress(float current, float min, float max) {
344 return Math.abs(current - min) / Math.abs(max - min);
345 }
346
Winson Chung3e803c72018-01-29 11:16:32 -0800347 public static float mapRange(float value, float min, float max) {
348 return min + (value * (max - min));
349 }
350
Sunny Goyal594d76d2014-11-06 10:12:54 -0800351 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700352 * Bounds parameter to the range [0, 1]
353 */
354 public static float saturate(float a) {
355 return boundToRange(a, 0, 1.0f);
356 }
357
358 /**
359 * Returns the compliment (1 - a) of the parameter.
360 */
361 public static float comp(float a) {
362 return 1 - a;
363 }
364
365 /**
366 * Returns the "probabilistic or" of a and b. (a + b - ab).
367 * Useful beyond probability, can be used to combine two unit progresses for example.
368 */
369 public static float or(float a, float b) {
370 float satA = saturate(a);
371 float satB = saturate(b);
372 return satA + satB - (satA * satB);
373 }
374
375 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700376 * Trims the string, removing all whitespace at the beginning and end of the string.
377 * Non-breaking whitespaces are also removed.
378 */
379 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700380 if (s == null) {
381 return null;
382 }
383
Winson Chung82b016c2015-05-08 17:00:10 -0700384 // Just strip any sequence of whitespace or java space characters from the beginning and end
385 Matcher m = sTrimPattern.matcher(s);
386 return m.replaceAll("$1");
387 }
Sunny Goyal70660032015-05-14 00:07:08 -0700388
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700389 /**
390 * Calculates the height of a given string at a specific text size.
391 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700392 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700393 Paint p = new Paint();
394 p.setTextSize(textSizePx);
395 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700396 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700397 }
398
Sunny Goyal70660032015-05-14 00:07:08 -0700399 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800400 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700401 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700402
Tony Wickham4fdba142019-11-04 16:23:51 -0800403 public static float dpiFromPx(float size, DisplayMetrics metrics) {
Adam Cohen2e6da152015-05-06 11:42:25 -0700404 float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
405 return (size / densityRatio);
406 }
vadimt1b383af2019-05-08 15:29:37 -0700407
Schneider Victor-tulias20bbaa32020-12-15 15:33:25 -0500408 /** Converts a dp value to pixels for the current device. */
409 public static int dpToPx(float dp) {
410 return (int) (dp * Resources.getSystem().getDisplayMetrics().density);
411 }
412
Adam Cohen2e6da152015-05-06 11:42:25 -0700413 public static int pxFromSp(float size, DisplayMetrics metrics) {
414 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
415 size, metrics));
416 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700417
Sunny Goyalefb7e842018-10-04 15:11:00 -0700418 public static String createDbSelectionQuery(String columnName, IntArray values) {
419 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700420 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700421
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700422 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700423 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
424 }
425
426 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700427 try {
428 Class clazz = Class.forName("android.os.SystemProperties");
429 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700430 String value = (String) getter.invoke(null, property);
431 if (!TextUtils.isEmpty(value)) {
432 return value;
433 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700434 } catch (Exception e) {
435 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700436 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700437 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700438 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700439
440 /**
441 * Ensures that a value is within given bounds. Specifically:
442 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
443 * return upperBound; else return value unchanged.
444 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700445 public static int boundToRange(int value, int lowerBound, int upperBound) {
446 return Math.max(lowerBound, Math.min(value, upperBound));
447 }
448
449 /**
450 * @see #boundToRange(int, int, int).
451 */
452 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700453 return Math.max(lowerBound, Math.min(value, upperBound));
454 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700455
Sunny Goyale78e3d72015-09-24 11:23:31 -0700456 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700457 * @see #boundToRange(int, int, int).
458 */
459 public static long boundToRange(long value, long lowerBound, long upperBound) {
460 return Math.max(lowerBound, Math.min(value, upperBound));
461 }
462
463 /**
Sunny Goyal53e3b142021-01-13 16:18:34 -0800464 * Returns an intent for starting the default home activity
465 */
466 public static Intent createHomeIntent() {
467 return new Intent(Intent.ACTION_MAIN)
468 .addCategory(Intent.CATEGORY_HOME)
469 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
470 }
471
472 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700473 * Wraps a message with a TTS span, so that a different message is spoken than
474 * what is getting displayed.
475 * @param msg original message
476 * @param ttsMsg message to be spoken
477 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700478 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800479 SpannableString spanned = new SpannableString(msg);
480 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
481 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
482 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700483 }
Winson12fb9fc2015-10-01 15:34:08 -0700484
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700485 /**
486 * Prefixes a text with the provided icon
487 */
488 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
489 // Update the hint to contain the icon.
490 // Prefix the original hint with two spaces. The first space gets replaced by the icon
491 // using span. The second space is used for a singe space character between the hint
492 // and the icon.
493 SpannableString spanned = new SpannableString(" " + msg);
494 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
495 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
496 return spanned;
497 }
498
Sunny Goyalf7258242015-10-19 16:59:07 -0700499 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800500 // Use application context for shared preferences, so that we use a single cached instance
501 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700502 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
503 }
Tony Wickham112ac952015-11-12 12:31:50 -0800504
Sunny Goyal9d887a22017-06-08 14:00:43 -0700505 public static SharedPreferences getDevicePrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800506 // Use application context for shared preferences, so that we use a single cached instance
507 return context.getApplicationContext().getSharedPreferences(
Sunny Goyal9d887a22017-06-08 14:00:43 -0700508 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
509 }
510
Hyunyoung Song0de01172016-10-05 16:27:48 -0700511 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800512 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700513 }
514
Sunny Goyal712ee532016-11-04 10:19:58 -0700515 public static boolean isBinderSizeError(Exception e) {
516 return e.getCause() instanceof TransactionTooLargeException
517 || e.getCause() instanceof DeadObjectException;
518 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530519
Tracy Zhouc6060e62020-04-27 13:05:34 -0700520 public static boolean isGridOptionsEnabled(Context context) {
521 return isComponentEnabled(context.getPackageManager(),
522 context.getPackageName(),
Tracy Zhou0455d142021-01-27 14:05:01 -0800523 GridCustomizationsProvider.class.getName());
Tracy Zhouc6060e62020-04-27 13:05:34 -0700524 }
525
526 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
527 ComponentName componentName = new ComponentName(pkgName, clsName);
528 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
529
530 switch (componentEnabledSetting) {
531 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
532 return false;
533 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
534 return true;
535 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
536 default:
537 // We need to get the application info to get the component's default state
538 try {
539 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
540 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
541
542 if (packageInfo.providers != null) {
543 return Arrays.stream(packageInfo.providers).anyMatch(
544 pi -> pi.name.equals(clsName) && pi.isEnabled());
545 }
546
547 // the component is not declared in the AndroidManifest
548 return false;
549 } catch (PackageManager.NameNotFoundException e) {
550 // the package isn't installed on the device
551 return false;
552 }
553 }
554 }
555
Tony Wickham580edcf2017-02-09 08:28:52 -0800556 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700557 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
558 */
559 public static void postAsyncCallback(Handler handler, Runnable callback) {
560 Message msg = Message.obtain(handler, callback);
561 msg.setAsynchronous(true);
562 handler.sendMessage(msg);
563 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700564
Sunny Goyal415f1732018-11-29 10:33:47 -0800565 /**
566 * Parses a string encoded using {@link #getPointString(int, int)}
567 */
568 public static Point parsePoint(String point) {
569 String[] split = point.split(",");
570 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
571 }
572
573 /**
574 * Encodes a point to string to that it can be persisted atomically.
575 */
576 public static String getPointString(int x, int y) {
577 return String.format(Locale.ENGLISH, "%d,%d", x, y);
578 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800579
Tony573c3e12019-02-22 13:10:59 -0800580 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
581 try {
582 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800583 } catch (IllegalArgumentException e) {}
584 }
585
586 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700587 * Returns the full drawable for info without any flattening or pre-processing.
588 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800589 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700590 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800591 */
592 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700593 Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800594 LauncherAppState appState = LauncherAppState.getInstance(launcher);
595 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700596 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800597 .resolveActivity(info.getIntent(), info.user);
598 outObj[0] = activityInfo;
Sunny Goyal14168432019-10-24 15:59:49 -0700599 return activityInfo == null ? null : new IconProvider(launcher).getIconForUI(
600 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800601 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
602 if (info instanceof PendingAddShortcutInfo) {
603 ShortcutConfigActivityInfo activityInfo =
604 ((PendingAddShortcutInfo) info).activityInfo;
605 outObj[0] = activityInfo;
606 return activityInfo.getFullResIcon(appState.getIconCache());
607 }
Samuel Fufaadbe9b62020-06-11 15:15:02 -0700608 if (info.getIntent() == null || info.getIntent().getPackage() == null) return null;
Sunny Goyalfa395362019-12-11 10:00:47 -0800609 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
610 .buildRequest(launcher)
611 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800612 if (si.isEmpty()) {
613 return null;
614 } else {
615 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800616 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800617 appState.getInvariantDeviceProfile().fillResIconDpi);
618 }
619 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
620 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
621 launcher, info.id, new Point(width, height));
622 if (icon == null) {
623 return null;
624 }
625 outObj[0] = icon;
626 return icon;
627 } else {
628 return null;
629 }
Tony573c3e12019-02-22 13:10:59 -0800630 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700631
Jon Miranda40285752019-05-14 15:17:30 -0700632 /**
633 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
634 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
635 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
636 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
637 **/
638 @TargetApi(Build.VERSION_CODES.O)
639 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
640 LauncherAppState appState = LauncherAppState.getInstance(launcher);
641 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
642 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
643 boolean iconBadged = (info instanceof ItemInfoWithIcon)
644 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
645 if ((info.id == ItemInfo.NO_ID && !iconBadged)
646 || !(obj instanceof ShortcutInfo)) {
647 // The item is not yet added on home screen.
648 return new FixedSizeEmptyDrawable(iconSize);
649 }
650 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800651 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
652 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800653 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700654 float insetFraction = (iconSize - badgeSize) / iconSize;
655 return new InsetDrawable(new FastBitmapDrawable(badge),
656 insetFraction, insetFraction, 0, 0);
657 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
658 return ((FolderAdaptiveIcon) obj).getBadge();
659 } else {
660 return launcher.getPackageManager()
661 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
662 }
663 }
664
Sunny Goyal53116c62020-08-07 16:32:18 -0700665 /**
666 * @return true is the extra is either null or is of type {@param type}
667 */
668 public static boolean isValidExtraType(Intent intent, String key, Class type) {
669 Object extra = intent.getParcelableExtra(key);
670 return extra == null || type.isInstance(extra);
671 }
672
Sunny Goyal878aa332019-05-20 12:40:42 -0700673 public static float squaredHypot(float x, float y) {
674 return x * x + y * y;
675 }
676
677 public static float squaredTouchSlop(Context context) {
678 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
679 return slop * slop;
680 }
681
Sunny Goyal733e3c62020-09-29 10:32:32 -0700682 /**
683 * Helper method to create a content provider
684 */
685 public static ContentObserver newContentObserver(Handler handler, Consumer<Uri> command) {
686 return new ContentObserver(handler) {
687 @Override
688 public void onChange(boolean selfChange, Uri uri) {
689 command.accept(uri);
690 }
691 };
692 }
693
Jon Miranda40285752019-05-14 15:17:30 -0700694 private static class FixedSizeEmptyDrawable extends ColorDrawable {
695
696 private final int mSize;
697
698 public FixedSizeEmptyDrawable(int size) {
699 super(Color.TRANSPARENT);
700 mSize = size;
701 }
702
703 @Override
704 public int getIntrinsicHeight() {
705 return mSize;
706 }
707
708 @Override
709 public int getIntrinsicWidth() {
710 return mSize;
711 }
712 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800713}