blob: b0cbbdb909cc6c8b527cb25b154113c63a5c80f5 [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
20#include <pthread.h>
Elliott Hughes95fc63e2015-04-10 19:12:01 -070021#include <stdio.h>
Doug Zongker211aebc2011-10-28 15:13:10 -070022
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 Baoe15d7a52017-09-07 13:38:51 -070026#include <vector>
Tao Bao736d59c2017-01-03 10:15:33 -080027
Doug Zongker211aebc2011-10-28 15:13:10 -070028#include "ui.h"
Tao Bao0ecbd762017-01-16 21:16:58 -080029
30// From minui/minui.h.
31struct GRSurface;
Doug Zongker211aebc2011-10-28 15:13:10 -070032
Tianjie Xu5fe5eb62018-03-20 16:07:39 -070033// This class maintains the menu selection and display of the screen ui.
34class Menu {
35 public:
36 Menu(bool scrollable, size_t max_items, size_t max_length);
37
38 bool scrollable() const {
39 return scrollable_;
40 }
41
42 int selection() const {
43 return selection_;
44 }
45
46 // Returns count of menu items.
47 size_t ItemsCount() const;
48 // Returns the index of the first menu item.
49 size_t MenuStart() const;
50 // Returns the index of the last menu item + 1.
51 size_t MenuEnd() const;
52
53 // Menu example:
54 // info: Android Recovery
55 // ....
56 // help messages: Swipe up/down to move
57 // Swipe left/right to select
58 // empty line (horizontal rule):
59 // menu headers: Select file to view
60 // menu items: /cache/recovery/last_log
61 // /cache/recovery/last_log.1
62 // /cache/recovery/last_log.2
63 // ...
64 const char* const* text_headers() const;
65 std::string TextItem(size_t index) const;
66
67 // Checks if the menu items fit vertically on the screen. Returns true and set the
68 // |cur_selection_str| if the items exceed the screen limit.
69 bool ItemsOverflow(std::string* cur_selection_str) const;
70
71 // Starts the menu with |headers| and |items| in text. Sets the default selection to
72 // |initial_selection|.
73 void Start(const char* const* headers, const char* const* items, int initial_selection);
74
75 // Sets the current selection to |sel|. Handle the overflow cases depending on if the menu is
76 // scrollable.
77 int Select(int sel);
78
79 private:
80 // The menu is scrollable to display more items. Used on wear devices who have smaller screens.
81 const bool scrollable_;
82 // The max number of menu items to fit vertically on a screen.
83 const size_t max_display_items_;
84 // The length of each item to fit horizontally on a screen.
85 const size_t max_item_length_;
86
87 // Internal storage for the menu headers and items in text.
88 const char* const* text_headers_;
89 std::vector<std::string> text_items_;
90
91 // The first item to display on the screen.
92 size_t menu_start_;
93 // Current menu selection.
94 int selection_;
95};
96
Doug Zongker211aebc2011-10-28 15:13:10 -070097// Implementation of RecoveryUI appropriate for devices with a screen
98// (shows an icon + a progress bar, text logging, menu, etc.)
99class ScreenRecoveryUI : public RecoveryUI {
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700100 public:
Tao Bao75779652017-09-10 11:28:32 -0700101 enum UIElement {
102 HEADER,
103 MENU,
104 MENU_SEL_BG,
105 MENU_SEL_BG_ACTIVE,
106 MENU_SEL_FG,
107 LOG,
108 TEXT_FILL,
109 INFO
110 };
111
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700112 ScreenRecoveryUI();
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700113 explicit ScreenRecoveryUI(bool scrollable_menu);
Doug Zongker211aebc2011-10-28 15:13:10 -0700114
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700115 bool Init(const std::string& locale) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700116
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700117 // overall recovery state ("background image")
Tao Bao99b2d772017-06-23 22:47:03 -0700118 void SetBackground(Icon icon) override;
119 void SetSystemUpdateText(bool security_update) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700120
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700121 // progress indicator
122 void SetProgressType(ProgressType type) override;
123 void ShowProgress(float portion, float seconds) override;
124 void SetProgress(float fraction) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700125
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700126 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800127
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700128 // text log
129 void ShowText(bool visible) override;
130 bool IsTextVisible() override;
131 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700132
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700133 // printing messages
Tao Bao99b2d772017-06-23 22:47:03 -0700134 void Print(const char* fmt, ...) override __printflike(2, 3);
135 void PrintOnScreenOnly(const char* fmt, ...) override __printflike(2, 3);
Tao Bao1d156b92018-05-02 12:43:18 -0700136 void ShowFile(const std::string& filename) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700137
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700138 // menu display
Tao Bao3aec6962018-04-20 09:24:58 -0700139 int ShowMenu(const char* const* headers, const char* const* items, int initial_selection,
140 bool menu_only, const std::function<int(int, bool)>& key_handler) override;
Doug Zongker211aebc2011-10-28 15:13:10 -0700141
Tao Bao99b2d772017-06-23 22:47:03 -0700142 void KeyLongPress(int) override;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700143
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700144 void Redraw();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700145
Tao Bao99b2d772017-06-23 22:47:03 -0700146 void SetColor(UIElement e) const;
Doug Zongkerc0441d12013-07-31 11:28:24 -0700147
Tianjie Xu29d55752017-09-20 17:53:46 -0700148 // Check the background text image. Use volume up/down button to cycle through the locales
149 // embedded in the png file, and power button to go back to recovery main menu.
150 void CheckBackgroundTextImages(const std::string& saved_locale);
151
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700152 protected:
153 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
154 // rounded corners).
155 const int kMarginWidth;
156 const int kMarginHeight;
Tao Bao4521b702017-06-20 18:11:21 -0700157
Tao Bao0470cee2017-08-02 17:11:04 -0700158 // Number of frames per sec (default: 30) for both parts of the animation.
159 const int kAnimationFps;
160
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700161 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
Tao Bao75779652017-09-10 11:28:32 -0700162 const float kDensity;
163
164 virtual bool InitTextParams();
165
Tao Bao3aec6962018-04-20 09:24:58 -0700166 // Displays some header text followed by a menu of items, which appears at the top of the screen
167 // (in place of any scrolling ui_print() output, if necessary).
168 virtual void StartMenu(const char* const* headers, const char* const* items,
169 int initial_selection);
170
171 // Sets the menu highlight to the given index, wrapping if necessary. Returns the actual item
172 // selected.
173 virtual int SelectMenu(int sel);
174
175 // Ends menu mode, resetting the text overlay so that ui_print() statements will be displayed.
176 virtual void EndMenu();
177
Tao Bao75779652017-09-10 11:28:32 -0700178 virtual void draw_background_locked();
179 virtual void draw_foreground_locked();
180 virtual void draw_screen_locked();
Tao Bao93e46ad2018-05-02 14:57:21 -0700181 virtual void draw_menu_and_text_buffer_locked(const std::vector<std::string>& help_message);
Tao Bao75779652017-09-10 11:28:32 -0700182 virtual void update_screen_locked();
183 virtual void update_progress_locked();
184
185 GRSurface* GetCurrentFrame() const;
186 GRSurface* GetCurrentText() const;
187
188 static void* ProgressThreadStartRoutine(void* data);
189 void ProgressThreadLoop();
190
191 virtual void ShowFile(FILE*);
192 virtual void PrintV(const char*, bool, va_list);
193 void PutChar(char);
194 void ClearText();
195
196 void LoadAnimation();
197 void LoadBitmap(const char* filename, GRSurface** surface);
198 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
199
200 int PixelsFromDp(int dp) const;
201 virtual int GetAnimationBaseline() const;
202 virtual int GetProgressBaseline() const;
203 virtual int GetTextBaseline() const;
204
Luke Song92eda4d2017-09-19 10:51:35 -0700205 // Returns pixel width of draw buffer.
206 virtual int ScreenWidth() const;
207 // Returns pixel height of draw buffer.
208 virtual int ScreenHeight() const;
209
Tao Bao75779652017-09-10 11:28:32 -0700210 // Draws a highlight bar at (x, y) - (x + width, y + height).
211 virtual void DrawHighlightBar(int x, int y, int width, int height) const;
212 // Draws a horizontal rule at Y. Returns the offset it should be moving along Y-axis.
213 virtual int DrawHorizontalRule(int y) const;
214 // Draws a line of text. Returns the offset it should be moving along Y-axis.
Tao Bao93e46ad2018-05-02 14:57:21 -0700215 virtual int DrawTextLine(int x, int y, const std::string& line, bool bold) const;
Luke Song92eda4d2017-09-19 10:51:35 -0700216 // Draws surface portion (sx, sy, w, h) at screen location (dx, dy).
217 virtual void DrawSurface(GRSurface* surface, int sx, int sy, int w, int h, int dx, int dy) const;
218 // Draws rectangle at (x, y) - (x + w, y + h).
219 virtual void DrawFill(int x, int y, int w, int h) const;
220 // Draws given surface (surface->pixel_bytes = 1) as text at (x, y).
221 virtual void DrawTextIcon(int x, int y, GRSurface* surface) const;
Tao Bao75779652017-09-10 11:28:32 -0700222 // Draws multiple text lines. Returns the offset it should be moving along Y-axis.
Tao Bao93e46ad2018-05-02 14:57:21 -0700223 int DrawTextLines(int x, int y, const std::vector<std::string>& lines) const;
Tao Bao75779652017-09-10 11:28:32 -0700224 // Similar to DrawTextLines() to draw multiple text lines, but additionally wraps long lines.
225 // Returns the offset it should be moving along Y-axis.
Tao Bao93e46ad2018-05-02 14:57:21 -0700226 int DrawWrappedTextLines(int x, int y, const std::vector<std::string>& lines) const;
Tao Bao171b4c42017-06-19 23:10:44 -0700227
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700228 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -0700229
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700230 // The layout to use.
231 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700232
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700233 GRSurface* error_icon;
Elliott Hughes498cda62016-04-14 16:49:04 -0700234
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700235 GRSurface* erasing_text;
236 GRSurface* error_text;
237 GRSurface* installing_text;
238 GRSurface* no_command_text;
Elliott Hughes498cda62016-04-14 16:49:04 -0700239
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700240 GRSurface** introFrames;
241 GRSurface** loopFrames;
Elliott Hughes498cda62016-04-14 16:49:04 -0700242
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700243 GRSurface* progressBarEmpty;
244 GRSurface* progressBarFill;
245 GRSurface* stageMarkerEmpty;
246 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700247
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700248 ProgressType progressBarType;
Doug Zongker211aebc2011-10-28 15:13:10 -0700249
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700250 float progressScopeStart, progressScopeSize, progress;
251 double progressScopeTime, progressScopeDuration;
Doug Zongker211aebc2011-10-28 15:13:10 -0700252
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700253 // true when both graphics pages are the same (except for the progress bar).
254 bool pagesIdentical;
Doug Zongker211aebc2011-10-28 15:13:10 -0700255
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700256 size_t text_cols_, text_rows_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700257
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700258 // Log text overlay, displayed when a magic key is pressed.
259 char** text_;
Tao Baocb5524c2017-09-08 21:25:32 -0700260 size_t text_col_, text_row_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700261
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700262 bool show_text;
263 bool show_text_ever; // has show_text ever been true?
Doug Zongker211aebc2011-10-28 15:13:10 -0700264
Tianjie Xu5fe5eb62018-03-20 16:07:39 -0700265 bool scrollable_menu_;
266 std::unique_ptr<Menu> menu_;
Doug Zongker211aebc2011-10-28 15:13:10 -0700267
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700268 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
269 char** file_viewer_text_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700270
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700271 pthread_t progress_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700272
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700273 // Number of intro frames and loop frames in the animation.
274 size_t intro_frames;
275 size_t loop_frames;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700276
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700277 size_t current_frame;
278 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700279
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700280 int stage, max_stage;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800281
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700282 int char_width_;
283 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700284
Tao Baoefb49ad2017-01-31 23:03:10 -0800285 // The locale that's used to show the rendered texts.
286 std::string locale_;
287 bool rtl_locale_;
288
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700289 pthread_mutex_t updateMutex;
Tao Baoefb49ad2017-01-31 23:03:10 -0800290
291 private:
292 void SetLocale(const std::string&);
Tianjie Xu29d55752017-09-20 17:53:46 -0700293
294 // Display the background texts for "erasing", "error", "no_command" and "installing" for the
295 // selected locale.
296 void SelectAndShowBackgroundText(const std::vector<std::string>& locales_entries, size_t sel);
Doug Zongker211aebc2011-10-28 15:13:10 -0700297};
298
299#endif // RECOVERY_UI_H