diff options
Diffstat (limited to 'ui.h')
-rw-r--r-- | ui.h | 296 |
1 files changed, 148 insertions, 148 deletions
@@ -25,163 +25,163 @@ | |||
25 | 25 | ||
26 | // Abstract class for controlling the user interface during recovery. | 26 | // Abstract class for controlling the user interface during recovery. |
27 | class RecoveryUI { | 27 | class RecoveryUI { |
28 | public: | 28 | public: |
29 | RecoveryUI(); | 29 | RecoveryUI(); |
30 | 30 | ||
31 | virtual ~RecoveryUI() { } | 31 | virtual ~RecoveryUI() {} |
32 | 32 | ||
33 | // Initialize the object; called before anything else. UI texts will be | 33 | // Initialize the object; called before anything else. UI texts will be |
34 | // initialized according to the given locale. Returns true on success. | 34 | // initialized according to the given locale. Returns true on success. |
35 | virtual bool Init(const std::string& locale); | 35 | virtual bool Init(const std::string& locale); |
36 | 36 | ||
37 | // Show a stage indicator. Call immediately after Init(). | 37 | // Show a stage indicator. Call immediately after Init(). |
38 | virtual void SetStage(int current, int max) = 0; | 38 | virtual void SetStage(int current, int max) = 0; |
39 | 39 | ||
40 | // Set the overall recovery state ("background image"). | 40 | // Set the overall recovery state ("background image"). |
41 | enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; | 41 | enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; |
42 | virtual void SetBackground(Icon icon) = 0; | 42 | virtual void SetBackground(Icon icon) = 0; |
43 | virtual void SetSystemUpdateText(bool security_update) = 0; | 43 | virtual void SetSystemUpdateText(bool security_update) = 0; |
44 | 44 | ||
45 | // --- progress indicator --- | 45 | // --- progress indicator --- |
46 | enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; | 46 | enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; |
47 | virtual void SetProgressType(ProgressType determinate) = 0; | 47 | virtual void SetProgressType(ProgressType determinate) = 0; |
48 | 48 | ||
49 | // Show a progress bar and define the scope of the next operation: | 49 | // Show a progress bar and define the scope of the next operation: |
50 | // portion - fraction of the progress bar the next operation will use | 50 | // portion - fraction of the progress bar the next operation will use |
51 | // seconds - expected time interval (progress bar moves at this minimum rate) | 51 | // seconds - expected time interval (progress bar moves at this minimum rate) |
52 | virtual void ShowProgress(float portion, float seconds) = 0; | 52 | virtual void ShowProgress(float portion, float seconds) = 0; |
53 | 53 | ||
54 | // Set progress bar position (0.0 - 1.0 within the scope defined | 54 | // Set progress bar position (0.0 - 1.0 within the scope defined |
55 | // by the last call to ShowProgress). | 55 | // by the last call to ShowProgress). |
56 | virtual void SetProgress(float fraction) = 0; | 56 | virtual void SetProgress(float fraction) = 0; |
57 | 57 | ||
58 | // --- text log --- | 58 | // --- text log --- |
59 | 59 | ||
60 | virtual void ShowText(bool visible) = 0; | 60 | virtual void ShowText(bool visible) = 0; |
61 | 61 | ||
62 | virtual bool IsTextVisible() = 0; | 62 | virtual bool IsTextVisible() = 0; |
63 | 63 | ||
64 | virtual bool WasTextEverVisible() = 0; | 64 | virtual bool WasTextEverVisible() = 0; |
65 | 65 | ||
66 | // Write a message to the on-screen log (shown if the user has | 66 | // Write a message to the on-screen log (shown if the user has |
67 | // toggled on the text display). Print() will also dump the message | 67 | // toggled on the text display). Print() will also dump the message |
68 | // to stdout / log file, while PrintOnScreenOnly() not. | 68 | // to stdout / log file, while PrintOnScreenOnly() not. |
69 | virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0; | 69 | virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0; |
70 | virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0; | 70 | virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0; |
71 | 71 | ||
72 | virtual void ShowFile(const char* filename) = 0; | 72 | virtual void ShowFile(const char* filename) = 0; |
73 | 73 | ||
74 | // --- key handling --- | 74 | // --- key handling --- |
75 | 75 | ||
76 | // Wait for a key and return it. May return -1 after timeout. | 76 | // Wait for a key and return it. May return -1 after timeout. |
77 | virtual int WaitKey(); | 77 | virtual int WaitKey(); |
78 | 78 | ||
79 | virtual bool IsKeyPressed(int key); | 79 | virtual bool IsKeyPressed(int key); |
80 | virtual bool IsLongPress(); | 80 | virtual bool IsLongPress(); |
81 | 81 | ||
82 | // Returns true if you have the volume up/down and power trio typical | 82 | // Returns true if you have the volume up/down and power trio typical |
83 | // of phones and tablets, false otherwise. | 83 | // of phones and tablets, false otherwise. |
84 | virtual bool HasThreeButtons(); | 84 | virtual bool HasThreeButtons(); |
85 | 85 | ||
86 | // Erase any queued-up keys. | 86 | // Erase any queued-up keys. |
87 | virtual void FlushKeys(); | 87 | virtual void FlushKeys(); |
88 | 88 | ||
89 | // Called on each key press, even while operations are in progress. | 89 | // Called on each key press, even while operations are in progress. |
90 | // Return value indicates whether an immediate operation should be | 90 | // Return value indicates whether an immediate operation should be |
91 | // triggered (toggling the display, rebooting the device), or if | 91 | // triggered (toggling the display, rebooting the device), or if |
92 | // the key should be enqueued for use by the main thread. | 92 | // the key should be enqueued for use by the main thread. |
93 | enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; | 93 | enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; |
94 | virtual KeyAction CheckKey(int key, bool is_long_press); | 94 | virtual KeyAction CheckKey(int key, bool is_long_press); |
95 | 95 | ||
96 | // Called when a key is held down long enough to have been a | 96 | // Called when a key is held down long enough to have been a |
97 | // long-press (but before the key is released). This means that | 97 | // long-press (but before the key is released). This means that |
98 | // if the key is eventually registered (released without any other | 98 | // if the key is eventually registered (released without any other |
99 | // keys being pressed in the meantime), CheckKey will be called with | 99 | // keys being pressed in the meantime), CheckKey will be called with |
100 | // 'is_long_press' true. | 100 | // 'is_long_press' true. |
101 | virtual void KeyLongPress(int key); | 101 | virtual void KeyLongPress(int key); |
102 | 102 | ||
103 | // Normally in recovery there's a key sequence that triggers | 103 | // Normally in recovery there's a key sequence that triggers |
104 | // immediate reboot of the device, regardless of what recovery is | 104 | // immediate reboot of the device, regardless of what recovery is |
105 | // doing (with the default CheckKey implementation, it's pressing | 105 | // doing (with the default CheckKey implementation, it's pressing |
106 | // the power button 7 times in row). Call this to enable or | 106 | // the power button 7 times in row). Call this to enable or |
107 | // disable that feature. It is enabled by default. | 107 | // disable that feature. It is enabled by default. |
108 | virtual void SetEnableReboot(bool enabled); | 108 | virtual void SetEnableReboot(bool enabled); |
109 | 109 | ||
110 | // --- menu display --- | 110 | // --- menu display --- |
111 | 111 | ||
112 | // Display some header text followed by a menu of items, which appears | 112 | // Display some header text followed by a menu of items, which appears |
113 | // at the top of the screen (in place of any scrolling ui_print() | 113 | // at the top of the screen (in place of any scrolling ui_print() |
114 | // output, if necessary). | 114 | // output, if necessary). |
115 | virtual void StartMenu(const char* const * headers, const char* const * items, | 115 | virtual void StartMenu(const char* const* headers, const char* const* items, |
116 | int initial_selection) = 0; | 116 | int initial_selection) = 0; |
117 | 117 | ||
118 | // Set the menu highlight to the given index, wrapping if necessary. | 118 | // Set the menu highlight to the given index, wrapping if necessary. |
119 | // Returns the actual item selected. | 119 | // Returns the actual item selected. |
120 | virtual int SelectMenu(int sel) = 0; | 120 | virtual int SelectMenu(int sel) = 0; |
121 | 121 | ||
122 | // End menu mode, resetting the text overlay so that ui_print() | 122 | // End menu mode, resetting the text overlay so that ui_print() |
123 | // statements will be displayed. | 123 | // statements will be displayed. |
124 | virtual void EndMenu() = 0; | 124 | virtual void EndMenu() = 0; |
125 | 125 | ||
126 | protected: | 126 | protected: |
127 | void EnqueueKey(int key_code); | 127 | void EnqueueKey(int key_code); |
128 | 128 | ||
129 | // The locale that's used to show the rendered texts. | 129 | // The locale that's used to show the rendered texts. |
130 | std::string locale_; | 130 | std::string locale_; |
131 | bool rtl_locale_; | 131 | bool rtl_locale_; |
132 | 132 | ||
133 | // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% | 133 | // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% |
134 | // of the max_brightness). Because the absolute values may vary across devices. These two | 134 | // of the max_brightness). Because the absolute values may vary across devices. These two |
135 | // values can be configured via subclassing. Setting brightness_normal_ to 0 to disable | 135 | // values can be configured via subclassing. Setting brightness_normal_ to 0 to disable |
136 | // screensaver. | 136 | // screensaver. |
137 | unsigned int brightness_normal_; | 137 | unsigned int brightness_normal_; |
138 | unsigned int brightness_dimmed_; | 138 | unsigned int brightness_dimmed_; |
139 | 139 | ||
140 | private: | 140 | private: |
141 | // Key event input queue | 141 | // Key event input queue |
142 | pthread_mutex_t key_queue_mutex; | 142 | pthread_mutex_t key_queue_mutex; |
143 | pthread_cond_t key_queue_cond; | 143 | pthread_cond_t key_queue_cond; |
144 | int key_queue[256], key_queue_len; | 144 | int key_queue[256], key_queue_len; |
145 | char key_pressed[KEY_MAX + 1]; // under key_queue_mutex | 145 | char key_pressed[KEY_MAX + 1]; // under key_queue_mutex |
146 | int key_last_down; // under key_queue_mutex | 146 | int key_last_down; // under key_queue_mutex |
147 | bool key_long_press; // under key_queue_mutex | 147 | bool key_long_press; // under key_queue_mutex |
148 | int key_down_count; // under key_queue_mutex | 148 | int key_down_count; // under key_queue_mutex |
149 | bool enable_reboot; // under key_queue_mutex | 149 | bool enable_reboot; // under key_queue_mutex |
150 | int rel_sum; | 150 | int rel_sum; |
151 | 151 | ||
152 | int consecutive_power_keys; | 152 | int consecutive_power_keys; |
153 | int last_key; | 153 | int last_key; |
154 | 154 | ||
155 | bool has_power_key; | 155 | bool has_power_key; |
156 | bool has_up_key; | 156 | bool has_up_key; |
157 | bool has_down_key; | 157 | bool has_down_key; |
158 | 158 | ||
159 | struct key_timer_t { | 159 | struct key_timer_t { |
160 | RecoveryUI* ui; | 160 | RecoveryUI* ui; |
161 | int key_code; | 161 | int key_code; |
162 | int count; | 162 | int count; |
163 | }; | 163 | }; |
164 | 164 | ||
165 | pthread_t input_thread_; | 165 | pthread_t input_thread_; |
166 | 166 | ||
167 | void OnKeyDetected(int key_code); | 167 | void OnKeyDetected(int key_code); |
168 | int OnInputEvent(int fd, uint32_t epevents); | 168 | int OnInputEvent(int fd, uint32_t epevents); |
169 | void ProcessKey(int key_code, int updown); | 169 | void ProcessKey(int key_code, int updown); |
170 | 170 | ||
171 | bool IsUsbConnected(); | 171 | bool IsUsbConnected(); |
172 | 172 | ||
173 | static void* time_key_helper(void* cookie); | 173 | static void* time_key_helper(void* cookie); |
174 | void time_key(int key_code, int count); | 174 | void time_key(int key_code, int count); |
175 | 175 | ||
176 | void SetLocale(const std::string&); | 176 | void SetLocale(const std::string&); |
177 | 177 | ||
178 | enum class ScreensaverState { DISABLED, NORMAL, DIMMED, OFF }; | 178 | enum class ScreensaverState { DISABLED, NORMAL, DIMMED, OFF }; |
179 | ScreensaverState screensaver_state_; | 179 | ScreensaverState screensaver_state_; |
180 | // The following two contain the absolute values computed from brightness_normal_ and | 180 | // The following two contain the absolute values computed from brightness_normal_ and |
181 | // brightness_dimmed_ respectively. | 181 | // brightness_dimmed_ respectively. |
182 | unsigned int brightness_normal_value_; | 182 | unsigned int brightness_normal_value_; |
183 | unsigned int brightness_dimmed_value_; | 183 | unsigned int brightness_dimmed_value_; |
184 | bool InitScreensaver(); | 184 | bool InitScreensaver(); |
185 | }; | 185 | }; |
186 | 186 | ||
187 | #endif // RECOVERY_UI_H | 187 | #endif // RECOVERY_UI_H |