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, 2010 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
34 * \author Bernie Innocenti <bernie@codewiz.org>
35 * \author Stefano Fedrigo <aleph@develer.com>
37 * \brief General pourpose menu handling functions
42 #include "cfg/cfg_menu.h"
43 #include "cfg/cfg_arch.h"
45 #include <cfg/compiler.h>
46 #include <cfg/debug.h>
52 #include <cpu/power.h>
56 #include <string.h> /* strcpy() */
59 #include <avr/pgmspace.h> /* strncpy_P() */
62 #if (CONFIG_MENU_TIMEOUT != 0)
63 #include <drv/timer.h>
66 #if CONFIG_MENU_MENUBAR
70 #if defined(CONFIG_LOCALE) && (CONFIG_LOCALE == 1)
73 #define PTRMSG(x) ((const char *)x)
77 /* Temporary fake defines for ABORT stuff... */
79 #define PUSH_ABORT false
80 #define POP_ABORT do {} while(0)
81 #define DO_ABORT do {} while(0)
85 * Return the total number of items in in a menu.
87 static int menu_count(const struct Menu *menu)
91 for (cnt = 0; /*NOP*/; ++cnt)
93 const MenuItem *item = &menu->items[cnt];
96 if (menu->flags & MF_ROMITEMS)
98 memcpy_P(&ram_item, item, sizeof(ram_item));
102 if (!(item->label || item->hook))
109 #if CONFIG_MENU_MENUBAR
112 * Update the menu bar according to the selected item and redraw it.
114 static void menu_update_menubar(
115 const struct Menu *menu,
121 if (menu->flags & MF_ROMITEMS)
123 ASSERT(sizeof(menu->items[selected].flags) == sizeof(int));
124 item_flags = pgm_read_int(&menu->items[selected].flags);
128 item_flags = menu->items[selected].flags;
130 const_iptr_t newlabel = (const_iptr_t)LABEL_OK;
132 if (item_flags & MIF_DISABLED)
133 newlabel = (const_iptr_t)LABEL_EMPTY;
134 else if (item_flags & MIF_TOGGLE)
135 newlabel = (const_iptr_t)LABEL_SEL;
136 else if (item_flags & MIF_CHECKIT)
138 newlabel = (item_flags & MIF_CHECKED) ?
139 (const_iptr_t)LABEL_EMPTY : (const_iptr_t)LABEL_SEL;
142 mb->labels[3] = newlabel;
145 #endif /* CONFIG_MENU_MENUBAR */
148 static void menu_defaultRenderHook(struct Bitmap *bm, int ypos, bool selected, const struct MenuItem *item)
150 if (item->flags & MIF_CHECKIT)
152 gfx_rectClear(bm, 0, ypos,
153 bm->font->height, ypos + bm->font->height);
155 if (item->flags & MIF_TOGGLE)
156 gfx_rectDraw(bm, 2, ypos + 2,
157 bm->font->height - 2, ypos + bm->font->height - 2);
158 if (item->flags & MIF_CHECKED)
162 bm->font->height - 3, ypos + bm->font->height - 3);
164 bm->font->height - 3, ypos + 3,
165 3, ypos + bm->font->height - 3);
170 ((item->flags & MIF_RAMLABEL) ? text_xyprintf : text_xyprintf_P)
175 bm, (item->flags & MIF_CHECKIT) ? bm->font->height : 0, ypos,
176 selected ? (STYLEF_INVERT | TEXT_FILL) : TEXT_FILL,
182 * Show a menu on the display.
184 static void menu_layout(
185 const struct Menu *menu,
192 const char * PROGMEM title = PTRMSG(menu->title);
193 Bitmap *bm = menu->bitmap;
200 text_clear(menu->bitmap);
206 text_xyprintf(bm, 0, ypos, STYLEF_UNDERLINE | STYLEF_BOLD | TEXT_CENTER | TEXT_FILL, title);
207 ypos += bm->font->height;
210 #if CONFIG_MENU_SMOOTH
211 static coord_t yoffset = 0;
212 static int old_first_item = 0;
214 coord_t old_ymin = bm->cr.ymin;
216 /* Clip drawing inside menu items area */
218 bm->cr.xmin, bm->cr.ymin + ypos,
219 bm->cr.xmax, bm->cr.ymax);
221 if (old_first_item != first_item)
223 /* Speed proportional to distance */
224 speed = ABS(old_first_item - first_item) * 3;
226 if (old_first_item > first_item)
229 if (yoffset > bm->font->height)
238 if (yoffset < -bm->font->height)
244 first_item = MIN(old_first_item, menu_count(menu));
249 #endif /* CONFIG_MENU_SMOOTH */
251 if (redraw) for (i = first_item; /**/; ++i)
253 const MenuItem *item = &menu->items[i];
256 if (menu->flags & MF_ROMITEMS)
258 memcpy_P(&ram_item, item, sizeof(ram_item));
261 #endif /* CPU_HARVARD */
263 /* Check for end of room */
264 if (ypos > bm->cr.ymax)
267 /* Check for end of menu */
268 if (!(item->label || item->hook))
271 /* Only print visible items */
272 if (!(item->flags & MIF_HIDDEN))
274 #warning __FILTER_NEXT_WARNING__
275 RenderHook renderhook = (item->flags & MIF_RENDERHOOK) ? (RenderHook)item->label : menu_defaultRenderHook;
277 /* Render menuitem */
278 renderhook(menu->bitmap, ypos++, (i == selected), item);
280 ypos += bm->font->height;
284 #if CONFIG_MENU_SMOOTH
287 /* Clear rest of area */
288 gfx_rectClear(bm, bm->cr.xmin, ypos, bm->cr.xmax, bm->cr.ymax);
290 menu->lcd_blitBitmap(bm);
293 /* Restore old cliprect */
295 bm->cr.xmin, old_ymin,
296 bm->cr.xmax, bm->cr.ymax);
298 #endif /* CONFIG_MENU_SMOOTH */
303 * Handle menu item selection
305 static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
309 /* Exclude other items */
311 for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
314 menu->items[i].flags &= ~MIF_CHECKED;
317 if (item->flags & MIF_DISABLED)
318 return MENU_DISABLED;
320 /* Handle checkable items */
321 if (item->flags & MIF_TOGGLE)
322 item->flags ^= MIF_CHECKED;
323 else if (item->flags & MIF_CHECKIT)
324 item->flags |= MIF_CHECKED;
326 /* Handle items with callback hooks */
329 /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
332 result = item->hook(item->userdata);
337 result = item->userdata;
344 * Return the next visible item (rolls back to the first item)
346 static int menu_next_visible_item(const struct Menu *menu, int index)
348 int total = menu_count(menu);
353 if (++index >= total)
357 if (menu->flags & MF_ROMITEMS)
359 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
360 item_flags = pgm_read_int(&menu->items[index].flags);
364 item_flags = menu->items[index].flags;
366 while (item_flags & MIF_HIDDEN);
373 * Return the previous visible item (rolls back to the last item)
375 static int menu_prev_visible_item(const struct Menu *menu, int index)
377 int total = menu_count(menu);
386 if (menu->flags & MF_ROMITEMS)
388 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
389 item_flags = pgm_read_int(&menu->items[index].flags);
393 item_flags = menu->items[index].flags;
395 while (item_flags & MIF_HIDDEN);
402 * Handle a menu and invoke hook functions for the selected menu items.
404 iptr_t menu_handle(const struct Menu *menu)
406 uint8_t items_per_page;
407 uint8_t first_item = 0;
412 #if (CONFIG_MENU_TIMEOUT != 0)
413 ticks_t now, menu_idle_time = timer_clock();
416 #if CONFIG_MENU_MENUBAR
418 const_iptr_t labels[] =
420 (const_iptr_t)LABEL_BACK,
421 (const_iptr_t)LABEL_UPARROW,
422 (const_iptr_t)LABEL_DOWNARROW,
427 * Initialize menu bar
429 if (menu->flags & MF_TOPLEVEL)
430 labels[0] = (const_iptr_t)LABEL_EMPTY;
432 mbar_init(&mb, menu->bitmap, labels, countof(labels));
433 #endif /* CONFIG_MENU_MENUBAR */
437 (menu->bitmap->height / menu->bitmap->font->height - 1)
438 #if CONFIG_MENU_MENUBAR
439 - 1 /* menu bar labels */
441 - (menu->title ? 1 : 0);
443 /* Selected item should be a visible entry */
444 //first_item = selected = menu_next_visible_item(menu, menu->selected - 1);
445 selected = menu->selected;
453 * Keep selected item visible
455 while (selected < first_item)
456 first_item = menu_prev_visible_item(menu, first_item);
457 while (selected >= first_item + items_per_page)
458 first_item = menu_next_visible_item(menu, first_item);
460 menu_layout(menu, first_item, selected, redraw);
463 #if CONFIG_MENU_MENUBAR
464 menu_update_menubar(menu, &mb, selected);
467 #if CONFIG_MENU_SMOOTH || (CONFIG_MENU_TIMEOUT != 0)
474 #if (CONFIG_MENU_TIMEOUT != 0)
475 /* Reset idle timer on key press. */
478 menu_idle_time = now;
483 struct MenuItem *item = &(menu->items[selected]);
486 if (menu->flags & MF_ROMITEMS)
488 memcpy_P(&ram_item, item, sizeof(ram_item));
492 result = menu_doselect(menu, item);
495 /* Return immediately */
496 if (!(menu->flags & MF_STICKY))
499 #if (CONFIG_MENU_TIMEOUT != 0)
501 if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
505 menu_idle_time = timer_clock();
510 selected = menu_prev_visible_item(menu, selected);
513 else if (key & K_DOWN)
515 selected = menu_next_visible_item(menu, selected);
518 else if (!(menu->flags & MF_TOPLEVEL))
522 result = MENU_CANCEL;
526 #if CONFIG_MENU_TIMEOUT != 0
527 if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
529 result = MENU_TIMEOUT;
536 /* Store currently selected item before leaving. */
537 if (menu->flags & MF_SAVESEL)
538 #warning __FILTER_NEXT_WARNING__
539 CONST_CAST(struct Menu *, menu)->selected = selected;
546 * Set flags on a menuitem.
548 * \param menu Menu owner of the item to change.
549 * \param idx Index of the menu item.
550 * \param flags Bit mask of the flags to set.
554 int menu_setFlags(struct Menu *menu, int idx, int flags)
556 ASSERT(idx < menu_count(menu));
557 ASSERT(!(menu->flags & MF_ROMITEMS));
559 int old = menu->items[idx].flags;
560 menu->items[idx].flags |= flags;
566 * Clear flags on a menuitem.
568 * \param menu Menu owner of the item to change.
569 * \param idx Index of the menu item.
570 * \param flags Bit mask of the flags to clear.
574 int menu_clearFlags(struct Menu *menu, int idx, int flags)
576 ASSERT(idx < menu_count(menu));
577 ASSERT(!(menu->flags & MF_ROMITEMS));
579 int old = menu->items[idx].flags;
580 menu->items[idx].flags &= ~flags;