4 * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
6 * This file is part of DevLib - See README.devlib for information.
11 * \author Bernardo Innocenti <bernie@develer.com>
12 * \author Stefano Fedrigo <aleph@develer.com>
14 * \brief General pourpose menu handling functions
19 *#* Revision 1.7 2006/08/01 12:22:46 bernie
20 *#* Mention DevLib license.
22 *#* Revision 1.6 2006/07/19 12:56:27 bernie
23 *#* Convert to new Doxygen style.
25 *#* Revision 1.5 2006/06/03 13:58:01 bernie
26 *#* Fix recursive timeout and add exit status information.
28 *#* Revision 1.4 2006/06/02 12:26:18 bernie
29 *#* Draw graphical checkmarks.
31 *#* Revision 1.3 2006/05/28 15:03:31 bernie
32 *#* Avoid unnecessary rendering.
34 *#* Revision 1.2 2006/05/25 23:34:38 bernie
35 *#* Implement menu timeouts.
37 *#* Revision 1.1 2006/05/15 07:20:54 bernie
38 *#* Move menu to gui/.
40 *#* Revision 1.7 2006/04/27 05:39:24 bernie
41 *#* Enhance text rendering to arbitrary x,y coords.
43 *#* Revision 1.6 2006/04/11 00:07:32 bernie
44 *#* Implemenent MF_SAVESEL flag.
46 *#* Revision 1.5 2006/03/22 09:49:51 bernie
47 *#* Simplifications from project_grl.
49 *#* Revision 1.4 2006/03/20 17:48:35 bernie
50 *#* Implement support for ROM menus.
52 *#* Revision 1.3 2006/02/20 14:34:32 bernie
53 *#* Include appconfig.h before using its definitions.
55 *#* Revision 1.2 2006/02/15 09:10:51 bernie
56 *#* Make title bold; Fix height when we have no menubar.
64 #include <cfg/compiler.h>
65 #include <cfg/debug.h>
66 #include <appconfig.h>
67 #include <string.h> /* strcpy() */
70 #include <avr/pgmspace.h> /* strncpy_P() */
73 #if CONFIG_MENU_SMOOTH
74 #include <drv/lcd_gfx.h>
77 #if (CONFIG_MENU_TIMEOUT != 0)
78 #include <drv/timer.h>
81 #if CONFIG_MENU_MENUBAR
85 #if defined(CONFIG_LOCALE) && (CONFIG_LOCALE == 1)
88 #define PTRMSG(x) ((const char *)x)
91 /* Temporary fake defines for ABORT stuff... */
93 #define PUSH_ABORT false
94 #define POP_ABORT do {} while(0)
95 #define DO_ABORT do {} while(0)
99 * Return the total number of items in in a menu.
101 static int menu_count(const struct Menu *menu)
105 for (cnt = 0; /*NOP*/; ++cnt)
107 const MenuItem *item = &menu->items[cnt];
110 if (menu->flags & MF_ROMITEMS)
112 memcpy_P(&ram_item, item, sizeof(ram_item));
116 if (!(item->label || item->hook))
123 #if CONFIG_MENU_MENUBAR
126 * Update the menu bar according to the selected item and redraw it.
128 static void menu_update_menubar(
129 const struct Menu *menu,
135 if (menu->flags & MF_ROMITEMS)
137 ASSERT(sizeof(menu->items[selected].flags) == sizeof(int));
138 item_flags = pgm_read_int(&menu->items[selected].flags);
142 item_flags = menu->items[selected].flags;
144 const_iptr_t newlabel = (const_iptr_t)LABEL_OK;
146 if (item_flags & MIF_DISABLED)
147 newlabel = (const_iptr_t)LABEL_EMPTY;
148 else if (item_flags & MIF_TOGGLE)
149 newlabel = (const_iptr_t)LABEL_SEL;
150 else if (item_flags & MIF_CHECKIT)
152 newlabel = (item_flags & MIF_CHECKED) ?
153 (const_iptr_t)LABEL_EMPTY : (const_iptr_t)LABEL_SEL;
156 mb->labels[3] = newlabel;
159 #endif /* CONFIG_MENU_MENUBAR */
163 * Show a menu on the display.
165 static void menu_layout(
166 const struct Menu *menu,
173 const char * PROGMEM title = PTRMSG(menu->title);
174 Bitmap *bm = menu->bitmap;
182 text_clear(menu->bitmap);
189 text_xyprintf(bm, 0, ypos, STYLEF_UNDERLINE | STYLEF_BOLD | TEXT_CENTER | TEXT_FILL, title);
190 ypos += bm->font->height;
193 #if CONFIG_MENU_SMOOTH
194 static coord_t yoffset = 0;
195 static int old_first_item = 0;
197 coord_t old_ymin = bm->cr.ymin;
199 /* Clip drawing inside menu items area */
201 bm->cr.xmin, bm->cr.ymin + ypos,
202 bm->cr.xmax, bm->cr.ymax);
204 if (old_first_item != first_item)
206 /* Speed proportional to distance */
207 speed = ABS(old_first_item - first_item) * 3;
209 if (old_first_item > first_item)
212 if (yoffset > bm->font->height)
221 if (yoffset < -bm->font->height)
227 first_item = MIN(old_first_item, menu_count(menu));
232 #endif /* CONFIG_MENU_SMOOTH */
234 if (redraw) for (i = first_item; /**/; ++i)
236 const MenuItem *item = &menu->items[i];
239 if (menu->flags & MF_ROMITEMS)
241 memcpy_P(&ram_item, item, sizeof(ram_item));
244 #endif /* CPU_HARVARD */
246 /* Check for end of room */
247 if (ypos > bm->cr.ymax)
250 /* Check for end of menu */
251 if (!(item->label || item->hook))
254 /* Only print visible items */
255 if (!(item->flags & MIF_HIDDEN))
257 if (item->flags & MIF_CHECKIT)
259 gfx_rectClear(bm, 0, ypos,
260 bm->font->height, ypos + bm->font->height);
262 if (item->flags & MIF_TOGGLE)
263 gfx_rectDraw(bm, 2, ypos + 2,
264 bm->font->height - 2, ypos + bm->font->height - 2);
265 if (item->flags & MIF_CHECKED)
269 bm->font->height - 3, ypos + bm->font->height - 3);
271 bm->font->height - 3, ypos + 3,
272 3, ypos + bm->font->height - 3);
277 ((item->flags & MIF_RAMLABEL) ? text_xyprintf : text_xyprintf_P)
282 bm, (item->flags & MIF_CHECKIT) ? bm->font->height : 0, ypos,
283 (i == selected) ? (STYLEF_INVERT | TEXT_FILL) : TEXT_FILL,
287 ypos += bm->font->height;
291 #if CONFIG_MENU_SMOOTH
294 /* Clear rest of area */
295 gfx_rectClear(bm, bm->cr.xmin, ypos, bm->cr.xmax, bm->cr.ymax);
297 lcd_blitBitmap(&lcd_bitmap);
300 /* Restore old cliprect */
302 bm->cr.xmin, old_ymin,
303 bm->cr.xmax, bm->cr.ymax);
305 #endif /* CONFIG_MENU_SMOOTH */
310 * Handle menu item selection
312 static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
316 /* Exclude other items */
318 for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
321 menu->items[i].flags &= ~MIF_CHECKED;
324 if (item->flags & MIF_DISABLED)
325 return MENU_DISABLED;
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;
333 /* Handle items with callback hooks */
336 /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
339 result = item->hook(item->userdata);
344 result = item->userdata;
351 * Return the next visible item (rolls back to the first item)
353 static int menu_next_visible_item(const struct Menu *menu, int index)
355 int total = menu_count(menu);
360 if (++index >= total)
364 if (menu->flags & MF_ROMITEMS)
366 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
367 item_flags = pgm_read_int(&menu->items[index].flags);
371 item_flags = menu->items[index].flags;
373 while (item_flags & MIF_HIDDEN);
380 * Return the previous visible item (rolls back to the last item)
382 static int menu_prev_visible_item(const struct Menu *menu, int index)
384 int total = menu_count(menu);
393 if (menu->flags & MF_ROMITEMS)
395 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
396 item_flags = pgm_read_int(&menu->items[index].flags);
400 item_flags = menu->items[index].flags;
402 while (item_flags & MIF_HIDDEN);
409 * Handle a menu and invoke hook functions for the selected menu items.
411 iptr_t menu_handle(const struct Menu *menu)
413 uint8_t items_per_page;
414 uint8_t first_item = 0;
419 #if (CONFIG_MENU_TIMEOUT != 0)
420 ticks_t now, menu_idle_time = timer_clock();
423 #if CONFIG_MENU_MENUBAR
425 const_iptr_t labels[] =
427 (const_iptr_t)LABEL_BACK,
428 (const_iptr_t)LABEL_UPARROW,
429 (const_iptr_t)LABEL_DOWNARROW,
434 * Initialize menu bar
436 if (menu->flags & MF_TOPLEVEL)
437 labels[0] = (const_iptr_t)LABEL_EMPTY;
439 mbar_init(&mb, menu->bitmap, labels, countof(labels));
440 #endif /* CONFIG_MENU_MENUBAR */
444 (menu->bitmap->height / menu->bitmap->font->height)
445 #if CONFIG_MENU_MENUBAR
446 - 1 /* menu bar labels */
448 - (menu->title ? 1 : 0);
450 /* Selected item should be a visible entry */
451 //first_item = selected = menu_next_visible_item(menu, menu->selected - 1);
452 selected = menu->selected;
460 * Keep selected item visible
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);
467 menu_layout(menu, first_item, selected, redraw);
470 #if CONFIG_MENU_MENUBAR
471 menu_update_menubar(menu, &mb, selected);
474 #if CONFIG_MENU_SMOOTH || (CONFIG_MENU_TIMEOUT != 0)
480 #if (CONFIG_MENU_TIMEOUT != 0)
481 /* Reset idle timer on key press. */
484 menu_idle_time = now;
489 struct MenuItem *item = &(menu->items[selected]);
492 if (menu->flags & MF_ROMITEMS)
494 memcpy_P(&ram_item, item, sizeof(ram_item));
498 result = menu_doselect(menu, item);
501 /* Return immediately */
502 if (!(menu->flags & MF_STICKY))
505 #if (CONFIG_MENU_TIMEOUT != 0)
507 if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
511 menu_idle_time = timer_clock();
516 selected = menu_prev_visible_item(menu, selected);
519 else if (key & K_DOWN)
521 selected = menu_next_visible_item(menu, selected);
524 else if (!(menu->flags & MF_TOPLEVEL))
528 result = MENU_CANCEL;
532 #if CONFIG_MENU_TIMEOUT != 0
533 if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
535 result = MENU_TIMEOUT;
542 /* Store currently selected item before leaving. */
543 if (menu->flags & MF_SAVESEL)
544 CONST_CAST(struct Menu *, menu)->selected = selected;
551 * Set flags on a menuitem.
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.
559 int menu_setFlags(struct Menu *menu, int idx, int flags)
561 ASSERT(idx < menu_count(menu));
562 ASSERT(!(menu->flags & MF_ROMITEMS));
564 int old = menu->items[idx].flags;
565 menu->items[idx].flags |= flags;
571 * Clear flags on a menuitem.
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.
579 int menu_clearFlags(struct Menu *menu, int idx, int flags)
581 ASSERT(idx < menu_count(menu));
582 ASSERT(!(menu->flags & MF_ROMITEMS));
584 int old = menu->items[idx].flags;
585 menu->items[idx].flags &= ~flags;