1 /* 2 * Copyright (C) 2007 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_COMMON_H 18 #define RECOVERY_COMMON_H 19 20 #include <stdio.h> 21 22 // Initialize the graphics system. 23 void ui_init(); 24 25 // Use KEY_* codes from <linux/input.h> or KEY_DREAM_* from "minui/minui.h". 26 int ui_wait_key(); // waits for a key/button press, returns the code 27 int ui_key_pressed(int key); // returns >0 if the code is currently pressed 28 int ui_text_visible(); // returns >0 if text log is currently visible 29 void ui_clear_key_queue(); 30 31 // Write a message to the on-screen log shown with Alt-L (also to stderr). 32 // The screen is small, and users may need to report these messages to support, 33 // so keep the output short and not too cryptic. 34 void ui_print(const char *fmt, ...); 35 36 // Display some header text followed by a menu of items, which appears 37 // at the top of the screen (in place of any scrolling ui_print() 38 // output, if necessary). 39 void ui_start_menu(char** headers, char** items); 40 // Set the menu highlight to the given index, and return it (capped to 41 // the range [0..numitems). 42 int ui_menu_select(int sel); 43 // End menu mode, resetting the text overlay so that ui_print() 44 // statements will be displayed. 45 void ui_end_menu(); 46 47 // Set the icon (normally the only thing visible besides the progress bar). 48 enum { 49 BACKGROUND_ICON_NONE, 50 BACKGROUND_ICON_INSTALLING, 51 BACKGROUND_ICON_ERROR, 52 NUM_BACKGROUND_ICONS 53 }; 54 void ui_set_background(int icon); 55 56 // Show a progress bar and define the scope of the next operation: 57 // portion - fraction of the progress bar the next operation will use 58 // seconds - expected time interval (progress bar moves at this minimum rate) 59 void ui_show_progress(float portion, int seconds); 60 void ui_set_progress(float fraction); // 0.0 - 1.0 within the defined scope 61 62 // Default allocation of progress bar segments to operations 63 static const int VERIFICATION_PROGRESS_TIME = 60; 64 static const float VERIFICATION_PROGRESS_FRACTION = 0.25; 65 static const float DEFAULT_FILES_PROGRESS_FRACTION = 0.4; 66 static const float DEFAULT_IMAGE_PROGRESS_FRACTION = 0.1; 67 68 // Show a rotating "barberpole" for ongoing operations. Updates automatically. 69 void ui_show_indeterminate_progress(); 70 71 // Hide and reset the progress bar. 72 void ui_reset_progress(); 73 74 #define LOGE(...) ui_print("E:" __VA_ARGS__) 75 #define LOGW(...) fprintf(stderr, "W:" __VA_ARGS__) 76 #define LOGI(...) fprintf(stderr, "I:" __VA_ARGS__) 77 78 #if 0 79 #define LOGV(...) fprintf(stderr, "V:" __VA_ARGS__) 80 #define LOGD(...) fprintf(stderr, "D:" __VA_ARGS__) 81 #else 82 #define LOGV(...) do {} while (0) 83 #define LOGD(...) do {} while (0) 84 #endif 85 86 #define STRINGIFY(x) #x 87 #define EXPAND(x) STRINGIFY(x) 88 89 #endif // RECOVERY_COMMON_H 90
