blob: 8231a2ba0c467f1489bc8ab192b899a3b7a18586 [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:
35 ScreenRecoveryUI();
Doug Zongker211aebc2011-10-28 15:13:10 -070036
Tao Bao5d2e3bd2017-06-23 22:23:50 -070037 bool Init(const std::string& locale) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070038
Tao Bao5d2e3bd2017-06-23 22:23:50 -070039 // overall recovery state ("background image")
Tao Bao99b2d772017-06-23 22:47:03 -070040 void SetBackground(Icon icon) override;
41 void SetSystemUpdateText(bool security_update) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070042
Tao Bao5d2e3bd2017-06-23 22:23:50 -070043 // progress indicator
44 void SetProgressType(ProgressType type) override;
45 void ShowProgress(float portion, float seconds) override;
46 void SetProgress(float fraction) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070047
Tao Bao5d2e3bd2017-06-23 22:23:50 -070048 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -080049
Tao Bao5d2e3bd2017-06-23 22:23:50 -070050 // text log
51 void ShowText(bool visible) override;
52 bool IsTextVisible() override;
53 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070054
Tao Bao5d2e3bd2017-06-23 22:23:50 -070055 // printing messages
Tao Bao99b2d772017-06-23 22:47:03 -070056 void Print(const char* fmt, ...) override __printflike(2, 3);
57 void PrintOnScreenOnly(const char* fmt, ...) override __printflike(2, 3);
58 void ShowFile(const char* filename) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070059
Tao Bao5d2e3bd2017-06-23 22:23:50 -070060 // menu display
Tao Bao99b2d772017-06-23 22:47:03 -070061 void StartMenu(const char* const* headers, const char* const* items,
62 int initial_selection) override;
63 int SelectMenu(int sel) override;
64 void EndMenu() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070065
Tao Bao99b2d772017-06-23 22:47:03 -070066 void KeyLongPress(int) override;
Elliott Hughes642aaa72015-04-10 12:47:46 -070067
Tao Bao5d2e3bd2017-06-23 22:23:50 -070068 void Redraw();
Doug Zongkerc0441d12013-07-31 11:28:24 -070069
Tao Bao5d2e3bd2017-06-23 22:23:50 -070070 enum UIElement {
71 HEADER,
72 MENU,
73 MENU_SEL_BG,
74 MENU_SEL_BG_ACTIVE,
75 MENU_SEL_FG,
76 LOG,
77 TEXT_FILL,
78 INFO
79 };
Tao Bao99b2d772017-06-23 22:47:03 -070080 void SetColor(UIElement e) const;
Doug Zongkerc0441d12013-07-31 11:28:24 -070081
Tao Bao5d2e3bd2017-06-23 22:23:50 -070082 protected:
83 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
84 // rounded corners).
85 const int kMarginWidth;
86 const int kMarginHeight;
Tao Bao4521b702017-06-20 18:11:21 -070087
Tao Bao0470cee2017-08-02 17:11:04 -070088 // Number of frames per sec (default: 30) for both parts of the animation.
89 const int kAnimationFps;
90
Tao Bao5d2e3bd2017-06-23 22:23:50 -070091 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
92 const float density_;
Tao Bao171b4c42017-06-19 23:10:44 -070093
Tao Bao5d2e3bd2017-06-23 22:23:50 -070094 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -070095
Tao Bao5d2e3bd2017-06-23 22:23:50 -070096 // The layout to use.
97 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -070098
Tao Bao5d2e3bd2017-06-23 22:23:50 -070099 GRSurface* error_icon;
Elliott Hughes498cda62016-04-14 16:49:04 -0700100
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700101 GRSurface* erasing_text;
102 GRSurface* error_text;
103 GRSurface* installing_text;
104 GRSurface* no_command_text;
Elliott Hughes498cda62016-04-14 16:49:04 -0700105
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700106 GRSurface** introFrames;
107 GRSurface** loopFrames;
Elliott Hughes498cda62016-04-14 16:49:04 -0700108
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700109 GRSurface* progressBarEmpty;
110 GRSurface* progressBarFill;
111 GRSurface* stageMarkerEmpty;
112 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700113
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700114 ProgressType progressBarType;
Doug Zongker211aebc2011-10-28 15:13:10 -0700115
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700116 float progressScopeStart, progressScopeSize, progress;
117 double progressScopeTime, progressScopeDuration;
Doug Zongker211aebc2011-10-28 15:13:10 -0700118
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700119 // true when both graphics pages are the same (except for the progress bar).
120 bool pagesIdentical;
Doug Zongker211aebc2011-10-28 15:13:10 -0700121
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700122 size_t text_cols_, text_rows_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700123
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700124 // Log text overlay, displayed when a magic key is pressed.
125 char** text_;
126 size_t text_col_, text_row_, text_top_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700127
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700128 bool show_text;
129 bool show_text_ever; // has show_text ever been true?
Doug Zongker211aebc2011-10-28 15:13:10 -0700130
Tao Baoe15d7a52017-09-07 13:38:51 -0700131 std::vector<std::string> menu_;
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700132 const char* const* menu_headers_;
133 bool show_menu;
134 int menu_items, menu_sel;
Doug Zongker211aebc2011-10-28 15:13:10 -0700135
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700136 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
137 char** file_viewer_text_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700138
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700139 pthread_t progress_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700140
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700141 // Number of intro frames and loop frames in the animation.
142 size_t intro_frames;
143 size_t loop_frames;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700144
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700145 size_t current_frame;
146 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700147
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700148 int stage, max_stage;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800149
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700150 int char_width_;
151 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700152
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700153 pthread_mutex_t updateMutex;
Elliott Hughes498cda62016-04-14 16:49:04 -0700154
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700155 virtual bool InitTextParams();
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700156
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700157 virtual void draw_background_locked();
158 virtual void draw_foreground_locked();
159 virtual void draw_screen_locked();
160 virtual void update_screen_locked();
161 virtual void update_progress_locked();
Elliott Hughes985022a2015-04-13 13:04:32 -0700162
Tao Bao99b2d772017-06-23 22:47:03 -0700163 GRSurface* GetCurrentFrame() const;
164 GRSurface* GetCurrentText() const;
Elliott Hughes498cda62016-04-14 16:49:04 -0700165
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700166 static void* ProgressThreadStartRoutine(void* data);
167 void ProgressThreadLoop();
Doug Zongker211aebc2011-10-28 15:13:10 -0700168
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700169 virtual void ShowFile(FILE*);
170 virtual void PrintV(const char*, bool, va_list);
171 void PutChar(char);
172 void ClearText();
Elliott Hughes95fc63e2015-04-10 19:12:01 -0700173
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700174 void LoadAnimation();
175 void LoadBitmap(const char* filename, GRSurface** surface);
176 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
Elliott Hughes498cda62016-04-14 16:49:04 -0700177
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700178 int PixelsFromDp(int dp) const;
Tao Bao99b2d772017-06-23 22:47:03 -0700179 virtual int GetAnimationBaseline() const;
180 virtual int GetProgressBaseline() const;
181 virtual int GetTextBaseline() const;
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700182
Tao Baoea78d862017-06-28 14:52:17 -0700183 // Draws a highlight bar at (x, y) - (x + width, y + height).
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700184 virtual void DrawHighlightBar(int x, int y, int width, int height) const;
Tao Baoea78d862017-06-28 14:52:17 -0700185 // Draws a horizontal rule at Y. Returns the offset it should be moving along Y-axis.
186 virtual int DrawHorizontalRule(int y) const;
187 // Draws a line of text. Returns the offset it should be moving along Y-axis.
188 virtual int DrawTextLine(int x, int y, const char* line, bool bold) const;
189 // Draws multiple text lines. Returns the offset it should be moving along Y-axis.
190 int DrawTextLines(int x, int y, const char* const* lines) const;
Tao Bao2bbc6d62017-08-13 23:48:55 -0700191 // Similar to DrawTextLines() to draw multiple text lines, but additionally wraps long lines.
192 // Returns the offset it should be moving along Y-axis.
193 int DrawWrappedTextLines(int x, int y, const char* const* lines) const;
Doug Zongker211aebc2011-10-28 15:13:10 -0700194};
195
196#endif // RECOVERY_UI_H