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