Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 1 | /* |
| 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 Hughes | 95fc63e | 2015-04-10 19:12:01 -0700 | [diff] [blame] | 21 | #include <stdio.h> |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 22 | |
Tao Bao | 736d59c | 2017-01-03 10:15:33 -0800 | [diff] [blame] | 23 | #include <string> |
Tao Bao | e15d7a5 | 2017-09-07 13:38:51 -0700 | [diff] [blame] | 24 | #include <vector> |
Tao Bao | 736d59c | 2017-01-03 10:15:33 -0800 | [diff] [blame] | 25 | |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 26 | #include "ui.h" |
Tao Bao | 0ecbd76 | 2017-01-16 21:16:58 -0800 | [diff] [blame] | 27 | |
| 28 | // From minui/minui.h. |
| 29 | struct GRSurface; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 30 | |
| 31 | // Implementation of RecoveryUI appropriate for devices with a screen |
| 32 | // (shows an icon + a progress bar, text logging, menu, etc.) |
| 33 | class ScreenRecoveryUI : public RecoveryUI { |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 34 | public: |
Tao Bao | 7577965 | 2017-09-10 11:28:32 -0700 | [diff] [blame] | 35 | 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 Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 46 | ScreenRecoveryUI(); |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 47 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 48 | bool Init(const std::string& locale) override; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 49 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 50 | // overall recovery state ("background image") |
Tao Bao | 99b2d77 | 2017-06-23 22:47:03 -0700 | [diff] [blame] | 51 | void SetBackground(Icon icon) override; |
| 52 | void SetSystemUpdateText(bool security_update) override; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 53 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 54 | // progress indicator |
| 55 | void SetProgressType(ProgressType type) override; |
| 56 | void ShowProgress(float portion, float seconds) override; |
| 57 | void SetProgress(float fraction) override; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 58 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 59 | void SetStage(int current, int max) override; |
Doug Zongker | c87bab1 | 2013-11-25 13:53:25 -0800 | [diff] [blame] | 60 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 61 | // text log |
| 62 | void ShowText(bool visible) override; |
| 63 | bool IsTextVisible() override; |
| 64 | bool WasTextEverVisible() override; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 65 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 66 | // printing messages |
Tao Bao | 99b2d77 | 2017-06-23 22:47:03 -0700 | [diff] [blame] | 67 | 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 Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 70 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 71 | // menu display |
Tao Bao | 99b2d77 | 2017-06-23 22:47:03 -0700 | [diff] [blame] | 72 | 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 Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 76 | |
Tao Bao | 99b2d77 | 2017-06-23 22:47:03 -0700 | [diff] [blame] | 77 | void KeyLongPress(int) override; |
Elliott Hughes | 642aaa7 | 2015-04-10 12:47:46 -0700 | [diff] [blame] | 78 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 79 | void Redraw(); |
Doug Zongker | c0441d1 | 2013-07-31 11:28:24 -0700 | [diff] [blame] | 80 | |
Tao Bao | 99b2d77 | 2017-06-23 22:47:03 -0700 | [diff] [blame] | 81 | void SetColor(UIElement e) const; |
Doug Zongker | c0441d1 | 2013-07-31 11:28:24 -0700 | [diff] [blame] | 82 | |
Tianjie Xu | 29d5575 | 2017-09-20 17:53:46 -0700 | [diff] [blame] | 83 | // 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 Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 87 | 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 Bao | 4521b70 | 2017-06-20 18:11:21 -0700 | [diff] [blame] | 92 | |
Tao Bao | 0470cee | 2017-08-02 17:11:04 -0700 | [diff] [blame] | 93 | // Number of frames per sec (default: 30) for both parts of the animation. |
| 94 | const int kAnimationFps; |
| 95 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 96 | // The scale factor from dp to pixels. 1.0 for mdpi, 4.0 for xxxhdpi. |
Tao Bao | 7577965 | 2017-09-10 11:28:32 -0700 | [diff] [blame] | 97 | 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 Bao | 171b4c4 | 2017-06-19 23:10:44 -0700 | [diff] [blame] | 138 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 139 | Icon currentIcon; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 140 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 141 | // The layout to use. |
| 142 | int layout_; |
Elliott Hughes | faf36e0 | 2016-04-20 17:22:16 -0700 | [diff] [blame] | 143 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 144 | GRSurface* error_icon; |
Elliott Hughes | 498cda6 | 2016-04-14 16:49:04 -0700 | [diff] [blame] | 145 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 146 | GRSurface* erasing_text; |
| 147 | GRSurface* error_text; |
| 148 | GRSurface* installing_text; |
| 149 | GRSurface* no_command_text; |
Elliott Hughes | 498cda6 | 2016-04-14 16:49:04 -0700 | [diff] [blame] | 150 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 151 | GRSurface** introFrames; |
| 152 | GRSurface** loopFrames; |
Elliott Hughes | 498cda6 | 2016-04-14 16:49:04 -0700 | [diff] [blame] | 153 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 154 | GRSurface* progressBarEmpty; |
| 155 | GRSurface* progressBarFill; |
| 156 | GRSurface* stageMarkerEmpty; |
| 157 | GRSurface* stageMarkerFill; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 158 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 159 | ProgressType progressBarType; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 160 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 161 | float progressScopeStart, progressScopeSize, progress; |
| 162 | double progressScopeTime, progressScopeDuration; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 163 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 164 | // true when both graphics pages are the same (except for the progress bar). |
| 165 | bool pagesIdentical; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 166 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 167 | size_t text_cols_, text_rows_; |
Elliott Hughes | c049163 | 2015-05-06 12:40:05 -0700 | [diff] [blame] | 168 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 169 | // Log text overlay, displayed when a magic key is pressed. |
| 170 | char** text_; |
Tao Bao | cb5524c | 2017-09-08 21:25:32 -0700 | [diff] [blame] | 171 | size_t text_col_, text_row_; |
Elliott Hughes | c049163 | 2015-05-06 12:40:05 -0700 | [diff] [blame] | 172 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 173 | bool show_text; |
| 174 | bool show_text_ever; // has show_text ever been true? |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 175 | |
Tao Bao | e15d7a5 | 2017-09-07 13:38:51 -0700 | [diff] [blame] | 176 | std::vector<std::string> menu_; |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 177 | const char* const* menu_headers_; |
| 178 | bool show_menu; |
| 179 | int menu_items, menu_sel; |
Doug Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 180 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 181 | // An alternate text screen, swapped with 'text_' when we're viewing a log file. |
| 182 | char** file_viewer_text_; |
Elliott Hughes | c049163 | 2015-05-06 12:40:05 -0700 | [diff] [blame] | 183 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 184 | pthread_t progress_thread_; |
Doug Zongker | 32a0a47 | 2011-11-01 11:00:20 -0700 | [diff] [blame] | 185 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 186 | // Number of intro frames and loop frames in the animation. |
| 187 | size_t intro_frames; |
| 188 | size_t loop_frames; |
Damien Bargiacchi | 5e7cfb9 | 2016-08-24 18:28:43 -0700 | [diff] [blame] | 189 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 190 | size_t current_frame; |
| 191 | bool intro_done; |
Elliott Hughes | 498cda6 | 2016-04-14 16:49:04 -0700 | [diff] [blame] | 192 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 193 | int stage, max_stage; |
Doug Zongker | c87bab1 | 2013-11-25 13:53:25 -0800 | [diff] [blame] | 194 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 195 | int char_width_; |
| 196 | int char_height_; |
Tao Bao | 171b4c4 | 2017-06-19 23:10:44 -0700 | [diff] [blame] | 197 | |
Tao Bao | efb49ad | 2017-01-31 23:03:10 -0800 | [diff] [blame] | 198 | // The locale that's used to show the rendered texts. |
| 199 | std::string locale_; |
| 200 | bool rtl_locale_; |
| 201 | |
Tao Bao | 5d2e3bd | 2017-06-23 22:23:50 -0700 | [diff] [blame] | 202 | pthread_mutex_t updateMutex; |
Tao Bao | efb49ad | 2017-01-31 23:03:10 -0800 | [diff] [blame] | 203 | |
| 204 | private: |
| 205 | void SetLocale(const std::string&); |
Tianjie Xu | 29d5575 | 2017-09-20 17:53:46 -0700 | [diff] [blame] | 206 | |
| 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 Zongker | 211aebc | 2011-10-28 15:13:10 -0700 | [diff] [blame] | 210 | }; |
| 211 | |
| 212 | #endif // RECOVERY_UI_H |