blob: df7cc25b3d8bf796af85d4edf2f01005290e3b87 [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 {
Tao Bao5d2e3bd2017-06-23 22:23:50 -070033 public:
34 ScreenRecoveryUI();
Doug Zongker211aebc2011-10-28 15:13:10 -070035
Tao Bao5d2e3bd2017-06-23 22:23:50 -070036 bool Init(const std::string& locale) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070037
Tao Bao5d2e3bd2017-06-23 22:23:50 -070038 // overall recovery state ("background image")
Tao Bao99b2d772017-06-23 22:47:03 -070039 void SetBackground(Icon icon) override;
40 void SetSystemUpdateText(bool security_update) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070041
Tao Bao5d2e3bd2017-06-23 22:23:50 -070042 // progress indicator
43 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
Tao Bao5d2e3bd2017-06-23 22:23:50 -070047 void SetStage(int current, int max) override;
Doug Zongkerc87bab12013-11-25 13:53:25 -080048
Tao Bao5d2e3bd2017-06-23 22:23:50 -070049 // text log
50 void ShowText(bool visible) override;
51 bool IsTextVisible() override;
52 bool WasTextEverVisible() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070053
Tao Bao5d2e3bd2017-06-23 22:23:50 -070054 // printing messages
Tao Bao99b2d772017-06-23 22:47:03 -070055 void Print(const char* fmt, ...) override __printflike(2, 3);
56 void PrintOnScreenOnly(const char* fmt, ...) override __printflike(2, 3);
57 void ShowFile(const char* filename) override;
Doug Zongker211aebc2011-10-28 15:13:10 -070058
Tao Bao5d2e3bd2017-06-23 22:23:50 -070059 // menu display
Tao Bao99b2d772017-06-23 22:47:03 -070060 void StartMenu(const char* const* headers, const char* const* items,
61 int initial_selection) override;
62 int SelectMenu(int sel) override;
63 void EndMenu() override;
Doug Zongker211aebc2011-10-28 15:13:10 -070064
Tao Bao99b2d772017-06-23 22:47:03 -070065 void KeyLongPress(int) override;
Elliott Hughes642aaa72015-04-10 12:47:46 -070066
Tao Bao5d2e3bd2017-06-23 22:23:50 -070067 void Redraw();
Doug Zongkerc0441d12013-07-31 11:28:24 -070068
Tao Bao5d2e3bd2017-06-23 22:23:50 -070069 enum UIElement {
70 HEADER,
71 MENU,
72 MENU_SEL_BG,
73 MENU_SEL_BG_ACTIVE,
74 MENU_SEL_FG,
75 LOG,
76 TEXT_FILL,
77 INFO
78 };
Tao Bao99b2d772017-06-23 22:47:03 -070079 void SetColor(UIElement e) const;
Doug Zongkerc0441d12013-07-31 11:28:24 -070080
Tao Bao5d2e3bd2017-06-23 22:23:50 -070081 protected:
82 // The margin that we don't want to use for showing texts (e.g. round screen, or screen with
83 // rounded corners).
84 const int kMarginWidth;
85 const int kMarginHeight;
Tao Bao4521b702017-06-20 18:11:21 -070086
Tao Bao5d2e3bd2017-06-23 22:23:50 -070087 // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi.
88 const float density_;
Tao Bao171b4c42017-06-19 23:10:44 -070089
Tao Bao5d2e3bd2017-06-23 22:23:50 -070090 Icon currentIcon;
Doug Zongker211aebc2011-10-28 15:13:10 -070091
Tao Bao5d2e3bd2017-06-23 22:23:50 -070092 // The layout to use.
93 int layout_;
Elliott Hughesfaf36e02016-04-20 17:22:16 -070094
Tao Bao5d2e3bd2017-06-23 22:23:50 -070095 GRSurface* error_icon;
Elliott Hughes498cda62016-04-14 16:49:04 -070096
Tao Bao5d2e3bd2017-06-23 22:23:50 -070097 GRSurface* erasing_text;
98 GRSurface* error_text;
99 GRSurface* installing_text;
100 GRSurface* no_command_text;
Elliott Hughes498cda62016-04-14 16:49:04 -0700101
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700102 GRSurface** introFrames;
103 GRSurface** loopFrames;
Elliott Hughes498cda62016-04-14 16:49:04 -0700104
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700105 GRSurface* progressBarEmpty;
106 GRSurface* progressBarFill;
107 GRSurface* stageMarkerEmpty;
108 GRSurface* stageMarkerFill;
Doug Zongker211aebc2011-10-28 15:13:10 -0700109
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700110 ProgressType progressBarType;
Doug Zongker211aebc2011-10-28 15:13:10 -0700111
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700112 float progressScopeStart, progressScopeSize, progress;
113 double progressScopeTime, progressScopeDuration;
Doug Zongker211aebc2011-10-28 15:13:10 -0700114
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700115 // true when both graphics pages are the same (except for the progress bar).
116 bool pagesIdentical;
Doug Zongker211aebc2011-10-28 15:13:10 -0700117
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700118 size_t text_cols_, text_rows_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700119
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700120 // Log text overlay, displayed when a magic key is pressed.
121 char** text_;
122 size_t text_col_, text_row_, text_top_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700123
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700124 bool show_text;
125 bool show_text_ever; // has show_text ever been true?
Doug Zongker211aebc2011-10-28 15:13:10 -0700126
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700127 char** menu_;
128 const char* const* menu_headers_;
129 bool show_menu;
130 int menu_items, menu_sel;
Doug Zongker211aebc2011-10-28 15:13:10 -0700131
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700132 // An alternate text screen, swapped with 'text_' when we're viewing a log file.
133 char** file_viewer_text_;
Elliott Hughesc0491632015-05-06 12:40:05 -0700134
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700135 pthread_t progress_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700136
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700137 // Number of intro frames and loop frames in the animation.
138 size_t intro_frames;
139 size_t loop_frames;
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700140
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700141 size_t current_frame;
142 bool intro_done;
Elliott Hughes498cda62016-04-14 16:49:04 -0700143
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700144 // Number of frames per sec (default: 30) for both parts of the animation.
145 int animation_fps;
Doug Zongkereac881c2014-03-07 09:21:25 -0800146
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700147 int stage, max_stage;
Doug Zongkerc87bab12013-11-25 13:53:25 -0800148
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700149 int char_width_;
150 int char_height_;
Tao Bao171b4c42017-06-19 23:10:44 -0700151
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700152 pthread_mutex_t updateMutex;
Elliott Hughes498cda62016-04-14 16:49:04 -0700153
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700154 virtual bool InitTextParams();
Damien Bargiacchi5e7cfb92016-08-24 18:28:43 -0700155
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700156 virtual void draw_background_locked();
157 virtual void draw_foreground_locked();
158 virtual void draw_screen_locked();
159 virtual void update_screen_locked();
160 virtual void update_progress_locked();
Elliott Hughes985022a2015-04-13 13:04:32 -0700161
Tao Bao99b2d772017-06-23 22:47:03 -0700162 GRSurface* GetCurrentFrame() const;
163 GRSurface* GetCurrentText() const;
Elliott Hughes498cda62016-04-14 16:49:04 -0700164
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700165 static void* ProgressThreadStartRoutine(void* data);
166 void ProgressThreadLoop();
Doug Zongker211aebc2011-10-28 15:13:10 -0700167
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700168 virtual void ShowFile(FILE*);
169 virtual void PrintV(const char*, bool, va_list);
170 void PutChar(char);
171 void ClearText();
Elliott Hughes95fc63e2015-04-10 19:12:01 -0700172
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700173 void LoadAnimation();
174 void LoadBitmap(const char* filename, GRSurface** surface);
175 void LoadLocalizedBitmap(const char* filename, GRSurface** surface);
Elliott Hughes498cda62016-04-14 16:49:04 -0700176
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700177 int PixelsFromDp(int dp) const;
Tao Bao99b2d772017-06-23 22:47:03 -0700178 virtual int GetAnimationBaseline() const;
179 virtual int GetProgressBaseline() const;
180 virtual int GetTextBaseline() const;
Elliott Hughesfaf36e02016-04-20 17:22:16 -0700181
Tao Baoea78d862017-06-28 14:52:17 -0700182 // Draws a highlight bar at (x, y) - (x + width, y + height).
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700183 virtual void DrawHighlightBar(int x, int y, int width, int height) const;
Tao Baoea78d862017-06-28 14:52:17 -0700184 // Draws a horizontal rule at Y. Returns the offset it should be moving along Y-axis.
185 virtual int DrawHorizontalRule(int y) const;
186 // Draws a line of text. Returns the offset it should be moving along Y-axis.
187 virtual int DrawTextLine(int x, int y, const char* line, bool bold) const;
188 // Draws multiple text lines. Returns the offset it should be moving along Y-axis.
189 int DrawTextLines(int x, int y, const char* const* lines) const;
Tao Bao2bbc6d62017-08-13 23:48:55 -0700190 // Similar to DrawTextLines() to draw multiple text lines, but additionally wraps long lines.
191 // Returns the offset it should be moving along Y-axis.
192 int DrawWrappedTextLines(int x, int y, const char* const* lines) const;
Doug Zongker211aebc2011-10-28 15:13:10 -0700193};
194
195#endif // RECOVERY_UI_H