apps/action.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2006 Jonathan Gordon
  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 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24
  25 #include "config.h"
  26 #include "lang.h"
  27
  28 #include "appevents.h"
  29 #include "button.h"
  30 #include "action.h"
  31 #include "kernel.h"
  32 #include "debug.h"
  33 #include "splash.h"
  34 #include "settings.h"
  35 #include "pcmbuf.h"
  36 #include "misc.h"
  37 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
  38 #include "language.h"
  39 #endif
  40 #include "viewport.h"
  41 #ifdef HAVE_TOUCHSCREEN
  42 #include "statusbar-skinned.h"
  43 #endif
  44
  45 static int last_button = BUTTON_NONE|BUTTON_REL; /* allow the ipod wheel to
  46                                                     work on startup */
  47 static intptr_t last_data = 0;
  48 static int last_action = ACTION_NONE;
  49 static bool repeated = false;
  50 static bool wait_for_release = false;
  51
  52 #ifdef HAVE_TOUCHSCREEN
  53 static bool short_press = false;
  54 #endif
  55
  56 #define REPEAT_WINDOW_TICKS HZ/4
  57 static int last_action_tick = 0;
  58
  59 /* software keylock stuff */
  60 #ifndef HAS_BUTTON_HOLD
  61 static bool keys_locked = false;
  62 static int unlock_combo = BUTTON_NONE;
  63 static bool screen_has_lock = false;
  64 #endif /* HAVE_SOFTWARE_KEYLOCK */
  65
  66 /*
  67  * do_button_check is the worker function for get_default_action.
  68  * returns ACTION_UNKNOWN or the requested return value from the list.
  69  */
  70 static inline int do_button_check(const struct button_mapping *items,
  71                                   int button, int last_button, int *start)
  72 {
  73     int i = 0;
  74     int ret = ACTION_UNKNOWN;
  75
  76     while (items[i].button_code != BUTTON_NONE)
  77     {
  78         if (items[i].button_code == button)
  79         {
  80             if ((items[i].pre_button_code == BUTTON_NONE)
  81                 || (items[i].pre_button_code == last_button))
  82             {
  83                 ret = items[i].action_code;
  84                 break;
  85             }
  86         }
  87         i++;
  88     }
  89     *start = i;
  90     return ret;
  91 }
  92
  93 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
  94 /*
  95  * button is horizontally inverted to support RTL language if the given language
  96  * and context combination require that
  97  */
  98 static int button_flip_horizontally(int context, int button)
  99 {
 100     int newbutton;
 101
 102     if (!(lang_is_rtl() && ((context == CONTEXT_STD) ||
 103         (context == CONTEXT_TREE) || (context == CONTEXT_LIST) ||
 104         (context == CONTEXT_MAINMENU))))
 105     {
 106         return button;
 107     }
 108
 109     newbutton = button &
 110         ~(BUTTON_LEFT | BUTTON_RIGHT
 111 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD) && \
 112     !defined(SIMULATOR)
 113         | BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD
 114 #endif
 115 #if defined(BUTTON_MINUS) && defined(BUTTON_PLUS) && \
 116     !defined(SIMULATOR)
 117         | BUTTON_MINUS | BUTTON_PLUS
 118 #endif
 119         );
 120
 121     if (button & BUTTON_LEFT)
 122         newbutton |= BUTTON_RIGHT;
 123     if (button & BUTTON_RIGHT)
 124         newbutton |= BUTTON_LEFT;
 125 #if defined(BUTTON_SCROLL_BACK) && defined(BUTTON_SCROLL_FWD) && \
 126     !defined(SIMULATOR)
 127     if (button & BUTTON_SCROLL_BACK)
 128         newbutton |= BUTTON_SCROLL_FWD;
 129     if (button & BUTTON_SCROLL_FWD)
 130         newbutton |= BUTTON_SCROLL_BACK;
 131 #endif
 132 #if defined(BUTTON_MINUS) && defined(BUTTON_PLUS) && \
 133     !defined(SIMULATOR)
 134     if (button & BUTTON_MINUS)
 135         newbutton |= BUTTON_PLUS;
 136     if (button & BUTTON_PLUS)
 137         newbutton |= BUTTON_MINUS;
 138 #endif
 139
 140     return newbutton;
 141 }
 142 #endif
 143
 144 static inline int get_next_context(const struct button_mapping *items, int i)
 145 {
 146     while (items[i].button_code != BUTTON_NONE)
 147         i++;
 148     return (items[i].action_code == ACTION_NONE ) ?
 149             CONTEXT_STD :
 150             items[i].action_code;
 151 }
 152 /*
 153  * int get_action_worker(int context, struct button_mapping *user_mappings,
 154    int timeout)
 155    This function searches the button list for the given context for the just
 156    pressed button.
 157    If there is a match it returns the value from the list.
 158    If there is no match..
 159         the last item in the list "points" to the next context in a chain
 160         so the "chain" is followed until the button is found.
 161         putting ACTION_NONE will get CONTEXT_STD which is always the last list checked.
 162
 163    Timeout can be TIMEOUT_NOBLOCK to return immediatly
 164                   TIMEOUT_BLOCK   to wait for a button press
 165    Any number >0   to wait that many ticks for a press
 166  */
 167 static int get_action_worker(int context, int timeout,
 168                              const struct button_mapping* (*get_context_map)(int) )
 169 {
 170     const struct button_mapping *items = NULL;
 171     int button;
 172     int i=0;
 173     int ret = ACTION_UNKNOWN;
 174     static int last_context = CONTEXT_STD;
 175
 176
 177     send_event(GUI_EVENT_ACTIONUPDATE, NULL);
 178
 179     if (timeout == TIMEOUT_NOBLOCK)
 180         button = button_get(false);
 181     else if  (timeout == TIMEOUT_BLOCK)
 182         button = button_get(true);
 183     else
 184         button = button_get_w_tmo(timeout);
 185
 186     /* Data from sys events can be pulled with button_get_data
 187      * multimedia button presses don't go through the action system */
 188     if (button == BUTTON_NONE || button & (SYS_EVENT|BUTTON_MULTIMEDIA))
 189         return button;
 190     /* Don't send any buttons through untill we see the release event */
 191     if (wait_for_release)
 192     {
 193         if (button&BUTTON_REL)
 194         {
 195             /* remember the button for the below button eating on context
 196              * change */
 197             last_button = button;
 198             wait_for_release = false;
 199         }
 200         return ACTION_NONE;
 201     }
 202
 203
 204 #if CONFIG_CODEC == SWCODEC
 205     /* Produce keyclick */
 206     keyclick_click(button);
 207 #endif
 208
 209     if ((context != last_context) && ((last_button & BUTTON_REL) == 0)
 210 #ifdef HAVE_SCROLLWHEEL
 211         /* Scrollwheel doesn't generate release events  */
 212         && !(last_button & (BUTTON_SCROLL_BACK | BUTTON_SCROLL_FWD))
 213 #endif
 214         )
 215     {
 216         if (button & BUTTON_REL)
 217         {
 218             last_button = button;
 219             last_action = ACTION_NONE;
 220         }
 221         /* eat all buttons until the previous button was |BUTTON_REL
 222            (also eat the |BUTTON_REL button) */
 223         return ACTION_NONE; /* "safest" return value */
 224     }
 225     last_context = context;
 226 #ifndef HAS_BUTTON_HOLD
 227     screen_has_lock = ((context & ALLOW_SOFTLOCK) == ALLOW_SOFTLOCK);
 228     if (screen_has_lock && keys_locked)
 229     {
 230         if (button == unlock_combo)
 231         {
 232             last_button = BUTTON_NONE;
 233             keys_locked = false;
 234             splash(HZ/2, str(LANG_KEYLOCK_OFF));
 235             return ACTION_REDRAW;
 236         }
 237         else
 238 #if (BUTTON_REMOTE != 0)
 239             if ((button & BUTTON_REMOTE) == 0)
 240 #endif
 241         {
 242             if ((button & BUTTON_REL))
 243                 splash(HZ/2, str(LANG_KEYLOCK_ON));
 244             return ACTION_REDRAW;
 245         }
 246     }
 247     context &= ~ALLOW_SOFTLOCK;
 248 #endif /* HAS_BUTTON_HOLD */
 249
 250 #ifdef HAVE_TOUCHSCREEN
 251     if (button & BUTTON_TOUCHSCREEN)
 252     {
 253         repeated = false;
 254         short_press = false;
 255         if (last_button & BUTTON_TOUCHSCREEN)
 256         {
 257             if ((button & BUTTON_REL) &&
 258                 ((last_button & BUTTON_REPEAT)==0))
 259             {
 260                 short_press = true;
 261             }
 262             else if (button & BUTTON_REPEAT)
 263                 repeated = true;
 264         }
 265         last_button = button;
 266         return ACTION_TOUCHSCREEN;
 267     }
 268 #endif
 269
 270 #if defined(HAVE_LCD_BITMAP) && !defined(BOOTLOADER)
 271     button = button_flip_horizontally(context, button);
 272 #endif
 273
 274     /*   logf("%x,%x",last_button,button); */
 275     while (1)
 276     {
 277         /*     logf("context = %x",context); */
 278 #if (BUTTON_REMOTE != 0)
 279         if (button & BUTTON_REMOTE)
 280             context |= CONTEXT_REMOTE;
 281 #endif
 282         if ((context & CONTEXT_PLUGIN) && get_context_map)
 283             items = get_context_map(context);
 284         else
 285             items = get_context_mapping(context);
 286
 287         if (items == NULL)
 288             break;
 289
 290         ret = do_button_check(items,button,last_button,&i);
 291
 292         if (ret == ACTION_UNKNOWN)
 293         {
 294             context = get_next_context(items,i);
 295
 296             if (context != (int)CONTEXT_STOPSEARCHING)
 297             {
 298                 i = 0;
 299                 continue;
 300             }
 301         }
 302
 303         /* Action was found or STOPSEARCHING was specified */
 304         break;
 305     }
 306     /* DEBUGF("ret = %x\n",ret); */
 307 #ifndef HAS_BUTTON_HOLD
 308     if (screen_has_lock && (ret == ACTION_STD_KEYLOCK))
 309     {
 310         unlock_combo = button;
 311         keys_locked = true;
 312         splash(HZ/2, str(LANG_KEYLOCK_ON));
 313
 314         button_clear_queue();
 315         return ACTION_REDRAW;
 316     }
 317 #endif
 318     if ((current_tick - last_action_tick < REPEAT_WINDOW_TICKS)
 319          && (ret == last_action))
 320         repeated = true;
 321     else
 322         repeated = false;
 323
 324     last_button = button;
 325     last_action = ret;
 326     last_data   = button_get_data();
 327     last_action_tick = current_tick;
 328     return ret;
 329 }
 330
 331 int get_action(int context, int timeout)
 332 {
 333     int button = get_action_worker(context,timeout,NULL);
 334 #ifdef HAVE_TOUCHSCREEN
 335     if (button == ACTION_TOUCHSCREEN)
 336         button = sb_touch_to_button(context);
 337 #endif
 338     return button;
 339 }
 340
 341 int get_custom_action(int context,int timeout,
 342                       const struct button_mapping* (*get_context_map)(int))
 343 {
 344     return get_action_worker(context,timeout,get_context_map);
 345 }
 346
 347 bool action_userabort(int timeout)
 348 {
 349     int action = get_action_worker(CONTEXT_STD,timeout,NULL);
 350     bool ret = (action == ACTION_STD_CANCEL);
 351     if(!ret)
 352     {
 353         default_event_handler(action);
 354     }
 355     return ret;
 356 }
 357
 358 #ifndef HAS_BUTTON_HOLD
 359 bool is_keys_locked(void)
 360 {
 361     return (screen_has_lock && keys_locked);
 362 }
 363 #endif
 364
 365 intptr_t get_action_data(void)
 366 {
 367     return last_data;
 368 }
 369
 370 int get_action_statuscode(int *button)
 371 {
 372     int ret = 0;
 373     if (button)
 374         *button = last_button;
 375
 376     if (last_button & BUTTON_REMOTE)
 377         ret |= ACTION_REMOTE;
 378     if (repeated)
 379         ret |= ACTION_REPEAT;
 380     return ret;
 381 }
 382
 383 #ifdef HAVE_TOUCHSCREEN
 384 /* return BUTTON_NONE               on error
 385  *        BUTTON_REPEAT             if repeated press
 386  *        BUTTON_REPEAT|BUTTON_REL  if release after repeated press
 387  *        BUTTON_REL                if it's a short press = release after press
 388  *        BUTTON_TOUCHSCREEN        if press
 389  */
 390 int action_get_touchscreen_press(short *x, short *y)
 391 {
 392     static int last_data = 0;
 393     int data;
 394     if ((last_button & BUTTON_TOUCHSCREEN) == 0)
 395         return BUTTON_NONE;
 396     data = button_get_data();
 397     if (last_button & BUTTON_REL)
 398     {
 399         *x = (last_data&0xffff0000)>>16;
 400         *y = (last_data&0xffff);
 401     }
 402     else
 403     {
 404         *x = (data&0xffff0000)>>16;
 405         *y = (data&0xffff);
 406     }
 407     last_data = data;
 408     if (repeated)
 409         return BUTTON_REPEAT;
 410     if (short_press)
 411         return BUTTON_REL;
 412     /* This is to return a BUTTON_REL after a BUTTON_REPEAT. */
 413     if (last_button & BUTTON_REL)
 414         return BUTTON_REPEAT|BUTTON_REL;
 415     return BUTTON_TOUCHSCREEN;
 416 }
 417
 418 int action_get_touchscreen_press_in_vp(short *x1, short *y1, struct viewport *vp)
 419 {
 420     short x, y;
 421     int ret;
 422
 423     ret = action_get_touchscreen_press(&x, &y);
 424
 425     if (ret != BUTTON_NONE && viewport_point_within_vp(vp, x, y))
 426     {
 427         *x1 = x - vp->x;
 428         *y1 = y - vp->y;
 429         return ret;
 430     }
 431     if (ret & BUTTON_TOUCHSCREEN)
 432         return ACTION_UNKNOWN;
 433     return BUTTON_NONE;
 434 }
 435 #endif
 436
 437 /* Don't let get_action*() return any ACTION_* values until the current buttons
 438  * have been released. SYS_* and BUTTON_NONE will go through.
 439  * Any actions relying on _RELEASE won't get seen.
 440  */
 441 void action_wait_for_release(void)
 442 {
 443     wait_for_release = true;
 444 }
 445