Changeset 59768c7 in mainline for uspace/lib/ui/src

Timestamp:

2022-01-10T19:29:00Z (4 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

5de852c

Parents:

9754ed2

git-author:

Jiri Svoboda <jiri@…> (2022-01-10 19:27:55)

git-committer:

Jiri Svoboda <jiri@…> (2022-01-10 19:29:00)

Message:

Menu control using F10, cursor keys, Enter, Escape

Location:

uspace/lib/ui/src

Files:

• menu.c (modified) (8 diffs)
• menubar.c (modified) (9 diffs)
• menuentry.c (modified) (6 diffs)
• popup.c (modified) (4 diffs)

uspace/lib/ui/src/menu.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2021 Jiri Svoboda
+ * Copyright (c) 2022 Jiri Svoboda
  * All rights reserved.
  *
@@ -47 +47 @@
 #include <ui/popup.h>
 #include <ui/menu.h>
+#include <ui/menubar.h>
 #include <ui/menuentry.h>
 #include <ui/resource.h>
@@ -63 +64 @@
 
 static void ui_menu_popup_close(ui_popup_t *, void *);
+static void ui_menu_popup_kbd(ui_popup_t *, void *, kbd_event_t *);
 static void ui_menu_popup_pos(ui_popup_t *, void *, pos_event_t *);
 
 static ui_popup_cb_t ui_menu_popup_cb = {
         .close = ui_menu_popup_close,
+        .kbd = ui_menu_popup_kbd,
         .pos = ui_menu_popup_pos
 };
@@ -149 +152 @@
 
         link = list_next(&cur->lmenus, &cur->mbar->menus);
+        if (link == NULL)
+                return NULL;
+
+        return list_get_instance(link, ui_menu_t, lmenus);
+}
+
+/** Get last menu in menu bar.
+ *
+ * @param mbar Menu bar
+ * @return Last menu or @c NULL if there is none
+ */
+ui_menu_t *ui_menu_last(ui_menu_bar_t *mbar)
+{
+        link_t *link;
+
+        link = list_last(&mbar->menus);
+        if (link == NULL)
+                return NULL;
+
+        return list_get_instance(link, ui_menu_t, lmenus);
+}
+
+/** Get previous menu in menu bar.
+ *
+ * @param cur Current menu
+ * @return Previous menu or @c NULL if @a cur is the fist one
+ */
+ui_menu_t *ui_menu_prev(ui_menu_t *cur)
+{
+        link_t *link;
+
+        link = list_prev(&cur->lmenus, &cur->mbar->menus);
         if (link == NULL)
                 return NULL;
@@ -240 +275 @@
         errno_t rc;
 
+        /* Select first entry */
+        menu->selected = ui_menu_entry_first(menu);
+
         /* Determine menu dimensions */
 
@@ -269 +307 @@
         ui_popup_destroy(menu->popup);
         menu->popup = NULL;
+}
+
+/** Determine if menu is open.
+ *
+ * @param menu Menu
+ * @return @c true iff menu is open
+ */
+bool ui_menu_is_open(ui_menu_t *menu)
+{
+        return menu->popup != NULL;
 }
 
@@ -439 +487 @@
                 /* Press outside menu - close it */
                 if (event->type == POS_PRESS)
-                        ui_menu_bar_select(menu->mbar, NULL, NULL);
+                        ui_menu_bar_deactivate(menu->mbar);
         }
 
@@ -454 +502 @@
         ui_menu_t *menu = (ui_menu_t *)arg;
 
-        /* Close the menu */
-        ui_menu_bar_select(menu->mbar, NULL, NULL);
+        /* Deactivate menu bar, close menu */
+        ui_menu_bar_deactivate(menu->mbar);
+}
+
+/** Move one entry up.
+ *
+ * Non-selectable entries are skipped. If we are already at the top,
+ * we wrap around.
+ *
+ * @param menu Menu
+ */
+void ui_menu_up(ui_menu_t *menu)
+{
+        gfx_coord2_t mpos;
+        ui_menu_entry_t *nentry;
+
+        if (menu->selected == NULL)
+                return;
+
+        nentry = ui_menu_entry_prev(menu->selected);
+        if (nentry == NULL)
+                nentry = ui_menu_entry_last(menu);
+
+        /* Need to find a selectable entry */
+        while (!ui_menu_entry_selectable(nentry)) {
+                nentry = ui_menu_entry_prev(nentry);
+                if (nentry == NULL)
+                        nentry = ui_menu_entry_last(menu);
+
+                /* Went completely around and found nothing? */
+                if (nentry == menu->selected)
+                        return;
+        }
+
+        menu->selected = nentry;
+
+        mpos.x = 0;
+        mpos.y = 0;
+        (void) ui_menu_paint(menu, &mpos);
+}
+
+/** Move one entry down.
+ *
+ * Non-selectable entries are skipped. If we are already at the bottom,
+ * we wrap around.
+ *
+ * @param menu Menu
+ */
+void ui_menu_down(ui_menu_t *menu)
+{
+        gfx_coord2_t mpos;
+        ui_menu_entry_t *nentry;
+
+        if (menu->selected == NULL)
+                return;
+
+        nentry = ui_menu_entry_next(menu->selected);
+        if (nentry == NULL)
+                nentry = ui_menu_entry_first(menu);
+
+        /* Need to find a selectable entry */
+        while (!ui_menu_entry_selectable(nentry)) {
+                nentry = ui_menu_entry_next(nentry);
+                if (nentry == NULL)
+                        nentry = ui_menu_entry_first(menu);
+
+                /* Went completely around and found nothing? */
+                if (nentry == menu->selected)
+                        return;
+        }
+
+        menu->selected = nentry;
+
+        mpos.x = 0;
+        mpos.y = 0;
+        (void) ui_menu_paint(menu, &mpos);
+}
+
+/** Handle key press without modifiers in menu popup window.
+ *
+ * @param menu Menu
+ * @param event Keyboard event
+ */
+static void ui_menu_key_press_unmod(ui_menu_t *menu, kbd_event_t *event)
+{
+        switch (event->key) {
+        case KC_ESCAPE:
+                ui_menu_bar_deactivate(menu->mbar);
+                break;
+        case KC_LEFT:
+                ui_menu_bar_left(menu->mbar);
+                break;
+        case KC_RIGHT:
+                ui_menu_bar_right(menu->mbar);
+                break;
+        case KC_UP:
+                ui_menu_up(menu);
+                break;
+        case KC_DOWN:
+                ui_menu_down(menu);
+                break;
+        case KC_ENTER:
+                if (menu->selected != NULL)
+                        ui_menu_entry_activate(menu->selected);
+                break;
+        default:
+                break;
+        }
+}
+
+/** Handle keyboard event in menu popup window.
+ *
+ * @param popup Menu popup window
+ * @param arg Argument (ui_menu_t *)
+ * @param event Keyboard event
+ */
+static void ui_menu_popup_kbd(ui_popup_t *popup, void *arg, kbd_event_t *event)
+{
+        ui_menu_t *menu = (ui_menu_t *)arg;
+
+        if (event->type == KEY_PRESS && (event->mods &
+            (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
+                ui_menu_key_press_unmod(menu, event);
+        }
 }
 

uspace/lib/ui/src/menubar.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2021 Jiri Svoboda
+ * Copyright (c) 2022 Jiri Svoboda
  * All rights reserved.
  *
@@ -60 +60 @@
 static void ui_menu_bar_ctl_destroy(void *);
 static errno_t ui_menu_bar_ctl_paint(void *);
+static ui_evclaim_t ui_menu_bar_ctl_kbd_event(void *, kbd_event_t *);
 static ui_evclaim_t ui_menu_bar_ctl_pos_event(void *, pos_event_t *);
 
@@ -66 +67 @@
         .destroy = ui_menu_bar_ctl_destroy,
         .paint = ui_menu_bar_ctl_paint,
-        .pos_event = ui_menu_bar_ctl_pos_event,
+        .kbd_event = ui_menu_bar_ctl_kbd_event,
+        .pos_event = ui_menu_bar_ctl_pos_event
 };
 
@@ -236 +238 @@
  *
  * @param mbar Menu bar
- * @param rect Menu bar entry rectangle
  * @param menu Menu to select (or deselect if selected) or @c NULL
- */
-void ui_menu_bar_select(ui_menu_bar_t *mbar, gfx_rect_t *rect,
-    ui_menu_t *menu)
+ * @param openup Open menu even if not currently open
+ */
+void ui_menu_bar_select(ui_menu_bar_t *mbar, ui_menu_t *menu, bool openup)
 {
         ui_menu_t *old_menu;
+        gfx_rect_t rect;
+        bool was_open;
 
         old_menu = mbar->selected;
@@ -252 +255 @@
 
         /* Close previously open menu */
-        if (old_menu != NULL)
+        if (old_menu != NULL && ui_menu_is_open(old_menu)) {
+                was_open = true;
                 (void) ui_menu_close(old_menu);
+        } else {
+                was_open = false;
+        }
 
         (void) ui_menu_bar_paint(mbar);
 
         if (mbar->selected != NULL) {
-                (void) ui_menu_open(mbar->selected, rect);
-        }
+                ui_menu_bar_entry_rect(mbar, mbar->selected, &rect);
+                if (openup || was_open) {
+                        /*
+                         * Open the newly selected menu if either
+                         * the old menu was open or @a openup was
+                         * specified.
+                         */
+                        (void) ui_menu_open(mbar->selected, &rect);
+                }
+        }
+}
+
+/** Move one entry left.
+ *
+ * If the selected menu is open, the newly selected menu will be open
+ * as well. If we are already at the first entry, we wrap around.
+ *
+ * @param mbar Menu bar
+ */
+void ui_menu_bar_left(ui_menu_bar_t *mbar)
+{
+        ui_menu_t *nmenu;
+
+        if (mbar->selected == NULL)
+                return;
+
+        nmenu = ui_menu_prev(mbar->selected);
+        if (nmenu == NULL)
+                nmenu = ui_menu_last(mbar);
+
+        ui_menu_bar_select(mbar, nmenu, false);
+}
+
+/** Move one entry right.
+ *
+ * If the selected menu is open, the newly selected menu will be open
+ * as well. If we are already at the last entry, we wrap around.
+ *
+ * @param mbar Menu bar
+ */
+void ui_menu_bar_right(ui_menu_bar_t *mbar)
+{
+        ui_menu_t *nmenu;
+
+        if (mbar->selected == NULL)
+                return;
+
+        nmenu = ui_menu_next(mbar->selected);
+        if (nmenu == NULL)
+                nmenu = ui_menu_first(mbar);
+
+        ui_menu_bar_select(mbar, nmenu, false);
+}
+
+/** Handle menu bar key press without modifiers.
+ *
+ * @param mbar Menu bar
+ * @param kbd_event Keyboard event
+ * @return @c ui_claimed iff the event is claimed
+ */
+ui_evclaim_t ui_menu_bar_key_press_unmod(ui_menu_bar_t *mbar, kbd_event_t *event)
+{
+        gfx_rect_t rect;
+
+        if (event->key == KC_F10) {
+                ui_menu_bar_activate(mbar);
+                return ui_claimed;
+        }
+
+        if (!mbar->active)
+                return ui_unclaimed;
+
+        if (event->key == KC_ESCAPE) {
+                ui_menu_bar_deactivate(mbar);
+                return ui_claimed;
+        }
+
+        if (event->key == KC_LEFT)
+                ui_menu_bar_left(mbar);
+
+        if (event->key == KC_RIGHT)
+                ui_menu_bar_right(mbar);
+
+        if (event->key == KC_ENTER || event->key == KC_DOWN) {
+                if (mbar->selected != NULL && !ui_menu_is_open(mbar->selected)) {
+                        ui_menu_bar_entry_rect(mbar, mbar->selected,
+                            &rect);
+                        ui_menu_open(mbar->selected, &rect);
+                }
+
+                return ui_claimed;
+        }
+
+        return ui_claimed;
+}
+
+/** Handle menu bar keyboard event.
+ *
+ * @param mbar Menu bar
+ * @param kbd_event Keyboard event
+ * @return @c ui_claimed iff the event is claimed
+ */
+ui_evclaim_t ui_menu_bar_kbd_event(ui_menu_bar_t *mbar, kbd_event_t *event)
+{
+        if (event->type == KEY_PRESS && (event->mods &
+            (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
+                ui_menu_bar_key_press_unmod(mbar, event);
+                return ui_claimed;
+        }
+
+        return ui_claimed;
 }
 
@@ -304 +420 @@
                 if (event->type == POS_PRESS &&
                     gfx_pix_inside_rect(&ppos, &rect)) {
-                        ui_menu_bar_select(mbar, &rect, menu);
+                        mbar->active = true;
+                        ui_menu_bar_select(mbar, menu, true);
                         return ui_claimed;
                 }
@@ -315 +432 @@
 }
 
+/** Handle menu bar position event.
+ *
+ * @param mbar Menu bar
+ * @param menu Menu whose entry's rectangle is to be returned
+ * @param rrect Place to store entry rectangle
+ */
+void ui_menu_bar_entry_rect(ui_menu_bar_t *mbar, ui_menu_t *menu,
+    gfx_rect_t *rrect)
+{
+        ui_resource_t *res;
+        gfx_coord2_t pos;
+        gfx_rect_t rect;
+        ui_menu_t *cur;
+        const char *caption;
+        gfx_coord_t width;
+        gfx_coord_t hpad;
+
+        res = ui_window_get_res(mbar->window);
+
+        if (res->textmode) {
+                hpad = menubar_hpad_text;
+        } else {
+                hpad = menubar_hpad;
+        }
+
+        pos = mbar->rect.p0;
+
+        cur = ui_menu_first(mbar);
+        while (cur != NULL) {
+                caption = ui_menu_caption(cur);
+                width = gfx_text_width(res->font, caption) + 2 * hpad;
+
+                rect.p0 = pos;
+                rect.p1.x = rect.p0.x + width;
+                rect.p1.y = mbar->rect.p1.y;
+
+                if (cur == menu) {
+                        *rrect = rect;
+                        return;
+                }
+
+                pos.x += width;
+                cur = ui_menu_next(cur);
+        }
+
+        /* We should never get here */
+        assert(false);
+}
+
+/** Activate menu bar.
+ *
+ * @param mbar Menu bar
+ */
+void ui_menu_bar_activate(ui_menu_bar_t *mbar)
+{
+        if (mbar->active)
+                return;
+
+        mbar->active = true;
+        if (mbar->selected == NULL)
+                mbar->selected = ui_menu_first(mbar);
+
+        (void) ui_menu_bar_paint(mbar);
+}
+
+void ui_menu_bar_deactivate(ui_menu_bar_t *mbar)
+{
+        ui_menu_bar_select(mbar, NULL, false);
+        mbar->active = false;
+}
+
 /** Destroy menu bar control.
  *
@@ -338 +526 @@
 }
 
-/** Handle menu bar control position event.
+/** Handle menu bar control keyboard event.
  *
  * @param arg Argument (ui_menu_bar_t *)
@@ -344 +532 @@
  * @return @c ui_claimed iff the event is claimed
  */
+ui_evclaim_t ui_menu_bar_ctl_kbd_event(void *arg, kbd_event_t *event)
+{
+        ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
+
+        return ui_menu_bar_kbd_event(mbar, event);
+}
+
+/** Handle menu bar control position event.
+ *
+ * @param arg Argument (ui_menu_bar_t *)
+ * @param pos_event Position event
+ * @return @c ui_claimed iff the event is claimed
+ */
 ui_evclaim_t ui_menu_bar_ctl_pos_event(void *arg, pos_event_t *event)
 {

uspace/lib/ui/src/menuentry.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2021 Jiri Svoboda
+ * Copyright (c) 2022 Jiri Svoboda
  * All rights reserved.
  *
@@ -45 +45 @@
 #include <ui/control.h>
 #include <ui/paint.h>
+#include <ui/menubar.h>
 #include <ui/menuentry.h>
 #include <ui/window.h>
@@ -177 +178 @@
 }
 
+/** Get last menu entry in menu.
+ *
+ * @param menu Menu
+ * @return Last menu entry or @c NULL if there is none
+ */
+ui_menu_entry_t *ui_menu_entry_last(ui_menu_t *menu)
+{
+        link_t *link;
+
+        link = list_last(&menu->entries);
+        if (link == NULL)
+                return NULL;
+
+        return list_get_instance(link, ui_menu_entry_t, lentries);
+}
+
 /** Get next menu entry in menu.
  *
@@ -187 +204 @@
 
         link = list_next(&cur->lentries, &cur->menu->entries);
+        if (link == NULL)
+                return NULL;
+
+        return list_get_instance(link, ui_menu_entry_t, lentries);
+}
+
+/** Get previous menu entry in menu.
+ *
+ * @param cur Current menu entry
+ * @return Next menu entry or @c NULL if @a cur is the last one
+ */
+ui_menu_entry_t *ui_menu_entry_prev(ui_menu_entry_t *cur)
+{
+        link_t *link;
+
+        link = list_prev(&cur->lentries, &cur->menu->entries);
         if (link == NULL)
                 return NULL;
@@ -378 +411 @@
 }
 
+/** Determine if entry is selectable.
+ *
+ * @return @c true iff entry is selectable
+ */
+bool ui_menu_entry_selectable(ui_menu_entry_t *mentry)
+{
+        return !mentry->separator;
+}
+
 /** Handle button press in menu entry.
  *
@@ -407 +449 @@
         mentry->held = false;
 
-        if (mentry->inside) {
-                /* Close menu */
-                ui_menu_bar_select(mentry->menu->mbar, NULL, NULL);
-
-                /* Call back */
-                ui_menu_entry_cb(mentry);
-        }
+        ui_menu_entry_activate(mentry);
+}
+
+/** Activate menu entry.
+ *
+ * @param mentry Menu entry
+ */
+void ui_menu_entry_activate(ui_menu_entry_t *mentry)
+{
+        /* Deactivate menu bar, close menu */
+        ui_menu_bar_deactivate(mentry->menu->mbar);
+
+        /* Call back */
+        ui_menu_entry_cb(mentry);
 }
 

uspace/lib/ui/src/popup.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2021 Jiri Svoboda
+ * Copyright (c) 2022 Jiri Svoboda
  * All rights reserved.
  *
@@ -36 +36 @@
 #include <errno.h>
 #include <gfx/context.h>
-//#include <io/kbd_event.h>
+#include <io/kbd_event.h>
 #include <io/pos_event.h>
 #include <mem.h>
@@ -47 +47 @@
 
 static void ui_popup_window_close(ui_window_t *, void *);
+static void ui_popup_window_kbd(ui_window_t *, void *, kbd_event_t *);
 static void ui_popup_window_pos(ui_window_t *, void *, pos_event_t *);
 
 static ui_window_cb_t ui_popup_window_cb = {
         .close = ui_popup_window_close,
+        .kbd = ui_popup_window_kbd,
         .pos = ui_popup_window_pos
 };
@@ -200 +202 @@
 }
 
+/** Handle keyboard event in popup window.
+ *
+ * @param window Window
+ * @param arg Argument (ui_popup_t *)
+ * @param event Keyboard event
+ */
+static void ui_popup_window_kbd(ui_window_t *window, void *arg,
+    kbd_event_t *event)
+{
+        ui_popup_t *popup = (ui_popup_t *)arg;
+
+        if (popup->cb != NULL && popup->cb->kbd != NULL)
+                popup->cb->kbd(popup, popup->arg, event);
+}
+
 /** Handle position event in popup window.
  *