blob: 7e8e51e1006f263d99af3c9af0ef46526cbe41a2 [file] [log] [blame]
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -07001/*
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 */
16syntax = "proto2";
17
18option java_package = "com.android.launcher3.logger";
19option java_outer_classname = "LauncherAtom";
20
21//
22// ItemInfos
23message ItemInfo {
24 oneof Item {
25 Application application = 1;
thiruramacbd7ef2020-04-17 19:10:49 -070026 Task task = 2;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070027 Shortcut shortcut = 3;
thiruramf81e8b02020-04-15 10:22:28 -070028 Widget widget = 4;
thiruram5a01f0e2020-05-04 17:49:37 -070029 FolderIcon folder_icon = 9;
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070030 }
31 // When used for launch event, stores the global predictive rank
32 optional int32 rank = 5;
33
34 // Stores whether the Item belows to non primary user
35 optional bool is_work = 6;
36
37 // Item can be child node to parent container or parent containers (nested)
thiruramacbd7ef2020-04-17 19:10:49 -070038 optional ContainerInfo container_info = 7;
39
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070040 // Stores the origin of the Item
Hyunyoung Song90c58732020-06-08 17:42:10 -070041 optional Attribute attribute = 8;
thiruramacbd7ef2020-04-17 19:10:49 -070042}
43
44// Represents various launcher surface where items are placed.
45message ContainerInfo {
46 oneof Container {
47 WorkspaceContainer workspace = 1;
48 HotseatContainer hotseat = 2;
49 FolderContainer folder = 3;
50 AllAppsContainer all_apps_container = 4;
thiruram6bf68482020-05-06 22:19:43 -070051 WidgetsContainer widgets_container = 5;
thiruram62c7b5c2020-05-19 09:31:38 -070052 PredictionContainer prediction_container = 6;
53 SearchResultContainer search_result_container = 7;
thiruram63bf8ee2020-06-01 12:03:19 -070054 ShortcutsContainer shortcuts_container = 8;
Hyunyoung Songf26c7932020-06-06 14:44:27 -070055 SettingsContainer settings_container = 9;
thiruram18c24952020-06-10 10:44:58 -070056 PredictedHotseatContainer predicted_hotseat_container = 10;
thiruramacbd7ef2020-04-17 19:10:49 -070057 }
58}
59
thiruram62c7b5c2020-05-19 09:31:38 -070060// Represents the apps list sorted alphabetically inside the all-apps view.
thiruramacbd7ef2020-04-17 19:10:49 -070061message AllAppsContainer {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070062}
63
thiruram6bf68482020-05-06 22:19:43 -070064message WidgetsContainer {
65}
66
thiruram62c7b5c2020-05-19 09:31:38 -070067// Represents the predicted apps row(top row) in the all-apps view.
68message PredictionContainer {
69}
70
71// Represents the apps container within search results.
72message SearchResultContainer {
73}
74
thiruram63bf8ee2020-06-01 12:03:19 -070075// Container for package specific shortcuts to deep links and notifications.
76// Typically shown as popup window by longpressing on an icon.
77message ShortcutsContainer {
78}
79
Hyunyoung Songf26c7932020-06-06 14:44:27 -070080// Container for generic system shortcuts for launcher specific settings.
81// Typically shown up as popup window by longpressing on empty space on workspace.
82message SettingsContainer {
83}
84
Hyunyoung Song90c58732020-06-08 17:42:10 -070085enum Attribute {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070086 UNKNOWN = 0;
87 DEFAULT_LAYOUT = 1; // icon automatically placed in workspace, folder, hotseat
88 BACKUP_RESTORE = 2; // icon layout restored from backup
89 PINITEM = 3; // from another app (e.g., Chrome's "Add to Home screen")
90 ALLAPPS_ATOZ = 4; // within launcher surface, all aps a-z
91 WIDGETS = 5; // within launcher, widgets tray
92 ADD_TO_HOMESCREEN = 6; // play install + launcher home setting
93 ALLAPPS_PREDICTION = 7; // from prediction bar in all apps container
94 HOTSEAT_PREDICTION = 8; // from prediction bar in hotseat container
Hyunyoung Song90c58732020-06-08 17:42:10 -070095 SUGGESTED_LABEL = 9; // folder icon's label was suggested
96 MANUAL_LABEL = 10; // folder icon's label was manually edited
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -070097}
98
99// Main app icons
100message Application {
101 optional string package_name = 1;
102 optional string component_name = 2;
103}
104
105// Legacy shortcuts and shortcuts handled by ShortcutManager
106message Shortcut {
107 optional string shortcut_name = 1;
108}
109
110// AppWidgets handled by AppWidgetManager
111message Widget {
thiruramacbd7ef2020-04-17 19:10:49 -0700112 optional int32 span_x = 1 [default = 1];
113 optional int32 span_y = 2 [default = 1];
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700114 optional int32 app_widget_id = 3;
115 optional string package_name = 4; // only populated during snapshot if from workspace
116 optional string component_name = 5; // only populated during snapshot if from workspace
117}
118
119// Tasks handled by PackageManager
120message Task {
121 optional string package_name = 1;
122 optional string component_name = 2;
123 optional int32 index = 3;
124}
125
thiruram5a01f0e2020-05-04 17:49:37 -0700126// Represents folder in a closed state.
127message FolderIcon {
thiruram6524cc72020-05-08 11:04:32 -0700128 // Number of items inside folder.
thiruram5a01f0e2020-05-04 17:49:37 -0700129 optional int32 cardinality = 1;
thiruram6524cc72020-05-08 11:04:32 -0700130
131 // State of the folder label before the event.
thiruramf95f1522020-05-08 17:53:19 -0700132 optional FromState from_label_state = 2;
thiruram6524cc72020-05-08 11:04:32 -0700133
134 // State of the folder label after the event.
thiruramf95f1522020-05-08 17:53:19 -0700135 optional ToState to_label_state = 3;
thiruram6524cc72020-05-08 11:04:32 -0700136
thiruramf95f1522020-05-08 17:53:19 -0700137 // Details about actual folder label.
138 // Populated when folder label is not a PII.
139 optional string label_info = 4;
thiruram5a01f0e2020-05-04 17:49:37 -0700140}
141
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700142//////////////////////////////////////////////
143// Containers
144
145message WorkspaceContainer {
thiruramacbd7ef2020-04-17 19:10:49 -0700146 optional int32 page_index = 1 [default = -2]; // range [-1, l], 0 is the index of the main homescreen
147 optional int32 grid_x = 2 [default = -1]; // [0, m], m varies based on the display density and resolution
148 optional int32 grid_y = 3 [default = -1]; // [0, n], n varies based on the display density and resolution
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700149}
150
151message HotseatContainer {
152 optional int32 index = 1;
153}
154
thiruram18c24952020-06-10 10:44:58 -0700155// Represents hotseat container with prediction feature enabled.
156message PredictedHotseatContainer {
157 optional int32 index = 1;
158
159 // No of hotseat positions filled with predicted items.
160 optional int32 cardinality = 2;
161}
162
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700163message FolderContainer {
thiruramacbd7ef2020-04-17 19:10:49 -0700164 optional int32 page_index = 1 [default = -1];
165 optional int32 grid_x = 2 [default = -1];
166 optional int32 grid_y = 3 [default = -1];
167 oneof ParentContainer {
Hyunyoung Song7ac0ef12020-03-26 01:48:24 -0700168 WorkspaceContainer workspace = 4;
169 HotseatContainer hotseat = 5;
170 }
171}
thiruram6524cc72020-05-08 11:04:32 -0700172
thiruramf95f1522020-05-08 17:53:19 -0700173// Represents state of EditText field before update.
thiruram6524cc72020-05-08 11:04:32 -0700174enum FromState {
175 // Default value.
thiruramf95f1522020-05-08 17:53:19 -0700176 // Used when a FromState is not applicable, for example, during folder creation.
thiruram6524cc72020-05-08 11:04:32 -0700177 FROM_STATE_UNSPECIFIED = 0;
178
thiruramf95f1522020-05-08 17:53:19 -0700179 // EditText was empty.
180 // Eg: When a folder label is updated from empty string.
thiruram6524cc72020-05-08 11:04:32 -0700181 FROM_EMPTY = 1;
182
thiruramf95f1522020-05-08 17:53:19 -0700183 // EditText was non-empty and manually entered by the user.
184 // Eg: When a folder label is updated from a user-entered value.
thiruram6524cc72020-05-08 11:04:32 -0700185 FROM_CUSTOM = 2;
186
thiruramf95f1522020-05-08 17:53:19 -0700187 // EditText was non-empty and one of the suggestions.
188 // Eg: When a folder label is updated from a suggested value.
thiruram6524cc72020-05-08 11:04:32 -0700189 FROM_SUGGESTED = 3;
190}
191
thiruramf95f1522020-05-08 17:53:19 -0700192// Represents state of EditText field after update.
thiruram6524cc72020-05-08 11:04:32 -0700193enum ToState {
194 // Default value.
thiruramf95f1522020-05-08 17:53:19 -0700195 // Used when ToState is not applicable, for example, when folder label is updated to a different
196 // value when folder label suggestion feature is disabled.
thiruram6524cc72020-05-08 11:04:32 -0700197 TO_STATE_UNSPECIFIED = 0;
thiruramf95f1522020-05-08 17:53:19 -0700198
199 // User attempted to change the EditText, but was not changed.
thiruram6524cc72020-05-08 11:04:32 -0700200 UNCHANGED = 1;
201
202 // New label matches with primary(aka top) suggestion.
203 TO_SUGGESTION0 = 2;
204
thiruramf95f1522020-05-08 17:53:19 -0700205 // New value matches with second top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700206 TO_SUGGESTION1_WITH_VALID_PRIMARY = 3;
207
thiruramf95f1522020-05-08 17:53:19 -0700208 // New value matches with second top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700209 TO_SUGGESTION1_WITH_EMPTY_PRIMARY = 4;
210
thiruramf95f1522020-05-08 17:53:19 -0700211 // New value matches with third top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700212 TO_SUGGESTION2_WITH_VALID_PRIMARY = 5;
213
thiruramf95f1522020-05-08 17:53:19 -0700214 // New value matches with third top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700215 TO_SUGGESTION2_WITH_EMPTY_PRIMARY = 6;
216
thiruramf95f1522020-05-08 17:53:19 -0700217 // New value matches with 4th top suggestion even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700218 TO_SUGGESTION3_WITH_VALID_PRIMARY = 7;
219
thiruramf95f1522020-05-08 17:53:19 -0700220 // New value matches with 4th top suggestion given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700221 TO_SUGGESTION3_WITH_EMPTY_PRIMARY = 8;
222
thiruramf95f1522020-05-08 17:53:19 -0700223 // New value is empty even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700224 TO_EMPTY_WITH_VALID_PRIMARY = 9;
225
thiruramf95f1522020-05-08 17:53:19 -0700226 // New value is empty given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700227 TO_EMPTY_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 10;
228
thiruramf95f1522020-05-08 17:53:19 -0700229 // New value is empty given that no suggestions were provided.
thiruram6524cc72020-05-08 11:04:32 -0700230 TO_EMPTY_WITH_EMPTY_SUGGESTIONS = 11;
231
thiruramf95f1522020-05-08 17:53:19 -0700232 // New value is empty given that suggestions feature was disabled.
thiruram6524cc72020-05-08 11:04:32 -0700233 TO_EMPTY_WITH_SUGGESTIONS_DISABLED = 12;
234
thiruramf95f1522020-05-08 17:53:19 -0700235 // New value is non-empty and does not match with any of the suggestions even though the top suggestion was non-empty.
thiruram6524cc72020-05-08 11:04:32 -0700236 TO_CUSTOM_WITH_VALID_PRIMARY = 13;
237
thiruramf95f1522020-05-08 17:53:19 -0700238 // New value is non-empty and not match with any suggestions given that top suggestion was empty.
thiruram6524cc72020-05-08 11:04:32 -0700239 TO_CUSTOM_WITH_VALID_SUGGESTIONS_AND_EMPTY_PRIMARY = 14;
240
thiruramf95f1522020-05-08 17:53:19 -0700241 // New value is non-empty and also no suggestions were provided.
thiruram6524cc72020-05-08 11:04:32 -0700242 TO_CUSTOM_WITH_EMPTY_SUGGESTIONS = 15;
243
thiruramf95f1522020-05-08 17:53:19 -0700244 // New value is non-empty and also suggestions feature was disable.
thiruram6524cc72020-05-08 11:04:32 -0700245 TO_CUSTOM_WITH_SUGGESTIONS_DISABLED = 16;
246}