include/gui.h

   1 #ifndef __GUI_H
   2 #define __GUI_H
   3
   4 #include "include/iosupport.h"
   5 #include "include/usbld.h"
   6 #include "include/texcache.h"
   7 #include "include/dialogs.h"
   8 #include "include/menusys.h"
   9
  10 typedef enum {
  11         // Informs gui that init is over and main gui can be rendered
  12         GUI_INIT_DONE = 1,
  13         GUI_OP_ADD_MENU,
  14         GUI_OP_APPEND_MENU,
  15         GUI_OP_SELECT_MENU,
  16         GUI_OP_CLEAR_SUBMENU,
  17         GUI_OP_SORT,
  18         GUI_OP_ADD_HINT
  19 }  gui_op_type_t;
  20
  21 /** a single GUI update in a package form */
  22 struct gui_update_t {
  23         gui_op_type_t type;
  24
  25         struct {
  26                 menu_item_t *menu;
  27                 submenu_list_t **subMenu;
  28         } menu;
  29
  30         union {
  31                 struct {
  32                         int icon_id;
  33                         char *text;
  34                         int id;
  35                         int text_id;
  36                         int selected;
  37                 } submenu;
  38
  39                 struct { // hint for the given menu
  40                         int icon_id;
  41                         int text_id;
  42                 } hint;
  43         };
  44 };
  45
  46 typedef void (*gui_callback_t)(void);
  47
  48 int guiInactiveFrames;
  49 int guiFrameId;
  50
  51 #define GUI_SCREEN_MAIN         0
  52 #define GUI_SCREEN_MENU         1
  53 #define GUI_SCREEN_INFO         2
  54
  55 #define TRANSITION_LEFT         0
  56 #define TRANSITION_RIGHT        1
  57 #define TRANSITION_UP           2
  58 #define TRANSITION_DOWN         3
  59
  60 void guiSwitchScreen(int target, int transition);
  61
  62 void guiReloadScreenExtents();
  63
  64 /** Initializes the GUI */
  65 void guiInit();
  66
  67 /** Clean-up the GUI */
  68 void guiEnd();
  69
  70 /** Locks gui for direct gui data updates */
  71 void guiLock();
  72
  73 /** Unlocks gui after direct gui data updates */
  74 void guiUnlock();
  75
  76 /** invokes the main loop */
  77 void guiMainLoop();
  78
  79 /** Hooks a single per-frame callback */
  80 void guiSetFrameHook(gui_callback_t cback);
  81
  82 // Deffered update handling:
  83 /* Note:
  84 All the GUI operation requests can be deffered to the proper time
  85 when rendering is not going on. This allows us, for example, to schedule
  86 updates of the menu from another thread without stalls.
  87 */
  88
  89 /** Detects if a given deffered operation is already complete
  90 * @param opid The operation id, as returned from guiDeferUpdate
  91 * @return 1 if the operation was already completed, 0 otherwise */
  92 int guiGetOpCompleted(int opid);
  93
  94 /** Defers the given update to an appropriate time.
  95 * @param op The operation to defer
  96 * @return int The operation serial id
  97 */
  98 int guiDeferUpdate(struct gui_update_t *op);
  99
 100 /** Allocates a new deffered operation */
 101 struct gui_update_t *guiOpCreate(gui_op_type_t type);
 102
 103 /** For completeness, the deffered operations are destroyed automatically */
 104 void guiDestroyOp(struct gui_update_t *op);
 105
 106 int guiShowCompatConfig(int id, item_list_t *support);
 107 int guiShowKeyboard(char* value, int maxLength);
 108 int guiMsgBox(const char* text, int addAccept, struct UIItem *ui);
 109
 110 void guiUpdateScrollSpeed(void);
 111 void guiUpdateScreenScale(void);
 112
 113 void guiDrawBGPlasma();
 114 int guiDrawIconAndText(int iconId, int textId, int font, int x, int y, u64 color);
 115
 116 void guiShowAbout();
 117 void guiShowConfig();
 118 void guiShowUIConfig();
 119 void guiShowIPConfig();
 120
 121 /** Renders the given string on screen for the given function until it's io finishes
 122 * @note The ptr pointer is watched for it's value. The IO is considered finished when the value becomes zero.
 123 * @param ptr The finished state pointer (1 unfinished, 0 finished)
 124 * @param message The message to display while working
 125 * @param type the io operation type
 126 * @param data the data for the operation
 127 */
 128 void guiHandleDefferedIO(int *ptr, const unsigned char* message, int type, void *data);
 129
 130 /** Renders a single frame with a specified message on the screen
 131 */
 132 void guiRenderTextScreen(const unsigned char* message);
 133
 134 #ifdef VMC
 135 int guiVmcNameHandler(char* text, int maxLen);
 136 #endif
 137
 138 #endif