4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
36 * \author Bernardo Innocenti <bernie@develer.com>
37 * \author Stefano Fedrigo <aleph@develer.com>
39 * \brief General pourpose menu handling functions
44 #include "cfg/cfg_gfx.h"
45 #include <cfg/compiler.h>
46 #include <cfg/debug.h>
54 #include <string.h> /* strcpy() */
57 #include <avr/pgmspace.h> /* strncpy_P() */
60 #if CONFIG_MENU_SMOOTH
61 #include <drv/lcd_gfx.h>
64 #if (CONFIG_MENU_TIMEOUT != 0)
65 #include <drv/timer.h>
68 #if CONFIG_MENU_MENUBAR
72 #if defined(CONFIG_LOCALE) && (CONFIG_LOCALE == 1)
75 #define PTRMSG(x) ((const char *)x)
79 /* Temporary fake defines for ABORT stuff... */
81 #define PUSH_ABORT false
82 #define POP_ABORT do {} while(0)
83 #define DO_ABORT do {} while(0)
87 * Return the total number of items in in a menu.
89 static int menu_count(const struct Menu *menu)
93 for (cnt = 0; /*NOP*/; ++cnt)
95 const MenuItem *item = &menu->items[cnt];
98 if (menu->flags & MF_ROMITEMS)
100 memcpy_P(&ram_item, item, sizeof(ram_item));
104 if (!(item->label || item->hook))
111 #if CONFIG_MENU_MENUBAR
114 * Update the menu bar according to the selected item and redraw it.
116 static void menu_update_menubar(
117 const struct Menu *menu,
123 if (menu->flags & MF_ROMITEMS)
125 ASSERT(sizeof(menu->items[selected].flags) == sizeof(int));
126 item_flags = pgm_read_int(&menu->items[selected].flags);
130 item_flags = menu->items[selected].flags;
132 const_iptr_t newlabel = (const_iptr_t)LABEL_OK;
134 if (item_flags & MIF_DISABLED)
135 newlabel = (const_iptr_t)LABEL_EMPTY;
136 else if (item_flags & MIF_TOGGLE)
137 newlabel = (const_iptr_t)LABEL_SEL;
138 else if (item_flags & MIF_CHECKIT)
140 newlabel = (item_flags & MIF_CHECKED) ?
141 (const_iptr_t)LABEL_EMPTY : (const_iptr_t)LABEL_SEL;
144 mb->labels[3] = newlabel;
147 #endif /* CONFIG_MENU_MENUBAR */
150 static void menu_defaultRenderHook(struct Bitmap *bm, int ypos, bool selected, const struct MenuItem *item)
152 if (item->flags & MIF_CHECKIT)
154 gfx_rectClear(bm, 0, ypos,
155 bm->font->height, ypos + bm->font->height);
157 if (item->flags & MIF_TOGGLE)
158 gfx_rectDraw(bm, 2, ypos + 2,
159 bm->font->height - 2, ypos + bm->font->height - 2);
160 if (item->flags & MIF_CHECKED)
164 bm->font->height - 3, ypos + bm->font->height - 3);
166 bm->font->height - 3, ypos + 3,
167 3, ypos + bm->font->height - 3);
171 #warning FIXME:REVISE this code!
174 ((item->flags & MIF_RAMLABEL) ? text_xyprintf : text_xyprintf_P)
179 bm, (item->flags & MIF_CHECKIT) ? bm->font->height : 0, ypos,
180 selected ? (STYLEF_INVERT | TEXT_FILL) : TEXT_FILL,
186 * Show a menu on the display.
188 static void menu_layout(
189 const struct Menu *menu,
196 const char * PROGMEM title = PTRMSG(menu->title);
197 Bitmap *bm = menu->bitmap;
205 text_clear(menu->bitmap);
212 text_xyprintf(bm, 0, ypos, STYLEF_UNDERLINE | STYLEF_BOLD | TEXT_CENTER | TEXT_FILL, title);
213 ypos += bm->font->height;
216 #if CONFIG_MENU_SMOOTH
217 static coord_t yoffset = 0;
218 static int old_first_item = 0;
220 coord_t old_ymin = bm->cr.ymin;
222 /* Clip drawing inside menu items area */
224 bm->cr.xmin, bm->cr.ymin + ypos,
225 bm->cr.xmax, bm->cr.ymax);
227 if (old_first_item != first_item)
229 /* Speed proportional to distance */
230 speed = ABS(old_first_item - first_item) * 3;
232 if (old_first_item > first_item)
235 if (yoffset > bm->font->height)
244 if (yoffset < -bm->font->height)
250 first_item = MIN(old_first_item, menu_count(menu));
255 #endif /* CONFIG_MENU_SMOOTH */
257 if (redraw) for (i = first_item; /**/; ++i)
259 const MenuItem *item = &menu->items[i];
262 if (menu->flags & MF_ROMITEMS)
264 memcpy_P(&ram_item, item, sizeof(ram_item));
267 #endif /* CPU_HARVARD */
269 /* Check for end of room */
270 if (ypos > bm->cr.ymax)
273 /* Check for end of menu */
274 if (!(item->label || item->hook))
277 /* Only print visible items */
278 if (!(item->flags & MIF_HIDDEN))
280 /* Check if a special render function is supplied, otherwise use defaults */
281 RenderHook renderhook = (item->flags & MIF_RENDERHOOK) ? (RenderHook)item->label : menu_defaultRenderHook;
283 /* Render menuitem */
284 renderhook(menu->bitmap, ypos++, (i == selected), item);
286 ypos += bm->font->height;
290 #if CONFIG_MENU_SMOOTH
293 /* Clear rest of area */
294 gfx_rectClear(bm, bm->cr.xmin, ypos, bm->cr.xmax, bm->cr.ymax);
296 lcd_blitBitmap(&lcd_bitmap);
299 /* Restore old cliprect */
301 bm->cr.xmin, old_ymin,
302 bm->cr.xmax, bm->cr.ymax);
304 #endif /* CONFIG_MENU_SMOOTH */
309 * Handle menu item selection
311 static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
315 /* Exclude other items */
317 for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
320 menu->items[i].flags &= ~MIF_CHECKED;
323 if (item->flags & MIF_DISABLED)
324 return MENU_DISABLED;
326 /* Handle checkable items */
327 if (item->flags & MIF_TOGGLE)
328 item->flags ^= MIF_CHECKED;
329 else if (item->flags & MIF_CHECKIT)
330 item->flags |= MIF_CHECKED;
332 /* Handle items with callback hooks */
335 /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
338 result = item->hook(item->userdata);
343 result = item->userdata;
350 * Return the next visible item (rolls back to the first item)
352 static int menu_next_visible_item(const struct Menu *menu, int index)
354 int total = menu_count(menu);
359 if (++index >= total)
363 if (menu->flags & MF_ROMITEMS)
365 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
366 item_flags = pgm_read_int(&menu->items[index].flags);
370 item_flags = menu->items[index].flags;
372 while (item_flags & MIF_HIDDEN);
379 * Return the previous visible item (rolls back to the last item)
381 static int menu_prev_visible_item(const struct Menu *menu, int index)
383 int total = menu_count(menu);
392 if (menu->flags & MF_ROMITEMS)
394 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
395 item_flags = pgm_read_int(&menu->items[index].flags);
399 item_flags = menu->items[index].flags;
401 while (item_flags & MIF_HIDDEN);
408 * Handle a menu and invoke hook functions for the selected menu items.
410 iptr_t menu_handle(const struct Menu *menu)
412 uint8_t items_per_page;
413 uint8_t first_item = 0;
418 #if (CONFIG_MENU_TIMEOUT != 0)
419 ticks_t now, menu_idle_time = timer_clock();
422 #if CONFIG_MENU_MENUBAR
424 const_iptr_t labels[] =
426 (const_iptr_t)LABEL_BACK,
427 (const_iptr_t)LABEL_UPARROW,
428 (const_iptr_t)LABEL_DOWNARROW,
433 * Initialize menu bar
435 if (menu->flags & MF_TOPLEVEL)
436 labels[0] = (const_iptr_t)LABEL_EMPTY;
438 mbar_init(&mb, menu->bitmap, labels, countof(labels));
439 #endif /* CONFIG_MENU_MENUBAR */
443 (menu->bitmap->height / menu->bitmap->font->height)
444 #if CONFIG_MENU_MENUBAR
445 - 1 /* menu bar labels */
447 - (menu->title ? 1 : 0);
449 /* Selected item should be a visible entry */
450 //first_item = selected = menu_next_visible_item(menu, menu->selected - 1);
451 selected = menu->selected;
459 * Keep selected item visible
461 while (selected < first_item)
462 first_item = menu_prev_visible_item(menu, first_item);
463 while (selected >= first_item + items_per_page)
464 first_item = menu_next_visible_item(menu, first_item);
466 menu_layout(menu, first_item, selected, redraw);
469 #if CONFIG_MENU_MENUBAR
470 menu_update_menubar(menu, &mb, selected);
473 #if CONFIG_MENU_SMOOTH || (CONFIG_MENU_TIMEOUT != 0)
479 #if (CONFIG_MENU_TIMEOUT != 0)
480 /* Reset idle timer on key press. */
483 menu_idle_time = now;
488 struct MenuItem *item = &(menu->items[selected]);
491 if (menu->flags & MF_ROMITEMS)
493 memcpy_P(&ram_item, item, sizeof(ram_item));
497 result = menu_doselect(menu, item);
500 /* Return immediately */
501 if (!(menu->flags & MF_STICKY))
504 #if (CONFIG_MENU_TIMEOUT != 0)
506 if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
510 menu_idle_time = timer_clock();
515 selected = menu_prev_visible_item(menu, selected);
518 else if (key & K_DOWN)
520 selected = menu_next_visible_item(menu, selected);
523 else if (!(menu->flags & MF_TOPLEVEL))
527 result = MENU_CANCEL;
531 #if CONFIG_MENU_TIMEOUT != 0
532 if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
534 result = MENU_TIMEOUT;
541 /* Store currently selected item before leaving. */
542 if (menu->flags & MF_SAVESEL)
543 CONST_CAST(struct Menu *, menu)->selected = selected;
550 * Set flags on a menuitem.
552 * \param menu Menu owner of the item to change.
553 * \param idx Index of the menu item.
554 * \param flags Bit mask of the flags to set.
558 int menu_setFlags(struct Menu *menu, int idx, int flags)
560 ASSERT(idx < menu_count(menu));
561 ASSERT(!(menu->flags & MF_ROMITEMS));
563 int old = menu->items[idx].flags;
564 menu->items[idx].flags |= flags;
570 * Clear flags on a menuitem.
572 * \param menu Menu owner of the item to change.
573 * \param idx Index of the menu item.
574 * \param flags Bit mask of the flags to clear.
578 int menu_clearFlags(struct Menu *menu, int idx, int flags)
580 ASSERT(idx < menu_count(menu));
581 ASSERT(!(menu->flags & MF_ROMITEMS));
583 int old = menu->items[idx].flags;
584 menu->items[idx].flags &= ~flags;