blob: 53563895a3790d089de16217ab9637e7293d3f6f [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
Sunny Goyal7368fa42019-04-22 09:58:14 -070021import android.animation.ValueAnimator;
Jon Miranda40285752019-05-14 15:17:30 -070022import android.annotation.TargetApi;
Vadim Tryshev2ce6a132018-06-18 19:14:44 -070023import android.app.ActivityManager;
Pinyao Ting49a3e692019-07-26 12:28:38 -070024import android.app.Person;
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -070025import android.app.WallpaperManager;
Tony573c3e12019-02-22 13:10:59 -080026import android.content.BroadcastReceiver;
Tracy Zhouc6060e62020-04-27 13:05:34 -070027import android.content.ComponentName;
Winson Chungaafa03c2010-06-11 17:34:16 -070028import android.content.Context;
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;
Tony Wickham112ac952015-11-12 12:31:50 -080051import android.os.PowerManager;
Sunny Goyal712ee532016-11-04 10:19:58 -070052import android.os.TransactionTooLargeException;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070053import android.provider.Settings;
Sunny Goyale78e3d72015-09-24 11:23:31 -070054import android.text.Spannable;
55import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070056import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070057import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070058import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020059import android.util.Log;
Adam Cohen2e6da152015-05-06 11:42:25 -070060import android.util.TypedValue;
Tonyd5a3df72019-03-13 10:12:01 -050061import android.view.MotionEvent;
Winson Chungc763c4e2013-07-19 13:49:06 -070062import android.view.View;
Sunny Goyal878aa332019-05-20 12:40:42 -070063import android.view.ViewConfiguration;
Sunny Goyal0f3af752018-06-08 13:01:04 -070064import android.view.animation.Interpolator;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070065
Vinit Nayakb9ec9312020-03-04 12:05:28 -080066import com.android.launcher3.config.FeatureFlags;
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 Goyal03340472019-05-17 16:57:12 -0700107 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700108
Tony Wickham8155fa22018-05-18 17:18:49 -0700109 public static final boolean ATLEAST_P =
110 Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Tony Mak6eeb0402018-01-03 14:41:31 +0000111
Hyunyoung Songe24cb632017-09-11 11:18:03 -0700112 public static final boolean ATLEAST_OREO_MR1 =
113 Build.VERSION.SDK_INT >= Build.VERSION_CODES.O_MR1;
114
115 public static final boolean ATLEAST_OREO =
116 Build.VERSION.SDK_INT >= Build.VERSION_CODES.O;
Sunny Goyaldcc0ba22016-11-02 11:22:39 -0700117
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
Vadim Tryshevc2950982018-10-04 16:33:45 -0700140 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700141 ActivityManager.isRunningInTestHarness();
142
Vadim Tryshevc2950982018-10-04 16:33:45 -0700143 public static void enableRunningInTestHarnessForTests() {
144 IS_RUNNING_IN_TEST_HARNESS = true;
145 }
146
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800147 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100148 return Log.isLoggable(propertyName, Log.VERBOSE);
149 }
150
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700151 public static boolean existsStyleWallpapers(Context context) {
152 ResolveInfo ri = context.getPackageManager().resolveActivity(
153 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
154 return ri != null;
155 }
156
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800157 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700158 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
159 * coordinates.
160 *
161 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700162 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700163 * @param coord The coordinate that we want mapped.
164 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
165 * sometimes this is relevant as in a child's coordinates within the descendant.
166 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
167 * this scale factor is assumed to be equal in X and Y, and so if at any point this
168 * assumption fails, we will need to return a pair of scale factors.
169 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700170 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700171 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
172 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700173 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700174 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700175
Sunny Goyalae6e3182019-04-30 12:04:37 -0700176 /**
177 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
178 * coordinates.
179 *
180 * @param descendant The descendant to which the passed coordinate is relative.
181 * @param ancestor The root view to make the coordinates relative to.
182 * @param coord The coordinate that we want mapped.
183 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
184 * sometimes this is relevant as in a child's coordinates within the descendant.
185 * @param ignoreTransform If true, view transform is ignored
186 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
187 * this scale factor is assumed to be equal in X and Y, and so if at any point this
188 * assumption fails, we will need to return a pair of scale factors.
189 */
190 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700191 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700192 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700193 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700194 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700195 // For TextViews, scroll has a meaning which relates to the text position
196 // which is very strange... ignore the scroll.
197 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700198 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700199 }
200
Sunny Goyalc4d32012020-04-03 17:10:11 -0700201 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700202 v.getMatrix().mapPoints(coord);
203 }
204 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700205 scale *= v.getScaleX();
206
Winson Chungc763c4e2013-07-19 13:49:06 -0700207 v = (View) v.getParent();
208 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700209 return scale;
210 }
211
212 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700213 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700214 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700215 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700216 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700217 View v = descendant;
218 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700219 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
220 sMatrix.postConcat(v.getMatrix());
221 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700222 v = (View) v.getParent();
223 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700224 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
225 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700226 sInverseMatrix.mapPoints(coord);
227 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700228
Sunny Goyalae6e3182019-04-30 12:04:37 -0700229 /**
230 * Sets {@param out} to be same as {@param in} by rounding individual values
231 */
232 public static void roundArray(float[] in, int[] out) {
233 for (int i = 0; i < in.length; i++) {
234 out[i] = Math.round(in[i]);
235 }
236 }
237
238 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
239 for (int i = 0; i < points.length; i += 2) {
240 points[i] += offsetX;
241 points[i + 1] += offsetY;
242 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700243 }
244
Jason Monk02dd7ae2014-04-15 15:23:31 -0400245 /**
246 * Utility method to determine whether the given point, in local coordinates,
247 * is inside the view, where the area of the view is expanded by the slop factor.
248 * This method is called while processing touch-move events to determine if the event
249 * is still within the view.
250 */
251 public static boolean pointInView(View v, float localX, float localY, float slop) {
252 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
253 localY < (v.getHeight() + slop);
254 }
255
Sunny Goyala52ecb02016-12-16 15:04:51 -0800256 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700257 v0.getLocationInWindow(sLoc0);
258 v1.getLocationInWindow(sLoc1);
259
260 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
261 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
262 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
263 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800264 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700265 }
266
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800267 public static void scaleRectFAboutCenter(RectF r, float scale) {
268 if (scale != 1.0f) {
269 float cx = r.centerX();
270 float cy = r.centerY();
271 r.offset(-cx, -cy);
272 r.left = r.left * scale;
273 r.top = r.top * scale ;
274 r.right = r.right * scale;
275 r.bottom = r.bottom * scale;
276 r.offset(cx, cy);
277 }
278 }
279
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800280 public static void scaleRectAboutCenter(Rect r, float scale) {
281 if (scale != 1.0f) {
282 int cx = r.centerX();
283 int cy = r.centerY();
284 r.offset(-cx, -cy);
Winson Chung3e803c72018-01-29 11:16:32 -0800285 scaleRect(r, scale);
286 r.offset(cx, cy);
287 }
288 }
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800289
Winson Chung3e803c72018-01-29 11:16:32 -0800290 public static void scaleRect(Rect r, float scale) {
291 if (scale != 1.0f) {
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800292 r.left = (int) (r.left * scale + 0.5f);
293 r.top = (int) (r.top * scale + 0.5f);
294 r.right = (int) (r.right * scale + 0.5f);
295 r.bottom = (int) (r.bottom * scale + 0.5f);
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800296 }
297 }
298
Winson Chung3e803c72018-01-29 11:16:32 -0800299 public static void insetRect(Rect r, Rect insets) {
300 r.left = Math.min(r.right, r.left + insets.left);
301 r.top = Math.min(r.bottom, r.top + insets.top);
302 r.right = Math.max(r.left, r.right - insets.right);
303 r.bottom = Math.max(r.top, r.bottom - insets.bottom);
304 }
305
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800306 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800307 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
308 if (scale < 1.0f) {
309 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
310 r.left += deltaX;
311 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700312
Jon Mirandae96798e2016-12-07 12:10:44 -0800313 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
314 r.top += deltaY;
315 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700316 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800317 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700318 }
319
Tony Wickhamb45444b2018-05-18 16:57:01 -0700320 /**
321 * Maps t from one range to another range.
322 * @param t The value to map.
323 * @param fromMin The lower bound of the range that t is being mapped from.
324 * @param fromMax The upper bound of the range that t is being mapped from.
325 * @param toMin The lower bound of the range that t is being mapped to.
326 * @param toMax The upper bound of the range that t is being mapped to.
327 * @return The mapped value of t.
328 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700329 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
330 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700331 if (fromMin == fromMax || toMin == toMax) {
332 Log.e(TAG, "mapToRange: range has 0 length");
333 return toMin;
334 }
Tonye4c2e2b2019-03-25 10:23:39 -0500335 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700336 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700337 }
338
Tonye4c2e2b2019-03-25 10:23:39 -0500339 public static float getProgress(float current, float min, float max) {
340 return Math.abs(current - min) / Math.abs(max - min);
341 }
342
Winson Chung3e803c72018-01-29 11:16:32 -0800343 public static float mapRange(float value, float min, float max) {
344 return min + (value * (max - min));
345 }
346
Sunny Goyal594d76d2014-11-06 10:12:54 -0800347 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700348 * Trims the string, removing all whitespace at the beginning and end of the string.
349 * Non-breaking whitespaces are also removed.
350 */
351 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700352 if (s == null) {
353 return null;
354 }
355
Winson Chung82b016c2015-05-08 17:00:10 -0700356 // Just strip any sequence of whitespace or java space characters from the beginning and end
357 Matcher m = sTrimPattern.matcher(s);
358 return m.replaceAll("$1");
359 }
Sunny Goyal70660032015-05-14 00:07:08 -0700360
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700361 /**
362 * Calculates the height of a given string at a specific text size.
363 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700364 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700365 Paint p = new Paint();
366 p.setTextSize(textSizePx);
367 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700368 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700369 }
370
Sunny Goyal70660032015-05-14 00:07:08 -0700371 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800372 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700373 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700374
Tony Wickham4fdba142019-11-04 16:23:51 -0800375 public static float dpiFromPx(float size, DisplayMetrics metrics) {
Adam Cohen2e6da152015-05-06 11:42:25 -0700376 float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
377 return (size / densityRatio);
378 }
vadimt1b383af2019-05-08 15:29:37 -0700379
Adam Cohen2e6da152015-05-06 11:42:25 -0700380 public static int pxFromSp(float size, DisplayMetrics metrics) {
381 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
382 size, metrics));
383 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700384
Sunny Goyalefb7e842018-10-04 15:11:00 -0700385 public static String createDbSelectionQuery(String columnName, IntArray values) {
386 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700387 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700388
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700389 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700390 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
391 }
392
393 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700394 try {
395 Class clazz = Class.forName("android.os.SystemProperties");
396 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700397 String value = (String) getter.invoke(null, property);
398 if (!TextUtils.isEmpty(value)) {
399 return value;
400 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700401 } catch (Exception e) {
402 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700403 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700404 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700405 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700406
407 /**
408 * Ensures that a value is within given bounds. Specifically:
409 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
410 * return upperBound; else return value unchanged.
411 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700412 public static int boundToRange(int value, int lowerBound, int upperBound) {
413 return Math.max(lowerBound, Math.min(value, upperBound));
414 }
415
416 /**
417 * @see #boundToRange(int, int, int).
418 */
419 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700420 return Math.max(lowerBound, Math.min(value, upperBound));
421 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700422
Sunny Goyale78e3d72015-09-24 11:23:31 -0700423 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700424 * @see #boundToRange(int, int, int).
425 */
426 public static long boundToRange(long value, long lowerBound, long upperBound) {
427 return Math.max(lowerBound, Math.min(value, upperBound));
428 }
429
430 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700431 * Wraps a message with a TTS span, so that a different message is spoken than
432 * what is getting displayed.
433 * @param msg original message
434 * @param ttsMsg message to be spoken
435 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700436 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800437 SpannableString spanned = new SpannableString(msg);
438 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
439 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
440 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700441 }
Winson12fb9fc2015-10-01 15:34:08 -0700442
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700443 /**
444 * Prefixes a text with the provided icon
445 */
446 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
447 // Update the hint to contain the icon.
448 // Prefix the original hint with two spaces. The first space gets replaced by the icon
449 // using span. The second space is used for a singe space character between the hint
450 // and the icon.
451 SpannableString spanned = new SpannableString(" " + msg);
452 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
453 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
454 return spanned;
455 }
456
Sunny Goyalf7258242015-10-19 16:59:07 -0700457 public static SharedPreferences getPrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800458 // Use application context for shared preferences, so that we use a single cached instance
459 return context.getApplicationContext().getSharedPreferences(
Sunny Goyalf7258242015-10-19 16:59:07 -0700460 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
461 }
Tony Wickham112ac952015-11-12 12:31:50 -0800462
Sunny Goyal9d887a22017-06-08 14:00:43 -0700463 public static SharedPreferences getDevicePrefs(Context context) {
Sunny Goyal09b03c52020-01-27 15:04:04 -0800464 // Use application context for shared preferences, so that we use a single cached instance
465 return context.getApplicationContext().getSharedPreferences(
Sunny Goyal9d887a22017-06-08 14:00:43 -0700466 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
467 }
468
Vinit Nayakb9ec9312020-03-04 12:05:28 -0800469 /**
470 * @return {@link SharedPreferences} that backs {@link FeatureFlags}
471 */
472 public static SharedPreferences getFeatureFlagsPrefs(Context context) {
473 // Use application context for shared preferences, so that we use a single cached instance
474 return context.getApplicationContext().getSharedPreferences(
475 FeatureFlags.FLAGS_PREF_NAME, Context.MODE_PRIVATE);
476 }
477
Sunny Goyal7368fa42019-04-22 09:58:14 -0700478 public static boolean areAnimationsEnabled(Context context) {
479 return ATLEAST_OREO
480 ? ValueAnimator.areAnimatorsEnabled()
481 : !context.getSystemService(PowerManager.class).isPowerSaveMode();
Tony Wickham112ac952015-11-12 12:31:50 -0800482 }
Sunny Goyale1483fb2016-01-08 12:16:15 -0800483
Hyunyoung Song0de01172016-10-05 16:27:48 -0700484 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800485 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700486 }
487
Sunny Goyal712ee532016-11-04 10:19:58 -0700488 public static boolean isBinderSizeError(Exception e) {
489 return e.getCause() instanceof TransactionTooLargeException
490 || e.getCause() instanceof DeadObjectException;
491 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530492
Tracy Zhouc6060e62020-04-27 13:05:34 -0700493 public static boolean isGridOptionsEnabled(Context context) {
494 return isComponentEnabled(context.getPackageManager(),
495 context.getPackageName(),
496 GridOptionsProvider.class.getName());
497 }
498
499 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) {
500 ComponentName componentName = new ComponentName(pkgName, clsName);
501 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName);
502
503 switch (componentEnabledSetting) {
504 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED:
505 return false;
506 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED:
507 return true;
508 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT:
509 default:
510 // We need to get the application info to get the component's default state
511 try {
512 PackageInfo packageInfo = pm.getPackageInfo(pkgName,
513 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS);
514
515 if (packageInfo.providers != null) {
516 return Arrays.stream(packageInfo.providers).anyMatch(
517 pi -> pi.name.equals(clsName) && pi.isEnabled());
518 }
519
520 // the component is not declared in the AndroidManifest
521 return false;
522 } catch (PackageManager.NameNotFoundException e) {
523 // the package isn't installed on the device
524 return false;
525 }
526 }
527 }
528
Tony Wickham580edcf2017-02-09 08:28:52 -0800529 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700530 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
531 */
532 public static void postAsyncCallback(Handler handler, Runnable callback) {
533 Message msg = Message.obtain(handler, callback);
534 msg.setAsynchronous(true);
535 handler.sendMessage(msg);
536 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700537
Sunny Goyal415f1732018-11-29 10:33:47 -0800538 /**
539 * Parses a string encoded using {@link #getPointString(int, int)}
540 */
541 public static Point parsePoint(String point) {
542 String[] split = point.split(",");
543 return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
544 }
545
546 /**
547 * Encodes a point to string to that it can be persisted atomically.
548 */
549 public static String getPointString(int x, int y) {
550 return String.format(Locale.ENGLISH, "%d,%d", x, y);
551 }
Jon Miranda0128d3f2019-02-14 09:19:31 -0800552
Tony573c3e12019-02-22 13:10:59 -0800553 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
554 try {
555 context.unregisterReceiver(receiver);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800556 } catch (IllegalArgumentException e) {}
557 }
558
559 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700560 * Returns the full drawable for info without any flattening or pre-processing.
561 *
Jon Miranda1a49fb52019-02-19 15:34:41 -0800562 * @param outObj this is set to the internal data associated with {@param info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700563 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800564 */
565 public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
Sunny Goyal14168432019-10-24 15:59:49 -0700566 Object[] outObj) {
Jon Miranda1a49fb52019-02-19 15:34:41 -0800567 LauncherAppState appState = LauncherAppState.getInstance(launcher);
568 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Sunny Goyale7b00122019-10-02 16:13:34 -0700569 LauncherActivityInfo activityInfo = launcher.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800570 .resolveActivity(info.getIntent(), info.user);
571 outObj[0] = activityInfo;
Sunny Goyal14168432019-10-24 15:59:49 -0700572 return activityInfo == null ? null : new IconProvider(launcher).getIconForUI(
573 activityInfo, launcher.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800574 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
575 if (info instanceof PendingAddShortcutInfo) {
576 ShortcutConfigActivityInfo activityInfo =
577 ((PendingAddShortcutInfo) info).activityInfo;
578 outObj[0] = activityInfo;
579 return activityInfo.getFullResIcon(appState.getIconCache());
580 }
Sunny Goyalfa395362019-12-11 10:00:47 -0800581 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
582 .buildRequest(launcher)
583 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800584 if (si.isEmpty()) {
585 return null;
586 } else {
587 outObj[0] = si.get(0);
Sunny Goyalfa395362019-12-11 10:00:47 -0800588 return ShortcutCachingLogic.getIcon(launcher, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800589 appState.getInvariantDeviceProfile().fillResIconDpi);
590 }
591 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
592 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
593 launcher, info.id, new Point(width, height));
594 if (icon == null) {
595 return null;
596 }
597 outObj[0] = icon;
598 return icon;
599 } else {
600 return null;
601 }
Tony573c3e12019-02-22 13:10:59 -0800602 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700603
Jon Miranda40285752019-05-14 15:17:30 -0700604 /**
605 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
606 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
607 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
608 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
609 **/
610 @TargetApi(Build.VERSION_CODES.O)
611 public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
612 LauncherAppState appState = LauncherAppState.getInstance(launcher);
613 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
614 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
615 boolean iconBadged = (info instanceof ItemInfoWithIcon)
616 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
617 if ((info.id == ItemInfo.NO_ID && !iconBadged)
618 || !(obj instanceof ShortcutInfo)) {
619 // The item is not yet added on home screen.
620 return new FixedSizeEmptyDrawable(iconSize);
621 }
622 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyal18204e42020-02-06 11:28:01 -0800623 Bitmap badge = LauncherAppState.getInstance(appState.getContext())
624 .getIconCache().getShortcutInfoBadge(si).icon;
Samuel Fufa37b24892019-11-05 15:29:10 -0800625 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize);
Jon Miranda40285752019-05-14 15:17:30 -0700626 float insetFraction = (iconSize - badgeSize) / iconSize;
627 return new InsetDrawable(new FastBitmapDrawable(badge),
628 insetFraction, insetFraction, 0, 0);
629 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
630 return ((FolderAdaptiveIcon) obj).getBadge();
631 } else {
632 return launcher.getPackageManager()
633 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
634 }
635 }
636
Sunny Goyal878aa332019-05-20 12:40:42 -0700637 public static float squaredHypot(float x, float y) {
638 return x * x + y * y;
639 }
640
641 public static float squaredTouchSlop(Context context) {
642 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
643 return slop * slop;
644 }
645
Jon Miranda40285752019-05-14 15:17:30 -0700646 private static class FixedSizeEmptyDrawable extends ColorDrawable {
647
648 private final int mSize;
649
650 public FixedSizeEmptyDrawable(int size) {
651 super(Color.TRANSPARENT);
652 mSize = size;
653 }
654
655 @Override
656 public int getIntrinsicHeight() {
657 return mSize;
658 }
659
660 @Override
661 public int getIntrinsicWidth() {
662 return mSize;
663 }
664 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800665}