blob: 3a28a09de8588513d7378657ff6183d3e14a0028 [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 Bao736d59c2017-01-03 10:15:33 -080023#include <string>
Tao Baoe15d7a52017-09-07 13:38:51 -070024#include <vector>
Tao Bao736d59c2017-01-03 10:15:33 -080025
Doug Zongker211aebc2011-10-28 15:13:10 -070026#include "ui.h"
Tao Bao0ecbd762017-01-16 21:16:58 -080027
28// From minui/minui.h.
29struct GRSurface;
Doug Zongker211aebc2011-10-28 15:13:10 -070030
31// Implementation of RecoveryUI appropriate for devices with a screen
32// (shows an icon + a progress bar, text logging, menu, etc.)
33class ScreenRecoveryUI : public RecoveryUI {
Tao Bao5d2e3bd2017-06-23 22:23:50 -070034 public:
Tao Bao75779652017-09-10 11:28:32 -070035 enum UIElement {
36 HEADER,
37 MENU,
38 MENU_SEL_BG,
39 MENU_SEL_BG_ACTIVE,
40 MENU_SEL_FG,
41 LOG,
42 TEXT_FILL,
43 INFO
44 };
45
Tao Bao5d2e3bd2017-06-23 22:23:50 -070046 ScreenRecoveryUI();
Doug Zongker211aebc2011-10-28 15:13:10 -070047
Tao Bao5d2e3bd2017-06-23 22:23:50 -070048 bool Init(const std::string& locale) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070049
Tao Bao5d2e3bd2017-06-23 22:23:50 -070050 // overall recovery state ("background image")
Tao Bao99b2d772017-06-23 22:47:03 -070051 void SetBackground(Icon icon) override;
52 void SetSystemUpdateText(bool security_update) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070053
Tao Bao5d2e3bd2017-06-23 22:23:50 -070054 // progress indicator
55 void SetProgressType(ProgressType type) override;
56 void ShowProgress(float portion, float seconds) override;
57 void SetProgress(float fraction) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070058
Tao Bao5d2e3bd2017-06-23 22:23:50 -070059 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -080060
Tao Bao5d2e3bd2017-06-23 22:23:50 -070061 // text log
62 void ShowText(bool visible) override;
63 bool IsTextVisible() override;
64 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070065
Tao Bao5d2e3bd2017-06-23 22:23:50 -070066 // printing messages
Tao Bao99b2d772017-06-23 22:47:03 -070067 void Print(const char* fmt, ...) override __printflike(2, 3);
68 void PrintOnScreenOnly(const char* fmt, ...) override __printflike(2, 3);
69 void ShowFile(const char* filename) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070070
Tao Bao5d2e3bd2017-06-23 22:23:50 -070071 // menu display
Tao Bao99b2d772017-06-23 22:47:03 -070072 void StartMenu(const char* const* headers, const char* const* items,
73 int initial_selection) override;
74 int SelectMenu(int sel) override;
75 void EndMenu() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070076
Tao Bao99b2d772017-06-23 22:47:03 -070077 void KeyLongPress(int) override;
Elliott Hughes642aaa72015-04-10 12:47:46 -070078
Tao Bao5d2e3bd2017-06-23 22:23:50 -070079 void Redraw();
Doug Zongkerc0441d12013-07-31 11:28:24 -070080
Tao Bao99b2d772017-06-23 22:47:03 -070081 void SetColor(UIElement e) const;
Doug Zongkerc0441d12013-07-31 11:28:24 -070082
Tianjie Xu29d55752017-09-20 17:53:46 -070083 // Check the background text image. Use volume up/down button to cycle through the locales
84 // embedded in the png file, and power button to go back to recovery main menu.
85 void CheckBackgroundTextImages(const std::string& saved_locale);
86
Tao Bao5d2e3bd2017-06-23 22:23:50 -070087 protected:
88 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
89 // rounded corners).
90 const int kMarginWidth;
91 const int kMarginHeight;
Tao Bao4521b702017-06-20 18:11:21 -070092
Tao Bao0470cee2017-08-02 17:11:04 -070093 // Number of frames per sec (default: 30) for both parts of the animation.
94 const int kAnimationFps;
95
Tao Bao5d2e3bd2017-06-23 22:23:50 -070096 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
Tao Bao75779652017-09-10 11:28:32 -070097 const float kDensity;
98
99 virtual bool InitTextParams();
100
101 virtual void draw_background_locked();
102 virtual void draw_foreground_locked();
103 virtual void draw_screen_locked();
104 virtual void update_screen_locked();
105 virtual void update_progress_locked();
106
107 GRSurface* GetCurrentFrame() const;
108 GRSurface* GetCurrentText() const;
109
110 static void* ProgressThreadStartRoutine(void* data);
111 void ProgressThreadLoop();
112
113 virtual void ShowFile(FILE*);
114 virtual void PrintV(const char*, bool, va_list);
115 void PutChar(char);
116 void ClearText();
117
118 void LoadAnimation();
119 void LoadBitmap(const char* filename, GRSurface** surface);
120 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
121
122 int PixelsFromDp(int dp) const;
123 virtual int GetAnimationBaseline() const;
124 virtual int GetProgressBaseline() const;
125 virtual int GetTextBaseline() const;
126
127 // Draws a highlight bar at (x, y) - (x + width, y + height).
128 virtual void DrawHighlightBar(int x, int y, int width, int height) const;
129 // Draws a horizontal rule at Y. Returns the offset it should be moving along Y-axis.
130 virtual int DrawHorizontalRule(int y) const;
131 // Draws a line of text. Returns the offset it should be moving along Y-axis.
132 virtual int DrawTextLine(int x, int y, const char* line, bool bold) const;
133 // Draws multiple text lines. Returns the offset it should be moving along Y-axis.
134 int DrawTextLines(int x, int y, const char* const* lines) const;
135 // Similar to DrawTextLines() to draw multiple text lines, but additionally wraps long lines.
136 // Returns the offset it should be moving along Y-axis.
137 int DrawWrappedTextLines(int x, int y, const char* const* lines) const;
Tao Bao171b4c42017-06-19 23:10:44 -0700138
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700139 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -0700140
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700141 // The layout to use.
142 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700143
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700144 GRSurface* error_icon;
Elliott Hughes498cda62016-04-14 16:49:04 -0700145
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700146 GRSurface* erasing_text;
147 GRSurface* error_text;
148 GRSurface* installing_text;
149 GRSurface* no_command_text;
Elliott Hughes498cda62016-04-14 16:49:04 -0700150
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700151 GRSurface** introFrames;
152 GRSurface** loopFrames;
Elliott Hughes498cda62016-04-14 16:49:04 -0700153
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700154 GRSurface* progressBarEmpty;
155 GRSurface* progressBarFill;
156 GRSurface* stageMarkerEmpty;
157 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700158
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700159 ProgressType progressBarType;
Doug Zongker211aebc2011-10-28 15:13:10 -0700160
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700161 float progressScopeStart, progressScopeSize, progress;
162 double progressScopeTime, progressScopeDuration;
Doug Zongker211aebc2011-10-28 15:13:10 -0700163
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700164 // true when both graphics pages are the same (except for the progress bar).
165 bool pagesIdentical;
Doug Zongker211aebc2011-10-28 15:13:10 -0700166
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700167 size_t text_cols_, text_rows_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700168
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700169 // Log text overlay, displayed when a magic key is pressed.
170 char** text_;
Tao Baocb5524c2017-09-08 21:25:32 -0700171 size_t text_col_, text_row_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700172
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700173 bool show_text;
174 bool show_text_ever; // has show_text ever been true?
Doug Zongker211aebc2011-10-28 15:13:10 -0700175
Tao Baoe15d7a52017-09-07 13:38:51 -0700176 std::vector<std::string> menu_;
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700177 const char* const* menu_headers_;
178 bool show_menu;
179 int menu_items, menu_sel;
Doug Zongker211aebc2011-10-28 15:13:10 -0700180
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700181 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
182 char** file_viewer_text_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700183
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700184 pthread_t progress_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700185
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700186 // Number of intro frames and loop frames in the animation.
187 size_t intro_frames;
188 size_t loop_frames;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700189
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700190 size_t current_frame;
191 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700192
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700193 int stage, max_stage;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800194
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700195 int char_width_;
196 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700197
Tao Baoefb49ad2017-01-31 23:03:10 -0800198 // The locale that's used to show the rendered texts.
199 std::string locale_;
200 bool rtl_locale_;
201
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700202 pthread_mutex_t updateMutex;
Tao Baoefb49ad2017-01-31 23:03:10 -0800203
204 private:
205 void SetLocale(const std::string&);
Tianjie Xu29d55752017-09-20 17:53:46 -0700206
207 // Display the background texts for "erasing", "error", "no_command" and "installing" for the
208 // selected locale.
209 void SelectAndShowBackgroundText(const std::vector<std::string>& locales_entries, size_t sel);
Doug Zongker211aebc2011-10-28 15:13:10 -0700210};
211
212#endif // RECOVERY_UI_H