bertos/gui/menu.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \version $Id$
  35  *
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  *
  39  * \brief General pourpose menu handling functions
  40  */
  41
  42 #include "menu.h"
  43
  44 #include <appconfig.h>
  45
  46 #include <cfg/compiler.h>
  47 #include <cfg/debug.h>
  48
  49 #include <gfx/gfx.h>
  50 #include <gfx/font.h>
  51 #include <gfx/text.h>
  52
  53 #include <drv/kbd.h>
  54
  55 #include <string.h> /* strcpy() */
  56
  57 #if CPU_HARVARD
  58 #include <avr/pgmspace.h> /* strncpy_P() */
  59 #endif
  60
  61 #if CONFIG_MENU_SMOOTH
  62 #include <drv/lcd_gfx.h>
  63 #endif
  64
  65 #if (CONFIG_MENU_TIMEOUT != 0)
  66 #include <drv/timer.h>
  67 #endif
  68
  69 #if CONFIG_MENU_MENUBAR
  70 #include "menubar.h"
  71 #endif
  72
  73 #if defined(CONFIG_LOCALE) && (CONFIG_LOCALE == 1)
  74 #include "msg.h"
  75 #else
  76 #define PTRMSG(x) ((const char *)x)
  77 #endif
  78
  79
  80 /* Temporary fake defines for ABORT stuff... */
  81 #define abort_top  0
  82 #define PUSH_ABORT false
  83 #define POP_ABORT  do {} while(0)
  84 #define DO_ABORT   do {} while(0)
  85
  86
  87 /**
  88  * Return the total number of items in in a menu.
  89  */
  90 static int menu_count(const struct Menu *menu)
  91 {
  92         int cnt = 0;
  93
  94         for (cnt = 0; /*NOP*/; ++cnt)
  95         {
  96                 const MenuItem *item = &menu->items[cnt];
  97 #if CPU_HARVARD
  98                 MenuItem ram_item;
  99                 if (menu->flags & MF_ROMITEMS)
 100                 {
 101                         memcpy_P(&ram_item, item, sizeof(ram_item));
 102                         item = &ram_item;
 103                 }
 104 #endif
 105                 if (!(item->label || item->hook))
 106                         break;
 107         }
 108
 109         return cnt;
 110 }
 111
 112 #if CONFIG_MENU_MENUBAR
 113
 114 /**
 115  * Update the menu bar according to the selected item and redraw it.
 116  */
 117 static void menu_update_menubar(
 118                 const struct Menu *menu,
 119                 struct MenuBar *mb,
 120                 int selected)
 121 {
 122         int item_flags;
 123 #if CPU_HARVARD
 124         if (menu->flags & MF_ROMITEMS)
 125         {
 126                 ASSERT(sizeof(menu->items[selected].flags) == sizeof(int));
 127                 item_flags = pgm_read_int(&menu->items[selected].flags);
 128         }
 129         else
 130 #endif
 131                 item_flags = menu->items[selected].flags;
 132
 133         const_iptr_t newlabel = (const_iptr_t)LABEL_OK;
 134
 135         if (item_flags & MIF_DISABLED)
 136                 newlabel = (const_iptr_t)LABEL_EMPTY;
 137         else if (item_flags & MIF_TOGGLE)
 138                 newlabel = (const_iptr_t)LABEL_SEL;
 139         else if (item_flags & MIF_CHECKIT)
 140         {
 141                 newlabel = (item_flags & MIF_CHECKED) ?
 142                         (const_iptr_t)LABEL_EMPTY : (const_iptr_t)LABEL_SEL;
 143         }
 144
 145         mb->labels[3] = newlabel;
 146         mbar_draw(mb);
 147 }
 148 #endif /* CONFIG_MENU_MENUBAR */
 149
 150
 151 static void menu_defaultRenderHook(struct Bitmap *bm, int ypos, bool selected, const struct MenuItem *item)
 152 {
 153         if (item->flags & MIF_CHECKIT)
 154         {
 155                 gfx_rectClear(bm, 0, ypos,
 156                                 bm->font->height, ypos + bm->font->height);
 157
 158                 if (item->flags & MIF_TOGGLE)
 159                         gfx_rectDraw(bm, 2, ypos + 2,
 160                                         bm->font->height - 2, ypos + bm->font->height - 2);
 161                 if (item->flags & MIF_CHECKED)
 162                 {
 163                         gfx_line(bm,
 164                                         3, ypos + 3,
 165                                         bm->font->height - 3, ypos + bm->font->height - 3);
 166                         gfx_line(bm,
 167                                         bm->font->height - 3, ypos + 3,
 168                                         3, ypos + bm->font->height - 3);
 169                 }
 170         }
 171
 172 #warning FIXME:REVISE this code!
 173 #if 0
 174 //#if CPU_HARVARD
 175         ((item->flags & MIF_RAMLABEL) ? text_xyprintf : text_xyprintf_P)
 176 #else
 177         text_xyprintf
 178 #endif
 179         (
 180                 bm, (item->flags & MIF_CHECKIT) ? bm->font->height : 0, ypos,
 181                 selected ? (STYLEF_INVERT | TEXT_FILL) : TEXT_FILL,
 182                 PTRMSG(item->label)
 183         );
 184 }
 185
 186 /**
 187  * Show a menu on the display.
 188  */
 189 static void menu_layout(
 190                 const struct Menu *menu,
 191                 int first_item,
 192                 int selected,
 193                 bool redraw)
 194 {
 195         coord_t ypos;
 196         int i;
 197         const char * PROGMEM title = PTRMSG(menu->title);
 198         Bitmap *bm = menu->bitmap;
 199
 200         ypos = bm->cr.ymin;
 201
 202 #if 0
 203         if (redraw)
 204         {
 205                 /* Clear screen */
 206                 text_clear(menu->bitmap);
 207         }
 208 #endif
 209
 210         if (title)
 211         {
 212                 if (redraw)
 213                         text_xyprintf(bm, 0, ypos, STYLEF_UNDERLINE | STYLEF_BOLD | TEXT_CENTER | TEXT_FILL, title);
 214                 ypos += bm->font->height;
 215         }
 216
 217 #if CONFIG_MENU_SMOOTH
 218         static coord_t yoffset = 0;
 219         static int old_first_item = 0;
 220         static int speed;
 221         coord_t old_ymin = bm->cr.ymin;
 222
 223         /* Clip drawing inside menu items area */
 224         gfx_setClipRect(bm,
 225                 bm->cr.xmin, bm->cr.ymin + ypos,
 226                 bm->cr.xmax, bm->cr.ymax);
 227
 228         if (old_first_item != first_item)
 229         {
 230                 /* Speed proportional to distance */
 231                 speed = ABS(old_first_item - first_item) * 3;
 232
 233                 if (old_first_item > first_item)
 234                 {
 235                         yoffset += speed;
 236                         if (yoffset > bm->font->height)
 237                         {
 238                                         yoffset = 0;
 239                                         --old_first_item;
 240                         }
 241                 }
 242                 else
 243                 {
 244                         yoffset -= speed;
 245                         if (yoffset < -bm->font->height)
 246                         {
 247                                         yoffset = 0;
 248                                         ++old_first_item;
 249                         }
 250                 }
 251                 first_item = MIN(old_first_item, menu_count(menu));
 252
 253                 ypos += yoffset;
 254                 redraw = true;
 255         }
 256 #endif /* CONFIG_MENU_SMOOTH */
 257
 258         if (redraw) for (i = first_item; /**/; ++i)
 259         {
 260                 const MenuItem *item = &menu->items[i];
 261 #if CPU_HARVARD
 262                 MenuItem ram_item;
 263                 if (menu->flags & MF_ROMITEMS)
 264                 {
 265                         memcpy_P(&ram_item, item, sizeof(ram_item));
 266                         item = &ram_item;
 267                 }
 268 #endif /* CPU_HARVARD */
 269
 270                 /* Check for end of room */
 271                 if (ypos > bm->cr.ymax)
 272                         break;
 273
 274                 /* Check for end of menu */
 275                 if (!(item->label || item->hook))
 276                         break;
 277
 278                 /* Only print visible items */
 279                 if (!(item->flags & MIF_HIDDEN))
 280                 {
 281                         /* Check if a special render function is supplied, otherwise use defaults */
 282                         RenderHook renderhook = (item->flags & MIF_RENDERHOOK) ? (RenderHook)item->label : menu_defaultRenderHook;
 283
 284                         /* Render menuitem */
 285                         renderhook(menu->bitmap, ypos++, (i == selected), item);
 286
 287                         ypos += bm->font->height;
 288                 }
 289         }
 290
 291 #if CONFIG_MENU_SMOOTH
 292         if (redraw)
 293         {
 294                 /* Clear rest of area */
 295                 gfx_rectClear(bm, bm->cr.xmin, ypos, bm->cr.xmax, bm->cr.ymax);
 296
 297                 lcd_blitBitmap(&lcd_bitmap);
 298         }
 299
 300         /* Restore old cliprect */
 301         gfx_setClipRect(bm,
 302                         bm->cr.xmin, old_ymin,
 303                         bm->cr.xmax, bm->cr.ymax);
 304
 305 #endif /* CONFIG_MENU_SMOOTH */
 306 }
 307
 308
 309 /**
 310  * Handle menu item selection
 311  */
 312 static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
 313 {
 314         iptr_t result = 0;
 315
 316         /* Exclude other items */
 317         int mask, i;
 318         for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
 319         {
 320                 if (mask & 1)
 321                         menu->items[i].flags &= ~MIF_CHECKED;
 322         }
 323
 324         if (item->flags & MIF_DISABLED)
 325                 return MENU_DISABLED;
 326
 327         /* Handle checkable items */
 328         if (item->flags & MIF_TOGGLE)
 329                 item->flags ^= MIF_CHECKED;
 330         else if (item->flags & MIF_CHECKIT)
 331                 item->flags |= MIF_CHECKED;
 332
 333         /* Handle items with callback hooks */
 334         if (item->hook)
 335         {
 336                 /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
 337                 if (!PUSH_ABORT)
 338                 {
 339                         result = item->hook(item->userdata);
 340                         POP_ABORT;
 341                 }
 342         }
 343         else
 344                 result = item->userdata;
 345
 346         return result;
 347 }
 348
 349
 350 /**
 351  * Return the next visible item (rolls back to the first item)
 352  */
 353 static int menu_next_visible_item(const struct Menu *menu, int index)
 354 {
 355         int total = menu_count(menu);
 356         int item_flags;
 357
 358         do
 359         {
 360                 if (++index >= total)
 361                    index = 0;
 362
 363 #if CPU_HARVARD
 364                 if (menu->flags & MF_ROMITEMS)
 365                 {
 366                         ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
 367                         item_flags = pgm_read_int(&menu->items[index].flags);
 368                 }
 369                 else
 370 #endif
 371                         item_flags = menu->items[index].flags;
 372         }
 373         while (item_flags & MIF_HIDDEN);
 374
 375         return index;
 376 }
 377
 378
 379 /**
 380  * Return the previous visible item (rolls back to the last item)
 381  */
 382 static int menu_prev_visible_item(const struct Menu *menu, int index)
 383 {
 384         int total = menu_count(menu);
 385         int item_flags;
 386
 387         do
 388         {
 389                 if (--index < 0)
 390                         index = total - 1;
 391
 392 #if CPU_HARVARD
 393                 if (menu->flags & MF_ROMITEMS)
 394                 {
 395                         ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
 396                         item_flags = pgm_read_int(&menu->items[index].flags);
 397                 }
 398                 else
 399 #endif
 400                         item_flags = menu->items[index].flags;
 401         }
 402         while (item_flags & MIF_HIDDEN);
 403
 404         return index;
 405 }
 406
 407
 408 /**
 409  * Handle a menu and invoke hook functions for the selected menu items.
 410  */
 411 iptr_t menu_handle(const struct Menu *menu)
 412 {
 413         uint8_t items_per_page;
 414         uint8_t first_item = 0;
 415         uint8_t selected;
 416         iptr_t result = 0;
 417         bool redraw = true;
 418
 419 #if (CONFIG_MENU_TIMEOUT != 0)
 420         ticks_t now, menu_idle_time = timer_clock();
 421 #endif
 422
 423 #if CONFIG_MENU_MENUBAR
 424         struct MenuBar mb;
 425         const_iptr_t labels[] =
 426         {
 427                 (const_iptr_t)LABEL_BACK,
 428                 (const_iptr_t)LABEL_UPARROW,
 429                 (const_iptr_t)LABEL_DOWNARROW,
 430                 (const_iptr_t)0
 431         };
 432
 433         /*
 434          * Initialize menu bar
 435          */
 436         if (menu->flags & MF_TOPLEVEL)
 437                 labels[0] = (const_iptr_t)LABEL_EMPTY;
 438
 439         mbar_init(&mb, menu->bitmap, labels, countof(labels));
 440 #endif /* CONFIG_MENU_MENUBAR */
 441
 442
 443         items_per_page =
 444                 (menu->bitmap->height / menu->bitmap->font->height)
 445 #if CONFIG_MENU_MENUBAR
 446                 - 1 /* menu bar labels */
 447 #endif
 448                 - (menu->title ? 1 : 0);
 449
 450         /* Selected item should be a visible entry */
 451         //first_item = selected = menu_next_visible_item(menu, menu->selected - 1);
 452         selected = menu->selected;
 453         first_item = 0;
 454
 455         for(;;)
 456         {
 457                 keymask_t key;
 458
 459                 /*
 460                  * Keep selected item visible
 461                  */
 462                 while (selected < first_item)
 463                         first_item = menu_prev_visible_item(menu, first_item);
 464                 while (selected >= first_item + items_per_page)
 465                         first_item = menu_next_visible_item(menu, first_item);
 466
 467                 menu_layout(menu, first_item, selected, redraw);
 468                 redraw = false;
 469
 470                 #if CONFIG_MENU_MENUBAR
 471                         menu_update_menubar(menu, &mb, selected);
 472                 #endif
 473
 474                 #if CONFIG_MENU_SMOOTH || (CONFIG_MENU_TIMEOUT != 0)
 475                         key = kbd_peek();
 476                 #else
 477                         key = kbd_get();
 478                 #endif
 479
 480                 #if (CONFIG_MENU_TIMEOUT != 0)
 481                         /* Reset idle timer on key press. */
 482                         now = timer_clock();
 483                         if (key)
 484                                 menu_idle_time = now;
 485                 #endif
 486
 487                 if (key & K_OK)
 488                 {
 489                         struct MenuItem *item = &(menu->items[selected]);
 490 #if CPU_HARVARD
 491                         MenuItem ram_item;
 492                         if (menu->flags & MF_ROMITEMS)
 493                         {
 494                                 memcpy_P(&ram_item, item, sizeof(ram_item));
 495                                 item = &ram_item;
 496                         }
 497 #endif
 498                         result = menu_doselect(menu, item);
 499                         redraw = true;
 500
 501                         /* Return immediately */
 502                         if (!(menu->flags & MF_STICKY))
 503                                 break;
 504
 505                         #if (CONFIG_MENU_TIMEOUT != 0)
 506                                 /* Chain timeout */
 507                                 if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
 508                                         break;
 509
 510                                 /* Reset timeout */
 511                                 menu_idle_time = timer_clock();
 512                         #endif
 513                 }
 514                 else if (key & K_UP)
 515                 {
 516                         selected = menu_prev_visible_item(menu, selected);
 517                         redraw = true;
 518                 }
 519                 else if (key & K_DOWN)
 520                 {
 521                         selected = menu_next_visible_item(menu, selected);
 522                         redraw = true;
 523                 }
 524                 else if (!(menu->flags & MF_TOPLEVEL))
 525                 {
 526                         if (key & K_CANCEL)
 527                         {
 528                                 result = MENU_CANCEL;
 529                                 break;
 530                         }
 531
 532                         #if CONFIG_MENU_TIMEOUT != 0
 533                                 if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
 534                                 {
 535                                         result = MENU_TIMEOUT;
 536                                         break;
 537                                 }
 538                         #endif
 539                 }
 540         }
 541
 542         /* Store currently selected item before leaving. */
 543         if (menu->flags & MF_SAVESEL)
 544                 CONST_CAST(struct Menu *, menu)->selected = selected;
 545
 546         return result;
 547 }
 548
 549
 550 /**
 551  * Set flags on a menuitem.
 552  *
 553  * \param menu  Menu owner of the item to change.
 554  * \param idx   Index of the menu item.
 555  * \param flags Bit mask of the flags to set.
 556  *
 557  * \return Old flags.
 558  */
 559 int menu_setFlags(struct Menu *menu, int idx, int flags)
 560 {
 561         ASSERT(idx < menu_count(menu));
 562         ASSERT(!(menu->flags & MF_ROMITEMS));
 563
 564         int old = menu->items[idx].flags;
 565         menu->items[idx].flags |= flags;
 566         return old;
 567 }
 568
 569
 570 /**
 571  * Clear flags on a menuitem.
 572  *
 573  * \param menu  Menu owner of the item to change.
 574  * \param idx   Index of the menu item.
 575  * \param flags Bit mask of the flags to clear.
 576  *
 577  * \return Old flags.
 578  */
 579 int menu_clearFlags(struct Menu *menu, int idx, int flags)
 580 {
 581         ASSERT(idx < menu_count(menu));
 582         ASSERT(!(menu->flags & MF_ROMITEMS));
 583
 584         int old = menu->items[idx].flags;
 585         menu->items[idx].flags &= ~flags;
 586         return old;
 587 }