source: mainline/uspace/lib/ui/src/menubar.c@ 59768c7

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

Menu control using F10, cursor keys, Enter, Escape
  • Property mode set to 100644
File size: 12.0 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 gfx_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 gfx_text_fmt_init(&fmt);
187 fmt.halign = gfx_halign_left;
188 fmt.valign = gfx_valign_top;
189
190 menu = ui_menu_first(mbar);
191 while (menu != NULL) {
192 caption = ui_menu_caption(menu);
193 width = gfx_text_width(res->font, caption) + 2 * hpad;
194 tpos.x = pos.x + hpad;
195 tpos.y = pos.y + vpad;
196
197 rect.p0 = pos;
198 rect.p1.x = rect.p0.x + width;
199 rect.p1.y = mbar->rect.p1.y;
200
201 if (menu == mbar->selected) {
202 fmt.color = res->wnd_sel_text_color;
203 bg_color = res->wnd_sel_text_bg_color;
204 } else {
205 fmt.color = res->wnd_text_color;
206 bg_color = res->wnd_face_color;
207 }
208
209 rc = gfx_set_color(res->gc, bg_color);
210 if (rc != EOK)
211 goto error;
212
213 rc = gfx_fill_rect(res->gc, &rect);
214 if (rc != EOK)
215 goto error;
216
217 rc = gfx_puttext(res->font, &tpos, &fmt, caption);
218 if (rc != EOK)
219 goto error;
220
221 pos.x += width;
222 menu = ui_menu_next(menu);
223 }
224
225 rc = gfx_update(res->gc);
226 if (rc != EOK)
227 goto error;
228
229 return EOK;
230error:
231 return rc;
232}
233
234/** Select or deselect menu from menu bar.
235 *
236 * Select @a menu. If @a menu is @c NULL or it is already selected,
237 * then select none.
238 *
239 * @param mbar Menu bar
240 * @param menu Menu to select (or deselect if selected) or @c NULL
241 * @param openup Open menu even if not currently open
242 */
243void ui_menu_bar_select(ui_menu_bar_t *mbar, ui_menu_t *menu, bool openup)
244{
245 ui_menu_t *old_menu;
246 gfx_rect_t rect;
247 bool was_open;
248
249 old_menu = mbar->selected;
250
251 if (mbar->selected != menu)
252 mbar->selected = menu;
253 else
254 mbar->selected = NULL;
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 ui_menu_bar_select(mbar, nmenu, false);
298}
299
300/** Move one entry right.
301 *
302 * If the selected menu is open, the newly selected menu will be open
303 * as well. If we are already at the last entry, we wrap around.
304 *
305 * @param mbar Menu bar
306 */
307void ui_menu_bar_right(ui_menu_bar_t *mbar)
308{
309 ui_menu_t *nmenu;
310
311 if (mbar->selected == NULL)
312 return;
313
314 nmenu = ui_menu_next(mbar->selected);
315 if (nmenu == NULL)
316 nmenu = ui_menu_first(mbar);
317
318 ui_menu_bar_select(mbar, nmenu, false);
319}
320
321/** Handle menu bar key press without modifiers.
322 *
323 * @param mbar Menu bar
324 * @param kbd_event Keyboard event
325 * @return @c ui_claimed iff the event is claimed
326 */
327ui_evclaim_t ui_menu_bar_key_press_unmod(ui_menu_bar_t *mbar, kbd_event_t *event)
328{
329 gfx_rect_t rect;
330
331 if (event->key == KC_F10) {
332 ui_menu_bar_activate(mbar);
333 return ui_claimed;
334 }
335
336 if (!mbar->active)
337 return ui_unclaimed;
338
339 if (event->key == KC_ESCAPE) {
340 ui_menu_bar_deactivate(mbar);
341 return ui_claimed;
342 }
343
344 if (event->key == KC_LEFT)
345 ui_menu_bar_left(mbar);
346
347 if (event->key == KC_RIGHT)
348 ui_menu_bar_right(mbar);
349
350 if (event->key == KC_ENTER || event->key == KC_DOWN) {
351 if (mbar->selected != NULL && !ui_menu_is_open(mbar->selected)) {
352 ui_menu_bar_entry_rect(mbar, mbar->selected,
353 &rect);
354 ui_menu_open(mbar->selected, &rect);
355 }
356
357 return ui_claimed;
358 }
359
360 return ui_claimed;
361}
362
363/** Handle menu bar keyboard event.
364 *
365 * @param mbar Menu bar
366 * @param kbd_event Keyboard event
367 * @return @c ui_claimed iff the event is claimed
368 */
369ui_evclaim_t ui_menu_bar_kbd_event(ui_menu_bar_t *mbar, kbd_event_t *event)
370{
371 if (event->type == KEY_PRESS && (event->mods &
372 (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
373 ui_menu_bar_key_press_unmod(mbar, event);
374 return ui_claimed;
375 }
376
377 return ui_claimed;
378}
379
380/** Handle menu bar position event.
381 *
382 * @param mbar Menu bar
383 * @param pos_event Position event
384 * @return @c ui_claimed iff the event is claimed
385 */
386ui_evclaim_t ui_menu_bar_pos_event(ui_menu_bar_t *mbar, pos_event_t *event)
387{
388 ui_resource_t *res;
389 gfx_coord2_t pos;
390 gfx_rect_t rect;
391 ui_menu_t *menu;
392 const char *caption;
393 gfx_coord_t width;
394 gfx_coord_t hpad;
395 gfx_coord2_t ppos;
396
397 res = ui_window_get_res(mbar->window);
398
399 ppos.x = event->hpos;
400 ppos.y = event->vpos;
401
402 if (res->textmode) {
403 hpad = menubar_hpad_text;
404 } else {
405 hpad = menubar_hpad;
406 }
407
408 pos = mbar->rect.p0;
409
410 menu = ui_menu_first(mbar);
411 while (menu != NULL) {
412 caption = ui_menu_caption(menu);
413 width = gfx_text_width(res->font, caption) + 2 * hpad;
414
415 rect.p0 = pos;
416 rect.p1.x = rect.p0.x + width;
417 rect.p1.y = mbar->rect.p1.y;
418
419 /* Check if press is inside menu bar entry */
420 if (event->type == POS_PRESS &&
421 gfx_pix_inside_rect(&ppos, &rect)) {
422 mbar->active = true;
423 ui_menu_bar_select(mbar, menu, true);
424 return ui_claimed;
425 }
426
427 pos.x += width;
428 menu = ui_menu_next(menu);
429 }
430
431 return ui_unclaimed;
432}
433
434/** Handle menu bar position event.
435 *
436 * @param mbar Menu bar
437 * @param menu Menu whose entry's rectangle is to be returned
438 * @param rrect Place to store entry rectangle
439 */
440void ui_menu_bar_entry_rect(ui_menu_bar_t *mbar, ui_menu_t *menu,
441 gfx_rect_t *rrect)
442{
443 ui_resource_t *res;
444 gfx_coord2_t pos;
445 gfx_rect_t rect;
446 ui_menu_t *cur;
447 const char *caption;
448 gfx_coord_t width;
449 gfx_coord_t hpad;
450
451 res = ui_window_get_res(mbar->window);
452
453 if (res->textmode) {
454 hpad = menubar_hpad_text;
455 } else {
456 hpad = menubar_hpad;
457 }
458
459 pos = mbar->rect.p0;
460
461 cur = ui_menu_first(mbar);
462 while (cur != NULL) {
463 caption = ui_menu_caption(cur);
464 width = gfx_text_width(res->font, caption) + 2 * hpad;
465
466 rect.p0 = pos;
467 rect.p1.x = rect.p0.x + width;
468 rect.p1.y = mbar->rect.p1.y;
469
470 if (cur == menu) {
471 *rrect = rect;
472 return;
473 }
474
475 pos.x += width;
476 cur = ui_menu_next(cur);
477 }
478
479 /* We should never get here */
480 assert(false);
481}
482
483/** Activate menu bar.
484 *
485 * @param mbar Menu bar
486 */
487void ui_menu_bar_activate(ui_menu_bar_t *mbar)
488{
489 if (mbar->active)
490 return;
491
492 mbar->active = true;
493 if (mbar->selected == NULL)
494 mbar->selected = ui_menu_first(mbar);
495
496 (void) ui_menu_bar_paint(mbar);
497}
498
499void ui_menu_bar_deactivate(ui_menu_bar_t *mbar)
500{
501 ui_menu_bar_select(mbar, NULL, false);
502 mbar->active = false;
503}
504
505/** Destroy menu bar control.
506 *
507 * @param arg Argument (ui_menu_bar_t *)
508 */
509void ui_menu_bar_ctl_destroy(void *arg)
510{
511 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
512
513 ui_menu_bar_destroy(mbar);
514}
515
516/** Paint menu bar control.
517 *
518 * @param arg Argument (ui_menu_bar_t *)
519 * @return EOK on success or an error code
520 */
521errno_t ui_menu_bar_ctl_paint(void *arg)
522{
523 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
524
525 return ui_menu_bar_paint(mbar);
526}
527
528/** Handle menu bar control keyboard event.
529 *
530 * @param arg Argument (ui_menu_bar_t *)
531 * @param pos_event Position event
532 * @return @c ui_claimed iff the event is claimed
533 */
534ui_evclaim_t ui_menu_bar_ctl_kbd_event(void *arg, kbd_event_t *event)
535{
536 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
537
538 return ui_menu_bar_kbd_event(mbar, event);
539}
540
541/** Handle menu bar control position event.
542 *
543 * @param arg Argument (ui_menu_bar_t *)
544 * @param pos_event Position event
545 * @return @c ui_claimed iff the event is claimed
546 */
547ui_evclaim_t ui_menu_bar_ctl_pos_event(void *arg, pos_event_t *event)
548{
549 ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
550
551 return ui_menu_bar_pos_event(mbar, event);
552}
553
554/** @}
555 */
Note: See TracBrowser for help on using the repository browser.