blob: 42d6b1246c067a3bc9ffd7d98b7527e1e9f65ca1 [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 Zhouc6060e62020-04-27 13:05:34 -070070import com.android.launcher3.graphics.GridOptionsProvider;
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-tulias229497d2021-01-07 19:44:44 +0000110 public static final boolean ATLEAST_R = BuildCompat.isAtLeastR();
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-tulias229497d2021-01-07 19:44:44 +0000114 public static final boolean ATLEAST_P =
115 Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Tony Mak6eeb0402018-01-03 14:41:31 +0000116
Sunny Goyal49f19f02017-01-05 14:36:02 -0800117 /**
Tonyd5a3df72019-03-13 10:12:01 -0500118 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
119 */
120 public static final int EDGE_NAV_BAR = 1 << 8;
121
122 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800123 * Indicates if the device has a debug build. Should only be used to store additional info or
124 * add extra logging and not for changing the app behavior.
125 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200126 public static final boolean IS_DEBUG_DEVICE =
127 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
128 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800129
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700130 public static boolean isDevelopersOptionsEnabled(Context context) {
131 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
132 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
133 }
134
Sunny Goyal6f866092016-03-17 17:04:15 -0700135 // An intent extra to indicate the horizontal scroll of the wallpaper.
136 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
Hyunyoung Song29e5d442019-02-07 10:33:55 -0800137 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
Sunny Goyal6f866092016-03-17 17:04:15 -0700138
Wesley.CW Wang0f5c9db2020-09-08 16:33:11 +0800139 // An intent extra to indicate the launch source by launcher.
140 public static final String EXTRA_WALLPAPER_LAUNCH_SOURCE =
141 "com.android.wallpaper.LAUNCH_SOURCE";
142
Vadim Tryshevc2950982018-10-04 16:33:45 -0700143 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700144 ActivityManager.isRunningInTestHarness();
145
Vadim Tryshevc2950982018-10-04 16:33:45 -0700146 public static void enableRunningInTestHarnessForTests() {
147 IS_RUNNING_IN_TEST_HARNESS = true;
148 }
149
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800150 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100151 return Log.isLoggable(propertyName, Log.VERBOSE);
152 }
153
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700154 public static boolean existsStyleWallpapers(Context context) {
155 ResolveInfo ri = context.getPackageManager().resolveActivity(
156 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
157 return ri != null;
158 }
159
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800160 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700161 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
162 * coordinates.
163 *
164 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700165 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700166 * @param coord The coordinate that we want mapped.
167 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
168 * sometimes this is relevant as in a child's coordinates within the descendant.
169 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
170 * this scale factor is assumed to be equal in X and Y, and so if at any point this
171 * assumption fails, we will need to return a pair of scale factors.
172 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700173 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700174 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
175 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700176 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700177 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700178
Sunny Goyalae6e3182019-04-30 12:04:37 -0700179 /**
180 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
181 * coordinates.
182 *
183 * @param descendant The descendant to which the passed coordinate is relative.
184 * @param ancestor The root view to make the coordinates relative to.
185 * @param coord The coordinate that we want mapped.
186 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
187 * sometimes this is relevant as in a child's coordinates within the descendant.
188 * @param ignoreTransform If true, view transform is ignored
189 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
190 * this scale factor is assumed to be equal in X and Y, and so if at any point this
191 * assumption fails, we will need to return a pair of scale factors.
192 */
193 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700194 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700195 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700196 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700197 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700198 // For TextViews, scroll has a meaning which relates to the text position
199 // which is very strange... ignore the scroll.
200 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700201 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700202 }
203
Sunny Goyalc4d32012020-04-03 17:10:11 -0700204 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700205 v.getMatrix().mapPoints(coord);
206 }
207 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700208 scale *= v.getScaleX();
209
Winson Chungc763c4e2013-07-19 13:49:06 -0700210 v = (View) v.getParent();
211 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700212 return scale;
213 }
214
215 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700216 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700217 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700218 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700219 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700220 View v = descendant;
221 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700222 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
223 sMatrix.postConcat(v.getMatrix());
224 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700225 v = (View) v.getParent();
226 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700227 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
228 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700229 sInverseMatrix.mapPoints(coord);
230 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700231
Sunny Goyalae6e3182019-04-30 12:04:37 -0700232 /**
233 * Sets {@param out} to be same as {@param in} by rounding individual values
234 */
235 public static void roundArray(float[] in, int[] out) {
236 for (int i = 0; i < in.length; i++) {
237 out[i] = Math.round(in[i]);
238 }
239 }
240
241 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
242 for (int i = 0; i < points.length; i += 2) {
243 points[i] += offsetX;
244 points[i + 1] += offsetY;
245 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700246 }
247
Jason Monk02dd7ae2014-04-15 15:23:31 -0400248 /**
249 * Utility method to determine whether the given point, in local coordinates,
250 * is inside the view, where the area of the view is expanded by the slop factor.
251 * This method is called while processing touch-move events to determine if the event
252 * is still within the view.
253 */
254 public static boolean pointInView(View v, float localX, float localY, float slop) {
255 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
256 localY < (v.getHeight() + slop);
257 }
258
Sunny Goyala52ecb02016-12-16 15:04:51 -0800259 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700260 v0.getLocationInWindow(sLoc0);
261 v1.getLocationInWindow(sLoc1);
262
263 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
264 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
265 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
266 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800267 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700268 }
269
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800270 public static void scaleRectFAboutCenter(RectF r, float scale) {
271 if (scale != 1.0f) {
272 float cx = r.centerX();
273 float cy = r.centerY();
274 r.offset(-cx, -cy);
275 r.left = r.left * scale;
276 r.top = r.top * scale ;
277 r.right = r.right * scale;
278 r.bottom = r.bottom * scale;
279 r.offset(cx, cy);
280 }
281 }
282
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800283 public static void scaleRectAboutCenter(Rect r, float scale) {
284 if (scale != 1.0f) {
285 int cx = r.centerX();
286 int cy = r.centerY();
287 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800288 scaleRect(r, scale);
289 r.offset(cx, cy);
290 }
291 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800292
Winson Chung3e803c72018-01-29 11:16:32 -0800293 public static void scaleRect(Rect r, float scale) {
294 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800295 r.left = (int) (r.left * scale + 0.5f);
296 r.top = (int) (r.top * scale + 0.5f);
297 r.right = (int) (r.right * scale + 0.5f);
298 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800299 }
300 }
301
Winson Chung3e803c72018-01-29 11:16:32 -0800302 public static void insetRect(Rect r, Rect insets) {
303 r.left = Math.min(r.right, r.left + insets.left);
304 r.top = Math.min(r.bottom, r.top + insets.top);
305 r.right = Math.max(r.left, r.right - insets.right);
306 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
307 }
308
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800309 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800310 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
311 if (scale < 1.0f) {
312 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
313 r.left += deltaX;
314 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700315
Jon Mirandae96798e2016-12-07 12:10:44 -0800316 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
317 r.top += deltaY;
318 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700319 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800320 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700321 }
322
Tony Wickhamb45444b2018-05-18 16:57:01 -0700323 /**
324 * Maps t from one range to another range.
325 * @param t The value to map.
326 * @param fromMin The lower bound of the range that t is being mapped from.
327 * @param fromMax The upper bound of the range that t is being mapped from.
328 * @param toMin The lower bound of the range that t is being mapped to.
329 * @param toMax The upper bound of the range that t is being mapped to.
330 * @return The mapped value of t.
331 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700332 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
333 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700334 if (fromMin == fromMax || toMin == toMax) {
335 Log.e(TAG, "mapToRange: range has 0 length");
336 return toMin;
337 }
Tonye4c2e2b2019-03-25 10:23:39 -0500338 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700339 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700340 }
341
Tonye4c2e2b2019-03-25 10:23:39 -0500342 public static float getProgress(float current, float min, float max) {
343 return Math.abs(current - min) / Math.abs(max - min);
344 }
345
Winson Chung3e803c72018-01-29 11:16:32 -0800346 public static float mapRange(float value, float min, float max) {
347 return min + (value * (max - min));
348 }
349
Sunny Goyal594d76d2014-11-06 10:12:54 -0800350 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700351 * Bounds parameter to the range [0, 1]
352 */
353 public static float saturate(float a) {
354 return boundToRange(a, 0, 1.0f);
355 }
356
357 /**
358 * Returns the compliment (1 - a) of the parameter.
359 */
360 public static float comp(float a) {
361 return 1 - a;
362 }
363
364 /**
365 * Returns the "probabilistic or" of a and b. (a + b - ab).
366 * Useful beyond probability, can be used to combine two unit progresses for example.
367 */
368 public static float or(float a, float b) {
369 float satA = saturate(a);
370 float satB = saturate(b);
371 return satA + satB - (satA * satB);
372 }
373
374 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700375 * Trims the string, removing all whitespace at the beginning and end of the string.
376 * Non-breaking whitespaces are also removed.
377 */
378 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700379 if (s == null) {
380 return null;
381 }
382
Winson Chung82b016c2015-05-08 17:00:10 -0700383 // Just strip any sequence of whitespace or java space characters from the beginning and end
384 Matcher m = sTrimPattern.matcher(s);
385 return m.replaceAll("$1");
386 }
Sunny Goyal70660032015-05-14 00:07:08 -0700387
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700388 /**
389 * Calculates the height of a given string at a specific text size.
390 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700391 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700392 Paint p = new Paint();
393 p.setTextSize(textSizePx);
394 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700395 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700396 }
397
Sunny Goyal70660032015-05-14 00:07:08 -0700398 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800399 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700400 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700401
Tony Wickham4fdba142019-11-04 16:23:51 -0800402 public static float dpiFromPx(float size, DisplayMetrics metrics) {
Adam Cohen2e6da152015-05-06 11:42:25 -0700403 float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
404 return (size / densityRatio);
405 }
vadimt1b383af2019-05-08 15:29:37 -0700406
Schneider Victor-tulias20bbaa32020-12-15 15:33:25 -0500407 /** Converts a dp value to pixels for the current device. */
408 public static int dpToPx(float dp) {
409 return (int) (dp * Resources.getSystem().getDisplayMetrics().density);
410 }
411
Adam Cohen2e6da152015-05-06 11:42:25 -0700412 public static int pxFromSp(float size, DisplayMetrics metrics) {
413 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
414 size, metrics));
415 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700416
Sunny Goyalefb7e842018-10-04 15:11:00 -0700417 public static String createDbSelectionQuery(String columnName, IntArray values) {
418 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700419 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700420
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700421 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700422 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
423 }
424
425 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700426 try {
427 Class clazz = Class.forName("android.os.SystemProperties");
428 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700429 String value = (String) getter.invoke(null, property);
430 if (!TextUtils.isEmpty(value)) {
431 return value;
432 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700433 } catch (Exception e) {
434 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700435 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700436 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700437 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700438
439 /**
440 * Ensures that a value is within given bounds. Specifically:
441 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
442 * return upperBound; else return value unchanged.
443 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700444 public static int boundToRange(int value, int lowerBound, int upperBound) {
445 return Math.max(lowerBound, Math.min(value, upperBound));
446 }
447
448 /**
449 * @see #boundToRange(int, int, int).
450 */
451 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700452 return Math.max(lowerBound, Math.min(value, upperBound));
453 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700454
Sunny Goyale78e3d72015-09-24 11:23:31 -0700455 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700456 * @see #boundToRange(int, int, int).
457 */
458 public static long boundToRange(long value, long lowerBound, long upperBound) {
459 return Math.max(lowerBound, Math.min(value, upperBound));
460 }
461
462 /**
Sunny Goyal53e3b142021-01-13 16:18:34 -0800463 * Returns an intent for starting the default home activity
464 */
465 public static Intent createHomeIntent() {
466 return new Intent(Intent.ACTION_MAIN)
467 .addCategory(Intent.CATEGORY_HOME)
468 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
469 }
470
471 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700472 * Wraps a message with a TTS span, so that a different message is spoken than
473 * what is getting displayed.
474 * @param msg original message
475 * @param ttsMsg message to be spoken
476 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700477 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800478 SpannableString spanned = new SpannableString(msg);
479 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
480 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
481 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700482 }
Winson12fb9fc2015-10-01 15:34:08 -0700483
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700484 /**
485 * Prefixes a text with the provided icon
486 */
487 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
488 // Update the hint to contain the icon.
489 // Prefix the original hint with two spaces. The first space gets replaced by the icon
490 // using span. The second space is used for a singe space character between the hint
491 // and the icon.
492 SpannableString spanned = new SpannableString(" " + msg);
493 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
494 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
495 return spanned;
496 }
497
Sunny Goyalf7258242015-10-19 16:59:07 -0700498 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800499 // Use application context for shared preferences, so that we use a single cached instance
500 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700501 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
502 }
Tony Wickham112ac952015-11-12 12:31:50 -0800503
Sunny Goyal9d887a22017-06-08 14:00:43 -0700504 public static SharedPreferences getDevicePrefs(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 Goyal9d887a22017-06-08 14:00:43 -0700507 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
508 }
509
Hyunyoung Song0de01172016-10-05 16:27:48 -0700510 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800511 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700512 }
513
Sunny Goyal712ee532016-11-04 10:19:58 -0700514 public static boolean isBinderSizeError(Exception e) {
515 return e.getCause() instanceof TransactionTooLargeException
516 || e.getCause() instanceof DeadObjectException;
517 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530518
Tracy Zhouc6060e62020-04-27 13:05:34 -0700519 public static boolean isGridOptionsEnabled(Context context) {
520 return isComponentEnabled(context.getPackageManager(),
521 context.getPackageName(),
522 GridOptionsProvider.class.getName());
523 }
524
525 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
526 ComponentName componentName = new ComponentName(pkgName, clsName);
527 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
528
529 switch (componentEnabledSetting) {
530 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
531 return false;
532 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
533 return true;
534 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
535 default:
536 // We need to get the application info to get the component's default state
537 try {
538 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
539 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
540
541 if (packageInfo.providers != null) {
542 return Arrays.stream(packageInfo.providers).anyMatch(
543 pi -> pi.name.equals(clsName) && pi.isEnabled());
544 }
545
546 // the component is not declared in the AndroidManifest
547 return false;
548 } catch (PackageManager.NameNotFoundException e) {
549 // the package isn't installed on the device
550 return false;
551 }
552 }
553 }
554
Tony Wickham580edcf2017-02-09 08:28:52 -0800555 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700556 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
557 */
558 public static void postAsyncCallback(Handler handler, Runnable callback) {
559 Message msg = Message.obtain(handler, callback);
560 msg.setAsynchronous(true);
561 handler.sendMessage(msg);
562 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700563
Sunny Goyal415f1732018-11-29 10:33:47 -0800564 /**
565 * Parses a string encoded using {@link #getPointString(int, int)}
566 */
567 public static Point parsePoint(String point) {
568 String[] split = point.split(",");
569 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
570 }
571
572 /**
573 * Encodes a point to string to that it can be persisted atomically.
574 */
575 public static String getPointString(int x, int y) {
576 return String.format(Locale.ENGLISH, "%d,%d", x, y);
577 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800578
Tony573c3e12019-02-22 13:10:59 -0800579 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
580 try {
581 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800582 } catch (IllegalArgumentException e) {}
583 }
584
585 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700586 * Returns the full drawable for info without any flattening or pre-processing.
587 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800588 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700589 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800590 */
591 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700592 Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800593 LauncherAppState appState = LauncherAppState.getInstance(launcher);
594 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700595 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800596 .resolveActivity(info.getIntent(), info.user);
597 outObj[0] = activityInfo;
Sunny Goyal14168432019-10-24 15:59:49 -0700598 return activityInfo == null ? null : new IconProvider(launcher).getIconForUI(
599 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800600 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
601 if (info instanceof PendingAddShortcutInfo) {
602 ShortcutConfigActivityInfo activityInfo =
603 ((PendingAddShortcutInfo) info).activityInfo;
604 outObj[0] = activityInfo;
605 return activityInfo.getFullResIcon(appState.getIconCache());
606 }
Samuel Fufaadbe9b62020-06-11 15:15:02 -0700607 if (info.getIntent() == null || info.getIntent().getPackage() == null) return null;
Sunny Goyalfa395362019-12-11 10:00:47 -0800608 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
609 .buildRequest(launcher)
610 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800611 if (si.isEmpty()) {
612 return null;
613 } else {
614 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800615 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800616 appState.getInvariantDeviceProfile().fillResIconDpi);
617 }
618 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
619 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
620 launcher, info.id, new Point(width, height));
621 if (icon == null) {
622 return null;
623 }
624 outObj[0] = icon;
625 return icon;
626 } else {
627 return null;
628 }
Tony573c3e12019-02-22 13:10:59 -0800629 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700630
Jon Miranda40285752019-05-14 15:17:30 -0700631 /**
632 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
633 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
634 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
635 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
636 **/
637 @TargetApi(Build.VERSION_CODES.O)
638 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
639 LauncherAppState appState = LauncherAppState.getInstance(launcher);
640 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
641 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
642 boolean iconBadged = (info instanceof ItemInfoWithIcon)
643 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
644 if ((info.id == ItemInfo.NO_ID && !iconBadged)
645 || !(obj instanceof ShortcutInfo)) {
646 // The item is not yet added on home screen.
647 return new FixedSizeEmptyDrawable(iconSize);
648 }
649 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800650 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
651 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800652 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700653 float insetFraction = (iconSize - badgeSize) / iconSize;
654 return new InsetDrawable(new FastBitmapDrawable(badge),
655 insetFraction, insetFraction, 0, 0);
656 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
657 return ((FolderAdaptiveIcon) obj).getBadge();
658 } else {
659 return launcher.getPackageManager()
660 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
661 }
662 }
663
Sunny Goyal53116c62020-08-07 16:32:18 -0700664 /**
665 * @return true is the extra is either null or is of type {@param type}
666 */
667 public static boolean isValidExtraType(Intent intent, String key, Class type) {
668 Object extra = intent.getParcelableExtra(key);
669 return extra == null || type.isInstance(extra);
670 }
671
Sunny Goyal878aa332019-05-20 12:40:42 -0700672 public static float squaredHypot(float x, float y) {
673 return x * x + y * y;
674 }
675
676 public static float squaredTouchSlop(Context context) {
677 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
678 return slop * slop;
679 }
680
Sunny Goyal733e3c62020-09-29 10:32:32 -0700681 /**
682 * Helper method to create a content provider
683 */
684 public static ContentObserver newContentObserver(Handler handler, Consumer<Uri> command) {
685 return new ContentObserver(handler) {
686 @Override
687 public void onChange(boolean selfChange, Uri uri) {
688 command.accept(uri);
689 }
690 };
691 }
692
Jon Miranda40285752019-05-14 15:17:30 -0700693 private static class FixedSizeEmptyDrawable extends ColorDrawable {
694
695 private final int mSize;
696
697 public FixedSizeEmptyDrawable(int size) {
698 super(Color.TRANSPARENT);
699 mSize = size;
700 }
701
702 @Override
703 public int getIntrinsicHeight() {
704 return mSize;
705 }
706
707 @Override
708 public int getIntrinsicWidth() {
709 return mSize;
710 }
711 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800712}