apps/action.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  *
   9  * Copyright (C) 2004 Brent Coutts
  10  *
  11  * All files in this archive are subject to the GNU General Public License.
  12  * See the file COPYING in the source tree root for full license agreement.
  13  *
  14  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  15  * KIND, either express or implied.
  16  *
  17  ****************************************************************************/
  18 #ifndef __ACTION_H__
  19 #define __ACTION_H__
  20
  21 #include "stdbool.h"
  22 #include "button.h"
  23
  24 #define TIMEOUT_BLOCK   -1
  25 #define TIMEOUT_NOBLOCK  0
  26
  27 #define CONTEXT_STOPSEARCHING 0xFFFFFFFF
  28 #define CONTEXT_REMOTE 0x80000000 /* | this against another context to get remote buttons for that context */
  29 #define CONTEXT_CUSTOM 0x40000000 /* | this against anything to get your context number */
  30
  31 #define LAST_ITEM_IN_LIST { CONTEXT_STOPSEARCHING, BUTTON_NONE, BUTTON_NONE }
  32 #define LAST_ITEM_IN_LIST__NEXTLIST(a) { a, BUTTON_NONE, BUTTON_NONE }
  33
  34 #ifndef HAS_BUTTON_HOLD
  35 #define ALLOW_SOFTLOCK 0x20000000 /* will be stripped.. never needed except in calls to get_action() */
  36 #else
  37 #define ALLOW_SOFTLOCK 0
  38 #endif
  39
  40 enum {
  41     CONTEXT_STD = 0,
  42     /* These CONTEXT_ values were here before me,
  43     there values may have significance, so dont touch! */
  44     CONTEXT_WPS = 1,
  45     CONTEXT_TREE = 2,
  46     CONTEXT_RECORD = 3,
  47     CONTEXT_MAINMENU = 4, /* uses CONTEXT_TREE and ACTION_TREE_* */
  48     CONTEXT_ID3DB = 5,
  49     /* Add new contexts here, no need to explicitly define a value for them */
  50     CONTEXT_LIST,
  51     CONTEXT_SETTINGS, /* regular setting screens (and debug screens) */
  52     /* bellow are setting screens which may need to redefine the standard
  53        setting screen keys, targets should return the CONTEXT_SETTINGS
  54        keymap unless they are not adequate for the screen
  55     NOTE: uses ACTION_STD_[NEXT|PREV] so make sure they are there also
  56           and (possibly) ACTION_SETTINGS_[INC|DEC] */
  57     CONTEXT_SETTINGS_EQ,
  58     CONTEXT_SETTINGS_COLOURCHOOSER,
  59     CONTEXT_SETTINGS_TIME,
  60
  61     /* The following contexts should use ACTION_STD_[NEXT|PREV]
  62         and (possibly) ACTION_SETTINGS_[INC|DEC]
  63        Also add any extra actions they need                        */
  64     CONTEXT_BOOKMARKSCREEN, /* uses ACTION_BMS_ defines */
  65     CONTEXT_ALARMSCREEN, /* uses ACTION_AS_ defines */
  66     CONTEXT_QUICKSCREEN, /* uses ACTION_QS_ defines below */
  67     CONTEXT_PITCHSCREEN, /* uses ACTION_PS_ defines below */
  68
  69     CONTEXT_YESNOSCREEN, /*NOTE: make sure your target has this and ACTION_YESNO_ACCEPT */
  70     CONTEXT_RECSCREEN,
  71     CONTEXT_KEYBOARD,
  72     CONTEXT_FM,
  73 };
  74
  75
  76 enum {
  77
  78     ACTION_NONE = BUTTON_NONE,
  79     ACTION_UNKNOWN,
  80     ACTION_REDRAW, /* returned if keys are locked and we splash()'ed */
  81
  82     /* standard actions, use these first */
  83     ACTION_STD_PREV,
  84     ACTION_STD_PREVREPEAT,
  85     ACTION_STD_NEXT,
  86     ACTION_STD_NEXTREPEAT,
  87
  88     ACTION_STD_OK,
  89     ACTION_STD_CANCEL,
  90     ACTION_STD_CONTEXT,
  91     ACTION_STD_MENU,
  92     ACTION_STD_QUICKSCREEN,
  93     ACTION_STD_KEYLOCK,
  94     ACTION_STD_REC,
  95
  96     ACTION_F3, /* just so everything works again, possibly change me */
  97     /* code context actions */
  98
  99     /* WPS codes */
 100     ACTION_WPS_BROWSE,
 101     ACTION_WPS_PLAY,
 102     ACTION_WPS_SEEKBACK,
 103     ACTION_WPS_SEEKFWD,
 104     ACTION_WPS_STOPSEEK,
 105     ACTION_WPS_SKIPNEXT,
 106     ACTION_WPS_SKIPPREV,
 107     ACTION_WPS_STOP,
 108     ACTION_WPS_VOLDOWN,
 109     ACTION_WPS_VOLUP,
 110     ACTION_WPS_PITCHSCREEN,/* optional */
 111     ACTION_WPS_ID3SCREEN,/* optional */
 112     ACTION_WPS_CONTEXT,
 113     ACTION_WPS_QUICKSCREEN,/* optional */
 114     ACTION_WPS_MENU, /*this should be the same as ACTION_STD_MENU */
 115     ACTION_WPS_REC,
 116 #if 0
 117     ACTION_WPSAB_SINGLE, /* This needs to be #defined in
 118                             the config-<target>.h to one of the ACTION_WPS_ actions
 119                             so it can be used */
 120 #endif
 121     ACTION_WPS_ABSETA_PREVDIR, /* these should be safe to put together seen as */
 122     ACTION_WPS_ABSETB_NEXTDIR, /* you shouldnt want to change dir in ab-mode */
 123     ACTION_WPS_ABRESET,
 124
 125     /* list and tree page up/down */
 126     ACTION_LISTTREE_PGUP,/* optional */
 127     ACTION_LISTTREE_PGDOWN,/* optional */
 128 #ifdef HAVE_VOLUME_IN_LIST
 129     ACTION_LIST_VOLUP,
 130     ACTION_LIST_VOLDOWN,
 131 #endif
 132
 133     /* tree */
 134     ACTION_TREE_ROOT_INIT,
 135     ACTION_TREE_PGLEFT,/* optional */
 136     ACTION_TREE_PGRIGHT,/* optional */
 137     ACTION_TREE_STOP,
 138     ACTION_TREE_WPS,
 139
 140     /* radio */
 141     ACTION_FM_MENU,
 142     ACTION_FM_PRESET,
 143     ACTION_FM_RECORD,
 144     ACTION_FM_FREEZE,
 145     ACTION_FM_STOP,
 146     ACTION_FM_MODE,
 147     ACTION_FM_EXIT,
 148     ACTION_FM_PLAY,
 149     ACTION_FM_RECORD_DBLPRE,
 150     ACTION_FM_NEXT_PRESET,
 151     ACTION_FM_PREV_PRESET,
 152
 153     /* recording screen */
 154     ACTION_REC_LCD,
 155     ACTION_REC_PAUSE,
 156     ACTION_REC_NEWFILE,
 157     ACTION_REC_F2,
 158     ACTION_REC_F3,
 159
 160     /* main menu */
 161     /* These are not strictly actions, but must be here
 162        so they dont conflict with real actions in the menu code */
 163     ACTION_REQUEST_MENUITEM,
 164     ACTION_EXIT_MENUITEM,
 165     ACTION_EXIT_AFTER_THIS_MENUITEM, /* if a menu returns this the menu will exit
 166                                         once the subitem returns */
 167     ACTION_ENTER_MENUITEM,
 168
 169     /* id3db */
 170
 171     /* list */
 172
 173     /* settings */
 174     ACTION_SETTINGS_INC,
 175     ACTION_SETTINGS_INCREPEAT,
 176     ACTION_SETTINGS_INCBIGSTEP,
 177     ACTION_SETTINGS_DEC,
 178     ACTION_SETTINGS_DECREPEAT,
 179     ACTION_SETTINGS_DECBIGSTEP,
 180     ACTION_SETTINGS_RESET,
 181
 182     /* bookmark screen */
 183     ACTION_BMS_DELETE,
 184
 185     /* alarm menu screen */
 186
 187     /* quickscreen */
 188     ACTION_QS_LEFT,
 189     ACTION_QS_RIGHT,
 190     ACTION_QS_DOWN,
 191     ACTION_QS_DOWNINV, /* why is this not called up?? :p */
 192
 193     /* pitchscreen */
 194     /* obviously ignore if you dont have thise screen */
 195     ACTION_PS_INC_SMALL,
 196     ACTION_PS_INC_BIG,
 197     ACTION_PS_DEC_SMALL,
 198     ACTION_PS_DEC_BIG,
 199     ACTION_PS_NUDGE_LEFT,
 200     ACTION_PS_NUDGE_RIGHT,
 201     ACTION_PS_NUDGE_LEFTOFF,
 202     ACTION_PS_NUDGE_RIGHTOFF,
 203     ACTION_PS_TOGGLE_MODE,
 204     ACTION_PS_RESET,
 205     ACTION_PS_EXIT, /* _STD_* isnt going to work here */
 206
 207     /* yesno screen */
 208     ACTION_YESNO_ACCEPT,
 209
 210     /* keyboard screen */
 211     ACTION_KBD_LEFT,
 212     ACTION_KBD_RIGHT,
 213     ACTION_KBD_CURSOR_LEFT,
 214     ACTION_KBD_CURSOR_RIGHT,
 215     ACTION_KBD_SELECT,
 216     ACTION_KBD_SELECT_REM,
 217     ACTION_KBD_PAGE_FLIP,
 218     ACTION_KBD_DONE,
 219     ACTION_KBD_ABORT,
 220     ACTION_KBD_BACKSPACE,
 221     ACTION_KBD_UP,
 222     ACTION_KBD_DOWN,
 223     ACTION_KBD_MORSE_INPUT,
 224     ACTION_KBD_MORSE_SELECT,
 225
 226
 227     LAST_ACTION_PLACEHOLDER, /* custom actions should be this + something */
 228 };
 229
 230 struct button_mapping {
 231     int action_code;
 232     int button_code;
 233     int pre_button_code;
 234 };
 235 /* use if you want to supply your own button mappings, PLUGINS ONLY */
 236 /* get_context_map is a function which returns a button_mapping* depedning on the given context */
 237 /* custom button_mappings may "chain" to inbuilt CONTEXT's */
 238 int get_custom_action(int context,int timeout,
 239                       const struct button_mapping* (*get_context_map)(int));
 240 /* use if one of the standard CONTEXT_ mappings will work (ALL the core should be using this! */
 241 int get_action(int context, int timeout);
 242
 243 /* call this if you need to check for ACTION_STD_CANCEL only (i.e user abort! */
 244 bool action_userabort(int timeout);
 245
 246 /* no other code should need this apart from action.c */
 247 const struct button_mapping* get_context_mapping(int context);
 248 #ifndef HAS_BUTTON_HOLD
 249 bool is_keys_locked(void);
 250 #endif
 251
 252 /* returns the status code variable from action.c for the button just pressed
 253    If button != NULL it will be set to the actual button code */
 254 #define ACTION_REMOTE   0x1 /* remote was pressed */
 255 #define ACTION_REPEAT   0x2 /* action was repeated (NOT button) */
 256 int get_action_statuscode(int *button);
 257
 258 /* returns the data value associated with the last action that is not
 259    BUTTON_NONE or flagged with SYS_EVENT */
 260 intptr_t get_action_data(void);
 261
 262 #endif /* __ACTION_H__ */