1 /* 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 17 package com.android.launcher3; 18 19 import static com.android.launcher3.model.data.ItemInfoWithIcon.FLAG_ICON_BADGED; 20 21 import android.annotation.TargetApi; 22 import android.app.ActivityManager; 23 import android.app.Person; 24 import android.app.WallpaperManager; 25 import android.content.BroadcastReceiver; 26 import android.content.ComponentName; 27 import android.content.Context; 28 import android.content.Intent; 29 import android.content.SharedPreferences; 30 import android.content.pm.LauncherActivityInfo; 31 import android.content.pm.LauncherApps; 32 import android.content.pm.PackageInfo; 33 import android.content.pm.PackageManager; 34 import android.content.pm.ResolveInfo; 35 import android.content.pm.ShortcutInfo; 36 import android.content.res.Configuration; 37 import android.content.res.Resources; 38 import android.database.ContentObserver; 39 import android.graphics.Bitmap; 40 import android.graphics.Color; 41 import android.graphics.ColorFilter; 42 import android.graphics.LightingColorFilter; 43 import android.graphics.Matrix; 44 import android.graphics.Paint; 45 import android.graphics.Point; 46 import android.graphics.Rect; 47 import android.graphics.RectF; 48 import android.graphics.drawable.AdaptiveIconDrawable; 49 import android.graphics.drawable.ColorDrawable; 50 import android.graphics.drawable.Drawable; 51 import android.graphics.drawable.InsetDrawable; 52 import android.net.Uri; 53 import android.os.Build; 54 import android.os.DeadObjectException; 55 import android.os.Handler; 56 import android.os.Message; 57 import android.os.TransactionTooLargeException; 58 import android.provider.Settings; 59 import android.text.Spannable; 60 import android.text.SpannableString; 61 import android.text.TextUtils; 62 import android.text.style.TtsSpan; 63 import android.util.DisplayMetrics; 64 import android.util.Log; 65 import android.util.TypedValue; 66 import android.view.MotionEvent; 67 import android.view.View; 68 import android.view.ViewConfiguration; 69 import android.view.animation.Interpolator; 70 import android.widget.LinearLayout; 71 72 import androidx.annotation.NonNull; 73 import androidx.core.graphics.ColorUtils; 74 import androidx.core.os.BuildCompat; 75 76 import com.android.launcher3.dragndrop.FolderAdaptiveIcon; 77 import com.android.launcher3.graphics.GridCustomizationsProvider; 78 import com.android.launcher3.graphics.TintedDrawableSpan; 79 import com.android.launcher3.icons.BitmapInfo; 80 import com.android.launcher3.icons.FastBitmapDrawable; 81 import com.android.launcher3.icons.LauncherIcons; 82 import com.android.launcher3.icons.ShortcutCachingLogic; 83 import com.android.launcher3.model.data.ItemInfo; 84 import com.android.launcher3.model.data.ItemInfoWithIcon; 85 import com.android.launcher3.model.data.SearchActionItemInfo; 86 import com.android.launcher3.pm.ShortcutConfigActivityInfo; 87 import com.android.launcher3.shortcuts.ShortcutKey; 88 import com.android.launcher3.shortcuts.ShortcutRequest; 89 import com.android.launcher3.util.IntArray; 90 import com.android.launcher3.util.PackageManagerHelper; 91 import com.android.launcher3.views.ActivityContext; 92 import com.android.launcher3.views.BaseDragLayer; 93 import com.android.launcher3.widget.PendingAddShortcutInfo; 94 95 import java.lang.reflect.Method; 96 import java.util.Arrays; 97 import java.util.List; 98 import java.util.Locale; 99 import java.util.function.Consumer; 100 import java.util.regex.Matcher; 101 import java.util.regex.Pattern; 102 103 /** 104 * Various utilities shared amongst the Launcher's classes. 105 */ 106 public final class Utilities { 107 108 private static final String TAG = "Launcher.Utilities"; 109 110 private static final Pattern sTrimPattern = 111 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$"); 112 113 private static final float[] sTmpFloatArray = new float[4]; 114 115 private static final int[] sLoc0 = new int[2]; 116 private static final int[] sLoc1 = new int[2]; 117 private static final Matrix sMatrix = new Matrix(); 118 private static final Matrix sInverseMatrix = new Matrix(); 119 120 public static final String[] EMPTY_STRING_ARRAY = new String[0]; 121 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0]; 122 123 public static final boolean ATLEAST_P = Build.VERSION.SDK_INT >= Build.VERSION_CODES.P; 124 125 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q; 126 127 public static final boolean ATLEAST_R = Build.VERSION.SDK_INT >= Build.VERSION_CODES.R; 128 129 public static final boolean ATLEAST_S = BuildCompat.isAtLeastS() 130 || Build.VERSION.SDK_INT >= Build.VERSION_CODES.S; 131 132 /** 133 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}. 134 */ 135 public static final int EDGE_NAV_BAR = 1 << 8; 136 137 /** 138 * Indicates if the device has a debug build. Should only be used to store additional info or 139 * add extra logging and not for changing the app behavior. 140 */ 141 public static final boolean IS_DEBUG_DEVICE = 142 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") || 143 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng"); 144 145 /** 146 * Returns true if theme is dark. 147 */ isDarkTheme(Context context)148 public static boolean isDarkTheme(Context context) { 149 Configuration configuration = context.getResources().getConfiguration(); 150 int nightMode = configuration.uiMode & Configuration.UI_MODE_NIGHT_MASK; 151 return nightMode == Configuration.UI_MODE_NIGHT_YES; 152 } 153 isDevelopersOptionsEnabled(Context context)154 public static boolean isDevelopersOptionsEnabled(Context context) { 155 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(), 156 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0; 157 } 158 159 // An intent extra to indicate the horizontal scroll of the wallpaper. 160 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET"; 161 public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR"; 162 163 // An intent extra to indicate the launch source by launcher. 164 public static final String EXTRA_WALLPAPER_LAUNCH_SOURCE = 165 "com.android.wallpaper.LAUNCH_SOURCE"; 166 167 public static boolean IS_RUNNING_IN_TEST_HARNESS = 168 ActivityManager.isRunningInTestHarness(); 169 enableRunningInTestHarnessForTests()170 public static void enableRunningInTestHarnessForTests() { 171 IS_RUNNING_IN_TEST_HARNESS = true; 172 } 173 isPropertyEnabled(String propertyName)174 public static boolean isPropertyEnabled(String propertyName) { 175 return Log.isLoggable(propertyName, Log.VERBOSE); 176 } 177 existsStyleWallpapers(Context context)178 public static boolean existsStyleWallpapers(Context context) { 179 ResolveInfo ri = context.getPackageManager().resolveActivity( 180 PackageManagerHelper.getStyleWallpapersIntent(context), 0); 181 return ri != null; 182 } 183 184 /** 185 * Given a coordinate relative to the descendant, find the coordinate in a parent view's 186 * coordinates. 187 * 188 * @param descendant The descendant to which the passed coordinate is relative. 189 * @param ancestor The root view to make the coordinates relative to. 190 * @param coord The coordinate that we want mapped. 191 * @param includeRootScroll Whether or not to account for the scroll of the descendant: 192 * sometimes this is relevant as in a child's coordinates within the descendant. 193 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution 194 * this scale factor is assumed to be equal in X and Y, and so if at any point this 195 * assumption fails, we will need to return a pair of scale factors. 196 */ getDescendantCoordRelativeToAncestor( View descendant, View ancestor, float[] coord, boolean includeRootScroll)197 public static float getDescendantCoordRelativeToAncestor( 198 View descendant, View ancestor, float[] coord, boolean includeRootScroll) { 199 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll, 200 false); 201 } 202 203 /** 204 * Given a coordinate relative to the descendant, find the coordinate in a parent view's 205 * coordinates. 206 * 207 * @param descendant The descendant to which the passed coordinate is relative. 208 * @param ancestor The root view to make the coordinates relative to. 209 * @param coord The coordinate that we want mapped. 210 * @param includeRootScroll Whether or not to account for the scroll of the descendant: 211 * sometimes this is relevant as in a child's coordinates within the descendant. 212 * @param ignoreTransform If true, view transform is ignored 213 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution 214 * this scale factor is assumed to be equal in X and Y, and so if at any point this 215 * assumption fails, we will need to return a pair of scale factors. 216 */ getDescendantCoordRelativeToAncestor(View descendant, View ancestor, float[] coord, boolean includeRootScroll, boolean ignoreTransform)217 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor, 218 float[] coord, boolean includeRootScroll, boolean ignoreTransform) { 219 float scale = 1.0f; 220 View v = descendant; 221 while(v != ancestor && v != null) { 222 // For TextViews, scroll has a meaning which relates to the text position 223 // which is very strange... ignore the scroll. 224 if (v != descendant || includeRootScroll) { 225 offsetPoints(coord, -v.getScrollX(), -v.getScrollY()); 226 } 227 228 if (!ignoreTransform) { 229 v.getMatrix().mapPoints(coord); 230 } 231 offsetPoints(coord, v.getLeft(), v.getTop()); 232 scale *= v.getScaleX(); 233 234 v = (View) v.getParent(); 235 } 236 return scale; 237 } 238 239 /** 240 * Returns bounds for a child view of DragLayer, in drag layer coordinates. 241 * 242 * see {@link com.android.launcher3.dragndrop.DragLayer}. 243 * 244 * @param viewBounds Bounds of the view wanted in drag layer coordinates, relative to the view 245 * itself. eg. (0, 0, view.getWidth, view.getHeight) 246 * @param ignoreTransform If true, view transform is ignored 247 * @param outRect The out rect where we return the bounds of {@param view} in drag layer coords. 248 */ getBoundsForViewInDragLayer(BaseDragLayer dragLayer, View view, Rect viewBounds, boolean ignoreTransform, float[] recycle, RectF outRect)249 public static void getBoundsForViewInDragLayer(BaseDragLayer dragLayer, View view, 250 Rect viewBounds, boolean ignoreTransform, float[] recycle, RectF outRect) { 251 float[] points = recycle == null ? new float[4] : recycle; 252 points[0] = viewBounds.left; 253 points[1] = viewBounds.top; 254 points[2] = viewBounds.right; 255 points[3] = viewBounds.bottom; 256 257 Utilities.getDescendantCoordRelativeToAncestor(view, dragLayer, points, 258 false, ignoreTransform); 259 outRect.set( 260 Math.min(points[0], points[2]), 261 Math.min(points[1], points[3]), 262 Math.max(points[0], points[2]), 263 Math.max(points[1], points[3])); 264 } 265 266 /** 267 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}. 268 */ mapCoordInSelfToDescendant(View descendant, View root, float[] coord)269 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) { 270 sMatrix.reset(); 271 View v = descendant; 272 while(v != root) { 273 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY()); 274 sMatrix.postConcat(v.getMatrix()); 275 sMatrix.postTranslate(v.getLeft(), v.getTop()); 276 v = (View) v.getParent(); 277 } 278 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY()); 279 sMatrix.invert(sInverseMatrix); 280 sInverseMatrix.mapPoints(coord); 281 } 282 283 /** 284 * Sets {@param out} to be same as {@param in} by rounding individual values 285 */ roundArray(float[] in, int[] out)286 public static void roundArray(float[] in, int[] out) { 287 for (int i = 0; i < in.length; i++) { 288 out[i] = Math.round(in[i]); 289 } 290 } 291 offsetPoints(float[] points, float offsetX, float offsetY)292 public static void offsetPoints(float[] points, float offsetX, float offsetY) { 293 for (int i = 0; i < points.length; i += 2) { 294 points[i] += offsetX; 295 points[i + 1] += offsetY; 296 } 297 } 298 299 /** 300 * Utility method to determine whether the given point, in local coordinates, 301 * is inside the view, where the area of the view is expanded by the slop factor. 302 * This method is called while processing touch-move events to determine if the event 303 * is still within the view. 304 */ pointInView(View v, float localX, float localY, float slop)305 public static boolean pointInView(View v, float localX, float localY, float slop) { 306 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) && 307 localY < (v.getHeight() + slop); 308 } 309 getCenterDeltaInScreenSpace(View v0, View v1)310 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) { 311 v0.getLocationInWindow(sLoc0); 312 v1.getLocationInWindow(sLoc1); 313 314 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2; 315 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2; 316 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2; 317 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2; 318 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]}; 319 } 320 321 /** 322 * Helper method to set rectOut with rectFSrc. 323 */ setRect(RectF rectFSrc, Rect rectOut)324 public static void setRect(RectF rectFSrc, Rect rectOut) { 325 rectOut.left = (int) rectFSrc.left; 326 rectOut.top = (int) rectFSrc.top; 327 rectOut.right = (int) rectFSrc.right; 328 rectOut.bottom = (int) rectFSrc.bottom; 329 } 330 scaleRectFAboutCenter(RectF r, float scale)331 public static void scaleRectFAboutCenter(RectF r, float scale) { 332 scaleRectFAboutPivot(r, scale, r.centerX(), r.centerY()); 333 } 334 scaleRectFAboutPivot(RectF r, float scale, float px, float py)335 public static void scaleRectFAboutPivot(RectF r, float scale, float px, float py) { 336 if (scale != 1.0f) { 337 r.offset(-px, -py); 338 r.left = r.left * scale; 339 r.top = r.top * scale ; 340 r.right = r.right * scale; 341 r.bottom = r.bottom * scale; 342 r.offset(px, py); 343 } 344 } 345 scaleRectAboutCenter(Rect r, float scale)346 public static void scaleRectAboutCenter(Rect r, float scale) { 347 if (scale != 1.0f) { 348 int cx = r.centerX(); 349 int cy = r.centerY(); 350 r.offset(-cx, -cy); 351 scaleRect(r, scale); 352 r.offset(cx, cy); 353 } 354 } 355 scaleRect(Rect r, float scale)356 public static void scaleRect(Rect r, float scale) { 357 if (scale != 1.0f) { 358 r.left = (int) (r.left * scale + 0.5f); 359 r.top = (int) (r.top * scale + 0.5f); 360 r.right = (int) (r.right * scale + 0.5f); 361 r.bottom = (int) (r.bottom * scale + 0.5f); 362 } 363 } 364 insetRect(Rect r, Rect insets)365 public static void insetRect(Rect r, Rect insets) { 366 r.left = Math.min(r.right, r.left + insets.left); 367 r.top = Math.min(r.bottom, r.top + insets.top); 368 r.right = Math.max(r.left, r.right - insets.right); 369 r.bottom = Math.max(r.top, r.bottom - insets.bottom); 370 } 371 shrinkRect(Rect r, float scaleX, float scaleY)372 public static float shrinkRect(Rect r, float scaleX, float scaleY) { 373 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f); 374 if (scale < 1.0f) { 375 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f); 376 r.left += deltaX; 377 r.right -= deltaX; 378 379 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f); 380 r.top += deltaY; 381 r.bottom -= deltaY; 382 } 383 return scale; 384 } 385 386 /** 387 * Similar to {@link #scaleRectAboutCenter(Rect, float)} except this allows different scales 388 * for X and Y 389 */ scaleRectFAboutCenter(RectF r, float scaleX, float scaleY)390 public static void scaleRectFAboutCenter(RectF r, float scaleX, float scaleY) { 391 float px = r.centerX(); 392 float py = r.centerY(); 393 r.offset(-px, -py); 394 r.left = r.left * scaleX; 395 r.top = r.top * scaleY; 396 r.right = r.right * scaleX; 397 r.bottom = r.bottom * scaleY; 398 r.offset(px, py); 399 } 400 401 /** 402 * Maps t from one range to another range. 403 * @param t The value to map. 404 * @param fromMin The lower bound of the range that t is being mapped from. 405 * @param fromMax The upper bound of the range that t is being mapped from. 406 * @param toMin The lower bound of the range that t is being mapped to. 407 * @param toMax The upper bound of the range that t is being mapped to. 408 * @return The mapped value of t. 409 */ mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax, Interpolator interpolator)410 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax, 411 Interpolator interpolator) { 412 if (fromMin == fromMax || toMin == toMax) { 413 Log.e(TAG, "mapToRange: range has 0 length"); 414 return toMin; 415 } 416 float progress = getProgress(t, fromMin, fromMax); 417 return mapRange(interpolator.getInterpolation(progress), toMin, toMax); 418 } 419 420 /** Bounds t between a lower and upper bound and maps the result to a range. */ mapBoundToRange(float t, float lowerBound, float upperBound, float toMin, float toMax, Interpolator interpolator)421 public static float mapBoundToRange(float t, float lowerBound, float upperBound, 422 float toMin, float toMax, Interpolator interpolator) { 423 return mapToRange(boundToRange(t, lowerBound, upperBound), lowerBound, upperBound, 424 toMin, toMax, interpolator); 425 } 426 getProgress(float current, float min, float max)427 public static float getProgress(float current, float min, float max) { 428 return Math.abs(current - min) / Math.abs(max - min); 429 } 430 mapRange(float value, float min, float max)431 public static float mapRange(float value, float min, float max) { 432 return min + (value * (max - min)); 433 } 434 435 /** 436 * Bounds parameter to the range [0, 1] 437 */ saturate(float a)438 public static float saturate(float a) { 439 return boundToRange(a, 0, 1.0f); 440 } 441 442 /** 443 * Returns the compliment (1 - a) of the parameter. 444 */ comp(float a)445 public static float comp(float a) { 446 return 1 - a; 447 } 448 449 /** 450 * Returns the "probabilistic or" of a and b. (a + b - ab). 451 * Useful beyond probability, can be used to combine two unit progresses for example. 452 */ or(float a, float b)453 public static float or(float a, float b) { 454 float satA = saturate(a); 455 float satB = saturate(b); 456 return satA + satB - (satA * satB); 457 } 458 459 /** 460 * Trims the string, removing all whitespace at the beginning and end of the string. 461 * Non-breaking whitespaces are also removed. 462 */ trim(CharSequence s)463 public static String trim(CharSequence s) { 464 if (s == null) { 465 return null; 466 } 467 468 // Just strip any sequence of whitespace or java space characters from the beginning and end 469 Matcher m = sTrimPattern.matcher(s); 470 return m.replaceAll("$1"); 471 } 472 473 /** 474 * Calculates the height of a given string at a specific text size. 475 */ calculateTextHeight(float textSizePx)476 public static int calculateTextHeight(float textSizePx) { 477 Paint p = new Paint(); 478 p.setTextSize(textSizePx); 479 Paint.FontMetrics fm = p.getFontMetrics(); 480 return (int) Math.ceil(fm.bottom - fm.top); 481 } 482 isRtl(Resources res)483 public static boolean isRtl(Resources res) { 484 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL; 485 } 486 dpiFromPx(float size, int densityDpi)487 public static float dpiFromPx(float size, int densityDpi) { 488 float densityRatio = (float) densityDpi / DisplayMetrics.DENSITY_DEFAULT; 489 return (size / densityRatio); 490 } 491 492 /** Converts a dp value to pixels for the current device. */ dpToPx(float dp)493 public static int dpToPx(float dp) { 494 return (int) (dp * Resources.getSystem().getDisplayMetrics().density); 495 } 496 497 pxFromSp(float size, DisplayMetrics metrics)498 public static int pxFromSp(float size, DisplayMetrics metrics) { 499 return pxFromSp(size, metrics, 1f); 500 } 501 pxFromSp(float size, DisplayMetrics metrics, float scale)502 public static int pxFromSp(float size, DisplayMetrics metrics, float scale) { 503 return Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP, 504 size, metrics) * scale); 505 } 506 createDbSelectionQuery(String columnName, IntArray values)507 public static String createDbSelectionQuery(String columnName, IntArray values) { 508 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString()); 509 } 510 isBootCompleted()511 public static boolean isBootCompleted() { 512 return "1".equals(getSystemProperty("sys.boot_completed", "1")); 513 } 514 getSystemProperty(String property, String defaultValue)515 public static String getSystemProperty(String property, String defaultValue) { 516 try { 517 Class clazz = Class.forName("android.os.SystemProperties"); 518 Method getter = clazz.getDeclaredMethod("get", String.class); 519 String value = (String) getter.invoke(null, property); 520 if (!TextUtils.isEmpty(value)) { 521 return value; 522 } 523 } catch (Exception e) { 524 Log.d(TAG, "Unable to read system properties"); 525 } 526 return defaultValue; 527 } 528 529 /** 530 * Using the view's bounds and icon size, calculate where the icon bounds will 531 * be if it was positioned at the center of the view. 532 */ setRectToViewCenter(View iconView, int iconSize, Rect outBounds)533 public static void setRectToViewCenter(View iconView, int iconSize, Rect outBounds) { 534 int top = (iconView.getHeight() - iconSize) / 2; 535 int left = (iconView.getWidth() - iconSize) / 2; 536 int right = left + iconSize; 537 int bottom = top + iconSize; 538 outBounds.set(left, top, right, bottom); 539 } 540 541 /** 542 * Ensures that a value is within given bounds. Specifically: 543 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound, 544 * return upperBound; else return value unchanged. 545 */ boundToRange(int value, int lowerBound, int upperBound)546 public static int boundToRange(int value, int lowerBound, int upperBound) { 547 return Math.max(lowerBound, Math.min(value, upperBound)); 548 } 549 550 /** 551 * @see #boundToRange(int, int, int). 552 */ boundToRange(float value, float lowerBound, float upperBound)553 public static float boundToRange(float value, float lowerBound, float upperBound) { 554 return Math.max(lowerBound, Math.min(value, upperBound)); 555 } 556 557 /** 558 * @see #boundToRange(int, int, int). 559 */ boundToRange(long value, long lowerBound, long upperBound)560 public static long boundToRange(long value, long lowerBound, long upperBound) { 561 return Math.max(lowerBound, Math.min(value, upperBound)); 562 } 563 564 /** 565 * Returns an intent for starting the default home activity 566 */ createHomeIntent()567 public static Intent createHomeIntent() { 568 return new Intent(Intent.ACTION_MAIN) 569 .addCategory(Intent.CATEGORY_HOME) 570 .setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 571 } 572 573 /** 574 * Wraps a message with a TTS span, so that a different message is spoken than 575 * what is getting displayed. 576 * @param msg original message 577 * @param ttsMsg message to be spoken 578 */ wrapForTts(CharSequence msg, String ttsMsg)579 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) { 580 SpannableString spanned = new SpannableString(msg); 581 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(), 582 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE); 583 return spanned; 584 } 585 586 /** 587 * Prefixes a text with the provided icon 588 */ prefixTextWithIcon(Context context, int iconRes, CharSequence msg)589 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) { 590 // Update the hint to contain the icon. 591 // Prefix the original hint with two spaces. The first space gets replaced by the icon 592 // using span. The second space is used for a singe space character between the hint 593 // and the icon. 594 SpannableString spanned = new SpannableString(" " + msg); 595 spanned.setSpan(new TintedDrawableSpan(context, iconRes), 596 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE); 597 return spanned; 598 } 599 getPrefs(Context context)600 public static SharedPreferences getPrefs(Context context) { 601 // Use application context for shared preferences, so that we use a single cached instance 602 return context.getApplicationContext().getSharedPreferences( 603 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE); 604 } 605 getDevicePrefs(Context context)606 public static SharedPreferences getDevicePrefs(Context context) { 607 // Use application context for shared preferences, so that we use a single cached instance 608 return context.getApplicationContext().getSharedPreferences( 609 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE); 610 } 611 isWallpaperAllowed(Context context)612 public static boolean isWallpaperAllowed(Context context) { 613 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed(); 614 } 615 isBinderSizeError(Exception e)616 public static boolean isBinderSizeError(Exception e) { 617 return e.getCause() instanceof TransactionTooLargeException 618 || e.getCause() instanceof DeadObjectException; 619 } 620 isGridOptionsEnabled(Context context)621 public static boolean isGridOptionsEnabled(Context context) { 622 return isComponentEnabled(context.getPackageManager(), 623 context.getPackageName(), 624 GridCustomizationsProvider.class.getName()); 625 } 626 isComponentEnabled(PackageManager pm, String pkgName, String clsName)627 private static boolean isComponentEnabled(PackageManager pm, String pkgName, String clsName) { 628 ComponentName componentName = new ComponentName(pkgName, clsName); 629 int componentEnabledSetting = pm.getComponentEnabledSetting(componentName); 630 631 switch (componentEnabledSetting) { 632 case PackageManager.COMPONENT_ENABLED_STATE_DISABLED: 633 return false; 634 case PackageManager.COMPONENT_ENABLED_STATE_ENABLED: 635 return true; 636 case PackageManager.COMPONENT_ENABLED_STATE_DEFAULT: 637 default: 638 // We need to get the application info to get the component's default state 639 try { 640 PackageInfo packageInfo = pm.getPackageInfo(pkgName, 641 PackageManager.GET_PROVIDERS | PackageManager.GET_DISABLED_COMPONENTS); 642 643 if (packageInfo.providers != null) { 644 return Arrays.stream(packageInfo.providers).anyMatch( 645 pi -> pi.name.equals(clsName) && pi.isEnabled()); 646 } 647 648 // the component is not declared in the AndroidManifest 649 return false; 650 } catch (PackageManager.NameNotFoundException e) { 651 // the package isn't installed on the device 652 return false; 653 } 654 } 655 } 656 657 /** 658 * Utility method to post a runnable on the handler, skipping the synchronization barriers. 659 */ postAsyncCallback(Handler handler, Runnable callback)660 public static void postAsyncCallback(Handler handler, Runnable callback) { 661 Message msg = Message.obtain(handler, callback); 662 msg.setAsynchronous(true); 663 handler.sendMessage(msg); 664 } 665 unregisterReceiverSafely(Context context, BroadcastReceiver receiver)666 public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) { 667 try { 668 context.unregisterReceiver(receiver); 669 } catch (IllegalArgumentException e) {} 670 } 671 672 /** 673 * Returns the full drawable for info without any flattening or pre-processing. 674 * 675 * @param outObj this is set to the internal data associated with {@param info}, 676 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}. 677 */ getFullDrawable(Context context, ItemInfo info, int width, int height, Object[] outObj)678 public static Drawable getFullDrawable(Context context, ItemInfo info, int width, int height, 679 Object[] outObj) { 680 Drawable icon = loadFullDrawableWithoutTheme(context, info, width, height, outObj); 681 if (icon instanceof BitmapInfo.Extender) { 682 icon = ((BitmapInfo.Extender) icon).getThemedDrawable(context); 683 } 684 return icon; 685 } 686 loadFullDrawableWithoutTheme(Context context, ItemInfo info, int width, int height, Object[] outObj)687 private static Drawable loadFullDrawableWithoutTheme(Context context, ItemInfo info, 688 int width, int height, Object[] outObj) { 689 ActivityContext activity = ActivityContext.lookupContext(context); 690 LauncherAppState appState = LauncherAppState.getInstance(context); 691 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) { 692 LauncherActivityInfo activityInfo = context.getSystemService(LauncherApps.class) 693 .resolveActivity(info.getIntent(), info.user); 694 outObj[0] = activityInfo; 695 return activityInfo == null ? null : LauncherAppState.getInstance(context) 696 .getIconProvider().getIcon( 697 activityInfo, activity.getDeviceProfile().inv.fillResIconDpi); 698 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) { 699 if (info instanceof PendingAddShortcutInfo) { 700 ShortcutConfigActivityInfo activityInfo = 701 ((PendingAddShortcutInfo) info).activityInfo; 702 outObj[0] = activityInfo; 703 return activityInfo.getFullResIcon(appState.getIconCache()); 704 } 705 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info) 706 .buildRequest(context) 707 .query(ShortcutRequest.ALL); 708 if (si.isEmpty()) { 709 return null; 710 } else { 711 outObj[0] = si.get(0); 712 return ShortcutCachingLogic.getIcon(context, si.get(0), 713 appState.getInvariantDeviceProfile().fillResIconDpi); 714 } 715 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) { 716 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon( 717 activity, info.id, new Point(width, height)); 718 if (icon == null) { 719 return null; 720 } 721 outObj[0] = icon; 722 return icon; 723 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_SEARCH_ACTION 724 && info instanceof SearchActionItemInfo) { 725 return new AdaptiveIconDrawable( 726 new FastBitmapDrawable(((SearchActionItemInfo) info).bitmap), null); 727 } else { 728 return null; 729 } 730 } 731 732 /** 733 * For apps icons and shortcut icons that have badges, this method creates a drawable that can 734 * later on be rendered on top of the layers for the badges. For app icons, work profile badges 735 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no 736 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge 737 **/ 738 @TargetApi(Build.VERSION_CODES.O) getBadge(Context context, ItemInfo info, Object obj)739 public static Drawable getBadge(Context context, ItemInfo info, Object obj) { 740 LauncherAppState appState = LauncherAppState.getInstance(context); 741 int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize; 742 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) { 743 boolean iconBadged = (info instanceof ItemInfoWithIcon) 744 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0; 745 if ((info.id == ItemInfo.NO_ID && !iconBadged) 746 || !(obj instanceof ShortcutInfo)) { 747 // The item is not yet added on home screen. 748 return new FixedSizeEmptyDrawable(iconSize); 749 } 750 ShortcutInfo si = (ShortcutInfo) obj; 751 Bitmap badge = LauncherAppState.getInstance(appState.getContext()) 752 .getIconCache().getShortcutInfoBadge(si).icon; 753 float badgeSize = LauncherIcons.getBadgeSizeForIconSize(iconSize); 754 float insetFraction = (iconSize - badgeSize) / iconSize; 755 return new InsetDrawable(new FastBitmapDrawable(badge), 756 insetFraction, insetFraction, 0, 0); 757 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) { 758 return ((FolderAdaptiveIcon) obj).getBadge(); 759 } else { 760 return context.getPackageManager() 761 .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user); 762 } 763 } 764 765 /** 766 * @return true is the extra is either null or is of type {@param type} 767 */ isValidExtraType(Intent intent, String key, Class type)768 public static boolean isValidExtraType(Intent intent, String key, Class type) { 769 Object extra = intent.getParcelableExtra(key); 770 return extra == null || type.isInstance(extra); 771 } 772 squaredHypot(float x, float y)773 public static float squaredHypot(float x, float y) { 774 return x * x + y * y; 775 } 776 squaredTouchSlop(Context context)777 public static float squaredTouchSlop(Context context) { 778 float slop = ViewConfiguration.get(context).getScaledTouchSlop(); 779 return slop * slop; 780 } 781 782 /** 783 * Helper method to create a content provider 784 */ newContentObserver(Handler handler, Consumer<Uri> command)785 public static ContentObserver newContentObserver(Handler handler, Consumer<Uri> command) { 786 return new ContentObserver(handler) { 787 @Override 788 public void onChange(boolean selfChange, Uri uri) { 789 command.accept(uri); 790 } 791 }; 792 } 793 794 /** 795 * Compares the ratio of two quantities and returns whether that ratio is greater than the 796 * provided bound. Order of quantities does not matter. Bound should be a decimal representation 797 * of a percentage. 798 */ 799 public static boolean isRelativePercentDifferenceGreaterThan(float first, float second, 800 float bound) { 801 return (Math.abs(first - second) / Math.abs((first + second) / 2.0f)) > bound; 802 } 803 804 /** 805 * Rotates `inOutBounds` by `delta` 90-degree increments. Rotation is visually CCW. Parent 806 * sizes represent the "space" that will rotate carrying inOutBounds along with it to determine 807 * the final bounds. 808 */ 809 public static void rotateBounds(Rect inOutBounds, int parentWidth, int parentHeight, 810 int delta) { 811 int rdelta = ((delta % 4) + 4) % 4; 812 int origLeft = inOutBounds.left; 813 switch (rdelta) { 814 case 0: 815 return; 816 case 1: 817 inOutBounds.left = inOutBounds.top; 818 inOutBounds.top = parentWidth - inOutBounds.right; 819 inOutBounds.right = inOutBounds.bottom; 820 inOutBounds.bottom = parentWidth - origLeft; 821 return; 822 case 2: 823 inOutBounds.left = parentWidth - inOutBounds.right; 824 inOutBounds.right = parentWidth - origLeft; 825 return; 826 case 3: 827 inOutBounds.left = parentHeight - inOutBounds.bottom; 828 inOutBounds.bottom = inOutBounds.right; 829 inOutBounds.right = parentHeight - inOutBounds.top; 830 inOutBounds.top = origLeft; 831 return; 832 } 833 } 834 835 /** 836 * Make a color filter that blends a color into the destination based on a scalable amout. 837 * 838 * @param color to blend in. 839 * @param tintAmount [0-1] 0 no tinting, 1 full color. 840 * @return ColorFilter for tinting, or {@code null} if no filter is needed. 841 */ 842 public static ColorFilter makeColorTintingColorFilter(int color, float tintAmount) { 843 if (tintAmount == 0f) { 844 return null; 845 } 846 return new LightingColorFilter( 847 // This isn't blending in white, its making a multiplication mask for the base color 848 ColorUtils.blendARGB(Color.WHITE, 0, tintAmount), 849 ColorUtils.blendARGB(0, color, tintAmount)); 850 } 851 852 /** 853 * Sets start margin on the provided {@param view} to be {@param margin}. 854 * Assumes {@param view} is a child of {@link LinearLayout} 855 */ 856 public static void setStartMarginForView(View view, int margin) { 857 LinearLayout.LayoutParams lp = (LinearLayout.LayoutParams) view.getLayoutParams(); 858 lp.setMarginStart(margin); 859 view.setLayoutParams(lp); 860 } 861 862 public static Rect getViewBounds(@NonNull View v) { 863 int[] pos = new int[2]; 864 v.getLocationOnScreen(pos); 865 return new Rect(pos[0], pos[1], pos[0] + v.getWidth(), pos[1] + v.getHeight()); 866 } 867 868 private static class FixedSizeEmptyDrawable extends ColorDrawable { 869 870 private final int mSize; 871 872 public FixedSizeEmptyDrawable(int size) { 873 super(Color.TRANSPARENT); 874 mSize = size; 875 } 876 877 @Override 878 public int getIntrinsicHeight() { 879 return mSize; 880 } 881 882 @Override 883 public int getIntrinsicWidth() { 884 return mSize; 885 } 886 } 887 } 888