blob: 861b3605a775565cea7a5c36e19d13d2d094312a [file] [log] [blame]
Doug Zongker211aebc2011-10-28 15:13:10 -07001/*
2 * Copyright (C) 2011 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#ifndef RECOVERY_SCREEN_UI_H
18#define RECOVERY_SCREEN_UI_H
19
Elliott Hughes95fc63e2015-04-10 19:12:01 -070020#include <stdio.h>
Doug Zongker211aebc2011-10-28 15:13:10 -070021
Tao Bao26ea9592018-05-09 16:32:02 -070022#include <atomic>
Tao Bao3aec6962018-04-20 09:24:58 -070023#include <functional>
Tianjie Xu5fe5eb62018-03-20 16:07:39 -070024#include <memory>
Tao Bao736d59c2017-01-03 10:15:33 -080025#include <string>
Tao Bao26ea9592018-05-09 16:32:02 -070026#include <thread>
Tao Baoe15d7a52017-09-07 13:38:51 -070027#include <vector>
Tao Bao736d59c2017-01-03 10:15:33 -080028
Doug Zongker211aebc2011-10-28 15:13:10 -070029#include "ui.h"
Tao Bao0ecbd762017-01-16 21:16:58 -080030
31// From minui/minui.h.
Tao Bao92bdb5a2018-10-21 12:12:37 -070032class GRSurface;
Doug Zongker211aebc2011-10-28 15:13:10 -070033
Tianjie Xu66dbf632018-10-11 16:54:50 -070034enum class UIElement {
35 HEADER,
36 MENU,
37 MENU_SEL_BG,
38 MENU_SEL_BG_ACTIVE,
39 MENU_SEL_FG,
40 LOG,
41 TEXT_FILL,
42 INFO
43};
44
45// Interface to draw the UI elements on the screen.
46class DrawInterface {
47 public:
48 virtual ~DrawInterface() = default;
49
50 // Sets the color to the predefined value for |element|.
51 virtual void SetColor(UIElement element) const = 0;
52
53 // Draws a highlight bar at (x, y) - (x + width, y + height).
54 virtual void DrawHighlightBar(int x, int y, int width, int height) const = 0;
55
56 // Draws a horizontal rule at Y. Returns the offset it should be moving along Y-axis.
57 virtual int DrawHorizontalRule(int y) const = 0;
58
59 // Draws a line of text. Returns the offset it should be moving along Y-axis.
60 virtual int DrawTextLine(int x, int y, const std::string& line, bool bold) const = 0;
61
62 // Draws surface portion (sx, sy, w, h) at screen location (dx, dy).
63 virtual void DrawSurface(GRSurface* surface, int sx, int sy, int w, int h, int dx,
64 int dy) const = 0;
65
66 // Draws rectangle at (x, y) - (x + w, y + h).
67 virtual void DrawFill(int x, int y, int w, int h) const = 0;
68
69 // Draws given surface (surface->pixel_bytes = 1) as text at (x, y).
70 virtual void DrawTextIcon(int x, int y, GRSurface* surface) const = 0;
71
72 // Draws multiple text lines. Returns the offset it should be moving along Y-axis.
73 virtual int DrawTextLines(int x, int y, const std::vector<std::string>& lines) const = 0;
74
75 // Similar to DrawTextLines() to draw multiple text lines, but additionally wraps long lines. It
76 // keeps symmetrical margins of 'x' at each end of a line. Returns the offset it should be moving
77 // along Y-axis.
78 virtual int DrawWrappedTextLines(int x, int y, const std::vector<std::string>& lines) const = 0;
79};
80
81// Interface for classes that maintain the menu selection and display.
Tianjie Xu5fe5eb62018-03-20 16:07:39 -070082class Menu {
83 public:
Tianjie Xu66dbf632018-10-11 16:54:50 -070084 virtual ~Menu() = default;
85 // Returns the current menu selection.
86 size_t selection() const;
87 // Sets the current selection to |sel|. Handle the overflow cases depending on if the menu is
88 // scrollable.
89 virtual int Select(int sel) = 0;
90 // Displays the menu headers on the screen at offset x, y
91 virtual int DrawHeader(int x, int y) const = 0;
92 // Iterates over the menu items and displays each of them at offset x, y.
93 virtual int DrawItems(int x, int y, int screen_width, bool long_press) const = 0;
94
95 protected:
96 Menu(size_t initial_selection, const DrawInterface& draw_func);
97 // Current menu selection.
98 size_t selection_;
99 // Reference to the class that implements all the draw functions.
100 const DrawInterface& draw_funcs_;
101};
102
103// This class uses strings as the menu header and items.
104class TextMenu : public Menu {
105 public:
Tao Baoe02a5b22018-05-02 15:46:11 -0700106 // Constructs a Menu instance with the given |headers|, |items| and properties. Sets the initial
107 // selection to |initial_selection|.
Tianjie Xu66dbf632018-10-11 16:54:50 -0700108 TextMenu(bool scrollable, size_t max_items, size_t max_length,
109 const std::vector<std::string>& headers, const std::vector<std::string>& items,
110 size_t initial_selection, int char_height, const DrawInterface& draw_funcs);
111
112 int Select(int sel) override;
113 int DrawHeader(int x, int y) const override;
114 int DrawItems(int x, int y, int screen_width, bool long_press) const override;
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700115
116 bool scrollable() const {
117 return scrollable_;
118 }
119
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700120 // Returns count of menu items.
121 size_t ItemsCount() const;
Tao Baoe02a5b22018-05-02 15:46:11 -0700122
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700123 // Returns the index of the first menu item.
124 size_t MenuStart() const;
Tao Baoe02a5b22018-05-02 15:46:11 -0700125
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700126 // Returns the index of the last menu item + 1.
127 size_t MenuEnd() const;
128
129 // Menu example:
130 // info: Android Recovery
131 // ....
132 // help messages: Swipe up/down to move
133 // Swipe left/right to select
134 // empty line (horizontal rule):
135 // menu headers: Select file to view
136 // menu items: /cache/recovery/last_log
137 // /cache/recovery/last_log.1
138 // /cache/recovery/last_log.2
139 // ...
Tao Bao1fe1afe2018-05-01 15:56:05 -0700140 const std::vector<std::string>& text_headers() const;
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700141 std::string TextItem(size_t index) const;
142
143 // Checks if the menu items fit vertically on the screen. Returns true and set the
144 // |cur_selection_str| if the items exceed the screen limit.
145 bool ItemsOverflow(std::string* cur_selection_str) const;
146
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700147 private:
148 // The menu is scrollable to display more items. Used on wear devices who have smaller screens.
149 const bool scrollable_;
150 // The max number of menu items to fit vertically on a screen.
151 const size_t max_display_items_;
152 // The length of each item to fit horizontally on a screen.
153 const size_t max_item_length_;
Tao Bao1fe1afe2018-05-01 15:56:05 -0700154 // The menu headers.
155 std::vector<std::string> text_headers_;
156 // The actual menu items trimmed to fit the given properties.
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700157 std::vector<std::string> text_items_;
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700158 // The first item to display on the screen.
159 size_t menu_start_;
Tianjie Xu66dbf632018-10-11 16:54:50 -0700160
161 // Height in pixels of each character.
162 int char_height_;
163};
164
165// This class uses GRSurfaces* as the menu header and items.
166class GraphicMenu : public Menu {
167 public:
168 // Constructs a Menu instance with the given |headers|, |items| and properties. Sets the initial
169 // selection to |initial_selection|.
170 GraphicMenu(size_t max_width, size_t max_height, GRSurface* graphic_headers,
171 const std::vector<GRSurface*>& graphic_items, size_t initial_selection,
172 const DrawInterface& draw_funcs);
173
174 int Select(int sel) override;
175 int DrawHeader(int x, int y) const override;
176 int DrawItems(int x, int y, int screen_width, bool long_press) const override;
177
178 // Checks if all the header and items are valid GRSurfaces; and that they can fit in the area
179 // defined by |max_width_| and |max_height_|.
180 bool Validate() const;
181
182 private:
183 // Returns true if |surface| fits on the screen with a vertical offset |y|.
184 bool ValidateGraphicSurface(int y, const GRSurface* surface) const;
185
186 const size_t max_width_;
187 const size_t max_height_;
188
189 // Pointers to the menu headers and items in graphic icons. This class does not have the ownership
190 // of the these objects.
191 GRSurface* graphic_headers_;
192 std::vector<GRSurface*> graphic_items_;
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700193};
194
Doug Zongker211aebc2011-10-28 15:13:10 -0700195// Implementation of RecoveryUI appropriate for devices with a screen
196// (shows an icon + a progress bar, text logging, menu, etc.)
Tianjie Xu66dbf632018-10-11 16:54:50 -0700197class ScreenRecoveryUI : public RecoveryUI, public DrawInterface {
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700198 public:
199 ScreenRecoveryUI();
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700200 explicit ScreenRecoveryUI(bool scrollable_menu);
Tao Bao26ea9592018-05-09 16:32:02 -0700201 ~ScreenRecoveryUI() override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700202
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700203 bool Init(const std::string& locale) override;
Tao Bao551d2c32018-05-09 20:53:13 -0700204 std::string GetLocale() const override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700205
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700206 // overall recovery state ("background image")
Tao Bao99b2d772017-06-23 22:47:03 -0700207 void SetBackground(Icon icon) override;
208 void SetSystemUpdateText(bool security_update) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700209
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700210 // progress indicator
211 void SetProgressType(ProgressType type) override;
212 void ShowProgress(float portion, float seconds) override;
213 void SetProgress(float fraction) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700214
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700215 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800216
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700217 // text log
218 void ShowText(bool visible) override;
219 bool IsTextVisible() override;
220 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700221
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700222 // printing messages
Tao Bao99b2d772017-06-23 22:47:03 -0700223 void Print(const char* fmt, ...) override __printflike(2, 3);
224 void PrintOnScreenOnly(const char* fmt, ...) override __printflike(2, 3);
Tao Bao1d156b92018-05-02 12:43:18 -0700225 void ShowFile(const std::string& filename) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700226
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700227 // menu display
Tao Bao1fe1afe2018-05-01 15:56:05 -0700228 size_t ShowMenu(const std::vector<std::string>& headers, const std::vector<std::string>& items,
229 size_t initial_selection, bool menu_only,
230 const std::function<int(int, bool)>& key_handler) override;
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700231 void SetTitle(const std::vector<std::string>& lines) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700232
Tao Bao99b2d772017-06-23 22:47:03 -0700233 void KeyLongPress(int) override;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700234
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700235 void Redraw();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700236
Tao Bao39c49182018-05-07 22:50:33 -0700237 // Checks the background text image, for debugging purpose. It iterates the locales embedded in
238 // the on-device resource files and shows the localized text, for manual inspection.
239 void CheckBackgroundTextImages();
Tianjie Xu29d55752017-09-20 17:53:46 -0700240
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700241 protected:
242 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
243 // rounded corners).
Tao Bao0bc88de2018-07-31 14:53:16 -0700244 const int margin_width_;
245 const int margin_height_;
Tao Bao4521b702017-06-20 18:11:21 -0700246
Tao Bao0470cee2017-08-02 17:11:04 -0700247 // Number of frames per sec (default: 30) for both parts of the animation.
Tao Bao0bc88de2018-07-31 14:53:16 -0700248 const int animation_fps_;
Tao Bao0470cee2017-08-02 17:11:04 -0700249
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700250 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
Tao Bao0bc88de2018-07-31 14:53:16 -0700251 const float density_;
Tao Bao75779652017-09-10 11:28:32 -0700252
253 virtual bool InitTextParams();
254
Tao Bao3aec6962018-04-20 09:24:58 -0700255 // Displays some header text followed by a menu of items, which appears at the top of the screen
256 // (in place of any scrolling ui_print() output, if necessary).
Tao Bao1fe1afe2018-05-01 15:56:05 -0700257 virtual void StartMenu(const std::vector<std::string>& headers,
258 const std::vector<std::string>& items, size_t initial_selection);
Tao Bao3aec6962018-04-20 09:24:58 -0700259
260 // Sets the menu highlight to the given index, wrapping if necessary. Returns the actual item
261 // selected.
262 virtual int SelectMenu(int sel);
263
264 // Ends menu mode, resetting the text overlay so that ui_print() statements will be displayed.
265 virtual void EndMenu();
266
Tao Bao75779652017-09-10 11:28:32 -0700267 virtual void draw_background_locked();
268 virtual void draw_foreground_locked();
269 virtual void draw_screen_locked();
Tao Bao93e46ad2018-05-02 14:57:21 -0700270 virtual void draw_menu_and_text_buffer_locked(const std::vector<std::string>& help_message);
Tao Bao75779652017-09-10 11:28:32 -0700271 virtual void update_screen_locked();
272 virtual void update_progress_locked();
273
274 GRSurface* GetCurrentFrame() const;
275 GRSurface* GetCurrentText() const;
276
Tao Bao75779652017-09-10 11:28:32 -0700277 void ProgressThreadLoop();
278
279 virtual void ShowFile(FILE*);
280 virtual void PrintV(const char*, bool, va_list);
281 void PutChar(char);
282 void ClearText();
283
284 void LoadAnimation();
285 void LoadBitmap(const char* filename, GRSurface** surface);
286 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
287
288 int PixelsFromDp(int dp) const;
289 virtual int GetAnimationBaseline() const;
290 virtual int GetProgressBaseline() const;
291 virtual int GetTextBaseline() const;
292
Luke Song92eda4d2017-09-19 10:51:35 -0700293 // Returns pixel width of draw buffer.
294 virtual int ScreenWidth() const;
295 // Returns pixel height of draw buffer.
296 virtual int ScreenHeight() const;
297
Tianjie Xu66dbf632018-10-11 16:54:50 -0700298 // Implementation of the draw functions in DrawInterface.
299 void SetColor(UIElement e) const override;
300 void DrawHighlightBar(int x, int y, int width, int height) const override;
301 int DrawHorizontalRule(int y) const override;
302 void DrawSurface(GRSurface* surface, int sx, int sy, int w, int h, int dx, int dy) const override;
303 void DrawFill(int x, int y, int w, int h) const override;
304 void DrawTextIcon(int x, int y, GRSurface* surface) const override;
305 int DrawTextLine(int x, int y, const std::string& line, bool bold) const override;
306 int DrawTextLines(int x, int y, const std::vector<std::string>& lines) const override;
307 int DrawWrappedTextLines(int x, int y, const std::vector<std::string>& lines) const override;
Tao Bao171b4c42017-06-19 23:10:44 -0700308
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700309 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -0700310
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700311 // The layout to use.
312 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700313
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700314 GRSurface* error_icon;
Elliott Hughes498cda62016-04-14 16:49:04 -0700315
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700316 GRSurface* erasing_text;
317 GRSurface* error_text;
318 GRSurface* installing_text;
319 GRSurface* no_command_text;
Elliott Hughes498cda62016-04-14 16:49:04 -0700320
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700321 GRSurface** introFrames;
322 GRSurface** loopFrames;
Elliott Hughes498cda62016-04-14 16:49:04 -0700323
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700324 GRSurface* progressBarEmpty;
325 GRSurface* progressBarFill;
326 GRSurface* stageMarkerEmpty;
327 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700328
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700329 ProgressType progressBarType;
Doug Zongker211aebc2011-10-28 15:13:10 -0700330
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700331 float progressScopeStart, progressScopeSize, progress;
332 double progressScopeTime, progressScopeDuration;
Doug Zongker211aebc2011-10-28 15:13:10 -0700333
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700334 // true when both graphics pages are the same (except for the progress bar).
335 bool pagesIdentical;
Doug Zongker211aebc2011-10-28 15:13:10 -0700336
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700337 size_t text_cols_, text_rows_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700338
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700339 // Log text overlay, displayed when a magic key is pressed.
340 char** text_;
Tao Baocb5524c2017-09-08 21:25:32 -0700341 size_t text_col_, text_row_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700342
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700343 bool show_text;
344 bool show_text_ever; // has show_text ever been true?
Doug Zongker211aebc2011-10-28 15:13:10 -0700345
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700346 std::vector<std::string> title_lines_;
347
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700348 bool scrollable_menu_;
349 std::unique_ptr<Menu> menu_;
Doug Zongker211aebc2011-10-28 15:13:10 -0700350
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700351 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
352 char** file_viewer_text_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700353
Tao Bao26ea9592018-05-09 16:32:02 -0700354 std::thread progress_thread_;
355 std::atomic<bool> progress_thread_stopped_{ false };
Doug Zongker32a0a472011-11-01 11:00:20 -0700356
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700357 // Number of intro frames and loop frames in the animation.
358 size_t intro_frames;
359 size_t loop_frames;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700360
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700361 size_t current_frame;
362 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700363
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700364 int stage, max_stage;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800365
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700366 int char_width_;
367 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700368
Tao Baoefb49ad2017-01-31 23:03:10 -0800369 // The locale that's used to show the rendered texts.
370 std::string locale_;
371 bool rtl_locale_;
372
Jerry Zhangb31f9ce2018-05-21 16:04:57 -0700373 std::mutex updateMutex;
Tao Baoefb49ad2017-01-31 23:03:10 -0800374
375 private:
376 void SetLocale(const std::string&);
Tianjie Xu29d55752017-09-20 17:53:46 -0700377
378 // Display the background texts for "erasing", "error", "no_command" and "installing" for the
379 // selected locale.
380 void SelectAndShowBackgroundText(const std::vector<std::string>& locales_entries, size_t sel);
Doug Zongker211aebc2011-10-28 15:13:10 -0700381};
382
383#endif // RECOVERY_UI_H