blob: ce009a1375367cea512b008b3e8c7c3cd5580a9c [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 Goyald872a972021-11-24 18:07:04 -080019import static com.android.launcher3.icons.BitmapInfo.FLAG_THEMED;
Sunny Goyale396abf2020-04-06 15:11:17 -070020import static com.android.launcher3.model.data.ItemInfoWithIcon.FLAG_ICON_BADGED;
Jeremy Simabdf25d2022-03-31 17:02:11 -070021import static com.android.launcher3.util.SplitConfigurationOptions.STAGE_POSITION_BOTTOM_OR_RIGHT;
22import static com.android.launcher3.util.SplitConfigurationOptions.STAGE_POSITION_TOP_OR_LEFT;
23import static com.android.launcher3.util.SplitConfigurationOptions.STAGE_TYPE_MAIN;
Sunny Goyal9dbb27c2019-07-17 15:12:56 -070024
Jon Miranda40285752019-05-14 15:17:30 -070025import android.annotation.TargetApi;
Vadim Tryshev2ce6a132018-06-18 19:14:44 -070026import android.app.ActivityManager;
Pinyao Ting49a3e692019-07-26 12:28:38 -070027import android.app.Person;
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -070028import android.app.WallpaperManager;
Winson Chungaafa03c2010-06-11 17:34:16 -070029import android.content.Context;
Jon Miranda1a49fb52019-02-19 15:34:41 -080030import android.content.pm.LauncherActivityInfo;
Sunny Goyale7b00122019-10-02 16:13:34 -070031import android.content.pm.LauncherApps;
Sunny Goyal6bbf6002019-04-17 18:38:52 -070032import android.content.pm.ShortcutInfo;
Jonathan Miranda21930da2021-05-03 18:44:13 +000033import android.content.res.Configuration;
Winson Chungaafa03c2010-06-11 17:34:16 -070034import android.content.res.Resources;
Jon Miranda40285752019-05-14 15:17:30 -070035import android.graphics.Color;
Zak Cohenec4407b2021-04-01 10:49:12 -070036import android.graphics.ColorFilter;
37import android.graphics.LightingColorFilter;
Winson Chungc763c4e2013-07-19 13:49:06 -070038import android.graphics.Matrix;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080039import android.graphics.Paint;
Sunny Goyal415f1732018-11-29 10:33:47 -080040import android.graphics.Point;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080041import android.graphics.Rect;
Sunny Goyalb1e2e292018-02-21 10:14:30 -080042import android.graphics.RectF;
sfufa@google.com1c5e6072021-10-05 18:08:05 -070043import android.graphics.drawable.AdaptiveIconDrawable;
Jon Miranda40285752019-05-14 15:17:30 -070044import android.graphics.drawable.ColorDrawable;
Jon Miranda1a49fb52019-02-19 15:34:41 -080045import android.graphics.drawable.Drawable;
Sandeep Siddhartha2efc7d92014-05-16 17:21:15 -070046import android.os.Build;
Sunny Goyal645af0a2022-04-14 21:26:57 +000047import android.os.Build.VERSION_CODES;
Sunny Goyal712ee532016-11-04 10:19:58 -070048import android.os.DeadObjectException;
Sunny Goyal3483c522018-04-12 11:23:33 -070049import android.os.Handler;
50import android.os.Message;
Sunny Goyald872a972021-11-24 18:07:04 -080051import android.os.Process;
Sunny Goyal712ee532016-11-04 10:19:58 -070052import android.os.TransactionTooLargeException;
Hyunyoung Song58de5de2019-05-15 14:01:30 -070053import android.provider.Settings;
Sunny Goyale78e3d72015-09-24 11:23:31 -070054import android.text.Spannable;
55import android.text.SpannableString;
Sunny Goyal5c97f512015-05-19 16:03:28 -070056import android.text.TextUtils;
Sunny Goyale78e3d72015-09-24 11:23:31 -070057import android.text.style.TtsSpan;
Adam Cohen2e6da152015-05-06 11:42:25 -070058import android.util.DisplayMetrics;
Michael Jurkaa805e1a2013-08-22 15:00:33 +020059import android.util.Log;
Adam Cohen2e6da152015-05-06 11:42:25 -070060import android.util.TypedValue;
Tonyd5a3df72019-03-13 10:12:01 -050061import android.view.MotionEvent;
Winson Chungc763c4e2013-07-19 13:49:06 -070062import android.view.View;
Sunny Goyal878aa332019-05-20 12:40:42 -070063import android.view.ViewConfiguration;
Sunny Goyal0f3af752018-06-08 13:01:04 -070064import android.view.animation.Interpolator;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070065
Sunny Goyal645af0a2022-04-14 21:26:57 +000066import androidx.annotation.ChecksSdkIntAtLeast;
Schneider Victor-tulias16e04e22021-10-15 14:43:54 -070067import androidx.annotation.NonNull;
Zak Cohenec4407b2021-04-01 10:49:12 -070068import androidx.core.graphics.ColorUtils;
Sunny Goyal0addbf02020-04-28 14:17:35 -070069
Jon Miranda1a49fb52019-02-19 15:34:41 -080070import com.android.launcher3.dragndrop.FolderAdaptiveIcon;
Sunny Goyal5b636eb2019-05-29 01:09:06 -070071import com.android.launcher3.graphics.TintedDrawableSpan;
Sunny Goyalfa395362019-12-11 10:00:47 -080072import com.android.launcher3.icons.ShortcutCachingLogic;
Sunny Goyal68af5492021-12-24 01:08:31 +053073import com.android.launcher3.icons.ThemedIconDrawable;
Sunny Goyale396abf2020-04-06 15:11:17 -070074import com.android.launcher3.model.data.ItemInfo;
75import com.android.launcher3.model.data.ItemInfoWithIcon;
sfufa@google.com1c5e6072021-10-05 18:08:05 -070076import com.android.launcher3.model.data.SearchActionItemInfo;
Sunny Goyale7b00122019-10-02 16:13:34 -070077import com.android.launcher3.pm.ShortcutConfigActivityInfo;
Jon Miranda1a49fb52019-02-19 15:34:41 -080078import com.android.launcher3.shortcuts.ShortcutKey;
Sunny Goyalfa395362019-12-11 10:00:47 -080079import com.android.launcher3.shortcuts.ShortcutRequest;
Pat Manning5f74bfd2022-07-20 12:08:54 +010080import com.android.launcher3.testing.shared.ResourceUtils;
Sunny Goyalefb7e842018-10-04 15:11:00 -070081import com.android.launcher3.util.IntArray;
Jeremy Simabdf25d2022-03-31 17:02:11 -070082import com.android.launcher3.util.SplitConfigurationOptions.SplitPositionOption;
Sunny Goyal68af5492021-12-24 01:08:31 +053083import com.android.launcher3.util.Themes;
Tony Wickhamc7cbf252021-05-24 15:46:48 -070084import com.android.launcher3.views.ActivityContext;
Jonathan Miranda21930da2021-05-03 18:44:13 +000085import com.android.launcher3.views.BaseDragLayer;
Jon Miranda1a49fb52019-02-19 15:34:41 -080086import com.android.launcher3.widget.PendingAddShortcutInfo;
Sunny Goyal6c56c682015-07-16 14:09:05 -070087
Sunny Goyal25aba0a2015-07-16 15:07:47 -070088import java.lang.reflect.Method;
Jeremy Simabdf25d2022-03-31 17:02:11 -070089import java.util.ArrayList;
Jon Miranda1a49fb52019-02-19 15:34:41 -080090import java.util.List;
Sunny Goyalb1622cc2015-06-10 16:00:42 -070091import java.util.Locale;
Winson Chung82b016c2015-05-08 17:00:10 -070092import java.util.regex.Matcher;
93import java.util.regex.Pattern;
The Android Open Source Project31dd5032009-03-03 19:32:27 -080094
95/**
96 * Various utilities shared amongst the Launcher's classes.
97 */
Mathew Inwood72fbec12013-11-19 15:45:07 +000098public final class Utilities {
Rahul Chaturvedi7fc77ca2015-05-19 18:02:16 -070099
Joe Onorato1291a8c2009-09-15 15:07:25 -0400100 private static final String TAG = "Launcher.Utilities";
101
Winson Chung82b016c2015-05-08 17:00:10 -0700102 private static final Pattern sTrimPattern =
103 Pattern.compile("^[\\s|\\p{javaSpaceChar}]*(.*)[\\s|\\p{javaSpaceChar}]*$");
104
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700105 private static final Matrix sMatrix = new Matrix();
106 private static final Matrix sInverseMatrix = new Matrix();
Michael Jurka7ad868b2013-12-12 15:04:25 +0100107
Pinyao Ting49a3e692019-07-26 12:28:38 -0700108 public static final String[] EMPTY_STRING_ARRAY = new String[0];
109 public static final Person[] EMPTY_PERSON_ARRAY = new Person[0];
110
Sunny Goyal645af0a2022-04-14 21:26:57 +0000111 @ChecksSdkIntAtLeast(api = VERSION_CODES.P)
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000112 public static final boolean ATLEAST_P = Build.VERSION.SDK_INT >= Build.VERSION_CODES.P;
Sunny Goyal0addbf02020-04-28 14:17:35 -0700113
Sunny Goyal645af0a2022-04-14 21:26:57 +0000114 @ChecksSdkIntAtLeast(api = VERSION_CODES.Q)
Sunny Goyal03340472019-05-17 16:57:12 -0700115 public static final boolean ATLEAST_Q = Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q;
Lucas Dupineca08a12018-08-11 15:53:40 -0700116
Sunny Goyal645af0a2022-04-14 21:26:57 +0000117 @ChecksSdkIntAtLeast(api = VERSION_CODES.R)
118 public static final boolean ATLEAST_R = Build.VERSION.SDK_INT >= Build.VERSION_CODES.R;
Schneider Victor-tulias6a5f4312021-01-12 19:30:02 +0000119
Sunny Goyal645af0a2022-04-14 21:26:57 +0000120 @ChecksSdkIntAtLeast(api = VERSION_CODES.S)
121 public static final boolean ATLEAST_S = Build.VERSION.SDK_INT >= Build.VERSION_CODES.S;
Sunny Goyal68af5492021-12-24 01:08:31 +0530122
Sunny Goyal645af0a2022-04-14 21:26:57 +0000123 @ChecksSdkIntAtLeast(api = VERSION_CODES.TIRAMISU, codename = "T")
124 public static final boolean ATLEAST_T = Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU;
Tony Mak6eeb0402018-01-03 14:41:31 +0000125
Sunny Goyal49f19f02017-01-05 14:36:02 -0800126 /**
Tonyd5a3df72019-03-13 10:12:01 -0500127 * Set on a motion event dispatched from the nav bar. See {@link MotionEvent#setEdgeFlags(int)}.
128 */
129 public static final int EDGE_NAV_BAR = 1 << 8;
130
131 /**
Sunny Goyal49f19f02017-01-05 14:36:02 -0800132 * Indicates if the device has a debug build. Should only be used to store additional info or
133 * add extra logging and not for changing the app behavior.
134 */
Tobias Dubois9c0ad562018-06-11 16:17:17 +0200135 public static final boolean IS_DEBUG_DEVICE =
136 Build.TYPE.toLowerCase(Locale.ROOT).contains("debug") ||
137 Build.TYPE.toLowerCase(Locale.ROOT).equals("eng");
Sunny Goyal49f19f02017-01-05 14:36:02 -0800138
Jonathan Miranda21930da2021-05-03 18:44:13 +0000139 /**
140 * Returns true if theme is dark.
141 */
142 public static boolean isDarkTheme(Context context) {
143 Configuration configuration = context.getResources().getConfiguration();
144 int nightMode = configuration.uiMode & Configuration.UI_MODE_NIGHT_MASK;
145 return nightMode == Configuration.UI_MODE_NIGHT_YES;
146 }
147
Hyunyoung Song58de5de2019-05-15 14:01:30 -0700148 public static boolean isDevelopersOptionsEnabled(Context context) {
149 return Settings.Global.getInt(context.getApplicationContext().getContentResolver(),
150 Settings.Global.DEVELOPMENT_SETTINGS_ENABLED, 0) != 0;
151 }
152
Vadim Tryshevc2950982018-10-04 16:33:45 -0700153 public static boolean IS_RUNNING_IN_TEST_HARNESS =
Vadim Tryshev2ce6a132018-06-18 19:14:44 -0700154 ActivityManager.isRunningInTestHarness();
155
Vadim Tryshevc2950982018-10-04 16:33:45 -0700156 public static void enableRunningInTestHarnessForTests() {
157 IS_RUNNING_IN_TEST_HARNESS = true;
158 }
159
Sunny Goyal4bbf4192014-11-11 12:23:59 -0800160 public static boolean isPropertyEnabled(String propertyName) {
Michael Jurka7ad868b2013-12-12 15:04:25 +0100161 return Log.isLoggable(propertyName, Log.VERBOSE);
162 }
163
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800164 /**
Winson Chungc763c4e2013-07-19 13:49:06 -0700165 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
166 * coordinates.
167 *
168 * @param descendant The descendant to which the passed coordinate is relative.
Sunny Goyale8b5d202016-06-13 16:36:59 -0700169 * @param ancestor The root view to make the coordinates relative to.
Winson Chungc763c4e2013-07-19 13:49:06 -0700170 * @param coord The coordinate that we want mapped.
171 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
172 * sometimes this is relevant as in a child's coordinates within the descendant.
173 * @return The factor by which this descendant is scaled relative to this DragLayer. Caution
174 * this scale factor is assumed to be equal in X and Y, and so if at any point this
175 * assumption fails, we will need to return a pair of scale factors.
176 */
Sunny Goyale8b5d202016-06-13 16:36:59 -0700177 public static float getDescendantCoordRelativeToAncestor(
Sunny Goyalae6e3182019-04-30 12:04:37 -0700178 View descendant, View ancestor, float[] coord, boolean includeRootScroll) {
179 return getDescendantCoordRelativeToAncestor(descendant, ancestor, coord, includeRootScroll,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700180 false);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700181 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700182
Sunny Goyalae6e3182019-04-30 12:04:37 -0700183 /**
184 * Given a coordinate relative to the descendant, find the coordinate in a parent view's
185 * coordinates.
186 *
187 * @param descendant The descendant to which the passed coordinate is relative.
188 * @param ancestor The root view to make the coordinates relative to.
189 * @param coord The coordinate that we want mapped.
190 * @param includeRootScroll Whether or not to account for the scroll of the descendant:
191 * sometimes this is relevant as in a child's coordinates within the descendant.
192 * @param ignoreTransform If true, view transform is ignored
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 */
197 public static float getDescendantCoordRelativeToAncestor(View descendant, View ancestor,
Sunny Goyalc4d32012020-04-03 17:10:11 -0700198 float[] coord, boolean includeRootScroll, boolean ignoreTransform) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700199 float scale = 1.0f;
Winson Chungc763c4e2013-07-19 13:49:06 -0700200 View v = descendant;
Sunny Goyale8b5d202016-06-13 16:36:59 -0700201 while(v != ancestor && v != null) {
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700202 // For TextViews, scroll has a meaning which relates to the text position
203 // which is very strange... ignore the scroll.
204 if (v != descendant || includeRootScroll) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700205 offsetPoints(coord, -v.getScrollX(), -v.getScrollY());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700206 }
207
Sunny Goyalc4d32012020-04-03 17:10:11 -0700208 if (!ignoreTransform) {
Sunny Goyalae6e3182019-04-30 12:04:37 -0700209 v.getMatrix().mapPoints(coord);
210 }
211 offsetPoints(coord, v.getLeft(), v.getTop());
Sunny Goyal8cf47a52016-06-15 10:11:30 -0700212 scale *= v.getScaleX();
213
Tony Wickham66971f82022-01-10 22:30:14 +0000214 v = v.getParent() instanceof View ? (View) v.getParent() : null;
Winson Chungc763c4e2013-07-19 13:49:06 -0700215 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700216 return scale;
217 }
218
219 /**
Jonathan Miranda21930da2021-05-03 18:44:13 +0000220 * Returns bounds for a child view of DragLayer, in drag layer coordinates.
221 *
222 * see {@link com.android.launcher3.dragndrop.DragLayer}.
223 *
224 * @param viewBounds Bounds of the view wanted in drag layer coordinates, relative to the view
225 * itself. eg. (0, 0, view.getWidth, view.getHeight)
226 * @param ignoreTransform If true, view transform is ignored
227 * @param outRect The out rect where we return the bounds of {@param view} in drag layer coords.
228 */
229 public static void getBoundsForViewInDragLayer(BaseDragLayer dragLayer, View view,
Jon Miranda88b7f6a2021-05-03 16:49:53 -0700230 Rect viewBounds, boolean ignoreTransform, float[] recycle, RectF outRect) {
231 float[] points = recycle == null ? new float[4] : recycle;
Jonathan Miranda21930da2021-05-03 18:44:13 +0000232 points[0] = viewBounds.left;
233 points[1] = viewBounds.top;
234 points[2] = viewBounds.right;
235 points[3] = viewBounds.bottom;
236
237 Utilities.getDescendantCoordRelativeToAncestor(view, dragLayer, points,
238 false, ignoreTransform);
239 outRect.set(
240 Math.min(points[0], points[2]),
241 Math.min(points[1], points[3]),
242 Math.max(points[0], points[2]),
243 Math.max(points[1], points[3]));
244 }
245
246 /**
Andras Kloczl0056e952022-03-16 11:14:05 +0000247 * Similar to {@link #mapCoordInSelfToDescendant(View descendant, View root, float[] coord)}
248 * but accepts a Rect instead of float[].
249 */
250 public static void mapRectInSelfToDescendant(View descendant, View root, Rect rect) {
251 float[] coords = new float[]{rect.left, rect.top, rect.right, rect.bottom};
252 mapCoordInSelfToDescendant(descendant, root, coords);
253 rect.set((int) coords[0], (int) coords[1], (int) coords[2], (int) coords[3]);
254 }
255
256 /**
Sunny Goyalae6e3182019-04-30 12:04:37 -0700257 * Inverse of {@link #getDescendantCoordRelativeToAncestor(View, View, float[], boolean)}.
Winson Chungc763c4e2013-07-19 13:49:06 -0700258 */
Sunny Goyalae6e3182019-04-30 12:04:37 -0700259 public static void mapCoordInSelfToDescendant(View descendant, View root, float[] coord) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700260 sMatrix.reset();
Winson Chungc763c4e2013-07-19 13:49:06 -0700261 View v = descendant;
262 while(v != root) {
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700263 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
264 sMatrix.postConcat(v.getMatrix());
265 sMatrix.postTranslate(v.getLeft(), v.getTop());
Winson Chungc763c4e2013-07-19 13:49:06 -0700266 v = (View) v.getParent();
267 }
Sunny Goyal5e0e94f2016-10-28 10:01:00 -0700268 sMatrix.postTranslate(-v.getScrollX(), -v.getScrollY());
269 sMatrix.invert(sInverseMatrix);
Sunny Goyalae6e3182019-04-30 12:04:37 -0700270 sInverseMatrix.mapPoints(coord);
271 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700272
Sunny Goyalae6e3182019-04-30 12:04:37 -0700273 /**
274 * Sets {@param out} to be same as {@param in} by rounding individual values
275 */
276 public static void roundArray(float[] in, int[] out) {
Sunny Goyal47d4d812022-11-04 16:43:42 -0700277 for (int i = 0; i < in.length; i++) {
278 out[i] = Math.round(in[i]);
279 }
Sunny Goyalae6e3182019-04-30 12:04:37 -0700280 }
281
282 public static void offsetPoints(float[] points, float offsetX, float offsetY) {
283 for (int i = 0; i < points.length; i += 2) {
284 points[i] += offsetX;
285 points[i + 1] += offsetY;
286 }
Winson Chungc763c4e2013-07-19 13:49:06 -0700287 }
288
Jason Monk02dd7ae2014-04-15 15:23:31 -0400289 /**
290 * Utility method to determine whether the given point, in local coordinates,
291 * is inside the view, where the area of the view is expanded by the slop factor.
292 * This method is called while processing touch-move events to determine if the event
293 * is still within the view.
294 */
295 public static boolean pointInView(View v, float localX, float localY, float slop) {
296 return localX >= -slop && localY >= -slop && localX < (v.getWidth() + slop) &&
297 localY < (v.getHeight() + slop);
298 }
299
Sunny Goyalb1e2e292018-02-21 10:14:30 -0800300 public static void scaleRectFAboutCenter(RectF r, float scale) {
Sunny Goyal47d4d812022-11-04 16:43:42 -0700301 scaleRectFAboutCenter(r, scale, scale);
Winson Chung3a6e7f32013-10-09 15:50:52 -0700302 }
303
Tony Wickhamb45444b2018-05-18 16:57:01 -0700304 /**
Vinit Nayak79037582021-06-24 15:23:21 -0700305 * Similar to {@link #scaleRectAboutCenter(Rect, float)} except this allows different scales
306 * for X and Y
307 */
308 public static void scaleRectFAboutCenter(RectF r, float scaleX, float scaleY) {
309 float px = r.centerX();
310 float py = r.centerY();
311 r.offset(-px, -py);
312 r.left = r.left * scaleX;
313 r.top = r.top * scaleY;
314 r.right = r.right * scaleX;
315 r.bottom = r.bottom * scaleY;
316 r.offset(px, py);
317 }
318
Sunny Goyal47d4d812022-11-04 16:43:42 -0700319 public static void scaleRectAboutCenter(Rect r, float scale) {
320 if (scale != 1.0f) {
321 int cx = r.centerX();
322 int cy = r.centerY();
323 r.offset(-cx, -cy);
324 r.left = (int) (r.left * scale + 0.5f);
325 r.top = (int) (r.top * scale + 0.5f);
326 r.right = (int) (r.right * scale + 0.5f);
327 r.bottom = (int) (r.bottom * scale + 0.5f);
328 r.offset(cx, cy);
329 }
330 }
331
332 public static float shrinkRect(Rect r, float scaleX, float scaleY) {
333 float scale = Math.min(Math.min(scaleX, scaleY), 1.0f);
334 if (scale < 1.0f) {
335 int deltaX = (int) (r.width() * (scaleX - scale) * 0.5f);
336 r.left += deltaX;
337 r.right -= deltaX;
338
339 int deltaY = (int) (r.height() * (scaleY - scale) * 0.5f);
340 r.top += deltaY;
341 r.bottom -= deltaY;
342 }
343 return scale;
344 }
345
Vinit Nayak79037582021-06-24 15:23:21 -0700346 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700347 * Maps t from one range to another range.
348 * @param t The value to map.
349 * @param fromMin The lower bound of the range that t is being mapped from.
350 * @param fromMax The upper bound of the range that t is being mapped from.
351 * @param toMin The lower bound of the range that t is being mapped to.
352 * @param toMax The upper bound of the range that t is being mapped to.
353 * @return The mapped value of t.
354 */
Sunny Goyal0f3af752018-06-08 13:01:04 -0700355 public static float mapToRange(float t, float fromMin, float fromMax, float toMin, float toMax,
356 Interpolator interpolator) {
Tony Wickhamb45444b2018-05-18 16:57:01 -0700357 if (fromMin == fromMax || toMin == toMax) {
358 Log.e(TAG, "mapToRange: range has 0 length");
359 return toMin;
360 }
Tonye4c2e2b2019-03-25 10:23:39 -0500361 float progress = getProgress(t, fromMin, fromMax);
Sunny Goyal0f3af752018-06-08 13:01:04 -0700362 return mapRange(interpolator.getInterpolation(progress), toMin, toMax);
Tony Wickhamb45444b2018-05-18 16:57:01 -0700363 }
364
Cyrus Boadway9f061682021-06-07 20:56:37 +0000365 /** Bounds t between a lower and upper bound and maps the result to a range. */
366 public static float mapBoundToRange(float t, float lowerBound, float upperBound,
367 float toMin, float toMax, Interpolator interpolator) {
368 return mapToRange(boundToRange(t, lowerBound, upperBound), lowerBound, upperBound,
369 toMin, toMax, interpolator);
370 }
371
Tonye4c2e2b2019-03-25 10:23:39 -0500372 public static float getProgress(float current, float min, float max) {
373 return Math.abs(current - min) / Math.abs(max - min);
374 }
375
Winson Chung3e803c72018-01-29 11:16:32 -0800376 public static float mapRange(float value, float min, float max) {
377 return min + (value * (max - min));
378 }
379
Sunny Goyal594d76d2014-11-06 10:12:54 -0800380 /**
Winson Chung82b016c2015-05-08 17:00:10 -0700381 * Trims the string, removing all whitespace at the beginning and end of the string.
382 * Non-breaking whitespaces are also removed.
383 */
Andy Wickham56be73b2022-01-18 09:13:43 -0800384 @NonNull
Winson Chung82b016c2015-05-08 17:00:10 -0700385 public static String trim(CharSequence s) {
Winson Chungafa77e92015-05-15 12:04:03 -0700386 if (s == null) {
Andy Wickham56be73b2022-01-18 09:13:43 -0800387 return "";
Winson Chungafa77e92015-05-15 12:04:03 -0700388 }
389
Winson Chung82b016c2015-05-08 17:00:10 -0700390 // Just strip any sequence of whitespace or java space characters from the beginning and end
391 Matcher m = sTrimPattern.matcher(s);
392 return m.replaceAll("$1");
393 }
Sunny Goyal70660032015-05-14 00:07:08 -0700394
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700395 /**
396 * Calculates the height of a given string at a specific text size.
397 */
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700398 public static int calculateTextHeight(float textSizePx) {
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700399 Paint p = new Paint();
400 p.setTextSize(textSizePx);
401 Paint.FontMetrics fm = p.getFontMetrics();
Sunny Goyalbaec6ff2016-09-14 11:26:21 -0700402 return (int) Math.ceil(fm.bottom - fm.top);
Winson Chung2c6e5cc2015-06-01 14:38:24 -0700403 }
404
Sunny Goyal70660032015-05-14 00:07:08 -0700405 public static boolean isRtl(Resources res) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800406 return res.getConfiguration().getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;
Sunny Goyal70660032015-05-14 00:07:08 -0700407 }
Hyunyoung Song2bd3d7d2015-05-21 13:04:53 -0700408
Sebastian Francod2d8e972022-04-04 14:51:53 -0700409 /** Converts a pixel value (px) to scale pixel value (SP) for the current device. */
410 public static float pxToSp(float size) {
411 return size / Resources.getSystem().getDisplayMetrics().scaledDensity;
412 }
413
Sunny Goyal35c7b192021-04-20 16:51:10 -0700414 public static float dpiFromPx(float size, int densityDpi) {
415 float densityRatio = (float) densityDpi / DisplayMetrics.DENSITY_DEFAULT;
Adam Cohen2e6da152015-05-06 11:42:25 -0700416 return (size / densityRatio);
417 }
vadimt1b383af2019-05-08 15:29:37 -0700418
Schneider Victor-tulias20bbaa32020-12-15 15:33:25 -0500419 /** Converts a dp value to pixels for the current device. */
420 public static int dpToPx(float dp) {
421 return (int) (dp * Resources.getSystem().getDisplayMetrics().density);
422 }
423
Thales Limab67bfa72022-11-02 15:30:11 +0000424 /** Converts a dp value to pixels for a certain density. */
425 public static int dpToPx(float dp, int densityDpi) {
426 float densityRatio = (float) densityDpi / DisplayMetrics.DENSITY_DEFAULT;
427 return (int) (dp * densityRatio);
428 }
Jon Mirandaaf3aed02021-05-06 18:28:45 -0700429
Adam Cohen2e6da152015-05-06 11:42:25 -0700430 public static int pxFromSp(float size, DisplayMetrics metrics) {
Jon Mirandaaf3aed02021-05-06 18:28:45 -0700431 return pxFromSp(size, metrics, 1f);
432 }
433
434 public static int pxFromSp(float size, DisplayMetrics metrics, float scale) {
Pat Manning5f74bfd2022-07-20 12:08:54 +0100435 float value = scale * TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_SP, size, metrics);
436 return ResourceUtils.roundPxValueFromFloat(value);
Adam Cohen2e6da152015-05-06 11:42:25 -0700437 }
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700438
Sunny Goyalefb7e842018-10-04 15:11:00 -0700439 public static String createDbSelectionQuery(String columnName, IntArray values) {
440 return String.format(Locale.ENGLISH, "%s IN (%s)", columnName, values.toConcatString());
Sunny Goyalb1622cc2015-06-10 16:00:42 -0700441 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700442
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700443 public static boolean isBootCompleted() {
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700444 return "1".equals(getSystemProperty("sys.boot_completed", "1"));
445 }
446
447 public static String getSystemProperty(String property, String defaultValue) {
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700448 try {
449 Class clazz = Class.forName("android.os.SystemProperties");
450 Method getter = clazz.getDeclaredMethod("get", String.class);
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700451 String value = (String) getter.invoke(null, property);
452 if (!TextUtils.isEmpty(value)) {
453 return value;
454 }
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700455 } catch (Exception e) {
456 Log.d(TAG, "Unable to read system properties");
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700457 }
Sunny Goyaldfc8b662016-08-30 12:05:48 -0700458 return defaultValue;
Sunny Goyal25aba0a2015-07-16 15:07:47 -0700459 }
Tony Wickham29d853c2015-09-08 10:35:56 -0700460
461 /**
462 * Ensures that a value is within given bounds. Specifically:
463 * If value is less than lowerBound, return lowerBound; else if value is greater than upperBound,
464 * return upperBound; else return value unchanged.
465 */
Tony Wickhamf549dab2016-05-16 09:54:06 -0700466 public static int boundToRange(int value, int lowerBound, int upperBound) {
467 return Math.max(lowerBound, Math.min(value, upperBound));
468 }
469
470 /**
471 * @see #boundToRange(int, int, int).
472 */
473 public static float boundToRange(float value, float lowerBound, float upperBound) {
Tony Wickham29d853c2015-09-08 10:35:56 -0700474 return Math.max(lowerBound, Math.min(value, upperBound));
475 }
Sunny Goyal9d438082015-09-25 11:50:16 -0700476
Sunny Goyale78e3d72015-09-24 11:23:31 -0700477 /**
Tony Wickhamb45444b2018-05-18 16:57:01 -0700478 * @see #boundToRange(int, int, int).
479 */
480 public static long boundToRange(long value, long lowerBound, long upperBound) {
481 return Math.max(lowerBound, Math.min(value, upperBound));
482 }
483
484 /**
Sunny Goyale78e3d72015-09-24 11:23:31 -0700485 * Wraps a message with a TTS span, so that a different message is spoken than
486 * what is getting displayed.
487 * @param msg original message
488 * @param ttsMsg message to be spoken
489 */
Sunny Goyale78e3d72015-09-24 11:23:31 -0700490 public static CharSequence wrapForTts(CharSequence msg, String ttsMsg) {
Sunny Goyala52ecb02016-12-16 15:04:51 -0800491 SpannableString spanned = new SpannableString(msg);
492 spanned.setSpan(new TtsSpan.TextBuilder(ttsMsg).build(),
493 0, spanned.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
494 return spanned;
Sunny Goyale78e3d72015-09-24 11:23:31 -0700495 }
Winson12fb9fc2015-10-01 15:34:08 -0700496
Sunny Goyal5b636eb2019-05-29 01:09:06 -0700497 /**
498 * Prefixes a text with the provided icon
499 */
500 public static CharSequence prefixTextWithIcon(Context context, int iconRes, CharSequence msg) {
501 // Update the hint to contain the icon.
502 // Prefix the original hint with two spaces. The first space gets replaced by the icon
503 // using span. The second space is used for a singe space character between the hint
504 // and the icon.
505 SpannableString spanned = new SpannableString(" " + msg);
506 spanned.setSpan(new TintedDrawableSpan(context, iconRes),
507 0, 1, Spannable.SPAN_EXCLUSIVE_INCLUSIVE);
508 return spanned;
509 }
510
Brian Isganitis88319c42022-03-21 17:09:24 -0700511 public static boolean isWallpaperSupported(Context context) {
512 return context.getSystemService(WallpaperManager.class).isWallpaperSupported();
513 }
514
Hyunyoung Song0de01172016-10-05 16:27:48 -0700515 public static boolean isWallpaperAllowed(Context context) {
Sunny Goyal8c48d8b2019-01-25 15:10:18 -0800516 return context.getSystemService(WallpaperManager.class).isSetWallpaperAllowed();
Sunny Goyal1ed6c4a2016-04-21 15:16:11 -0700517 }
518
Sunny Goyal712ee532016-11-04 10:19:58 -0700519 public static boolean isBinderSizeError(Exception e) {
520 return e.getCause() instanceof TransactionTooLargeException
521 || e.getCause() instanceof DeadObjectException;
522 }
Sunny Goyalab121c12016-12-02 19:29:43 +0530523
Tony Wickham580edcf2017-02-09 08:28:52 -0800524 /**
Sunny Goyal3483c522018-04-12 11:23:33 -0700525 * Utility method to post a runnable on the handler, skipping the synchronization barriers.
526 */
527 public static void postAsyncCallback(Handler handler, Runnable callback) {
528 Message msg = Message.obtain(handler, callback);
529 msg.setAsynchronous(true);
530 handler.sendMessage(msg);
531 }
Vadim Tryshevff3fa342018-07-25 16:29:06 -0700532
Jon Miranda1a49fb52019-02-19 15:34:41 -0800533 /**
Sunny Goyal14168432019-10-24 15:59:49 -0700534 * Returns the full drawable for info without any flattening or pre-processing.
535 *
Jon Miranda0aa263c2022-02-15 13:16:22 -0800536 * @param shouldThemeIcon If true, will theme icons when applicable
537 * @param outObj this is set to the internal data associated with {@code info},
Sunny Goyal6bbf6002019-04-17 18:38:52 -0700538 * eg {@link LauncherActivityInfo} or {@link ShortcutInfo}.
Jon Miranda1a49fb52019-02-19 15:34:41 -0800539 */
Sunny Goyal68af5492021-12-24 01:08:31 +0530540 @TargetApi(Build.VERSION_CODES.TIRAMISU)
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700541 public static Drawable getFullDrawable(Context context, ItemInfo info, int width, int height,
Jon Miranda0aa263c2022-02-15 13:16:22 -0800542 boolean shouldThemeIcon, Object[] outObj) {
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700543 Drawable icon = loadFullDrawableWithoutTheme(context, info, width, height, outObj);
Jon Miranda0aa263c2022-02-15 13:16:22 -0800544 if (ATLEAST_T && icon instanceof AdaptiveIconDrawable && shouldThemeIcon) {
Sunny Goyal68af5492021-12-24 01:08:31 +0530545 AdaptiveIconDrawable aid = (AdaptiveIconDrawable) icon.mutate();
546 Drawable mono = aid.getMonochrome();
547 if (mono != null && Themes.isThemedIconEnabled(context)) {
548 int[] colors = ThemedIconDrawable.getColors(context);
549 mono = mono.mutate();
550 mono.setTint(colors[1]);
551 return new AdaptiveIconDrawable(new ColorDrawable(colors[0]), mono);
552 }
Sunny Goyal9ab43772021-04-23 11:40:58 -0700553 }
554 return icon;
555 }
556
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700557 private static Drawable loadFullDrawableWithoutTheme(Context context, ItemInfo info,
Sunny Goyal9ab43772021-04-23 11:40:58 -0700558 int width, int height, Object[] outObj) {
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700559 ActivityContext activity = ActivityContext.lookupContext(context);
560 LauncherAppState appState = LauncherAppState.getInstance(context);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800561 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_APPLICATION) {
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700562 LauncherActivityInfo activityInfo = context.getSystemService(LauncherApps.class)
Jon Miranda1a49fb52019-02-19 15:34:41 -0800563 .resolveActivity(info.getIntent(), info.user);
564 outObj[0] = activityInfo;
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700565 return activityInfo == null ? null : LauncherAppState.getInstance(context)
Sunny Goyalb47172b2021-05-03 19:59:51 -0700566 .getIconProvider().getIcon(
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700567 activityInfo, activity.getDeviceProfile().inv.fillResIconDpi);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800568 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
569 if (info instanceof PendingAddShortcutInfo) {
570 ShortcutConfigActivityInfo activityInfo =
571 ((PendingAddShortcutInfo) info).activityInfo;
572 outObj[0] = activityInfo;
573 return activityInfo.getFullResIcon(appState.getIconCache());
574 }
Sunny Goyalfa395362019-12-11 10:00:47 -0800575 List<ShortcutInfo> si = ShortcutKey.fromItemInfo(info)
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700576 .buildRequest(context)
Sunny Goyalfa395362019-12-11 10:00:47 -0800577 .query(ShortcutRequest.ALL);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800578 if (si.isEmpty()) {
579 return null;
580 } else {
581 outObj[0] = si.get(0);
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700582 return ShortcutCachingLogic.getIcon(context, si.get(0),
Jon Miranda1a49fb52019-02-19 15:34:41 -0800583 appState.getInvariantDeviceProfile().fillResIconDpi);
584 }
585 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
586 FolderAdaptiveIcon icon = FolderAdaptiveIcon.createFolderAdaptiveIcon(
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700587 activity, info.id, new Point(width, height));
Jon Miranda1a49fb52019-02-19 15:34:41 -0800588 if (icon == null) {
589 return null;
590 }
591 outObj[0] = icon;
592 return icon;
sfufa@google.com1c5e6072021-10-05 18:08:05 -0700593 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_SEARCH_ACTION
594 && info instanceof SearchActionItemInfo) {
Sunny Goyal68af5492021-12-24 01:08:31 +0530595 return ((SearchActionItemInfo) info).bitmap.newIcon(context);
Jon Miranda1a49fb52019-02-19 15:34:41 -0800596 } else {
597 return null;
598 }
Tony573c3e12019-02-22 13:10:59 -0800599 }
Jon Mirandac7206ca2019-05-13 14:57:50 -0700600
Jon Miranda40285752019-05-14 15:17:30 -0700601 /**
602 * For apps icons and shortcut icons that have badges, this method creates a drawable that can
603 * later on be rendered on top of the layers for the badges. For app icons, work profile badges
604 * can only be applied. For deep shortcuts, when dragged from the pop up container, there's no
605 * badge. When dragged from workspace or folder, it may contain app AND/OR work profile badge
606 **/
607 @TargetApi(Build.VERSION_CODES.O)
Tony Wickhamc7cbf252021-05-24 15:46:48 -0700608 public static Drawable getBadge(Context context, ItemInfo info, Object obj) {
609 LauncherAppState appState = LauncherAppState.getInstance(context);
Jon Miranda40285752019-05-14 15:17:30 -0700610 if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_DEEP_SHORTCUT) {
611 boolean iconBadged = (info instanceof ItemInfoWithIcon)
612 && (((ItemInfoWithIcon) info).runtimeStatusFlags & FLAG_ICON_BADGED) > 0;
613 if ((info.id == ItemInfo.NO_ID && !iconBadged)
614 || !(obj instanceof ShortcutInfo)) {
615 // The item is not yet added on home screen.
Sunny Goyald872a972021-11-24 18:07:04 -0800616 return new ColorDrawable(Color.TRANSPARENT);
Jon Miranda40285752019-05-14 15:17:30 -0700617 }
618 ShortcutInfo si = (ShortcutInfo) obj;
Sunny Goyald872a972021-11-24 18:07:04 -0800619 return LauncherAppState.getInstance(appState.getContext())
620 .getIconCache().getShortcutInfoBadge(si).newIcon(context, FLAG_THEMED);
Jon Miranda40285752019-05-14 15:17:30 -0700621 } else if (info.itemType == LauncherSettings.Favorites.ITEM_TYPE_FOLDER) {
622 return ((FolderAdaptiveIcon) obj).getBadge();
623 } else {
Sunny Goyald872a972021-11-24 18:07:04 -0800624 return Process.myUserHandle().equals(info.user)
625 ? new ColorDrawable(Color.TRANSPARENT)
626 : context.getDrawable(R.drawable.ic_work_app_badge);
Jon Miranda40285752019-05-14 15:17:30 -0700627 }
628 }
629
Sunny Goyal878aa332019-05-20 12:40:42 -0700630 public static float squaredHypot(float x, float y) {
631 return x * x + y * y;
632 }
633
634 public static float squaredTouchSlop(Context context) {
635 float slop = ViewConfiguration.get(context).getScaledTouchSlop();
636 return slop * slop;
637 }
638
Sunny Goyal733e3c62020-09-29 10:32:32 -0700639 /**
[1;3Ca608d812021-01-22 13:34:46 -0800640 * Rotates `inOutBounds` by `delta` 90-degree increments. Rotation is visually CCW. Parent
641 * sizes represent the "space" that will rotate carrying inOutBounds along with it to determine
642 * the final bounds.
643 */
644 public static void rotateBounds(Rect inOutBounds, int parentWidth, int parentHeight,
645 int delta) {
646 int rdelta = ((delta % 4) + 4) % 4;
647 int origLeft = inOutBounds.left;
648 switch (rdelta) {
649 case 0:
650 return;
651 case 1:
652 inOutBounds.left = inOutBounds.top;
653 inOutBounds.top = parentWidth - inOutBounds.right;
654 inOutBounds.right = inOutBounds.bottom;
655 inOutBounds.bottom = parentWidth - origLeft;
656 return;
657 case 2:
658 inOutBounds.left = parentWidth - inOutBounds.right;
659 inOutBounds.right = parentWidth - origLeft;
660 return;
661 case 3:
662 inOutBounds.left = parentHeight - inOutBounds.bottom;
663 inOutBounds.bottom = inOutBounds.right;
664 inOutBounds.right = parentHeight - inOutBounds.top;
665 inOutBounds.top = origLeft;
666 return;
667 }
668 }
669
Zak Cohenec4407b2021-04-01 10:49:12 -0700670 /**
671 * Make a color filter that blends a color into the destination based on a scalable amout.
672 *
673 * @param color to blend in.
674 * @param tintAmount [0-1] 0 no tinting, 1 full color.
675 * @return ColorFilter for tinting, or {@code null} if no filter is needed.
676 */
677 public static ColorFilter makeColorTintingColorFilter(int color, float tintAmount) {
678 if (tintAmount == 0f) {
679 return null;
680 }
681 return new LightingColorFilter(
682 // This isn't blending in white, its making a multiplication mask for the base color
683 ColorUtils.blendARGB(Color.WHITE, 0, tintAmount),
684 ColorUtils.blendARGB(0, color, tintAmount));
685 }
686
Schneider Victor-tulias16e04e22021-10-15 14:43:54 -0700687 public static Rect getViewBounds(@NonNull View v) {
688 int[] pos = new int[2];
689 v.getLocationOnScreen(pos);
690 return new Rect(pos[0], pos[1], pos[0] + v.getWidth(), pos[1] + v.getHeight());
691 }
Jeremy Simabdf25d2022-03-31 17:02:11 -0700692
693 /**
694 * Returns a list of screen-splitting options depending on the device orientation (split top for
695 * portrait, split left for landscape, split left and right for landscape tablets, etc.)
696 */
697 public static List<SplitPositionOption> getSplitPositionOptions(
698 DeviceProfile dp) {
699 List<SplitPositionOption> options = new ArrayList<>();
700 // Add both left and right options if we're in tablet mode
701 if (dp.isTablet && dp.isLandscape) {
702 options.add(new SplitPositionOption(
703 R.drawable.ic_split_left, R.string.split_screen_position_left,
704 STAGE_POSITION_TOP_OR_LEFT, STAGE_TYPE_MAIN));
705 options.add(new SplitPositionOption(
706 R.drawable.ic_split_right, R.string.split_screen_position_right,
707 STAGE_POSITION_BOTTOM_OR_RIGHT, STAGE_TYPE_MAIN));
708 } else {
709 if (dp.isSeascape()) {
710 // Add left/right options
711 options.add(new SplitPositionOption(
712 R.drawable.ic_split_right, R.string.split_screen_position_right,
713 STAGE_POSITION_BOTTOM_OR_RIGHT, STAGE_TYPE_MAIN));
714 } else if (dp.isLandscape) {
715 options.add(new SplitPositionOption(
716 R.drawable.ic_split_left, R.string.split_screen_position_left,
717 STAGE_POSITION_TOP_OR_LEFT, STAGE_TYPE_MAIN));
718 } else {
719 // Only add top option
720 options.add(new SplitPositionOption(
721 R.drawable.ic_split_top, R.string.split_screen_position_top,
722 STAGE_POSITION_TOP_OR_LEFT, STAGE_TYPE_MAIN));
723 }
724 }
725 return options;
726 }
The Android Open Source Project31dd5032009-03-03 19:32:27 -0800727}