apps/menu.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Robert E. Hak
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef __MENU_H__
  23 #define __MENU_H__
  24
  25 #include <stdbool.h>
  26 #include "icon.h"
  27 #include "icons.h"
  28 #include "root_menu.h" /* needed for MENU_* return codes */
  29
  30
  31 enum menu_item_type {
  32     MT_MENU = 0,
  33     MT_SETTING,
  34     MT_SETTING_W_TEXT, /* same as setting, but uses different
  35                           text for the setting title,
  36                           ID2P() or "literal" for the str param */
  37     MT_FUNCTION_CALL, /* call a function from the menus */
  38     MT_RETURN_ID, /* returns the position of the selected item (starting at 0)*/
  39     MT_RETURN_VALUE, /* returns a value associated with an item */
  40 };
  41 #define MENU_TYPE_MASK 0xF /* MT_* type */
  42
  43 typedef int (*menu_function)(void);
  44 struct menu_func {
  45     union {
  46         int (*function_w_param)(void* param); /* intptr_t instead of void*
  47                                                     for 64bit systems */
  48         int (*function)(void);
  49     };
  50     void *param; /* passed to function_w_param */
  51 };
  52
  53 /* these next two are mutually exclusive */
  54 #define MENU_HAS_DESC   0x10
  55 #define MENU_DYNAMIC_DESC 0x20 /* the name of this menu item is set by the  \
  56                                   list_get_name callback */
  57
  58 #define MENU_EXITAFTERTHISMENU 0x40 /* do_menu() will exiting out of any    \
  59                                        menu item with this flag set */
  60
  61 /* Flags for MT_FUNCTION_CALL */
  62 #define MENU_FUNC_USEPARAM 0x80
  63 #define MENU_FUNC_CHECK_RETVAL 0x100
  64 #define MENU_FUNC_HOTKEYABLE 0x200
  65
  66 #define MENU_COUNT_MASK 0xFFF
  67 #define MENU_COUNT_SHIFT 12
  68 #define MENU_ITEM_COUNT(c) ((c&MENU_COUNT_MASK)<<MENU_COUNT_SHIFT)
  69 #define MENU_GET_COUNT(flags) ((flags>>MENU_COUNT_SHIFT)&MENU_COUNT_MASK)
  70
  71 struct menu_item_ex {
  72     unsigned int flags; /* above defines */
  73     union {
  74         const struct menu_item_ex **submenus; /* used with MT_MENU */
  75         void *variable; /* used with MT_SETTING,
  76                            must be in the settings_list.c list */
  77         const struct menu_func *function; /* MT_FUNCTION_* */
  78         const char **strings; /* used with MT_RETURN_ID */
  79         int value; /* MT_RETURN_VALUE */
  80     };
  81     union {
  82         /* For settings */
  83         int (*menu_callback)(int action, const struct menu_item_ex *this_item);
  84         /* For everything else, except if the text is dynamic */
  85         const struct menu_callback_with_desc {
  86             int (*menu_callback)(int action,
  87                                  const struct menu_item_ex *this_item);
  88             unsigned char *desc; /* string or ID */
  89             int icon_id; /* from icons_6x8 in icons.h */
  90         } *callback_and_desc;
  91         /* For when the item text is dynamic */
  92         const struct menu_get_name_and_icon {
  93             int (*menu_callback)(int action,
  94                                  const struct menu_item_ex *this_item);
  95             char *(*list_get_name)(int selected_item, void * data, char *buffer);
  96             int (*list_speak_item)(int selected_item, void * data);
  97             void *list_get_name_data;
  98             int icon_id;
  99         } *menu_get_name_and_icon;
 100     };
 101 };
 102
 103 typedef int (*menu_callback_type)(int action,
 104                                   const struct menu_item_ex *this_item);
 105 void do_setting_from_menu(const struct menu_item_ex *temp,
 106                           struct viewport parent[NB_SCREENS]);
 107
 108 /*
 109    int do_menu(const struct menu_item_ex *menu, int *start_selected)
 110
 111    Return value - usually one of the GO_TO_* values from root_menu.h,
 112    however, some of the following defines can cause this to
 113    return a different value.
 114
 115    *menu - The menu to run, can be a pointer to a MAKE_MENU() variable,
 116             MENUITEM_STRINGLIST() or MENUITEM_RETURNVALUE() variable.
 117
 118    *start_selected - the item to select when the menu is first run.
 119                      When do_menu() returns, this will be set to the
 120                      index of the selected item at the time of the exit.
 121                      This is always set, even if the menu was cancelled.
 122                      If NULL it is ignored and the firs item starts selected
 123 */
 124 int do_menu(const struct menu_item_ex *menu, int *start_selected,
 125             struct viewport parent[NB_SCREENS], bool hide_theme);
 126
 127 /* In all the following macros the argument names are as follows:
 128     - name: The name for the variable (so it can be used in a MAKE_MENU()
 129     - str:  the string to display for this menu item. use ID2P() for LANG_* id's
 130     - callback: The callback function to call for this menu item.
 131 */
 132
 133 /*  Use this to put a setting into a menu.
 134     The setting must appear in settings_list.c.
 135     If the setting is not configured properly, the menu will display "Not Done yet!"
 136     When the user selects this item the setting select screen will load,
 137     when that screen exits the user wll be back in the menu */
 138 #define MENUITEM_SETTING(name,var,callback)                  \
 139     static const struct menu_item_ex name =                  \
 140         {MT_SETTING, {.variable = (void*)var},{callback}};
 141
 142 /*  Use this for settings which have a differnt title in their
 143     setting screen than in the menu (e.g scroll options */
 144 #define MENUITEM_SETTING_W_TEXT(name, var, str, callback )              \
 145     static const struct menu_callback_with_desc name##__ =              \
 146                 {callback,str, Icon_NOICON};                            \
 147     static const struct menu_item_ex name =                             \
 148         {MT_SETTING_W_TEXT|MENU_HAS_DESC, {.variable = (void*)var },    \
 149             {.callback_and_desc = & name##__}};
 150
 151 /*  Use this To create a list of Strings (or ID2P()'s )
 152     When the user enters this list and selects one, the menu will exit
 153     and do_menu() will return value the index of the chosen item.
 154     if the user cancels, GO_TO_PREVIOUS will be returned */
 155 #define MENUITEM_STRINGLIST(name, str, callback, ... )                  \
 156     static const char *name##_[] = {__VA_ARGS__};                       \
 157     static const struct menu_callback_with_desc name##__ =              \
 158             {callback,str, Icon_NOICON};                                \
 159     static const struct menu_item_ex name =                             \
 160         {MT_RETURN_ID|MENU_HAS_DESC|                                    \
 161          MENU_ITEM_COUNT(sizeof( name##_)/sizeof(*name##_)),            \
 162             { .strings = name##_},{.callback_and_desc = & name##__}};
 163
 164
 165 /* causes do_menu() to return a value associated with the item */
 166 #define MENUITEM_RETURNVALUE(name, str, val, cb, icon)                      \
 167      static const struct menu_callback_with_desc name##_ = {cb,str,icon};   \
 168      static const struct menu_item_ex name   =                              \
 169          { MT_RETURN_VALUE|MENU_HAS_DESC, { .value = val},                  \
 170          {.callback_and_desc = & name##_}};
 171
 172 /* same as above, except the item name is dynamic */
 173 #define MENUITEM_RETURNVALUE_DYNTEXT(name, val, cb, text_callback,          \
 174                                      voice_callback, text_cb_data, icon)    \
 175      static const struct menu_get_name_and_icon name##_                     \
 176          = {cb,text_callback,voice_callback,text_cb_data,icon};             \
 177      static const struct menu_item_ex name   =                              \
 178         { MT_RETURN_VALUE|MENU_DYNAMIC_DESC, { .value = val},               \
 179         {.menu_get_name_and_icon = & name##_}};
 180
 181 /*  Use this to put a function call into the menu.
 182     When the user selects this item the function will be run,
 183     if MENU_FUNC_CHECK_RETVAL is set, the return value
 184     will be checked, returning 1 will exit do_menu();
 185     if MENU_FUNC_USEPARAM is set, param will be passed to the function */
 186 #define MENUITEM_FUNCTION(name, flags, str, func, param,                       \
 187                               callback, icon)                                  \
 188     static const struct menu_callback_with_desc name##_ = {callback,str,icon}; \
 189     static const struct menu_func name##__ = {{(void*)func}, param};           \
 190     /* should be const, but recording_settings wont let us do that */          \
 191     const struct menu_item_ex name   =                                         \
 192         { MT_FUNCTION_CALL|MENU_HAS_DESC|flags,                                \
 193          { .function = & name##__}, {.callback_and_desc = & name##_}};
 194
 195 /* As above, except the text is dynamic */
 196 #define MENUITEM_FUNCTION_DYNTEXT(name, flags, func, param,                 \
 197                                   text_callback, voice_callback,            \
 198                                   text_cb_data, callback, icon)             \
 199     static const struct menu_get_name_and_icon name##_                      \
 200         = {callback,text_callback,voice_callback,text_cb_data,icon};        \
 201     static const struct menu_func name##__ = {{(void*)func}, param};           \
 202     static const struct menu_item_ex name   =                                  \
 203         { MT_FUNCTION_CALL|MENU_DYNAMIC_DESC|flags,                            \
 204          { .function = & name##__}, {.menu_get_name_and_icon = & name##_}};
 205
 206 /*  Use this to actually create a menu. the ... argument is a list of pointers
 207     to any of the above macro'd variables.
 208     (It can also have other menus in the list.) */
 209 #define MAKE_MENU( name, str, callback, icon, ... )                            \
 210     static const struct menu_item_ex *name##_[]  = {__VA_ARGS__};              \
 211     static const struct menu_callback_with_desc name##__ = {callback,str,icon};\
 212     const struct menu_item_ex name =                                           \
 213         {MT_MENU|MENU_HAS_DESC|                                                \
 214          MENU_ITEM_COUNT(sizeof( name##_)/sizeof(*name##_)),                   \
 215             { (void*)name##_},{.callback_and_desc = & name##__}};
 216
 217
 218 #endif /* End __MENU_H__ */