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_UI_H 18 #define RECOVERY_UI_H 19 20 #include <linux/input.h> 21 #include <pthread.h> 22 23 // Abstract class for controlling the user interface during recovery. 24 class RecoveryUI { 25 public: 26 RecoveryUI(); 27 ~RecoveryUI()28 virtual ~RecoveryUI() { } 29 30 // Initialize the object; called before anything else. 31 virtual void Init(); 32 33 // After calling Init(), you can tell the UI what locale it is operating in. SetLocale(const char * locale)34 virtual void SetLocale(const char* locale) { } 35 36 // Set the overall recovery state ("background image"). 37 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; 38 virtual void SetBackground(Icon icon) = 0; 39 40 // --- progress indicator --- 41 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; 42 virtual void SetProgressType(ProgressType determinate) = 0; 43 44 // Show a progress bar and define the scope of the next operation: 45 // portion - fraction of the progress bar the next operation will use 46 // seconds - expected time interval (progress bar moves at this minimum rate) 47 virtual void ShowProgress(float portion, float seconds) = 0; 48 49 // Set progress bar position (0.0 - 1.0 within the scope defined 50 // by the last call to ShowProgress). 51 virtual void SetProgress(float fraction) = 0; 52 53 // --- text log --- 54 55 virtual void ShowText(bool visible) = 0; 56 57 virtual bool IsTextVisible() = 0; 58 59 virtual bool WasTextEverVisible() = 0; 60 61 // Write a message to the on-screen log (shown if the user has 62 // toggled on the text display). 63 virtual void Print(const char* fmt, ...) = 0; // __attribute__((format(printf, 1, 2))) = 0; 64 65 // --- key handling --- 66 67 // Wait for keypress and return it. May return -1 after timeout. 68 virtual int WaitKey(); 69 70 virtual bool IsKeyPressed(int key); 71 72 // Erase any queued-up keys. 73 virtual void FlushKeys(); 74 75 // Called on each keypress, even while operations are in progress. 76 // Return value indicates whether an immediate operation should be 77 // triggered (toggling the display, rebooting the device), or if 78 // the key should be enqueued for use by the main thread. 79 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; 80 virtual KeyAction CheckKey(int key); 81 82 // --- menu display --- 83 84 // Display some header text followed by a menu of items, which appears 85 // at the top of the screen (in place of any scrolling ui_print() 86 // output, if necessary). 87 virtual void StartMenu(const char* const * headers, const char* const * items, 88 int initial_selection) = 0; 89 90 // Set the menu highlight to the given index, and return it (capped to 91 // the range [0..numitems). 92 virtual int SelectMenu(int sel) = 0; 93 94 // End menu mode, resetting the text overlay so that ui_print() 95 // statements will be displayed. 96 virtual void EndMenu() = 0; 97 98 private: 99 // Key event input queue 100 pthread_mutex_t key_queue_mutex; 101 pthread_cond_t key_queue_cond; 102 int key_queue[256], key_queue_len; 103 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex 104 int key_last_down; // under key_queue_mutex 105 int rel_sum; 106 107 pthread_t input_t; 108 109 static void* input_thread(void* cookie); 110 static int input_callback(int fd, short revents, void* data); 111 void process_key(int key_code, int updown); 112 bool usb_connected(); 113 }; 114 115 #endif // RECOVERY_UI_H 116