1 /*
2  * Copyright (C) 2019 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.systemui.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     static final boolean TAG_WITH_CLASS_NAME = false;
37 
38     // Default log tag for the Bubbles package.
39     static final String TAG_BUBBLES = "Bubbles";
40 
41     static final boolean DEBUG_BUBBLE_CONTROLLER = false;
42     static final boolean DEBUG_BUBBLE_DATA = false;
43     static final boolean DEBUG_BUBBLE_STACK_VIEW = false;
44     static final boolean DEBUG_BUBBLE_EXPANDED_VIEW = false;
45     static final boolean DEBUG_EXPERIMENTS = true;
46     static final boolean DEBUG_OVERFLOW = false;
47     static final boolean DEBUG_USER_EDUCATION = false;
48 
49     private static final boolean FORCE_SHOW_USER_EDUCATION = false;
50     private static final String FORCE_SHOW_USER_EDUCATION_SETTING =
51             "force_show_bubbles_user_education";
52 
53     /**
54      * @return whether we should force show user education for bubbles. Used for debugging & demos.
55      */
forceShowUserEducation(Context context)56     static boolean forceShowUserEducation(Context context) {
57         boolean forceShow = Settings.Secure.getInt(context.getContentResolver(),
58                 FORCE_SHOW_USER_EDUCATION_SETTING, 0) != 0;
59         return FORCE_SHOW_USER_EDUCATION || forceShow;
60     }
61 
formatBubblesString(List<Bubble> bubbles, BubbleViewProvider selected)62     static String formatBubblesString(List<Bubble> bubbles, BubbleViewProvider selected) {
63         StringBuilder sb = new StringBuilder();
64         for (Bubble bubble : bubbles) {
65             if (bubble == null) {
66                 sb.append("   <null> !!!!!\n");
67             } else {
68                 boolean isSelected = (selected != null
69                         && selected.getKey() != BubbleOverflow.KEY
70                         && bubble == selected);
71                 String arrow = isSelected ? "=>" : "  ";
72                 sb.append(String.format("%s Bubble{act=%12d, showInShade=%d, key=%s}\n",
73                         arrow,
74                         bubble.getLastActivity(),
75                         (bubble.showInShade() ? 1 : 0),
76                         bubble.getKey()));
77             }
78         }
79         return sb.toString();
80     }
81 }
82