1 /*
2  * Copyright (C) 2020 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.wm.shell.bubbles;
18 
19 import android.content.Context;
20 import android.provider.Settings;
21 
22 import java.util.List;
23 
24 /**
25  * Common class for the various debug {@link android.util.Log} output configuration in the Bubbles
26  * package.
27  */
28 public class BubbleDebugConfig {
29 
30     // All output logs in the Bubbles package use the {@link #TAG_BUBBLES} string for tagging their
31     // log output. This makes it easy to identify the origin of the log message when sifting
32     // through a large amount of log output from multiple sources. However, it also makes trying
33     // to figure-out the origin of a log message while debugging the Bubbles a little painful. By
34     // setting this constant to true, log messages from the Bubbles package will be tagged with
35     // their class names instead fot the generic tag.
36     public static final boolean TAG_WITH_CLASS_NAME = false;
37 
38     // Default log tag for the Bubbles package.
39     public static final String TAG_BUBBLES = "Bubbles";
40     public static final boolean DEBUG_USER_EDUCATION = false;
41 
42     private static final boolean FORCE_SHOW_USER_EDUCATION = false;
43     private static final String FORCE_SHOW_USER_EDUCATION_SETTING =
44             "force_show_bubbles_user_education";
45     /**
46      * When set to true, bubbles user education flow never shows up.
47      */
48     private static final String FORCE_HIDE_USER_EDUCATION_SETTING =
49             "force_hide_bubbles_user_education";
50 
51     /**
52      * @return whether we should force show user education for bubbles. Used for debugging & demos.
53      */
forceShowUserEducation(Context context)54     static boolean forceShowUserEducation(Context context) {
55         boolean forceShow = Settings.Secure.getInt(context.getContentResolver(),
56                 FORCE_SHOW_USER_EDUCATION_SETTING, 0) != 0;
57         return FORCE_SHOW_USER_EDUCATION || forceShow;
58     }
59 
60     /**
61      * @return whether we should never show user education for bubbles. Used in tests.
62      */
neverShowUserEducation(Context context)63     static boolean neverShowUserEducation(Context context) {
64         return Settings.Secure.getInt(context.getContentResolver(),
65                 FORCE_HIDE_USER_EDUCATION_SETTING, 0) != 0;
66     }
67 
formatBubblesString(List<Bubble> bubbles, BubbleViewProvider selected)68     static String formatBubblesString(List<Bubble> bubbles, BubbleViewProvider selected) {
69         StringBuilder sb = new StringBuilder();
70         for (int i = 0; i < bubbles.size(); i++) {
71             Bubble bubble = bubbles.get(i);
72             if (bubble == null) {
73                 sb.append("   <null> !!!!!");
74             } else {
75                 boolean isSelected = (selected != null
76                         && !BubbleOverflow.KEY.equals(selected.getKey())
77                         && bubble == selected);
78                 String arrow = isSelected ? "=>" : "  ";
79 
80                 sb.append(String.format("%s Bubble{act=%12d, showInShade=%d, key=%s}",
81                         arrow,
82                         bubble.getLastActivity(),
83                         (bubble.showInShade() ? 1 : 0),
84                         bubble.getKey()));
85             }
86             if (i != bubbles.size() - 1) {
87                 sb.append("\n");
88             }
89         }
90         return sb.toString();
91     }
92 }
93