apps/action.h

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