Mention DevLib license.

[bertos.git] / gui / menu.c

diff --git a/gui/menu.c b/gui/menu.c
index c77bf2e7287f7452e63c18f902270cdc9fd19c8f..756aba53585c4b2dd0c282482484487614f2267f 100755 (executable)
--- a/gui/menu.c
+++ b/gui/menu.c
@@ -1,9 +1,9 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
- * All Rights Reserved.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \version $Id$
@@ -16,6 +16,15 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.7  2006/08/01 12:22:46  bernie
+ *#* Mention DevLib license.
+ *#*
+ *#* Revision 1.6  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.5  2006/06/03 13:58:01  bernie
+ *#* Fix recursive timeout and add exit status information.
+ *#*
  *#* Revision 1.4  2006/06/02 12:26:18  bernie
  *#* Draw graphical checkmarks.
  *#*
@@ -113,9 +122,8 @@ static int menu_count(const struct Menu *menu)
 
 #if CONFIG_MENU_MENUBAR
 
-/*!
- * Update the menu bar according to the selected item
- * and redraw it.
+/**
+ * Update the menu bar according to the selected item and redraw it.
  */
 static void menu_update_menubar(
                const struct Menu *menu,
@@ -233,7 +241,7 @@ static void menu_layout(
                        memcpy_P(&ram_item, item, sizeof(ram_item));
                        item = &ram_item;
                }
-#endif
+#endif /* CPU_HARVARD */
 
                /* Check for end of room */
                if (ypos > bm->cr.ymax)
@@ -293,15 +301,18 @@ static void menu_layout(
        gfx_setClipRect(bm,
                        bm->cr.xmin, old_ymin,
                        bm->cr.xmax, bm->cr.ymax);
-#endif
+
+#endif /* CONFIG_MENU_SMOOTH */
 }
 
 
-/*!
+/**
  * Handle menu item selection
  */
-static void menu_doselect(const struct Menu *menu, struct MenuItem *item)
+static iptr_t menu_doselect(const struct Menu *menu, struct MenuItem *item)
 {
+       iptr_t result = 0;
+
        /* Exclude other items */
        int mask, i;
        for (mask = item->flags & MIF_EXCLUDE_MASK, i = 0; mask; mask >>= 1, ++i)
@@ -311,7 +322,7 @@ static void menu_doselect(const struct Menu *menu, struct MenuItem *item)
        }
 
        if (item->flags & MIF_DISABLED)
-               return;
+               return MENU_DISABLED;
 
        /* Handle checkable items */
        if (item->flags & MIF_TOGGLE)
@@ -322,13 +333,17 @@ static void menu_doselect(const struct Menu *menu, struct MenuItem *item)
        /* Handle items with callback hooks */
        if (item->hook)
        {
-               /* Push a jmp buffer to abort the operation with the STOP key */
+               /* Push a jmp buffer to abort the operation with the STOP/CANCEL key */
                if (!PUSH_ABORT)
                {
-                       item->hook(item->userdata);
+                       result = item->hook(item->userdata);
                        POP_ABORT;
                }
        }
+       else
+               result = item->userdata;
+
+       return result;
 }
 
 
@@ -398,6 +413,7 @@ iptr_t menu_handle(const struct Menu *menu)
        uint8_t items_per_page;
        uint8_t first_item = 0;
        uint8_t selected;
+       iptr_t result = 0;
        bool redraw = true;
 
 #if (CONFIG_MENU_TIMEOUT != 0)
@@ -479,17 +495,21 @@ iptr_t menu_handle(const struct Menu *menu)
                                item = &ram_item;
                        }
 #endif
-                       menu_doselect(menu, item);
+                       result = menu_doselect(menu, item);
                        redraw = true;
 
-                       /* Return userdata as result */
-                       if (!menu->flags & MF_STICKY)
-                       {
-                               /* Store currently selected item before leaving. */
-                               if (menu->flags & MF_SAVESEL)
-                                       CONST_CAST(struct Menu *, menu)->selected = selected;
-                               return item->userdata;
-                       }
+                       /* Return immediately */
+                       if (!(menu->flags & MF_STICKY))
+                               break;
+
+                       #if (CONFIG_MENU_TIMEOUT != 0)
+                               /* Chain timeout */
+                               if ((result == MENU_TIMEOUT) && !(menu->flags & MF_TOPLEVEL))
+                                       break;
+
+                               /* Reset timeout */
+                               menu_idle_time = timer_clock();
+                       #endif
                }
                else if (key & K_UP)
                {
@@ -501,23 +521,33 @@ iptr_t menu_handle(const struct Menu *menu)
                        selected = menu_next_visible_item(menu, selected);
                        redraw = true;
                }
-               else if (((key & K_CANCEL)
+               else if (!(menu->flags & MF_TOPLEVEL))
+               {
+                       if (key & K_CANCEL)
+                       {
+                               result = MENU_CANCEL;
+                               break;
+                       }
+
                        #if CONFIG_MENU_TIMEOUT != 0
-                               || (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
+                               if (now - menu_idle_time > ms_to_ticks(CONFIG_MENU_TIMEOUT))
+                               {
+                                       result = MENU_TIMEOUT;
+                                       break;
+                               }
                        #endif
-                               ) && !(menu->flags & MF_TOPLEVEL)
-               )
-               {
-                       /* Store currently selected item before leaving. */
-                       if (menu->flags & MF_SAVESEL)
-                               CONST_CAST(struct Menu *, menu)->selected = selected;
-                       return 0;
                }
        }
+
+       /* Store currently selected item before leaving. */
+       if (menu->flags & MF_SAVESEL)
+               CONST_CAST(struct Menu *, menu)->selected = selected;
+
+       return result;
 }
 
 
-/*!
+/**
  * Set flags on a menuitem.
  *
  * \param menu  Menu owner of the item to change.
@@ -537,7 +567,7 @@ int menu_setFlags(struct Menu *menu, int idx, int flags)
 }
 
 
-/*!
+/**
  * Clear flags on a menuitem.
  *
  * \param menu  Menu owner of the item to change.