blob: e961c1c936199cf29e7d4f73a17b06cb7516d0da [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>
24
Doug Zongker211aebc2011-10-28 15:13:10 -070025#include "ui.h"
Tao Bao0ecbd762017-01-16 21:16:58 -080026
27// From minui/minui.h.
28struct GRSurface;
Doug Zongker211aebc2011-10-28 15:13:10 -070029
30// Implementation of RecoveryUI appropriate for devices with a screen
31// (shows an icon + a progress bar, text logging, menu, etc.)
32class ScreenRecoveryUI : public RecoveryUI {
33 public:
34 ScreenRecoveryUI();
35
Tao Bao736d59c2017-01-03 10:15:33 -080036 bool Init(const std::string& locale) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070037
38 // overall recovery state ("background image")
39 void SetBackground(Icon icon);
Tianjie Xu35926c42016-04-28 18:06:26 -070040 void SetSystemUpdateText(bool security_update);
Doug Zongker211aebc2011-10-28 15:13:10 -070041
42 // progress indicator
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -070043 void SetProgressType(ProgressType type) override;
44 void ShowProgress(float portion, float seconds) override;
45 void SetProgress(float fraction) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070046
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -070047 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -080048
Doug Zongker211aebc2011-10-28 15:13:10 -070049 // text log
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -070050 void ShowText(bool visible) override;
51 bool IsTextVisible() override;
52 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070053
Doug Zongker211aebc2011-10-28 15:13:10 -070054 // printing messages
Elliott Hughes018ed312015-04-08 16:51:36 -070055 void Print(const char* fmt, ...) __printflike(2, 3);
Tao Baob6918c72015-05-19 17:02:16 -070056 void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3);
Elliott Hughes8de52072015-04-08 20:06:50 -070057 void ShowFile(const char* filename);
Doug Zongker211aebc2011-10-28 15:13:10 -070058
59 // menu display
60 void StartMenu(const char* const * headers, const char* const * items,
Elliott Hughes018ed312015-04-08 16:51:36 -070061 int initial_selection);
Doug Zongker211aebc2011-10-28 15:13:10 -070062 int SelectMenu(int sel);
63 void EndMenu();
64
Elliott Hughes642aaa72015-04-10 12:47:46 -070065 void KeyLongPress(int);
66
Doug Zongkerc0441d12013-07-31 11:28:24 -070067 void Redraw();
68
Elliott Hughes8fd86d72015-04-13 14:36:02 -070069 enum UIElement {
70 HEADER, MENU, MENU_SEL_BG, MENU_SEL_BG_ACTIVE, MENU_SEL_FG, LOG, TEXT_FILL, INFO
71 };
Elliott Hughes642aaa72015-04-10 12:47:46 -070072 void SetColor(UIElement e);
Doug Zongkerc0441d12013-07-31 11:28:24 -070073
Elliott Hughes498cda62016-04-14 16:49:04 -070074 protected:
Tao Bao4521b702017-06-20 18:11:21 -070075 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
76 // rounded corners).
77 const int kMarginWidth;
78 const int kMarginHeight;
79
Tao Bao171b4c42017-06-19 23:10:44 -070080 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
81 const float density_;
82
Prashant Malanif7f9e502016-03-10 03:40:20 +000083 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -070084
Elliott Hughes6d089a92016-07-08 17:23:41 -070085 // The layout to use.
86 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -070087
Elliott Hughes498cda62016-04-14 16:49:04 -070088 GRSurface* error_icon;
89
90 GRSurface* erasing_text;
91 GRSurface* error_text;
92 GRSurface* installing_text;
93 GRSurface* no_command_text;
94
95 GRSurface** introFrames;
96 GRSurface** loopFrames;
97
Elliott Hughes0a5cb0c2015-04-15 10:58:56 -070098 GRSurface* progressBarEmpty;
99 GRSurface* progressBarFill;
100 GRSurface* stageMarkerEmpty;
101 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700102
103 ProgressType progressBarType;
104
105 float progressScopeStart, progressScopeSize, progress;
106 double progressScopeTime, progressScopeDuration;
107
Elliott Hughes8de52072015-04-08 20:06:50 -0700108 // true when both graphics pages are the same (except for the progress bar).
Doug Zongker211aebc2011-10-28 15:13:10 -0700109 bool pagesIdentical;
110
Elliott Hughesc0491632015-05-06 12:40:05 -0700111 size_t text_cols_, text_rows_;
112
Elliott Hughes8de52072015-04-08 20:06:50 -0700113 // Log text overlay, displayed when a magic key is pressed.
Elliott Hughesc0491632015-05-06 12:40:05 -0700114 char** text_;
115 size_t text_col_, text_row_, text_top_;
Luke Songe2bd8762017-06-12 16:08:33 -0700116 int log_bottom_offset_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700117
Doug Zongker211aebc2011-10-28 15:13:10 -0700118 bool show_text;
119 bool show_text_ever; // has show_text ever been true?
120
Elliott Hughesc0491632015-05-06 12:40:05 -0700121 char** menu_;
122 const char* const* menu_headers_;
Doug Zongker211aebc2011-10-28 15:13:10 -0700123 bool show_menu;
Elliott Hughes8fd86d72015-04-13 14:36:02 -0700124 int menu_items, menu_sel;
Doug Zongker211aebc2011-10-28 15:13:10 -0700125
Elliott Hughesc0491632015-05-06 12:40:05 -0700126 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
127 char** file_viewer_text_;
128
Elliott Hughes985022a2015-04-13 13:04:32 -0700129 pthread_t progress_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700130
Elliott Hughes498cda62016-04-14 16:49:04 -0700131 // Number of intro frames and loop frames in the animation.
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700132 size_t intro_frames;
133 size_t loop_frames;
134
135 size_t current_frame;
136 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700137
138 // Number of frames per sec (default: 30) for both parts of the animation.
Doug Zongker32a0a472011-11-01 11:00:20 -0700139 int animation_fps;
Doug Zongkereac881c2014-03-07 09:21:25 -0800140
Doug Zongkerc87bab12013-11-25 13:53:25 -0800141 int stage, max_stage;
142
Elliott Hughes498cda62016-04-14 16:49:04 -0700143 int char_width_;
144 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700145
Elliott Hughes498cda62016-04-14 16:49:04 -0700146 pthread_mutex_t updateMutex;
Elliott Hughes498cda62016-04-14 16:49:04 -0700147
Sen Jiangd5304492016-12-09 16:20:49 -0800148 virtual bool InitTextParams();
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700149
150 virtual void draw_background_locked();
151 virtual void draw_foreground_locked();
152 virtual void draw_screen_locked();
153 virtual void update_screen_locked();
154 virtual void update_progress_locked();
Elliott Hughes985022a2015-04-13 13:04:32 -0700155
Elliott Hughes498cda62016-04-14 16:49:04 -0700156 GRSurface* GetCurrentFrame();
157 GRSurface* GetCurrentText();
158
Elliott Hughes985022a2015-04-13 13:04:32 -0700159 static void* ProgressThreadStartRoutine(void* data);
160 void ProgressThreadLoop();
Doug Zongker211aebc2011-10-28 15:13:10 -0700161
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700162 virtual void ShowFile(FILE*);
163 virtual void PrintV(const char*, bool, va_list);
Elliott Hughes95fc63e2015-04-10 19:12:01 -0700164 void PutChar(char);
165 void ClearText();
166
Elliott Hughes498cda62016-04-14 16:49:04 -0700167 void LoadAnimation();
Prashant Malani0ba21cf2016-03-10 14:51:25 -0800168 void LoadBitmap(const char* filename, GRSurface** surface);
Elliott Hughes498cda62016-04-14 16:49:04 -0700169 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
170
Mikhail Lappob49767c2017-03-23 21:44:26 +0100171 int PixelsFromDp(int dp) const;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700172 virtual int GetAnimationBaseline();
173 virtual int GetProgressBaseline();
174 virtual int GetTextBaseline();
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700175
Luke Songe2bd8762017-06-12 16:08:33 -0700176 virtual void DrawHorizontalRule(int* y);
177 virtual void DrawHighlightBar(int x, int y, int width, int height) const;
178 virtual void DrawTextLine(int x, int* y, const char* line, bool bold) const;
Mikhail Lappob49767c2017-03-23 21:44:26 +0100179 void DrawTextLines(int x, int* y, const char* const* lines) const;
Doug Zongker211aebc2011-10-28 15:13:10 -0700180};
181
182#endif // RECOVERY_UI_H