common.h revision c24a8e688a6312764254beac2b2520bb0c5e998d
1c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project/* 2c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * 4c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * you may not use this file except in compliance with the License. 6c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * You may obtain a copy of the License at 7c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * 8c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * 10c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * See the License for the specific language governing permissions and 14c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project * limitations under the License. 15c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project */ 16c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 17c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#ifndef RECOVERY_COMMON_H 18c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define RECOVERY_COMMON_H 19c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 20c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#include <stdio.h> 21c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 22c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Initialize the graphics system. 23c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_init(); 24c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 25c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Use KEY_* codes from <linux/input.h> or KEY_DREAM_* from "minui/minui.h". 26c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectint ui_wait_key(); // waits for a key/button press, returns the code 27c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectint ui_key_pressed(int key); // returns >0 if the code is currently pressed 28c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectint ui_text_visible(); // returns >0 if text log is currently visible 29c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_clear_key_queue(); 30c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 31c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Write a message to the on-screen log shown with Alt-L (also to stderr). 32c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// The screen is small, and users may need to report these messages to support, 33c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// so keep the output short and not too cryptic. 34c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_print(const char *fmt, ...); 35c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 36c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Display some header text followed by a menu of items, which appears 37c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// at the top of the screen (in place of any scrolling ui_print() 38c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// output, if necessary). 39c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_start_menu(char** headers, char** items); 40c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Set the menu highlight to the given index, and return it (capped to 41c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// the range [0..numitems). 42c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectint ui_menu_select(int sel); 43c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// End menu mode, resetting the text overlay so that ui_print() 44c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// statements will be displayed. 45c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_end_menu(); 46c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 47c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Set the icon (normally the only thing visible besides the progress bar). 48c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectenum { 49c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_NONE, 50c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_UNPACKING, 51c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_INSTALLING, 52c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_ERROR, 53c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_FIRMWARE_INSTALLING, 54c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project BACKGROUND_ICON_FIRMWARE_ERROR, 55c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project NUM_BACKGROUND_ICONS 56c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project}; 57c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_set_background(int icon); 58c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 59c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Get a malloc'd copy of the screen image showing (only) the specified icon. 60c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Also returns the width, height, and bits per pixel of the returned image. 61c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// TODO: Use some sort of "struct Bitmap" here instead of all these variables? 62c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectchar *ui_copy_image(int icon, int *width, int *height, int *bpp); 63c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 64c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Show a progress bar and define the scope of the next operation: 65c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// portion - fraction of the progress bar the next operation will use 66c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// seconds - expected time interval (progress bar moves at this minimum rate) 67c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_show_progress(float portion, int seconds); 68c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_set_progress(float fraction); // 0.0 - 1.0 within the defined scope 69c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 70c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Default allocation of progress bar segments to operations 71c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectstatic const int VERIFICATION_PROGRESS_TIME = 60; 72c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectstatic const float VERIFICATION_PROGRESS_FRACTION = 0.5; 73c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectstatic const float DEFAULT_FILES_PROGRESS_FRACTION = 0.4; 74c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectstatic const float DEFAULT_IMAGE_PROGRESS_FRACTION = 0.1; 75c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 76c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Show a rotating "barberpole" for ongoing operations. Updates automatically. 77c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_show_indeterminate_progress(); 78c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 79c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project// Hide and reset the progress bar. 80c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Projectvoid ui_reset_progress(); 81c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 82c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGE(...) ui_print("E:" __VA_ARGS__) 83c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGW(...) fprintf(stderr, "W:" __VA_ARGS__) 84c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGI(...) fprintf(stderr, "I:" __VA_ARGS__) 85c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 86c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#if 0 87c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGV(...) fprintf(stderr, "V:" __VA_ARGS__) 88c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGD(...) fprintf(stderr, "D:" __VA_ARGS__) 89c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#else 90c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGV(...) do {} while (0) 91c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#define LOGD(...) do {} while (0) 92c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#endif 93c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project 94c24a8e688a6312764254beac2b2520bb0c5e998dThe Android Open Source Project#endif // RECOVERY_COMMON_H 95