source: mainline/uspace/lib/ui/src/menubar.c@ 96c6a00

ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 96c6a00 was 96c6a00, checked in by Jiri Svoboda <jiri@…>, 4 years ago

Menu accelerators

Open a menu by pressing F10, then accelerator key (e.g. 'F').
  • Property mode set to 100644
File size: 12.6 KB
Line 
1/*
2 * Copyright (c) 2022 Jiri Svoboda
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libui
30 * @{
31 */
32/**
33 * @file Menu bar
34 */
35
36#include <adt/list.h>
37#include <errno.h>
38#include <gfx/color.h>
39#include <gfx/context.h>
40#include <gfx/render.h>
41#include <gfx/text.h>
42#include <io/pos_event.h>
43#include <stdlib.h>
44#include <str.h>
45#include <ui/control.h>
46#include <ui/paint.h>
47#include <ui/menu.h>
48#include <ui/menubar.h>
49#include <ui/window.h>
50#include "../private/menubar.h"
51#include "../private/resource.h"
52
53enum {
54 menubar_hpad = 4,
55 menubar_vpad = 4,
56 menubar_hpad_text = 1,
57 menubar_vpad_text = 0
58};
59
60static void ui_menu_bar_ctl_destroy(void *);
61static errno_t ui_menu_bar_ctl_paint(void *);
62static ui_evclaim_t ui_menu_bar_ctl_kbd_event(void *, kbd_event_t *);
63static ui_evclaim_t ui_menu_bar_ctl_pos_event(void *, pos_event_t *);
64
65/** Menu bar control ops */
66ui_control_ops_t ui_menu_bar_ops = {
67 .destroy = ui_menu_bar_ctl_destroy,
68 .paint = ui_menu_bar_ctl_paint,
69 .kbd_event = ui_menu_bar_ctl_kbd_event,
70 .pos_event = ui_menu_bar_ctl_pos_event
71};
72
73/** Create new menu bar.
74 *
75 * @param ui UI
76 * @param window Window that will contain the menu bar
77 * @param rmbar Place to store pointer to new menu bar
78 * @return EOK on success, ENOMEM if out of memory
79 */
80errno_t ui_menu_bar_create(ui_t *ui, ui_window_t *window, ui_menu_bar_t **rmbar)
81{
82 ui_menu_bar_t *mbar;
83 errno_t rc;
84
85 mbar = calloc(1, sizeof(ui_menu_bar_t));
86 if (mbar == NULL)
87 return ENOMEM;
88
89 rc = ui_control_new(&ui_menu_bar_ops, (void *) mbar, &mbar->control);
90 if (rc != EOK) {
91 free(mbar);
92 return rc;
93 }
94
95 mbar->ui = ui;
96 mbar->window = window;
97 list_initialize(&mbar->menus);
98 *rmbar = mbar;
99 return EOK;
100}
101
102/** Destroy menu bar
103 *
104 * @param mbar Menu bar or @c NULL
105 */
106void ui_menu_bar_destroy(ui_menu_bar_t *mbar)
107{
108 ui_menu_t *menu;
109
110 if (mbar == NULL)
111 return;
112
113 /* Destroy menus */
114 menu = ui_menu_first(mbar);
115 while (menu != NULL) {
116 ui_menu_destroy(menu);
117 menu = ui_menu_first(mbar);
118 }
119
120 ui_control_delete(mbar->control);
121 free(mbar);
122}
123
124/** Get base control from menu bar.
125 *
126 * @param mbar Menu bar
127 * @return Control
128 */
129ui_control_t *ui_menu_bar_ctl(ui_menu_bar_t *mbar)
130{
131 return mbar->control;
132}
133
134/** Set menu bar rectangle.
135 *
136 * @param mbar Menu bar
137 * @param rect New menu bar rectangle
138 */
139void ui_menu_bar_set_rect(ui_menu_bar_t *mbar, gfx_rect_t *rect)
140{
141 mbar->rect = *rect;
142}
143
144/** Paint menu bar.
145 *
146 * @param mbar Menu bar
147 * @return EOK on success or an error code
148 */
149errno_t ui_menu_bar_paint(ui_menu_bar_t *mbar)
150{
151 ui_resource_t *res;
152 ui_text_fmt_t fmt;
153 gfx_coord2_t pos;
154 gfx_coord2_t tpos;
155 gfx_rect_t rect;
156 gfx_color_t *bg_color;
157 ui_menu_t *menu;
158 const char *caption;
159 gfx_coord_t width;
160 gfx_coord_t hpad;
161 gfx_coord_t vpad;
162 errno_t rc;
163
164 res = ui_window_get_res(mbar->window);
165
166 /* Paint menu bar background */
167
168 rc = gfx_set_color(res->gc, res->wnd_face_color);
169 if (rc != EOK)
170 goto error;
171
172 rc = gfx_fill_rect(res->gc, &mbar->rect);
173 if (rc != EOK)
174 goto error;
175
176 if (res->textmode) {
177 hpad = menubar_hpad_text;
178 vpad = menubar_vpad_text;
179 } else {
180 hpad = menubar_hpad;
181 vpad = menubar_vpad;
182 }
183
184 pos = mbar->rect.p0;
185
186 ui_text_fmt_init(&fmt);
187 fmt.font = res->font;
188 fmt.halign = gfx_halign_left;
189 fmt.valign = gfx_valign_top;
190
191 menu = ui_menu_first(mbar);
192 while (menu != NULL) {
193 caption = ui_menu_caption(menu);
194 width = ui_text_width(res->font, caption) + 2 * hpad;
195 tpos.x = pos.x + hpad;
196 tpos.y = pos.y + vpad;
197
198 rect.p0 = pos;
199 rect.p1.x = rect.p0.x + width;
200 rect.p1.y = mbar->rect.p1.y;
201
202 if (menu == mbar->selected) {
203 fmt.color = res->wnd_sel_text_color;
204 fmt.hgl_color = res->wnd_sel_text_hgl_color;
205 bg_color = res->wnd_sel_text_bg_color;
206 } else {
207 fmt.color = res->wnd_text_color;
208 fmt.hgl_color = res->wnd_text_hgl_color;
209 bg_color = res->wnd_face_color;
210 }
211
212 rc = gfx_set_color(res->gc, bg_color);
213 if (rc != EOK)
214 goto error;
215
216 rc = gfx_fill_rect(res->gc, &rect);
217 if (rc != EOK)
218 goto error;
219
220 rc = ui_paint_text(&tpos, &fmt, caption);
221 if (rc != EOK)
222 goto error;
223
224 pos.x += width;
225 menu = ui_menu_next(menu);
226 }
227
228 rc = gfx_update(res->gc);
229 if (rc != EOK)
230 goto error;
231
232 return EOK;
233error:
234 return rc;
235}
236
237/** Select or deselect menu from menu bar.
238 *
239 * Select @a menu. If @a menu is @c NULL or it is already selected,
240 * then select none.
241 *
242 * @param mbar Menu bar
243 * @param menu Menu to select (or deselect if selected) or @c NULL
244 * @param openup Open menu even if not currently open
245 */
246void ui_menu_bar_select(ui_menu_bar_t *mbar, ui_menu_t *menu, bool openup)
247{
248 ui_menu_t *old_menu;
249 gfx_rect_t rect;
250 bool was_open;
251
252 old_menu = mbar->selected;
253
254 mbar->selected = menu;
255
256 /* Close previously open menu */
257 if (old_menu != NULL && ui_menu_is_open(old_menu)) {
258 was_open = true;
259 (void) ui_menu_close(old_menu);
260 } else {
261 was_open = false;
262 }
263
264 (void) ui_menu_bar_paint(mbar);
265
266 if (mbar->selected != NULL) {
267 ui_menu_bar_entry_rect(mbar, mbar->selected, &rect);
268 if (openup || was_open) {
269 /*
270 * Open the newly selected menu if either
271 * the old menu was open or @a openup was
272 * specified.
273 */
274 (void) ui_menu_open(mbar->selected, &rect);
275 }
276 }
277}
278
279/** Move one entry left.
280 *
281 * If the selected menu is open, the newly selected menu will be open
282 * as well. If we are already at the first entry, we wrap around.
283 *
284 * @param mbar Menu bar
285 */
286void ui_menu_bar_left(ui_menu_bar_t *mbar)
287{
288 ui_menu_t *nmenu;
289
290 if (mbar->selected == NULL)
291 return;
292
293 nmenu = ui_menu_prev(mbar->selected);
294 if (nmenu == NULL)
295 nmenu = ui_menu_last(mbar);
296
297 if (nmenu != mbar->selected)
298 ui_menu_bar_select(mbar, nmenu, false);
299}
300
301/** Move one entry right.
302 *
303 * If the selected menu is open, the newly selected menu will be open
304 * as well. If we are already at the last entry, we wrap around.
305 *
306 * @param mbar Menu bar
307 */
308void ui_menu_bar_right(ui_menu_bar_t *mbar)
309{
310 ui_menu_t *nmenu;
311
312 if (mbar->selected == NULL)
313 return;
314
315 nmenu = ui_menu_next(mbar->selected);
316 if (nmenu == NULL)
317 nmenu = ui_menu_first(mbar);
318
319 if (nmenu != mbar->selected)
320 ui_menu_bar_select(mbar, nmenu, false);
321}
322
323/** Handle menu bar key press without modifiers.
324 *
325 * @param mbar Menu bar
326 * @param kbd_event Keyboard event
327 * @return @c ui_claimed iff the event is claimed
328 */
329ui_evclaim_t ui_menu_bar_key_press_unmod(ui_menu_bar_t *mbar, kbd_event_t *event)
330{
331 gfx_rect_t rect;
332 ui_menu_t *menu;
333 char32_t maccel;
334
335 if (event->key == KC_F10) {
336 ui_menu_bar_activate(mbar);
337 return ui_claimed;
338 }
339
340 if (!mbar->active)
341 return ui_unclaimed;
342
343 if (event->key == KC_ESCAPE) {
344 ui_menu_bar_deactivate(mbar);
345 return ui_claimed;
346 }
347
348 if (event->key == KC_LEFT)
349 ui_menu_bar_left(mbar);
350
351 if (event->key == KC_RIGHT)
352 ui_menu_bar_right(mbar);
353
354 if (event->key == KC_ENTER || event->key == KC_DOWN) {
355 if (mbar->selected != NULL && !ui_menu_is_open(mbar->selected)) {
356 ui_menu_bar_entry_rect(mbar, mbar->selected,
357 &rect);
358 ui_menu_open(mbar->selected, &rect);
359 }
360
361 return ui_claimed;
362 }
363
364 if (event->c != '\0' && !ui_menu_is_open(mbar->selected)) {
365 /* Check if it is an accelerator. */
366
367 menu = ui_menu_first(mbar);
368 while (menu != NULL) {
369 maccel = ui_menu_get_accel(menu);
370 if (event->c == maccel) {
371 ui_menu_bar_select(mbar, menu, true);
372 return ui_claimed;
373 }
374
375 menu = ui_menu_next(menu);
376 }
377 }
378
379 return ui_claimed;
380}
381
382/** Handle menu bar keyboard event.
383 *
384 * @param mbar Menu bar
385 * @param kbd_event Keyboard event
386 * @return @c ui_claimed iff the event is claimed
387 */
388ui_evclaim_t ui_menu_bar_kbd_event(ui_menu_bar_t *mbar, kbd_event_t *event)
389{
390 if (event->type == KEY_PRESS && (event->mods &
391 (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
392 return ui_menu_bar_key_press_unmod(mbar, event);
393 }
394
395 if (mbar->active)
396 return ui_claimed;
397
398 return ui_unclaimed;
399}
400
401/** Handle menu bar position event.
402 *
403 * @param mbar Menu bar
404 * @param pos_event Position event
405 * @return @c ui_claimed iff the event is claimed
406 */
407ui_evclaim_t ui_menu_bar_pos_event(ui_menu_bar_t *mbar, pos_event_t *event)
408{
409 ui_resource_t *res;
410 gfx_coord2_t pos;
411 gfx_rect_t rect;
412 ui_menu_t *menu;
413 const char *caption;
414 gfx_coord_t width;
415 gfx_coord_t hpad;
416 gfx_coord2_t ppos;
417
418 res = ui_window_get_res(mbar->window);
419
420 ppos.x = event->hpos;
421 ppos.y = event->vpos;
422
423 if (res->textmode) {
424 hpad = menubar_hpad_text;
425 } else {
426 hpad = menubar_hpad;
427 }
428
429 pos = mbar->rect.p0;
430
431 menu = ui_menu_first(mbar);
432 while (menu != NULL) {
433 caption = ui_menu_caption(menu);
434 width = ui_text_width(res->font, caption) + 2 * hpad;
435
436 rect.p0 = pos;
437 rect.p1.x = rect.p0.x + width;
438 rect.p1.y = mbar->rect.p1.y;
439
440 /* Check if press is inside menu bar entry */
441 if (event->type == POS_PRESS &&
442 gfx_pix_inside_rect(&ppos, &rect)) {
443 mbar->active = true;
444
445 /* Open the menu, close if already open. */
446 if (menu == mbar->selected)
447 ui_menu_bar_select(mbar, NULL, false);
448 else
449 ui_menu_bar_select(mbar, menu, true);
450
451 return ui_claimed;
452 }
453
454 pos.x += width;
455 menu = ui_menu_next(menu);
456 }
457
458 return ui_unclaimed;
459}
460
461/** Handle menu bar position event.
462 *
463 * @param mbar Menu bar
464 * @param menu Menu whose entry's rectangle is to be returned
465 * @param rrect Place to store entry rectangle
466 */
467void ui_menu_bar_entry_rect(ui_menu_bar_t *mbar, ui_menu_t *menu,
468 gfx_rect_t *rrect)
469{
470 ui_resource_t *res;
471 gfx_coord2_t pos;
472 gfx_rect_t rect;
473 ui_menu_t *cur;
474 const char *caption;
475 gfx_coord_t width;
476 gfx_coord_t hpad;
477
478 res = ui_window_get_res(mbar->window);
479
480 if (res->textmode) {
481 hpad = menubar_hpad_text;
482 } else {
483 hpad = menubar_hpad;
484 }
485
486 pos = mbar->rect.p0;
487
488 cur = ui_menu_first(mbar);
489 while (cur != NULL) {
490 caption = ui_menu_caption(cur);
491 width = ui_text_width(res->font, caption) + 2 * hpad;
492
493 rect.p0 = pos;
494 rect.p1.x = rect.p0.x + width;
495 rect.p1.y = mbar->rect.p1.y;
496
497 if (cur == menu) {
498 *rrect = rect;
499 return;
500 }
501
502 pos.x += width;
503 cur = ui_menu_next(cur);
504 }
505
506 /* We should never get here */
507 assert(false);
508}
509
510/** Activate menu bar.
511 *
512 * @param mbar Menu bar
513 */
514void ui_menu_bar_activate(ui_menu_bar_t *mbar)
515{
516 if (mbar->active)
517 return;
518
519 mbar->active = true;
520 if (mbar->selected == NULL)
521 mbar->selected = ui_menu_first(mbar);
522
523 (void) ui_menu_bar_paint(mbar);
524}
525
526void ui_menu_bar_deactivate(ui_menu_bar_t *mbar)
527{
528 ui_menu_bar_select(mbar, NULL, false);
529 mbar->active = false;
530}
531
532/** Destroy menu bar control.
533 *
534 * @param arg Argument (ui_menu_bar_t *)
535 */
536void ui_menu_bar_ctl_destroy(void *arg)
537{
538 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
539
540 ui_menu_bar_destroy(mbar);
541}
542
543/** Paint menu bar control.
544 *
545 * @param arg Argument (ui_menu_bar_t *)
546 * @return EOK on success or an error code
547 */
548errno_t ui_menu_bar_ctl_paint(void *arg)
549{
550 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
551
552 return ui_menu_bar_paint(mbar);
553}
554
555/** Handle menu bar control keyboard event.
556 *
557 * @param arg Argument (ui_menu_bar_t *)
558 * @param pos_event Position event
559 * @return @c ui_claimed iff the event is claimed
560 */
561ui_evclaim_t ui_menu_bar_ctl_kbd_event(void *arg, kbd_event_t *event)
562{
563 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
564
565 return ui_menu_bar_kbd_event(mbar, event);
566}
567
568/** Handle menu bar control position event.
569 *
570 * @param arg Argument (ui_menu_bar_t *)
571 * @param pos_event Position event
572 * @return @c ui_claimed iff the event is claimed
573 */
574ui_evclaim_t ui_menu_bar_ctl_pos_event(void *arg, pos_event_t *event)
575{
576 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
577
578 return ui_menu_bar_pos_event(mbar, event);
579}
580
581/** @}
582 */
Note: See TracBrowser for help on using the repository browser.