• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 android.animation.ValueAnimator;
20 import android.annotation.TargetApi;
21 import android.app.ActivityManager;
22 import android.app.WallpaperManager;
23 import android.content.BroadcastReceiver;
24 import android.content.ComponentName;
25 import android.content.Context;
26 import android.content.Intent;
27 import android.content.SharedPreferences;
28 import android.content.pm.ApplicationInfo;
29 import android.content.pm.LauncherActivityInfo;
30 import android.content.pm.PackageInfo;
31 import android.content.pm.PackageManager;
32 import android.content.pm.PackageManager.NameNotFoundException;
33 import android.content.pm.ResolveInfo;
34 import android.content.pm.ShortcutInfo;
35 import android.content.res.Resources;
36 import android.graphics.Bitmap;
37 import android.graphics.Color;
38 import android.graphics.Matrix;
39 import android.graphics.Paint;
40 import android.graphics.Point;
41 import android.graphics.Rect;
42 import android.graphics.RectF;
43 import android.graphics.drawable.ColorDrawable;
44 import android.graphics.drawable.Drawable;
45 import android.graphics.drawable.InsetDrawable;
46 import android.os.Build;
47 import android.os.Bundle;
48 import android.os.DeadObjectException;
49 import android.os.Handler;
50 import android.os.Message;
51 import android.os.PowerManager;
52 import android.os.TransactionTooLargeException;
53 import android.provider.Settings;
54 import android.text.Spannable;
55 import android.text.SpannableString;
56 import android.text.TextUtils;
57 import android.text.style.TtsSpan;
58 import android.util.DisplayMetrics;
59 import android.util.Log;
60 import android.util.Pair;
61 import android.util.TypedValue;
62 import android.view.MotionEvent;
63 import android.view.View;
64 import android.view.ViewConfiguration;
65 import android.view.animation.Interpolator;
66 
67 import com.android.launcher3.compat.LauncherAppsCompat;
68 import com.android.launcher3.compat.ShortcutConfigActivityInfo;
69 import com.android.launcher3.config.FeatureFlags;
70 import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
71 import com.android.launcher3.graphics.RotationMode;
72 import com.android.launcher3.graphics.TintedDrawableSpan;
73 import com.android.launcher3.icons.LauncherIcons;
74 import com.android.launcher3.shortcuts.DeepShortcutManager;
75 import com.android.launcher3.shortcuts.ShortcutKey;
76 import com.android.launcher3.util.IntArray;
77 import com.android.launcher3.util.PackageManagerHelper;
78 import com.android.launcher3.views.Transposable;
79 import com.android.launcher3.widget.PendingAddShortcutInfo;
80 
81 import java.io.Closeable;
82 import java.io.IOException;
83 import java.lang.reflect.Method;
84 import java.util.Arrays;
85 import java.util.List;
86 import java.util.Locale;
87 import java.util.StringTokenizer;
88 import java.util.concurrent.Executor;
89 import java.util.concurrent.LinkedBlockingQueue;
90 import java.util.concurrent.ThreadPoolExecutor;
91 import java.util.concurrent.TimeUnit;
92 import java.util.regex.Matcher;
93 import java.util.regex.Pattern;
94 
95 import static com.android.launcher3.ItemInfoWithIcon.FLAG_ICON_BADGED;
96 
97 /**
98  * Various utilities shared amongst the Launcher's classes.
99  */
100 public final class Utilities {
101 
102     private static final String TAG = "Launcher.Utilities";
103 
104     private static final Pattern sTrimPattern =
105             Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
106 
107     private static final int[] sLoc0 = new int[2];
108     private static final int[] sLoc1 = new int[2];
109     private static final Matrix sMatrix = new Matrix();
110     private static final Matrix sInverseMatrix = new Matrix();
111 
112     public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
113 
114     public static final boolean ATLEAST_P =
115             Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
116 
117     public static final boolean ATLEAST_OREO_MR1 =
118             Build.VERSION.SDK_INT >= Build.VERSION_CODES.O_MR1;
119 
120     public static final boolean ATLEAST_OREO =
121             Build.VERSION.SDK_INT >= Build.VERSION_CODES.O;
122 
123     public static final int SINGLE_FRAME_MS = 16;
124 
125     /**
126      * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
127      */
128     public static final int EDGE_NAV_BAR = 1 << 8;
129 
130     /**
131      * Set on a motion event do disallow any gestures and only handle touch.
132      * See {@link MotionEvent#setEdgeFlags(int)}.
133      */
134     public static final int FLAG_NO_GESTURES = 1 << 9;
135 
shouldDisableGestures(MotionEvent ev)136     public static boolean shouldDisableGestures(MotionEvent ev) {
137         return (ev.getEdgeFlags() & FLAG_NO_GESTURES) == FLAG_NO_GESTURES;
138     }
139 
140     /**
141      * Indicates if the device has a debug build. Should only be used to store additional info or
142      * add extra logging and not for changing the app behavior.
143      */
144     public static final boolean IS_DEBUG_DEVICE =
145             Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
146             Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
147 
isDevelopersOptionsEnabled(Context context)148     public static boolean isDevelopersOptionsEnabled(Context context) {
149         return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
150                         Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
151     }
152 
153     // An intent extra to indicate the horizontal scroll of the wallpaper.
154     public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
155     public static final String EXTRA_WALLPAPER_FLAVOR = "com.android.launcher3.WALLPAPER_FLAVOR";
156 
157     // These values are same as that in {@link AsyncTask}.
158     private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
159     private static final int CORE_POOL_SIZE = CPU_COUNT + 1;
160     private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
161     private static final int KEEP_ALIVE = 1;
162     /**
163      * An {@link Executor} to be used with async task with no limit on the queue size.
164      */
165     public static final Executor THREAD_POOL_EXECUTOR = new ThreadPoolExecutor(
166             CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE,
167             TimeUnit.SECONDS, new LinkedBlockingQueue<>());
168 
169     public static boolean IS_RUNNING_IN_TEST_HARNESS =
170                     ActivityManager.isRunningInTestHarness();
171 
enableRunningInTestHarnessForTests()172     public static void enableRunningInTestHarnessForTests() {
173         IS_RUNNING_IN_TEST_HARNESS = true;
174     }
175 
isPropertyEnabled(String propertyName)176     public static boolean isPropertyEnabled(String propertyName) {
177         return Log.isLoggable(propertyName, Log.VERBOSE);
178     }
179 
existsStyleWallpapers(Context context)180     public static boolean existsStyleWallpapers(Context context) {
181         ResolveInfo ri = context.getPackageManager().resolveActivity(
182                 PackageManagerHelper.getStyleWallpapersIntent(context), 0);
183         return ri != null;
184     }
185 
186     /**
187      * Given a coordinate relative to the descendant, find the coordinate in a parent view's
188      * coordinates.
189      *
190      * @param descendant The descendant to which the passed coordinate is relative.
191      * @param ancestor The root view to make the coordinates relative to.
192      * @param coord The coordinate that we want mapped.
193      * @param includeRootScroll Whether or not to account for the scroll of the descendant:
194      *          sometimes this is relevant as in a child's coordinates within the descendant.
195      * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
196      *         this scale factor is assumed to be equal in X and Y, and so if at any point this
197      *         assumption fails, we will need to return a pair of scale factors.
198      */
getDescendantCoordRelativeToAncestor( View descendant, View ancestor, float[] coord, boolean includeRootScroll)199     public static float getDescendantCoordRelativeToAncestor(
200             View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
201         return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
202                 false, null);
203     }
204 
205     /**
206      * Given a coordinate relative to the descendant, find the coordinate in a parent view's
207      * coordinates.
208      *
209      * @param descendant The descendant to which the passed coordinate is relative.
210      * @param ancestor The root view to make the coordinates relative to.
211      * @param coord The coordinate that we want mapped.
212      * @param includeRootScroll Whether or not to account for the scroll of the descendant:
213      *          sometimes this is relevant as in a child's coordinates within the descendant.
214      * @param ignoreTransform If true, view transform is ignored
215      * @param outRotation If not null, and {@param ignoreTransform} is true, this is set to the
216      *                   overall rotation of the view in degrees.
217      * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
218      *         this scale factor is assumed to be equal in X and Y, and so if at any point this
219      *         assumption fails, we will need to return a pair of scale factors.
220      */
getDescendantCoordRelativeToAncestor(View descendant, View ancestor, float[] coord, boolean includeRootScroll, boolean ignoreTransform, float[] outRotation)221     public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
222             float[] coord, boolean includeRootScroll, boolean ignoreTransform,
223             float[] outRotation) {
224         float scale = 1.0f;
225         View v = descendant;
226         while(v != ancestor && v != null) {
227             // For TextViews, scroll has a meaning which relates to the text position
228             // which is very strange... ignore the scroll.
229             if (v != descendant || includeRootScroll) {
230                 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
231             }
232 
233             if (ignoreTransform) {
234                 if (v instanceof Transposable) {
235                     RotationMode m = ((Transposable) v).getRotationMode();
236                     if (m.isTransposed) {
237                         sMatrix.setRotate(m.surfaceRotation, v.getPivotX(), v.getPivotY());
238                         sMatrix.mapPoints(coord);
239 
240                         if (outRotation != null) {
241                             outRotation[0] += m.surfaceRotation;
242                         }
243                     }
244                 }
245             } else {
246                 v.getMatrix().mapPoints(coord);
247             }
248             offsetPoints(coord, v.getLeft(), v.getTop());
249             scale *= v.getScaleX();
250 
251             v = (View) v.getParent();
252         }
253         return scale;
254     }
255 
256 
257     /**
258      * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
259      */
mapCoordInSelfToDescendant(View descendant, View root, float[] coord)260     public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
261         sMatrix.reset();
262         View v = descendant;
263         while(v != root) {
264             sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
265             sMatrix.postConcat(v.getMatrix());
266             sMatrix.postTranslate(v.getLeft(), v.getTop());
267             v = (View) v.getParent();
268         }
269         sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
270         sMatrix.invert(sInverseMatrix);
271         sInverseMatrix.mapPoints(coord);
272     }
273 
274     /**
275      * Sets {@param out} to be same as {@param in} by rounding individual values
276      */
roundArray(float[] in, int[] out)277     public static void roundArray(float[] in, int[] out) {
278        for (int i = 0; i < in.length; i++) {
279            out[i] = Math.round(in[i]);
280        }
281     }
282 
offsetPoints(float[] points, float offsetX, float offsetY)283     public static void offsetPoints(float[] points, float offsetX, float offsetY) {
284         for (int i = 0; i < points.length; i += 2) {
285             points[i] += offsetX;
286             points[i + 1] += offsetY;
287         }
288     }
289 
290     /**
291      * Utility method to determine whether the given point, in local coordinates,
292      * is inside the view, where the area of the view is expanded by the slop factor.
293      * This method is called while processing touch-move events to determine if the event
294      * is still within the view.
295      */
pointInView(View v, float localX, float localY, float slop)296     public static boolean pointInView(View v, float localX, float localY, float slop) {
297         return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
298                 localY < (v.getHeight() + slop);
299     }
300 
getCenterDeltaInScreenSpace(View v0, View v1)301     public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
302         v0.getLocationInWindow(sLoc0);
303         v1.getLocationInWindow(sLoc1);
304 
305         sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
306         sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
307         sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
308         sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
309         return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
310     }
311 
scaleRectFAboutCenter(RectF r, float scale)312     public static void scaleRectFAboutCenter(RectF r, float scale) {
313         if (scale != 1.0f) {
314             float cx = r.centerX();
315             float cy = r.centerY();
316             r.offset(-cx, -cy);
317             r.left = r.left * scale;
318             r.top = r.top * scale ;
319             r.right = r.right * scale;
320             r.bottom = r.bottom * scale;
321             r.offset(cx, cy);
322         }
323     }
324 
scaleRectAboutCenter(Rect r, float scale)325     public static void scaleRectAboutCenter(Rect r, float scale) {
326         if (scale != 1.0f) {
327             int cx = r.centerX();
328             int cy = r.centerY();
329             r.offset(-cx, -cy);
330             scaleRect(r, scale);
331             r.offset(cx, cy);
332         }
333     }
334 
scaleRect(Rect r, float scale)335     public static void scaleRect(Rect r, float scale) {
336         if (scale != 1.0f) {
337             r.left = (int) (r.left * scale + 0.5f);
338             r.top = (int) (r.top * scale + 0.5f);
339             r.right = (int) (r.right * scale + 0.5f);
340             r.bottom = (int) (r.bottom * scale + 0.5f);
341         }
342     }
343 
insetRect(Rect r, Rect insets)344     public static void insetRect(Rect r, Rect insets) {
345         r.left = Math.min(r.right, r.left + insets.left);
346         r.top = Math.min(r.bottom, r.top + insets.top);
347         r.right = Math.max(r.left, r.right - insets.right);
348         r.bottom = Math.max(r.top, r.bottom - insets.bottom);
349     }
350 
shrinkRect(Rect r, float scaleX, float scaleY)351     public static float shrinkRect(Rect r, float scaleX, float scaleY) {
352         float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
353         if (scale < 1.0f) {
354             int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
355             r.left += deltaX;
356             r.right -= deltaX;
357 
358             int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
359             r.top += deltaY;
360             r.bottom -= deltaY;
361         }
362         return scale;
363     }
364 
365     /**
366      * Maps t from one range to another range.
367      * @param t The value to map.
368      * @param fromMin The lower bound of the range that t is being mapped from.
369      * @param fromMax The upper bound of the range that t is being mapped from.
370      * @param toMin The lower bound of the range that t is being mapped to.
371      * @param toMax The upper bound of the range that t is being mapped to.
372      * @return The mapped value of t.
373      */
mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax, Interpolator interpolator)374     public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
375             Interpolator interpolator) {
376         if (fromMin == fromMax || toMin == toMax) {
377             Log.e(TAG, "mapToRange: range has 0 length");
378             return toMin;
379         }
380         float progress = getProgress(t, fromMin, fromMax);
381         return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
382     }
383 
getProgress(float current, float min, float max)384     public static float getProgress(float current, float min, float max) {
385         return Math.abs(current - min) / Math.abs(max - min);
386     }
387 
mapRange(float value, float min, float max)388     public static float mapRange(float value, float min, float max) {
389         return min + (value * (max - min));
390     }
391 
isSystemApp(Context context, Intent intent)392     public static boolean isSystemApp(Context context, Intent intent) {
393         PackageManager pm = context.getPackageManager();
394         ComponentName cn = intent.getComponent();
395         String packageName = null;
396         if (cn == null) {
397             ResolveInfo info = pm.resolveActivity(intent, PackageManager.MATCH_DEFAULT_ONLY);
398             if ((info != null) && (info.activityInfo != null)) {
399                 packageName = info.activityInfo.packageName;
400             }
401         } else {
402             packageName = cn.getPackageName();
403         }
404         if (packageName != null) {
405             try {
406                 PackageInfo info = pm.getPackageInfo(packageName, 0);
407                 return (info != null) && (info.applicationInfo != null) &&
408                         ((info.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0);
409             } catch (NameNotFoundException e) {
410                 return false;
411             }
412         } else {
413             return false;
414         }
415     }
416 
417     /*
418      * Finds a system apk which had a broadcast receiver listening to a particular action.
419      * @param action intent action used to find the apk
420      * @return a pair of apk package name and the resources.
421      */
findSystemApk(String action, PackageManager pm)422     static Pair<String, Resources> findSystemApk(String action, PackageManager pm) {
423         final Intent intent = new Intent(action);
424         for (ResolveInfo info : pm.queryBroadcastReceivers(intent, 0)) {
425             if (info.activityInfo != null &&
426                     (info.activityInfo.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
427                 final String packageName = info.activityInfo.packageName;
428                 try {
429                     final Resources res = pm.getResourcesForApplication(packageName);
430                     return Pair.create(packageName, res);
431                 } catch (NameNotFoundException e) {
432                     Log.w(TAG, "Failed to find resources for " + packageName);
433                 }
434             }
435         }
436         return null;
437     }
438 
439     /**
440      * Trims the string, removing all whitespace at the beginning and end of the string.
441      * Non-breaking whitespaces are also removed.
442      */
trim(CharSequence s)443     public static String trim(CharSequence s) {
444         if (s == null) {
445             return null;
446         }
447 
448         // Just strip any sequence of whitespace or java space characters from the beginning and end
449         Matcher m = sTrimPattern.matcher(s);
450         return m.replaceAll("$1");
451     }
452 
453     /**
454      * Calculates the height of a given string at a specific text size.
455      */
calculateTextHeight(float textSizePx)456     public static int calculateTextHeight(float textSizePx) {
457         Paint p = new Paint();
458         p.setTextSize(textSizePx);
459         Paint.FontMetrics fm = p.getFontMetrics();
460         return (int) Math.ceil(fm.bottom - fm.top);
461     }
462 
463     /**
464      * Convenience println with multiple args.
465      */
println(String key, Object... args)466     public static void println(String key, Object... args) {
467         StringBuilder b = new StringBuilder();
468         b.append(key);
469         b.append(": ");
470         boolean isFirstArgument = true;
471         for (Object arg : args) {
472             if (isFirstArgument) {
473                 isFirstArgument = false;
474             } else {
475                 b.append(", ");
476             }
477             b.append(arg);
478         }
479         System.out.println(b.toString());
480     }
481 
isRtl(Resources res)482     public static boolean isRtl(Resources res) {
483         return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
484     }
485 
486     /**
487      * Returns true if the intent is a valid launch intent for a launcher activity of an app.
488      * This is used to identify shortcuts which are different from the ones exposed by the
489      * applications' manifest file.
490      *
491      * @param launchIntent The intent that will be launched when the shortcut is clicked.
492      */
isLauncherAppTarget(Intent launchIntent)493     public static boolean isLauncherAppTarget(Intent launchIntent) {
494         if (launchIntent != null
495                 && Intent.ACTION_MAIN.equals(launchIntent.getAction())
496                 && launchIntent.getComponent() != null
497                 && launchIntent.getCategories() != null
498                 && launchIntent.getCategories().size() == 1
499                 && launchIntent.hasCategory(Intent.CATEGORY_LAUNCHER)
500                 && TextUtils.isEmpty(launchIntent.getDataString())) {
501             // An app target can either have no extra or have ItemInfo.EXTRA_PROFILE.
502             Bundle extras = launchIntent.getExtras();
503             return extras == null || extras.keySet().isEmpty();
504         }
505         return false;
506     }
507 
dpiFromPx(int size, DisplayMetrics metrics)508     public static float dpiFromPx(int size, DisplayMetrics metrics){
509         float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
510         return (size / densityRatio);
511     }
512 
pxFromSp(float size, DisplayMetrics metrics)513     public static int pxFromSp(float size, DisplayMetrics metrics) {
514         return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
515                 size, metrics));
516     }
517 
createDbSelectionQuery(String columnName, IntArray values)518     public static String createDbSelectionQuery(String columnName, IntArray values) {
519         return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
520     }
521 
isBootCompleted()522     public static boolean isBootCompleted() {
523         return "1".equals(getSystemProperty("sys.boot_completed", "1"));
524     }
525 
getSystemProperty(String property, String defaultValue)526     public static String getSystemProperty(String property, String defaultValue) {
527         try {
528             Class clazz = Class.forName("android.os.SystemProperties");
529             Method getter = clazz.getDeclaredMethod("get", String.class);
530             String value = (String) getter.invoke(null, property);
531             if (!TextUtils.isEmpty(value)) {
532                 return value;
533             }
534         } catch (Exception e) {
535             Log.d(TAG, "Unable to read system properties");
536         }
537         return defaultValue;
538     }
539 
540     /**
541      * Ensures that a value is within given bounds. Specifically:
542      * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
543      * return upperBound; else return value unchanged.
544      */
boundToRange(int value, int lowerBound, int upperBound)545     public static int boundToRange(int value, int lowerBound, int upperBound) {
546         return Math.max(lowerBound, Math.min(value, upperBound));
547     }
548 
549     /**
550      * @see #boundToRange(int, int, int).
551      */
boundToRange(float value, float lowerBound, float upperBound)552     public static float boundToRange(float value, float lowerBound, float upperBound) {
553         return Math.max(lowerBound, Math.min(value, upperBound));
554     }
555 
556     /**
557      * @see #boundToRange(int, int, int).
558      */
boundToRange(long value, long lowerBound, long upperBound)559     public static long boundToRange(long value, long lowerBound, long upperBound) {
560         return Math.max(lowerBound, Math.min(value, upperBound));
561     }
562 
563     /**
564      * Wraps a message with a TTS span, so that a different message is spoken than
565      * what is getting displayed.
566      * @param msg original message
567      * @param ttsMsg message to be spoken
568      */
wrapForTts(CharSequence msg, String ttsMsg)569     public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
570         SpannableString spanned = new SpannableString(msg);
571         spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
572                 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
573         return spanned;
574     }
575 
576     /**
577      * Prefixes a text with the provided icon
578      */
prefixTextWithIcon(Context context, int iconRes, CharSequence msg)579     public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
580         // Update the hint to contain the icon.
581         // Prefix the original hint with two spaces. The first space gets replaced by the icon
582         // using span. The second space is used for a singe space character between the hint
583         // and the icon.
584         SpannableString spanned = new SpannableString("  " + msg);
585         spanned.setSpan(new TintedDrawableSpan(context, iconRes),
586                 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
587         return spanned;
588     }
589 
getPrefs(Context context)590     public static SharedPreferences getPrefs(Context context) {
591         return context.getSharedPreferences(
592                 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
593     }
594 
getDevicePrefs(Context context)595     public static SharedPreferences getDevicePrefs(Context context) {
596         return context.getSharedPreferences(
597                 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
598     }
599 
areAnimationsEnabled(Context context)600     public static boolean areAnimationsEnabled(Context context) {
601         return ATLEAST_OREO
602                 ? ValueAnimator.areAnimatorsEnabled()
603                 : !context.getSystemService(PowerManager.class).isPowerSaveMode();
604     }
605 
isWallpaperAllowed(Context context)606     public static boolean isWallpaperAllowed(Context context) {
607         return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
608     }
609 
closeSilently(Closeable c)610     public static void closeSilently(Closeable c) {
611         if (c != null) {
612             try {
613                 c.close();
614             } catch (IOException e) {
615                 if (FeatureFlags.IS_DOGFOOD_BUILD) {
616                     Log.d(TAG, "Error closing", e);
617                 }
618             }
619         }
620     }
621 
isBinderSizeError(Exception e)622     public static boolean isBinderSizeError(Exception e) {
623         return e.getCause() instanceof TransactionTooLargeException
624                 || e.getCause() instanceof DeadObjectException;
625     }
626 
627     /**
628      * Utility method to post a runnable on the handler, skipping the synchronization barriers.
629      */
postAsyncCallback(Handler handler, Runnable callback)630     public static void postAsyncCallback(Handler handler, Runnable callback) {
631         Message msg = Message.obtain(handler, callback);
632         msg.setAsynchronous(true);
633         handler.sendMessage(msg);
634     }
635 
636     /**
637      * Parses a string encoded using {@link #getPointString(int, int)}
638      */
parsePoint(String point)639     public static Point parsePoint(String point) {
640         String[] split = point.split(",");
641         return new Point(Integer.parseInt(split[0]), Integer.parseInt(split[1]));
642     }
643 
644     /**
645      * Encodes a point to string to that it can be persisted atomically.
646      */
getPointString(int x, int y)647     public static String getPointString(int x, int y) {
648         return String.format(Locale.ENGLISH, "%d,%d", x, y);
649     }
650 
unregisterReceiverSafely(Context context, BroadcastReceiver receiver)651     public static void unregisterReceiverSafely(Context context, BroadcastReceiver receiver) {
652         try {
653             context.unregisterReceiver(receiver);
654         } catch (IllegalArgumentException e) {}
655     }
656 
657     /**
658      * Returns the full drawable for {@param info}.
659      * @param outObj this is set to the internal data associated with {@param info},
660      *               eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
661      */
getFullDrawable(Launcher launcher, ItemInfo info, int width, int height, boolean flattenDrawable, Object[] outObj)662     public static Drawable getFullDrawable(Launcher launcher, ItemInfo info, int width, int height,
663             boolean flattenDrawable, Object[] outObj) {
664         LauncherAppState appState = LauncherAppState.getInstance(launcher);
665         if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
666             LauncherActivityInfo activityInfo = LauncherAppsCompat.getInstance(launcher)
667                     .resolveActivity(info.getIntent(), info.user);
668             outObj[0] = activityInfo;
669             return (activityInfo != null) ? appState.getIconCache()
670                     .getFullResIcon(activityInfo, flattenDrawable) : null;
671         } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
672             if (info instanceof PendingAddShortcutInfo) {
673                 ShortcutConfigActivityInfo activityInfo =
674                         ((PendingAddShortcutInfo) info).activityInfo;
675                 outObj[0] = activityInfo;
676                 return activityInfo.getFullResIcon(appState.getIconCache());
677             }
678             ShortcutKey key = ShortcutKey.fromItemInfo(info);
679             DeepShortcutManager sm = DeepShortcutManager.getInstance(launcher);
680             List<ShortcutInfo> si = sm.queryForFullDetails(
681                     key.componentName.getPackageName(), Arrays.asList(key.getId()), key.user);
682             if (si.isEmpty()) {
683                 return null;
684             } else {
685                 outObj[0] = si.get(0);
686                 return sm.getShortcutIconDrawable(si.get(0),
687                         appState.getInvariantDeviceProfile().fillResIconDpi);
688             }
689         } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
690             FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
691                     launcher, info.id, new Point(width, height));
692             if (icon == null) {
693                 return null;
694             }
695             outObj[0] = icon;
696             return icon;
697         } else {
698             return null;
699         }
700     }
701 
702     /**
703      * For apps icons and shortcut icons that have badges, this method creates a drawable that can
704      * later on be rendered on top of the layers for the badges. For app icons, work profile badges
705      * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
706      * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
707      **/
708     @TargetApi(Build.VERSION_CODES.O)
getBadge(Launcher launcher, ItemInfo info, Object obj)709     public static Drawable getBadge(Launcher launcher, ItemInfo info, Object obj) {
710         LauncherAppState appState = LauncherAppState.getInstance(launcher);
711         int iconSize = appState.getInvariantDeviceProfile().iconBitmapSize;
712         if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
713             boolean iconBadged = (info instanceof ItemInfoWithIcon)
714                     && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
715             if ((info.id == ItemInfo.NO_ID && !iconBadged)
716                     || !(obj instanceof ShortcutInfo)) {
717                 // The item is not yet added on home screen.
718                 return new FixedSizeEmptyDrawable(iconSize);
719             }
720             ShortcutInfo si = (ShortcutInfo) obj;
721             LauncherIcons li = LauncherIcons.obtain(appState.getContext());
722             Bitmap badge = li.getShortcutInfoBadge(si, appState.getIconCache()).iconBitmap;
723             li.recycle();
724             float badgeSize = launcher.getResources().getDimension(R.dimen.profile_badge_size);
725             float insetFraction = (iconSize - badgeSize) / iconSize;
726             return new InsetDrawable(new FastBitmapDrawable(badge),
727                     insetFraction, insetFraction, 0, 0);
728         } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
729             return ((FolderAdaptiveIcon) obj).getBadge();
730         } else {
731             return launcher.getPackageManager()
732                     .getUserBadgedIcon(new FixedSizeEmptyDrawable(iconSize), info.user);
733         }
734     }
735 
getIntArrayFromString(String tokenized)736     public static int[] getIntArrayFromString(String tokenized) {
737         StringTokenizer tokenizer = new StringTokenizer(tokenized, ",");
738         int[] array = new int[tokenizer.countTokens()];
739         int count = 0;
740         while (tokenizer.hasMoreTokens()) {
741             array[count] = Integer.parseInt(tokenizer.nextToken());
742             count++;
743         }
744         return array;
745     }
746 
getStringFromIntArray(int[] array)747     public static String getStringFromIntArray(int[] array) {
748         StringBuilder str = new StringBuilder();
749         for (int value : array) {
750             str.append(value).append(",");
751         }
752         return str.toString();
753     }
754 
squaredHypot(float x, float y)755     public static float squaredHypot(float x, float y) {
756         return x * x + y * y;
757     }
758 
squaredTouchSlop(Context context)759     public static float squaredTouchSlop(Context context) {
760         float slop = ViewConfiguration.get(context).getScaledTouchSlop();
761         return slop * slop;
762     }
763 
764     private static class FixedSizeEmptyDrawable extends ColorDrawable {
765 
766         private final int mSize;
767 
FixedSizeEmptyDrawable(int size)768         public FixedSizeEmptyDrawable(int size) {
769             super(Color.TRANSPARENT);
770             mSize = size;
771         }
772 
773         @Override
getIntrinsicHeight()774         public int getIntrinsicHeight() {
775             return mSize;
776         }
777 
778         @Override
getIntrinsicWidth()779         public int getIntrinsicWidth() {
780             return mSize;
781         }
782     }
783 }
784