blob: ca235eb010f616faf7383951228f9dc892cf1cbf [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 Goyal1ed6c4a2016-04-21 15:16:11 -070019import android.app.WallpaperManager;
Sunny Goyalc5c60ad2014-07-14 12:02:01 -070020import android.content.ComponentName;
Winson Chungaafa03c2010-06-11 17:34:16 -070021import android.content.Context;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020022import android.content.Intent;
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070023import android.content.SharedPreferences;
Sunny Goyalc5c60ad2014-07-14 12:02:01 -070024import android.content.pm.ApplicationInfo;
25import android.content.pm.PackageInfo;
26import android.content.pm.PackageManager;
27import android.content.pm.PackageManager.NameNotFoundException;
28import android.content.pm.ResolveInfo;
Winson Chungaafa03c2010-06-11 17:34:16 -070029import android.content.res.Resources;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080030import android.graphics.Bitmap;
Sunny Goyal95abbb32014-08-04 10:53:22 -070031import android.graphics.Color;
Winson Chungc763c4e2013-07-19 13:49:06 -070032import android.graphics.Matrix;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080033import android.graphics.Paint;
34import android.graphics.Rect;
Sandeep Siddhartha2efc7d92014-05-16 17:21:15 -070035import android.os.Build;
Sunny Goyal4e5cc642015-06-25 16:37:44 -070036import android.os.Bundle;
Sunny Goyal712ee532016-11-04 10:19:58 -070037import android.os.DeadObjectException;
Tony Wickham112ac952015-11-12 12:31:50 -080038import android.os.PowerManager;
Sunny Goyal712ee532016-11-04 10:19:58 -070039import android.os.TransactionTooLargeException;
Sunny Goyale78e3d72015-09-24 11:23:31 -070040import android.text.Spannable;
41import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070042import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070043import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070044import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020045import android.util.Log;
Sunny Goyal0fe505b2014-08-06 09:55:36 -070046import android.util.Pair;
Sunny Goyal95abbb32014-08-04 10:53:22 -070047import android.util.SparseArray;
Adam Cohen2e6da152015-05-06 11:42:25 -070048import android.util.TypedValue;
Winson Chungc763c4e2013-07-19 13:49:06 -070049import android.view.View;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070050
Sunny Goyal3d706ad2017-03-06 16:56:39 -080051import com.android.launcher3.config.FeatureFlags;
Sunny Goyal6c56c682015-07-16 14:09:05 -070052
Sunny Goyal5b0e6692015-03-19 14:31:19 -070053import java.io.ByteArrayOutputStream;
Sunny Goyal713edfc2016-05-06 09:58:34 -070054import java.io.Closeable;
Sunny Goyal5b0e6692015-03-19 14:31:19 -070055import java.io.IOException;
Sunny Goyalab121c12016-12-02 19:29:43 +053056import java.lang.reflect.InvocationTargetException;
Sunny Goyal25aba0a2015-07-16 15:07:47 -070057import java.lang.reflect.Method;
Tony Wickham1bce7fd2016-04-28 17:39:03 -070058import java.util.Collection;
Tony Wickham580edcf2017-02-09 08:28:52 -080059import java.util.HashSet;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070060import java.util.Locale;
Sunny Goyal8ac727b2015-09-23 15:38:09 -070061import java.util.concurrent.Executor;
62import java.util.concurrent.LinkedBlockingQueue;
63import java.util.concurrent.ThreadPoolExecutor;
64import java.util.concurrent.TimeUnit;
Winson Chung82b016c2015-05-08 17:00:10 -070065import java.util.regex.Matcher;
66import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080067
68/**
69 * Various utilities shared amongst the Launcher's classes.
70 */
Mathew Inwood72fbec12013-11-19 15:45:07 +000071public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070072
Joe Onorato1291a8c2009-09-15 15:07:25 -040073 private static final String TAG = "Launcher.Utilities";
74
Winson Chung82b016c2015-05-08 17:00:10 -070075 private static final Pattern sTrimPattern =
76 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
77
Sunny Goyal53d7ee42015-05-22 12:25:45 -070078 private static final int[] sLoc0 = new int[2];
79 private static final int[] sLoc1 = new int[2];
Sunny Goyal5e0e94f2016-10-28 10:01:00 -070080 private static final float[] sPoint = new float[2];
81 private static final Matrix sMatrix = new Matrix();
82 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +010083
Hyunyoung Songe24cb632017-09-11 11:18:03 -070084 public static final boolean ATLEAST_OREO_MR1 =
85 Build.VERSION.SDK_INT >= Build.VERSION_CODES.O_MR1;
86
87 public static final boolean ATLEAST_OREO =
88 Build.VERSION.SDK_INT >= Build.VERSION_CODES.O;
Sunny Goyaldcc0ba22016-11-02 11:22:39 -070089
Sunny Goyalf5e37442016-11-02 10:31:24 -070090 public static final boolean ATLEAST_NOUGAT_MR1 =
Hyunyoung Songe24cb632017-09-11 11:18:03 -070091 Build.VERSION.SDK_INT >= Build.VERSION_CODES.N_MR1;
Sunny Goyal9994b2b2016-06-23 14:17:24 -070092
Sunny Goyalf5e37442016-11-02 10:31:24 -070093 public static final boolean ATLEAST_NOUGAT =
Hyunyoung Songe24cb632017-09-11 11:18:03 -070094 Build.VERSION.SDK_INT >= Build.VERSION_CODES.N;
Sunny Goyale2ec8a32016-09-01 11:00:49 -070095
Winsonbe9798b2016-07-20 12:55:49 -070096 public static final boolean ATLEAST_MARSHMALLOW =
97 Build.VERSION.SDK_INT >= Build.VERSION_CODES.M;
Sunny Goyal9fc953b2015-08-17 12:24:25 -070098
99 public static final boolean ATLEAST_LOLLIPOP_MR1 =
100 Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP_MR1;
101
Sunny Goyal49f19f02017-01-05 14:36:02 -0800102 /**
103 * Indicates if the device has a debug build. Should only be used to store additional info or
104 * add extra logging and not for changing the app behavior.
105 */
106 public static final boolean IS_DEBUG_DEVICE = Build.TYPE.toLowerCase().contains("debug");
107
Sunny Goyal6f866092016-03-17 17:04:15 -0700108 // An intent extra to indicate the horizontal scroll of the wallpaper.
109 public static final String EXTRA_WALLPAPER_OFFSET = "com.android.launcher3.WALLPAPER_OFFSET";
110
Tony629a67c2017-06-02 15:43:26 -0700111 public static final int COLOR_EXTRACTION_JOB_ID = 1;
Sunny Goyal82315962017-06-08 14:27:49 -0700112 public static final int WALLPAPER_COMPAT_JOB_ID = 2;
Tony629a67c2017-06-02 15:43:26 -0700113
Sunny Goyal8ac727b2015-09-23 15:38:09 -0700114 // These values are same as that in {@link AsyncTask}.
115 private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
116 private static final int CORE_POOL_SIZE = CPU_COUNT + 1;
117 private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
118 private static final int KEEP_ALIVE = 1;
119 /**
120 * An {@link Executor} to be used with async task with no limit on the queue size.
121 */
122 public static final Executor THREAD_POOL_EXECUTOR = new ThreadPoolExecutor(
123 CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE,
124 TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>());
125
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -0700126 public static final String ALLOW_ROTATION_PREFERENCE_KEY = "pref_allowRotation";
127
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800128 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100129 return Log.isLoggable(propertyName, Log.VERBOSE);
130 }
131
Sunny Goyal21bf5312015-08-21 11:08:24 -0700132 public static boolean isAllowRotationPrefEnabled(Context context) {
Sunny Goyalf48e5922016-05-12 15:36:20 -0700133 return getPrefs(context).getBoolean(ALLOW_ROTATION_PREFERENCE_KEY,
134 getAllowRotationDefaultValue(context));
135 }
136
137 public static boolean getAllowRotationDefaultValue(Context context) {
Sunny Goyalf5e37442016-11-02 10:31:24 -0700138 if (ATLEAST_NOUGAT) {
Sunny Goyal8f3819b2016-02-23 14:49:22 -0800139 // If the device was scaled, used the original dimensions to determine if rotation
140 // is allowed of not.
Sunny Goyale2ec8a32016-09-01 11:00:49 -0700141 Resources res = context.getResources();
142 int originalSmallestWidth = res.getConfiguration().smallestScreenWidthDp
143 * res.getDisplayMetrics().densityDpi / DisplayMetrics.DENSITY_DEVICE_STABLE;
144 return originalSmallestWidth >= 600;
Sunny Goyal8f3819b2016-02-23 14:49:22 -0800145 }
Sunny Goyalf48e5922016-05-12 15:36:20 -0700146 return false;
Michael Jurka7ad868b2013-12-12 15:04:25 +0100147 }
148
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800149 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700150 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
151 * coordinates.
152 *
153 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700154 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700155 * @param coord The coordinate that we want mapped.
156 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
157 * sometimes this is relevant as in a child's coordinates within the descendant.
158 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
159 * this scale factor is assumed to be equal in X and Y, and so if at any point this
160 * assumption fails, we will need to return a pair of scale factors.
161 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700162 public static float getDescendantCoordRelativeToAncestor(
163 View descendant, View ancestor, int[] coord, boolean includeRootScroll) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700164 sPoint[0] = coord[0];
165 sPoint[1] = coord[1];
166
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700167 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700168 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700169 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700170 // For TextViews, scroll has a meaning which relates to the text position
171 // which is very strange... ignore the scroll.
172 if (v != descendant || includeRootScroll) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700173 sPoint[0] -= v.getScrollX();
174 sPoint[1] -= v.getScrollY();
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700175 }
176
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700177 v.getMatrix().mapPoints(sPoint);
178 sPoint[0] += v.getLeft();
179 sPoint[1] += v.getTop();
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700180 scale *= v.getScaleX();
181
Winson Chungc763c4e2013-07-19 13:49:06 -0700182 v = (View) v.getParent();
183 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700184
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700185 coord[0] = Math.round(sPoint[0]);
186 coord[1] = Math.round(sPoint[1]);
Winson Chungc763c4e2013-07-19 13:49:06 -0700187 return scale;
188 }
189
190 /**
Sunny Goyale8b5d202016-06-13 16:36:59 -0700191 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, int[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700192 */
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700193 public static void mapCoordInSelfToDescendant(View descendant, View root, int[] coord) {
194 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700195 View v = descendant;
196 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700197 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
198 sMatrix.postConcat(v.getMatrix());
199 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700200 v = (View) v.getParent();
201 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700202 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
203 sMatrix.invert(sInverseMatrix);
Winson Chungc763c4e2013-07-19 13:49:06 -0700204
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700205 sPoint[0] = coord[0];
206 sPoint[1] = coord[1];
207 sInverseMatrix.mapPoints(sPoint);
208 coord[0] = Math.round(sPoint[0]);
209 coord[1] = Math.round(sPoint[1]);
Winson Chungc763c4e2013-07-19 13:49:06 -0700210 }
211
Jason Monk02dd7ae2014-04-15 15:23:31 -0400212 /**
213 * Utility method to determine whether the given point, in local coordinates,
214 * is inside the view, where the area of the view is expanded by the slop factor.
215 * This method is called while processing touch-move events to determine if the event
216 * is still within the view.
217 */
218 public static boolean pointInView(View v, float localX, float localY, float slop) {
219 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
220 localY < (v.getHeight() + slop);
221 }
222
Sunny Goyala52ecb02016-12-16 15:04:51 -0800223 public static int[] getCenterDeltaInScreenSpace(View v0, View v1) {
Adam Cohen63f1ec02014-08-12 09:23:13 -0700224 v0.getLocationInWindow(sLoc0);
225 v1.getLocationInWindow(sLoc1);
226
227 sLoc0[0] += (v0.getMeasuredWidth() * v0.getScaleX()) / 2;
228 sLoc0[1] += (v0.getMeasuredHeight() * v0.getScaleY()) / 2;
229 sLoc1[0] += (v1.getMeasuredWidth() * v1.getScaleX()) / 2;
230 sLoc1[1] += (v1.getMeasuredHeight() * v1.getScaleY()) / 2;
Sunny Goyala52ecb02016-12-16 15:04:51 -0800231 return new int[] {sLoc1[0] - sLoc0[0], sLoc1[1] - sLoc0[1]};
Adam Cohen63f1ec02014-08-12 09:23:13 -0700232 }
233
Jon Miranda6f6a06a2016-12-15 11:24:18 -0800234 public static void scaleRectAboutCenter(Rect r, float scale) {
235 if (scale != 1.0f) {
236 int cx = r.centerX();
237 int cy = r.centerY();
238 r.offset(-cx, -cy);
239
240 r.left = (int) (r.left * scale + 0.5f);
241 r.top = (int) (r.top * scale + 0.5f);
242 r.right = (int) (r.right * scale + 0.5f);
243 r.bottom = (int) (r.bottom * scale + 0.5f);
244
245 r.offset(cx, cy);
246 }
247 }
248
249 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
Jon Mirandae96798e2016-12-07 12:10:44 -0800250 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
251 if (scale < 1.0f) {
252 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
253 r.left += deltaX;
254 r.right -= deltaX;
Sunny Goyal106bf642015-07-16 12:18:06 -0700255
Jon Mirandae96798e2016-12-07 12:10:44 -0800256 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
257 r.top += deltaY;
258 r.bottom -= deltaY;
Sunny Goyal106bf642015-07-16 12:18:06 -0700259 }
Jon Mirandae96798e2016-12-07 12:10:44 -0800260 return scale;
Winson Chung3a6e7f32013-10-09 15:50:52 -0700261 }
262
Sunny Goyal0e947fb2017-05-19 12:21:50 -0700263 public static boolean isSystemApp(Context context, Intent intent) {
Sunny Goyalc5c60ad2014-07-14 12:02:01 -0700264 PackageManager pm = context.getPackageManager();
265 ComponentName cn = intent.getComponent();
266 String packageName = null;
267 if (cn == null) {
268 ResolveInfo info = pm.resolveActivity(intent, PackageManager.MATCH_DEFAULT_ONLY);
269 if ((info != null) && (info.activityInfo != null)) {
270 packageName = info.activityInfo.packageName;
271 }
272 } else {
273 packageName = cn.getPackageName();
274 }
275 if (packageName != null) {
276 try {
277 PackageInfo info = pm.getPackageInfo(packageName, 0);
278 return (info != null) && (info.applicationInfo != null) &&
279 ((info.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0);
280 } catch (NameNotFoundException e) {
281 return false;
282 }
283 } else {
284 return false;
285 }
286 }
Sunny Goyal95abbb32014-08-04 10:53:22 -0700287
288 /**
289 * This picks a dominant color, looking for high-saturation, high-value, repeated hues.
290 * @param bitmap The bitmap to scan
291 * @param samples The approximate max number of samples to use.
292 */
Tony Wickham9a8d11f2017-01-11 09:53:12 -0800293 public static int findDominantColorByHue(Bitmap bitmap, int samples) {
Sunny Goyal95abbb32014-08-04 10:53:22 -0700294 final int height = bitmap.getHeight();
295 final int width = bitmap.getWidth();
296 int sampleStride = (int) Math.sqrt((height * width) / samples);
297 if (sampleStride < 1) {
298 sampleStride = 1;
299 }
300
301 // This is an out-param, for getting the hsv values for an rgb
302 float[] hsv = new float[3];
303
304 // First get the best hue, by creating a histogram over 360 hue buckets,
305 // where each pixel contributes a score weighted by saturation, value, and alpha.
306 float[] hueScoreHistogram = new float[360];
307 float highScore = -1;
308 int bestHue = -1;
309
Sunny Goyal9b8e36b2017-09-28 19:13:53 -0700310 int[] pixels = new int[samples];
311 int pixelCount = 0;
312
Sunny Goyal95abbb32014-08-04 10:53:22 -0700313 for (int y = 0; y < height; y += sampleStride) {
314 for (int x = 0; x < width; x += sampleStride) {
315 int argb = bitmap.getPixel(x, y);
316 int alpha = 0xFF & (argb >> 24);
317 if (alpha < 0x80) {
318 // Drop mostly-transparent pixels.
319 continue;
320 }
321 // Remove the alpha channel.
322 int rgb = argb | 0xFF000000;
323 Color.colorToHSV(rgb, hsv);
324 // Bucket colors by the 360 integer hues.
325 int hue = (int) hsv[0];
326 if (hue < 0 || hue >= hueScoreHistogram.length) {
327 // Defensively avoid array bounds violations.
328 continue;
329 }
Sunny Goyal9b8e36b2017-09-28 19:13:53 -0700330 if (pixelCount < samples) {
331 pixels[pixelCount++] = rgb;
332 }
Sunny Goyal95abbb32014-08-04 10:53:22 -0700333 float score = hsv[1] * hsv[2];
334 hueScoreHistogram[hue] += score;
335 if (hueScoreHistogram[hue] > highScore) {
336 highScore = hueScoreHistogram[hue];
337 bestHue = hue;
338 }
339 }
340 }
341
Sunny Goyal9b8e36b2017-09-28 19:13:53 -0700342 SparseArray<Float> rgbScores = new SparseArray<>();
Sunny Goyal95abbb32014-08-04 10:53:22 -0700343 int bestColor = 0xff000000;
344 highScore = -1;
345 // Go back over the RGB colors that match the winning hue,
346 // creating a histogram of weighted s*v scores, for up to 100*100 [s,v] buckets.
347 // The highest-scoring RGB color wins.
Sunny Goyal9b8e36b2017-09-28 19:13:53 -0700348 for (int i = 0; i < pixelCount; i++) {
349 int rgb = pixels[i];
350 Color.colorToHSV(rgb, hsv);
351 int hue = (int) hsv[0];
352 if (hue == bestHue) {
353 float s = hsv[1];
354 float v = hsv[2];
355 int bucket = (int) (s * 100) + (int) (v * 10000);
356 // Score by cumulative saturation * value.
357 float score = s * v;
358 Float oldTotal = rgbScores.get(bucket);
359 float newTotal = oldTotal == null ? score : oldTotal + score;
360 rgbScores.put(bucket, newTotal);
361 if (newTotal > highScore) {
362 highScore = newTotal;
363 // All the colors in the winning bucket are very similar. Last in wins.
364 bestColor = rgb;
Sunny Goyal95abbb32014-08-04 10:53:22 -0700365 }
366 }
367 }
368 return bestColor;
369 }
Sunny Goyal0fe505b2014-08-06 09:55:36 -0700370
371 /*
372 * Finds a system apk which had a broadcast receiver listening to a particular action.
373 * @param action intent action used to find the apk
374 * @return a pair of apk package name and the resources.
375 */
376 static Pair<String, Resources> findSystemApk(String action, PackageManager pm) {
377 final Intent intent = new Intent(action);
378 for (ResolveInfo info : pm.queryBroadcastReceivers(intent, 0)) {
379 if (info.activityInfo != null &&
380 (info.activityInfo.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
381 final String packageName = info.activityInfo.packageName;
382 try {
383 final Resources res = pm.getResourcesForApplication(packageName);
384 return Pair.create(packageName, res);
385 } catch (NameNotFoundException e) {
386 Log.w(TAG, "Failed to find resources for " + packageName);
387 }
388 }
389 }
390 return null;
391 }
Sunny Goyalfafca522014-11-03 11:30:01 -0800392
Sunny Goyal594d76d2014-11-06 10:12:54 -0800393 /**
Sunny Goyal5b0e6692015-03-19 14:31:19 -0700394 * Compresses the bitmap to a byte array for serialization.
395 */
396 public static byte[] flattenBitmap(Bitmap bitmap) {
397 // Try go guesstimate how much space the icon will take when serialized
398 // to avoid unnecessary allocations/copies during the write.
399 int size = bitmap.getWidth() * bitmap.getHeight() * 4;
400 ByteArrayOutputStream out = new ByteArrayOutputStream(size);
401 try {
402 bitmap.compress(Bitmap.CompressFormat.PNG, 100, out);
403 out.flush();
404 out.close();
405 return out.toByteArray();
406 } catch (IOException e) {
407 Log.w(TAG, "Could not write bitmap");
408 return null;
409 }
410 }
411
Sunny Goyalf7a29e82015-04-24 15:20:43 -0700412 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700413 * Trims the string, removing all whitespace at the beginning and end of the string.
414 * Non-breaking whitespaces are also removed.
415 */
416 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700417 if (s == null) {
418 return null;
419 }
420
Winson Chung82b016c2015-05-08 17:00:10 -0700421 // Just strip any sequence of whitespace or java space characters from the beginning and end
422 Matcher m = sTrimPattern.matcher(s);
423 return m.replaceAll("$1");
424 }
Sunny Goyal70660032015-05-14 00:07:08 -0700425
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700426 /**
427 * Calculates the height of a given string at a specific text size.
428 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700429 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700430 Paint p = new Paint();
431 p.setTextSize(textSizePx);
432 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700433 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700434 }
435
Winson Chungb1777442015-06-16 13:35:04 -0700436 /**
437 * Convenience println with multiple args.
438 */
439 public static void println(String key, Object... args) {
440 StringBuilder b = new StringBuilder();
441 b.append(key);
442 b.append(": ");
443 boolean isFirstArgument = true;
444 for (Object arg : args) {
445 if (isFirstArgument) {
446 isFirstArgument = false;
447 } else {
448 b.append(", ");
449 }
450 b.append(arg);
451 }
452 System.out.println(b.toString());
453 }
454
Sunny Goyal70660032015-05-14 00:07:08 -0700455 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800456 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700457 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700458
Sunny Goyal5c97f512015-05-19 16:03:28 -0700459 /**
460 * Returns true if the intent is a valid launch intent for a launcher activity of an app.
461 * This is used to identify shortcuts which are different from the ones exposed by the
462 * applications' manifest file.
463 *
464 * @param launchIntent The intent that will be launched when the shortcut is clicked.
465 */
466 public static boolean isLauncherAppTarget(Intent launchIntent) {
Sunny Goyal4e5cc642015-06-25 16:37:44 -0700467 if (launchIntent != null
Sunny Goyal5c97f512015-05-19 16:03:28 -0700468 && Intent.ACTION_MAIN.equals(launchIntent.getAction())
469 && launchIntent.getComponent() != null
470 && launchIntent.getCategories() != null
471 && launchIntent.getCategories().size() == 1
472 && launchIntent.hasCategory(Intent.CATEGORY_LAUNCHER)
Sunny Goyal4e5cc642015-06-25 16:37:44 -0700473 && TextUtils.isEmpty(launchIntent.getDataString())) {
474 // An app target can either have no extra or have ItemInfo.EXTRA_PROFILE.
475 Bundle extras = launchIntent.getExtras();
Sunny Goyal24bb66a2017-03-21 15:12:01 -0700476 return extras == null || extras.keySet().isEmpty();
477 }
Sunny Goyal4e5cc642015-06-25 16:37:44 -0700478 return false;
Sunny Goyal5c97f512015-05-19 16:03:28 -0700479 }
Adam Cohen2e6da152015-05-06 11:42:25 -0700480
481 public static float dpiFromPx(int size, DisplayMetrics metrics){
482 float densityRatio = (float) metrics.densityDpi / DisplayMetrics.DENSITY_DEFAULT;
483 return (size / densityRatio);
484 }
485 public static int pxFromDp(float size, DisplayMetrics metrics) {
486 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP,
487 size, metrics));
488 }
489 public static int pxFromSp(float size, DisplayMetrics metrics) {
490 return (int) Math.round(TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP,
491 size, metrics));
492 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700493
494 public static String createDbSelectionQuery(String columnName, Iterable<?> values) {
495 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, TextUtils.join(", ", values));
496 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700497
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700498 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700499 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
500 }
501
502 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700503 try {
504 Class clazz = Class.forName("android.os.SystemProperties");
505 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700506 String value = (String) getter.invoke(null, property);
507 if (!TextUtils.isEmpty(value)) {
508 return value;
509 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700510 } catch (Exception e) {
511 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700512 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700513 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700514 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700515
516 /**
517 * Ensures that a value is within given bounds. Specifically:
518 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
519 * return upperBound; else return value unchanged.
520 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700521 public static int boundToRange(int value, int lowerBound, int upperBound) {
522 return Math.max(lowerBound, Math.min(value, upperBound));
523 }
524
525 /**
526 * @see #boundToRange(int, int, int).
527 */
528 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700529 return Math.max(lowerBound, Math.min(value, upperBound));
530 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700531
Sunny Goyale78e3d72015-09-24 11:23:31 -0700532 /**
533 * Wraps a message with a TTS span, so that a different message is spoken than
534 * what is getting displayed.
535 * @param msg original message
536 * @param ttsMsg message to be spoken
537 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700538 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800539 SpannableString spanned = new SpannableString(msg);
540 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
541 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
542 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700543 }
Winson12fb9fc2015-10-01 15:34:08 -0700544
545 /**
546 * Replacement for Long.compare() which was added in API level 19.
547 */
548 public static int longCompare(long lhs, long rhs) {
549 return lhs < rhs ? -1 : (lhs == rhs ? 0 : 1);
550 }
Sunny Goyalf7258242015-10-19 16:59:07 -0700551
552 public static SharedPreferences getPrefs(Context context) {
553 return context.getSharedPreferences(
554 LauncherFiles.SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE);
555 }
Tony Wickham112ac952015-11-12 12:31:50 -0800556
Sunny Goyal9d887a22017-06-08 14:00:43 -0700557 public static SharedPreferences getDevicePrefs(Context context) {
558 return context.getSharedPreferences(
559 LauncherFiles.DEVICE_PREFERENCES_KEY, Context.MODE_PRIVATE);
560 }
561
Tony Wickham112ac952015-11-12 12:31:50 -0800562 public static boolean isPowerSaverOn(Context context) {
563 PowerManager powerManager = (PowerManager) context.getSystemService(Context.POWER_SERVICE);
Sunny Goyala52ecb02016-12-16 15:04:51 -0800564 return powerManager.isPowerSaveMode();
Tony Wickham112ac952015-11-12 12:31:50 -0800565 }
Sunny Goyale1483fb2016-01-08 12:16:15 -0800566
Hyunyoung Song0de01172016-10-05 16:27:48 -0700567 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyalf5e37442016-11-02 10:31:24 -0700568 if (ATLEAST_NOUGAT) {
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700569 try {
570 WallpaperManager wm = context.getSystemService(WallpaperManager.class);
Kenny Guy367da9f2016-05-25 19:22:14 +0100571 return (Boolean) wm.getClass().getDeclaredMethod("isSetWallpaperAllowed")
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700572 .invoke(wm);
573 } catch (Exception e) { }
574 }
575 return true;
576 }
577
Sunny Goyal713edfc2016-05-06 09:58:34 -0700578 public static void closeSilently(Closeable c) {
579 if (c != null) {
580 try {
581 c.close();
582 } catch (IOException e) {
Sunny Goyal3d706ad2017-03-06 16:56:39 -0800583 if (FeatureFlags.IS_DOGFOOD_BUILD) {
Sunny Goyal713edfc2016-05-06 09:58:34 -0700584 Log.d(TAG, "Error closing", e);
585 }
586 }
587 }
588 }
589
Sunny Goyale1483fb2016-01-08 12:16:15 -0800590 /**
Sunny Goyal3f732192016-05-13 13:48:44 -0700591 * Returns true if {@param original} contains all entries defined in {@param updates} and
592 * have the same value.
593 * The comparison uses {@link Object#equals(Object)} to compare the values.
594 */
595 public static boolean containsAll(Bundle original, Bundle updates) {
596 for (String key : updates.keySet()) {
597 Object value1 = updates.get(key);
598 Object value2 = original.get(key);
599 if (value1 == null) {
600 if (value2 != null) {
601 return false;
602 }
603 } else if (!value1.equals(value2)) {
604 return false;
605 }
606 }
607 return true;
608 }
609
Tony Wickham1bce7fd2016-04-28 17:39:03 -0700610 /** Returns whether the collection is null or empty. */
611 public static boolean isEmpty(Collection c) {
612 return c == null || c.isEmpty();
613 }
614
Sunny Goyal712ee532016-11-04 10:19:58 -0700615 public static boolean isBinderSizeError(Exception e) {
616 return e.getCause() instanceof TransactionTooLargeException
617 || e.getCause() instanceof DeadObjectException;
618 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530619
620 public static <T> T getOverrideObject(Class<T> clazz, Context context, int resId) {
621 String className = context.getString(resId);
622 if (!TextUtils.isEmpty(className)) {
623 try {
624 Class<?> cls = Class.forName(className);
625 return (T) cls.getDeclaredConstructor(Context.class).newInstance(context);
626 } catch (ClassNotFoundException | InstantiationException | IllegalAccessException
627 | ClassCastException | NoSuchMethodException | InvocationTargetException e) {
628 Log.e(TAG, "Bad overriden class", e);
629 }
630 }
631
632 try {
633 return clazz.newInstance();
634 } catch (InstantiationException|IllegalAccessException e) {
635 throw new RuntimeException(e);
636 }
637 }
Tony Wickham580edcf2017-02-09 08:28:52 -0800638
639 /**
640 * Returns a HashSet with a single element. We use this instead of Collections.singleton()
641 * because HashSet ensures all operations, such as remove, are supported.
642 */
643 public static <T> HashSet<T> singletonHashSet(T elem) {
644 HashSet<T> hashSet = new HashSet<>(1);
645 hashSet.add(elem);
646 return hashSet;
647 }
Mario Bertschler48198d02017-01-30 17:05:24 -0800648
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800649}