blob: dea2a8dfd20321765020f0fb4d1f747e43dfaaf1 [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;
Jon Miranda40285752019-05-14 15:17:30 -070037import android.graphics.Bitmap;
38import android.graphics.Color;
Winson Chungc763c4e2013-07-19 13:49:06 -070039import android.graphics.Matrix;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080040import android.graphics.Paint;
Sunny Goyal415f1732018-11-29 10:33:47 -080041import android.graphics.Point;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080042import android.graphics.Rect;
Sunny Goyalb1e2e292018-02-21 10:14:30 -080043import android.graphics.RectF;
Jon Miranda40285752019-05-14 15:17:30 -070044import android.graphics.drawable.ColorDrawable;
Jon Miranda1a49fb52019-02-19 15:34:41 -080045import android.graphics.drawable.Drawable;
Jon Miranda40285752019-05-14 15:17:30 -070046import android.graphics.drawable.InsetDrawable;
Sandeep Siddhartha2efc7d92014-05-16 17:21:15 -070047import android.os.Build;
Sunny Goyal712ee532016-11-04 10:19:58 -070048import android.os.DeadObjectException;
Sunny Goyal3483c522018-04-12 11:23:33 -070049import android.os.Handler;
50import android.os.Message;
Sunny Goyal712ee532016-11-04 10:19:58 -070051import android.os.TransactionTooLargeException;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070052import android.provider.Settings;
Sunny Goyale78e3d72015-09-24 11:23:31 -070053import android.text.Spannable;
54import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070055import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070056import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070057import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020058import android.util.Log;
Adam Cohen2e6da152015-05-06 11:42:25 -070059import android.util.TypedValue;
Tonyd5a3df72019-03-13 10:12:01 -050060import android.view.MotionEvent;
Winson Chungc763c4e2013-07-19 13:49:06 -070061import android.view.View;
Sunny Goyal878aa332019-05-20 12:40:42 -070062import android.view.ViewConfiguration;
Sunny Goyal0f3af752018-06-08 13:01:04 -070063import android.view.animation.Interpolator;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070064
Sunny Goyal0addbf02020-04-28 14:17:35 -070065import androidx.core.os.BuildCompat;
66
Jon Miranda1a49fb52019-02-19 15:34:41 -080067import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
Tracy Zhouc6060e62020-04-27 13:05:34 -070068import com.android.launcher3.graphics.GridOptionsProvider;
Sunny Goyal5b636eb2019-05-29 01:09:06 -070069import com.android.launcher3.graphics.TintedDrawableSpan;
Sunny Goyal14168432019-10-24 15:59:49 -070070import com.android.launcher3.icons.IconProvider;
Jon Miranda40285752019-05-14 15:17:30 -070071import com.android.launcher3.icons.LauncherIcons;
Sunny Goyalfa395362019-12-11 10:00:47 -080072import com.android.launcher3.icons.ShortcutCachingLogic;
Sunny Goyale396abf2020-04-06 15:11:17 -070073import com.android.launcher3.model.data.ItemInfo;
74import com.android.launcher3.model.data.ItemInfoWithIcon;
Sunny Goyale7b00122019-10-02 16:13:34 -070075import com.android.launcher3.pm.ShortcutConfigActivityInfo;
Jon Miranda1a49fb52019-02-19 15:34:41 -080076import com.android.launcher3.shortcuts.ShortcutKey;
Sunny Goyalfa395362019-12-11 10:00:47 -080077import com.android.launcher3.shortcuts.ShortcutRequest;
Sunny Goyalefb7e842018-10-04 15:11:00 -070078import com.android.launcher3.util.IntArray;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070079import com.android.launcher3.util.PackageManagerHelper;
Jon Miranda1a49fb52019-02-19 15:34:41 -080080import com.android.launcher3.widget.PendingAddShortcutInfo;
Sunny Goyal6c56c682015-07-16 14:09:05 -070081
Sunny Goyal25aba0a2015-07-16 15:07:47 -070082import java.lang.reflect.Method;
Tracy Zhouc6060e62020-04-27 13:05:34 -070083import java.util.Arrays;
Jon Miranda1a49fb52019-02-19 15:34:41 -080084import java.util.List;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070085import java.util.Locale;
Winson Chung82b016c2015-05-08 17:00:10 -070086import java.util.regex.Matcher;
87import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080088
89/**
90 * Various utilities shared amongst the Launcher's classes.
91 */
Mathew Inwood72fbec12013-11-19 15:45:07 +000092public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070093
Joe Onorato1291a8c2009-09-15 15:07:25 -040094 private static final String TAG = "Launcher.Utilities";
95
Winson Chung82b016c2015-05-08 17:00:10 -070096 private static final Pattern sTrimPattern =
97 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
98
Sunny Goyal53d7ee42015-05-22 12:25:45 -070099 private static final int[] sLoc0 = new int[2];
100 private static final int[] sLoc1 = new int[2];
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700101 private static final Matrix sMatrix = new Matrix();
102 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +0100103
Pinyao Ting49a3e692019-07-26 12:28:38 -0700104 public static final String[] EMPTY_STRING_ARRAY = new String[0];
105 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0];
106
Sunny Goyal0addbf02020-04-28 14:17:35 -0700107 public static final boolean ATLEAST_R = BuildCompat.isAtLeastR();
108
Sunny Goyal03340472019-05-17 16:57:12 -0700109 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700110
Tony Wickham8155fa22018-05-18 17:18:49 -0700111 public static final boolean ATLEAST_P =
112 Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Tony Mak6eeb0402018-01-03 14:41:31 +0000113
Sunny Goyal49f19f02017-01-05 14:36:02 -0800114 /**
Tonyd5a3df72019-03-13 10:12:01 -0500115 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
116 */
117 public static final int EDGE_NAV_BAR = 1 << 8;
118
119 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800120 * Indicates if the device has a debug build. Should only be used to store additional info or
121 * add extra logging and not for changing the app behavior.
122 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200123 public static final boolean IS_DEBUG_DEVICE =
124 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
125 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800126
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700127 public static boolean isDevelopersOptionsEnabled(Context context) {
128 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
129 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
130 }
131
Sunny Goyal6f866092016-03-17 17:04:15 -0700132 // An intent extra to indicate the horizontal scroll of the wallpaper.
133 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
Hyunyoung Song29e5d442019-02-07 10:33:55 -0800134 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
Sunny Goyal6f866092016-03-17 17:04:15 -0700135
Vadim Tryshevc2950982018-10-04 16:33:45 -0700136 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700137 ActivityManager.isRunningInTestHarness();
138
Vadim Tryshevc2950982018-10-04 16:33:45 -0700139 public static void enableRunningInTestHarnessForTests() {
140 IS_RUNNING_IN_TEST_HARNESS = true;
141 }
142
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800143 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100144 return Log.isLoggable(propertyName, Log.VERBOSE);
145 }
146
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700147 public static boolean existsStyleWallpapers(Context context) {
148 ResolveInfo ri = context.getPackageManager().resolveActivity(
149 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
150 return ri != null;
151 }
152
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800153 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700154 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
155 * coordinates.
156 *
157 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700158 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700159 * @param coord The coordinate that we want mapped.
160 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
161 * sometimes this is relevant as in a child's coordinates within the descendant.
162 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
163 * this scale factor is assumed to be equal in X and Y, and so if at any point this
164 * assumption fails, we will need to return a pair of scale factors.
165 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700166 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700167 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
168 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700169 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700170 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700171
Sunny Goyalae6e3182019-04-30 12:04:37 -0700172 /**
173 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
174 * coordinates.
175 *
176 * @param descendant The descendant to which the passed coordinate is relative.
177 * @param ancestor The root view to make the coordinates relative to.
178 * @param coord The coordinate that we want mapped.
179 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
180 * sometimes this is relevant as in a child's coordinates within the descendant.
181 * @param ignoreTransform If true, view transform is ignored
182 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
183 * this scale factor is assumed to be equal in X and Y, and so if at any point this
184 * assumption fails, we will need to return a pair of scale factors.
185 */
186 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700187 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700188 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700189 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700190 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700191 // For TextViews, scroll has a meaning which relates to the text position
192 // which is very strange... ignore the scroll.
193 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700194 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700195 }
196
Sunny Goyalc4d32012020-04-03 17:10:11 -0700197 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700198 v.getMatrix().mapPoints(coord);
199 }
200 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700201 scale *= v.getScaleX();
202
Winson Chungc763c4e2013-07-19 13:49:06 -0700203 v = (View) v.getParent();
204 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700205 return scale;
206 }
207
208 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700209 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700210 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700211 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700212 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700213 View v = descendant;
214 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700215 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
216 sMatrix.postConcat(v.getMatrix());
217 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700218 v = (View) v.getParent();
219 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700220 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
221 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700222 sInverseMatrix.mapPoints(coord);
223 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700224
Sunny Goyalae6e3182019-04-30 12:04:37 -0700225 /**
226 * Sets {@param out} to be same as {@param in} by rounding individual values
227 */
228 public static void roundArray(float[] in, int[] out) {
229 for (int i = 0; i < in.length; i++) {
230 out[i] = Math.round(in[i]);
231 }
232 }
233
234 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
235 for (int i = 0; i < points.length; i += 2) {
236 points[i] += offsetX;
237 points[i + 1] += offsetY;
238 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700239 }
240
Jason Monk02dd7ae2014-04-15 15:23:31 -0400241 /**
242 * Utility method to determine whether the given point, in local coordinates,
243 * is inside the view, where the area of the view is expanded by the slop factor.
244 * This method is called while processing touch-move events to determine if the event
245 * is still within the view.
246 */
247 public static boolean pointInView(View v, float localX, float localY, float slop) {
248 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
249 localY < (v.getHeight() + slop);
250 }
251
Sunny Goyala52ecb02016-12-16 15:04:51 -0800252 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700253 v0.getLocationInWindow(sLoc0);
254 v1.getLocationInWindow(sLoc1);
255
256 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
257 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
258 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
259 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800260 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700261 }
262
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800263 public static void scaleRectFAboutCenter(RectF r, float scale) {
264 if (scale != 1.0f) {
265 float cx = r.centerX();
266 float cy = r.centerY();
267 r.offset(-cx, -cy);
268 r.left = r.left * scale;
269 r.top = r.top * scale ;
270 r.right = r.right * scale;
271 r.bottom = r.bottom * scale;
272 r.offset(cx, cy);
273 }
274 }
275
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800276 public static void scaleRectAboutCenter(Rect r, float scale) {
277 if (scale != 1.0f) {
278 int cx = r.centerX();
279 int cy = r.centerY();
280 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800281 scaleRect(r, scale);
282 r.offset(cx, cy);
283 }
284 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800285
Winson Chung3e803c72018-01-29 11:16:32 -0800286 public static void scaleRect(Rect r, float scale) {
287 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800288 r.left = (int) (r.left * scale + 0.5f);
289 r.top = (int) (r.top * scale + 0.5f);
290 r.right = (int) (r.right * scale + 0.5f);
291 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800292 }
293 }
294
Winson Chung3e803c72018-01-29 11:16:32 -0800295 public static void insetRect(Rect r, Rect insets) {
296 r.left = Math.min(r.right, r.left + insets.left);
297 r.top = Math.min(r.bottom, r.top + insets.top);
298 r.right = Math.max(r.left, r.right - insets.right);
299 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
300 }
301
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800302 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800303 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
304 if (scale < 1.0f) {
305 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
306 r.left += deltaX;
307 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700308
Jon Mirandae96798e2016-12-07 12:10:44 -0800309 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
310 r.top += deltaY;
311 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700312 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800313 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700314 }
315
Tony Wickhamb45444b2018-05-18 16:57:01 -0700316 /**
317 * Maps t from one range to another range.
318 * @param t The value to map.
319 * @param fromMin The lower bound of the range that t is being mapped from.
320 * @param fromMax The upper bound of the range that t is being mapped from.
321 * @param toMin The lower bound of the range that t is being mapped to.
322 * @param toMax The upper bound of the range that t is being mapped to.
323 * @return The mapped value of t.
324 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700325 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
326 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700327 if (fromMin == fromMax || toMin == toMax) {
328 Log.e(TAG, "mapToRange: range has 0 length");
329 return toMin;
330 }
Tonye4c2e2b2019-03-25 10:23:39 -0500331 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700332 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700333 }
334
Tonye4c2e2b2019-03-25 10:23:39 -0500335 public static float getProgress(float current, float min, float max) {
336 return Math.abs(current - min) / Math.abs(max - min);
337 }
338
Winson Chung3e803c72018-01-29 11:16:32 -0800339 public static float mapRange(float value, float min, float max) {
340 return min + (value * (max - min));
341 }
342
Sunny Goyal594d76d2014-11-06 10:12:54 -0800343 /**
Zak Cohena39544d2020-04-27 16:26:55 -0700344 * Bounds parameter to the range [0, 1]
345 */
346 public static float saturate(float a) {
347 return boundToRange(a, 0, 1.0f);
348 }
349
350 /**
351 * Returns the compliment (1 - a) of the parameter.
352 */
353 public static float comp(float a) {
354 return 1 - a;
355 }
356
357 /**
358 * Returns the "probabilistic or" of a and b. (a + b - ab).
359 * Useful beyond probability, can be used to combine two unit progresses for example.
360 */
361 public static float or(float a, float b) {
362 float satA = saturate(a);
363 float satB = saturate(b);
364 return satA + satB - (satA * satB);
365 }
366
367 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700368 * Trims the string, removing all whitespace at the beginning and end of the string.
369 * Non-breaking whitespaces are also removed.
370 */
371 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700372 if (s == null) {
373 return null;
374 }
375
Winson Chung82b016c2015-05-08 17:00:10 -0700376 // Just strip any sequence of whitespace or java space characters from the beginning and end
377 Matcher m = sTrimPattern.matcher(s);
378 return m.replaceAll("$1");
379 }
Sunny Goyal70660032015-05-14 00:07:08 -0700380
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700381 /**
382 * Calculates the height of a given string at a specific text size.
383 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700384 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700385 Paint p = new Paint();
386 p.setTextSize(textSizePx);
387 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700388 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700389 }
390
Sunny Goyal70660032015-05-14 00:07:08 -0700391 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800392 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700393 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700394
Tony Wickham4fdba142019-11-04 16:23:51 -0800395 public static float dpiFromPx(float size, DisplayMetrics metrics) {
Adam Cohen2e6da152015-05-06 11:42:25 -0700396 float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
397 return (size / densityRatio);
398 }
vadimt1b383af2019-05-08 15:29:37 -0700399
Adam Cohen2e6da152015-05-06 11:42:25 -0700400 public static int pxFromSp(float size, DisplayMetrics metrics) {
401 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
402 size, metrics));
403 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700404
Sunny Goyalefb7e842018-10-04 15:11:00 -0700405 public static String createDbSelectionQuery(String columnName, IntArray values) {
406 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700407 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700408
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700409 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700410 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
411 }
412
413 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700414 try {
415 Class clazz = Class.forName("android.os.SystemProperties");
416 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700417 String value = (String) getter.invoke(null, property);
418 if (!TextUtils.isEmpty(value)) {
419 return value;
420 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700421 } catch (Exception e) {
422 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700423 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700424 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700425 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700426
427 /**
428 * Ensures that a value is within given bounds. Specifically:
429 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
430 * return upperBound; else return value unchanged.
431 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700432 public static int boundToRange(int value, int lowerBound, int upperBound) {
433 return Math.max(lowerBound, Math.min(value, upperBound));
434 }
435
436 /**
437 * @see #boundToRange(int, int, int).
438 */
439 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700440 return Math.max(lowerBound, Math.min(value, upperBound));
441 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700442
Sunny Goyale78e3d72015-09-24 11:23:31 -0700443 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700444 * @see #boundToRange(int, int, int).
445 */
446 public static long boundToRange(long value, long lowerBound, long upperBound) {
447 return Math.max(lowerBound, Math.min(value, upperBound));
448 }
449
450 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700451 * Wraps a message with a TTS span, so that a different message is spoken than
452 * what is getting displayed.
453 * @param msg original message
454 * @param ttsMsg message to be spoken
455 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700456 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800457 SpannableString spanned = new SpannableString(msg);
458 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
459 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
460 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700461 }
Winson12fb9fc2015-10-01 15:34:08 -0700462
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700463 /**
464 * Prefixes a text with the provided icon
465 */
466 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
467 // Update the hint to contain the icon.
468 // Prefix the original hint with two spaces. The first space gets replaced by the icon
469 // using span. The second space is used for a singe space character between the hint
470 // and the icon.
471 SpannableString spanned = new SpannableString(" " + msg);
472 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
473 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
474 return spanned;
475 }
476
Sunny Goyalf7258242015-10-19 16:59:07 -0700477 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800478 // Use application context for shared preferences, so that we use a single cached instance
479 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700480 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
481 }
Tony Wickham112ac952015-11-12 12:31:50 -0800482
Sunny Goyal9d887a22017-06-08 14:00:43 -0700483 public static SharedPreferences getDevicePrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800484 // Use application context for shared preferences, so that we use a single cached instance
485 return context.getApplicationContext().getSharedPreferences(
Sunny Goyal9d887a22017-06-08 14:00:43 -0700486 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
487 }
488
Hyunyoung Song0de01172016-10-05 16:27:48 -0700489 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800490 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700491 }
492
Sunny Goyal712ee532016-11-04 10:19:58 -0700493 public static boolean isBinderSizeError(Exception e) {
494 return e.getCause() instanceof TransactionTooLargeException
495 || e.getCause() instanceof DeadObjectException;
496 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530497
Tracy Zhouc6060e62020-04-27 13:05:34 -0700498 public static boolean isGridOptionsEnabled(Context context) {
499 return isComponentEnabled(context.getPackageManager(),
500 context.getPackageName(),
501 GridOptionsProvider.class.getName());
502 }
503
504 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
505 ComponentName componentName = new ComponentName(pkgName, clsName);
506 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
507
508 switch (componentEnabledSetting) {
509 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
510 return false;
511 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
512 return true;
513 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
514 default:
515 // We need to get the application info to get the component's default state
516 try {
517 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
518 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
519
520 if (packageInfo.providers != null) {
521 return Arrays.stream(packageInfo.providers).anyMatch(
522 pi -> pi.name.equals(clsName) && pi.isEnabled());
523 }
524
525 // the component is not declared in the AndroidManifest
526 return false;
527 } catch (PackageManager.NameNotFoundException e) {
528 // the package isn't installed on the device
529 return false;
530 }
531 }
532 }
533
Tony Wickham580edcf2017-02-09 08:28:52 -0800534 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700535 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
536 */
537 public static void postAsyncCallback(Handler handler, Runnable callback) {
538 Message msg = Message.obtain(handler, callback);
539 msg.setAsynchronous(true);
540 handler.sendMessage(msg);
541 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700542
Sunny Goyal415f1732018-11-29 10:33:47 -0800543 /**
544 * Parses a string encoded using {@link #getPointString(int, int)}
545 */
546 public static Point parsePoint(String point) {
547 String[] split = point.split(",");
548 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
549 }
550
551 /**
552 * Encodes a point to string to that it can be persisted atomically.
553 */
554 public static String getPointString(int x, int y) {
555 return String.format(Locale.ENGLISH, "%d,%d", x, y);
556 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800557
Tony573c3e12019-02-22 13:10:59 -0800558 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
559 try {
560 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800561 } catch (IllegalArgumentException e) {}
562 }
563
564 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700565 * Returns the full drawable for info without any flattening or pre-processing.
566 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800567 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700568 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800569 */
570 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700571 Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800572 LauncherAppState appState = LauncherAppState.getInstance(launcher);
573 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700574 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800575 .resolveActivity(info.getIntent(), info.user);
576 outObj[0] = activityInfo;
Sunny Goyal14168432019-10-24 15:59:49 -0700577 return activityInfo == null ? null : new IconProvider(launcher).getIconForUI(
578 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800579 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
580 if (info instanceof PendingAddShortcutInfo) {
581 ShortcutConfigActivityInfo activityInfo =
582 ((PendingAddShortcutInfo) info).activityInfo;
583 outObj[0] = activityInfo;
584 return activityInfo.getFullResIcon(appState.getIconCache());
585 }
Samuel Fufaadbe9b62020-06-11 15:15:02 -0700586 if (info.getIntent() == null || info.getIntent().getPackage() == null) return null;
Sunny Goyalfa395362019-12-11 10:00:47 -0800587 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
588 .buildRequest(launcher)
589 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800590 if (si.isEmpty()) {
591 return null;
592 } else {
593 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800594 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800595 appState.getInvariantDeviceProfile().fillResIconDpi);
596 }
597 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
598 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
599 launcher, info.id, new Point(width, height));
600 if (icon == null) {
601 return null;
602 }
603 outObj[0] = icon;
604 return icon;
605 } else {
606 return null;
607 }
Tony573c3e12019-02-22 13:10:59 -0800608 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700609
Jon Miranda40285752019-05-14 15:17:30 -0700610 /**
611 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
612 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
613 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
614 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
615 **/
616 @TargetApi(Build.VERSION_CODES.O)
617 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
618 LauncherAppState appState = LauncherAppState.getInstance(launcher);
619 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
620 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
621 boolean iconBadged = (info instanceof ItemInfoWithIcon)
622 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
623 if ((info.id == ItemInfo.NO_ID && !iconBadged)
624 || !(obj instanceof ShortcutInfo)) {
625 // The item is not yet added on home screen.
626 return new FixedSizeEmptyDrawable(iconSize);
627 }
628 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800629 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
630 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800631 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700632 float insetFraction = (iconSize - badgeSize) / iconSize;
633 return new InsetDrawable(new FastBitmapDrawable(badge),
634 insetFraction, insetFraction, 0, 0);
635 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
636 return ((FolderAdaptiveIcon) obj).getBadge();
637 } else {
638 return launcher.getPackageManager()
639 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
640 }
641 }
642
Sunny Goyal53116c62020-08-07 16:32:18 -0700643 /**
644 * @return true is the extra is either null or is of type {@param type}
645 */
646 public static boolean isValidExtraType(Intent intent, String key, Class type) {
647 Object extra = intent.getParcelableExtra(key);
648 return extra == null || type.isInstance(extra);
649 }
650
Sunny Goyal878aa332019-05-20 12:40:42 -0700651 public static float squaredHypot(float x, float y) {
652 return x * x + y * y;
653 }
654
655 public static float squaredTouchSlop(Context context) {
656 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
657 return slop * slop;
658 }
659
Jon Miranda40285752019-05-14 15:17:30 -0700660 private static class FixedSizeEmptyDrawable extends ColorDrawable {
661
662 private final int mSize;
663
664 public FixedSizeEmptyDrawable(int size) {
665 super(Color.TRANSPARENT);
666 mSize = size;
667 }
668
669 @Override
670 public int getIntrinsicHeight() {
671 return mSize;
672 }
673
674 @Override
675 public int getIntrinsicWidth() {
676 return mSize;
677 }
678 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800679}