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_gfx.h"
43 #include "cfg/cfg_menu.h"
44 #include "cfg/cfg_arch.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>
63 * With this you can choose, at compile time, which backend to use.
65 * $WIZ$ menu_backend_lcd = "LCD_RIT128X96_DRV", "LCD_32122A_DRV"
67 #define LCD_RIT128X96_DRV 0 ///<
68 #define LCD_32122A_DRV 1 ///<
73 #if (CONFIG_MENU_TIMEOUT != 0)
74 #include <drv/timer.h>
77 #if CONFIG_MENU_MENUBAR
81 #if defined(CONFIG_LOCALE) && (CONFIG_LOCALE == 1)
84 #define PTRMSG(x) ((const char *)x)
88 /* Temporary fake defines for ABORT stuff... */
90 #define PUSH_ABORT false
91 #define POP_ABORT do {} while(0)
92 #define DO_ABORT do {} while(0)
96 * Return the total number of items in in a menu.
98 static int menu_count(const struct Menu *menu)
102 for (cnt = 0; /*NOP*/; ++cnt)
104 const MenuItem *item = &menu->items[cnt];
107 if (menu->flags & MF_ROMITEMS)
109 memcpy_P(&ram_item, item, sizeof(ram_item));
113 if (!(item->label || item->hook))
120 #if CONFIG_MENU_MENUBAR
123 * Update the menu bar according to the selected item and redraw it.
125 static void menu_update_menubar(
126 const struct Menu *menu,
132 if (menu->flags & MF_ROMITEMS)
134 ASSERT(sizeof(menu->items[selected].flags) == sizeof(int));
135 item_flags = pgm_read_int(&menu->items[selected].flags);
139 item_flags = menu->items[selected].flags;
141 const_iptr_t newlabel = (const_iptr_t)LABEL_OK;
143 if (item_flags & MIF_DISABLED)
144 newlabel = (const_iptr_t)LABEL_EMPTY;
145 else if (item_flags & MIF_TOGGLE)
146 newlabel = (const_iptr_t)LABEL_SEL;
147 else if (item_flags & MIF_CHECKIT)
149 newlabel = (item_flags & MIF_CHECKED) ?
150 (const_iptr_t)LABEL_EMPTY : (const_iptr_t)LABEL_SEL;
153 mb->labels[3] = newlabel;
156 #endif /* CONFIG_MENU_MENUBAR */
159 static void menu_defaultRenderHook(struct Bitmap *bm, int ypos, bool selected, const struct MenuItem *item)
161 if (item->flags & MIF_CHECKIT)
163 gfx_rectClear(bm, 0, ypos,
164 bm->font->height, ypos + bm->font->height);
166 if (item->flags & MIF_TOGGLE)
167 gfx_rectDraw(bm, 2, ypos + 2,
168 bm->font->height - 2, ypos + bm->font->height - 2);
169 if (item->flags & MIF_CHECKED)
173 bm->font->height - 3, ypos + bm->font->height - 3);
175 bm->font->height - 3, ypos + 3,
176 3, ypos + bm->font->height - 3);
181 ((item->flags & MIF_RAMLABEL) ? text_xyprintf : text_xyprintf_P)
186 bm, (item->flags & MIF_CHECKIT) ? bm->font->height : 0, ypos,
187 selected ? (STYLEF_INVERT | TEXT_FILL) : TEXT_FILL,
193 * Show a menu on the display.
195 static void menu_layout(
196 const struct Menu *menu,
203 const char * PROGMEM title = PTRMSG(menu->title);
204 Bitmap *bm = menu->bitmap;
212 text_clear(menu->bitmap);
219 text_xyprintf(bm, 0, ypos, STYLEF_UNDERLINE | STYLEF_BOLD | TEXT_CENTER | TEXT_FILL, title);
220 ypos += bm->font->height;
223 #if CONFIG_MENU_SMOOTH
224 static coord_t yoffset = 0;
225 static int old_first_item = 0;
227 coord_t old_ymin = bm->cr.ymin;
229 /* Clip drawing inside menu items area */
231 bm->cr.xmin, bm->cr.ymin + ypos,
232 bm->cr.xmax, bm->cr.ymax);
234 if (old_first_item != first_item)
236 /* Speed proportional to distance */
237 speed = ABS(old_first_item - first_item) * 3;
239 if (old_first_item > first_item)
242 if (yoffset > bm->font->height)
251 if (yoffset < -bm->font->height)
257 first_item = MIN(old_first_item, menu_count(menu));
262 #endif /* CONFIG_MENU_SMOOTH */
264 if (redraw) for (i = first_item; /**/; ++i)
266 const MenuItem *item = &menu->items[i];
269 if (menu->flags & MF_ROMITEMS)
271 memcpy_P(&ram_item, item, sizeof(ram_item));
274 #endif /* CPU_HARVARD */
276 /* Check for end of room */
277 if (ypos > bm->cr.ymax)
280 /* Check for end of menu */
281 if (!(item->label || item->hook))
284 /* Only print visible items */
285 if (!(item->flags & MIF_HIDDEN))
287 /* Check if a special render function is supplied, otherwise use defaults */
288 #if (ARCH & ARCH_NIGHTTEST)
289 #warning __FILTER_NEXT_WARNING__
291 RenderHook renderhook = (item->flags & MIF_RENDERHOOK) ? (RenderHook)item->label : menu_defaultRenderHook;
293 /* Render menuitem */
294 renderhook(menu->bitmap, ypos++, (i == selected), item);
296 ypos += bm->font->height;
300 #if CONFIG_MENU_SMOOTH
303 /* Clear rest of area */
304 gfx_rectClear(bm, bm->cr.xmin, ypos, bm->cr.xmax, bm->cr.ymax);
309 /* Restore old cliprect */
311 bm->cr.xmin, old_ymin,
312 bm->cr.xmax, bm->cr.ymax);
314 #endif /* CONFIG_MENU_SMOOTH */
319 * Handle menu item selection
321 static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
325 /* Exclude other items */
327 for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
330 menu->items[i].flags &= ~MIF_CHECKED;
333 if (item->flags & MIF_DISABLED)
334 return MENU_DISABLED;
336 /* Handle checkable items */
337 if (item->flags & MIF_TOGGLE)
338 item->flags ^= MIF_CHECKED;
339 else if (item->flags & MIF_CHECKIT)
340 item->flags |= MIF_CHECKED;
342 /* Handle items with callback hooks */
345 /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
348 result = item->hook(item->userdata);
353 result = item->userdata;
360 * Return the next visible item (rolls back to the first item)
362 static int menu_next_visible_item(const struct Menu *menu, int index)
364 int total = menu_count(menu);
369 if (++index >= total)
373 if (menu->flags & MF_ROMITEMS)
375 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
376 item_flags = pgm_read_int(&menu->items[index].flags);
380 item_flags = menu->items[index].flags;
382 while (item_flags & MIF_HIDDEN);
389 * Return the previous visible item (rolls back to the last item)
391 static int menu_prev_visible_item(const struct Menu *menu, int index)
393 int total = menu_count(menu);
402 if (menu->flags & MF_ROMITEMS)
404 ASSERT(sizeof(menu->items[index].flags) == sizeof(int));
405 item_flags = pgm_read_int(&menu->items[index].flags);
409 item_flags = menu->items[index].flags;
411 while (item_flags & MIF_HIDDEN);
418 * Handle a menu and invoke hook functions for the selected menu items.
420 iptr_t menu_handle(const struct Menu *menu)
422 uint8_t items_per_page;
423 uint8_t first_item = 0;
428 #if (CONFIG_MENU_TIMEOUT != 0)
429 ticks_t now, menu_idle_time = timer_clock();
432 #if CONFIG_MENU_MENUBAR
434 const_iptr_t labels[] =
436 (const_iptr_t)LABEL_BACK,
437 (const_iptr_t)LABEL_UPARROW,
438 (const_iptr_t)LABEL_DOWNARROW,
443 * Initialize menu bar
445 if (menu->flags & MF_TOPLEVEL)
446 labels[0] = (const_iptr_t)LABEL_EMPTY;
448 mbar_init(&mb, menu->bitmap, labels, countof(labels));
449 #endif /* CONFIG_MENU_MENUBAR */
453 (menu->bitmap->height / menu->bitmap->font->height - 1)
454 #if CONFIG_MENU_MENUBAR
455 - 1 /* menu bar labels */
457 - (menu->title ? 1 : 0);
459 /* Selected item should be a visible entry */
460 //first_item = selected = menu_next_visible_item(menu, menu->selected - 1);
461 selected = menu->selected;
469 * Keep selected item visible
471 while (selected < first_item)
472 first_item = menu_prev_visible_item(menu, first_item);
473 while (selected >= first_item + items_per_page)
474 first_item = menu_next_visible_item(menu, first_item);
476 menu_layout(menu, first_item, selected, redraw);
479 #if CONFIG_MENU_MENUBAR
480 menu_update_menubar(menu, &mb, selected);
483 #if CONFIG_MENU_SMOOTH || (CONFIG_MENU_TIMEOUT != 0)
489 #if (CONFIG_MENU_TIMEOUT != 0)
490 /* Reset idle timer on key press. */
493 menu_idle_time = now;
498 struct MenuItem *item = &(menu->items[selected]);
501 if (menu->flags & MF_ROMITEMS)
503 memcpy_P(&ram_item, item, sizeof(ram_item));
507 result = menu_doselect(menu, item);
510 /* Return immediately */
511 if (!(menu->flags & MF_STICKY))
514 #if (CONFIG_MENU_TIMEOUT != 0)
516 if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
520 menu_idle_time = timer_clock();
525 selected = menu_prev_visible_item(menu, selected);
528 else if (key & K_DOWN)
530 selected = menu_next_visible_item(menu, selected);
533 else if (!(menu->flags & MF_TOPLEVEL))
537 result = MENU_CANCEL;
541 #if CONFIG_MENU_TIMEOUT != 0
542 if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
544 result = MENU_TIMEOUT;
551 /* Store currently selected item before leaving. */
552 if (menu->flags & MF_SAVESEL)
553 #if (ARCH & ARCH_NIGHTTEST)
554 #warning __FILTER_NEXT_WARNING__
556 CONST_CAST(struct Menu *, menu)->selected = selected;
563 * Set flags on a menuitem.
565 * \param menu Menu owner of the item to change.
566 * \param idx Index of the menu item.
567 * \param flags Bit mask of the flags to set.
571 int menu_setFlags(struct Menu *menu, int idx, int flags)
573 ASSERT(idx < menu_count(menu));
574 ASSERT(!(menu->flags & MF_ROMITEMS));
576 int old = menu->items[idx].flags;
577 menu->items[idx].flags |= flags;
583 * Clear flags on a menuitem.
585 * \param menu Menu owner of the item to change.
586 * \param idx Index of the menu item.
587 * \param flags Bit mask of the flags to clear.
591 int menu_clearFlags(struct Menu *menu, int idx, int flags)
593 ASSERT(idx < menu_count(menu));
594 ASSERT(!(menu->flags & MF_ROMITEMS));
596 int old = menu->items[idx].flags;
597 menu->items[idx].flags &= ~flags;