1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
|
// license:BSD-3-Clause
// copyright-holders:Nicola Salmoria, Aaron Giles, Nathan Woods
/***************************************************************************
ui/menu.h
Internal MAME menus for the user interface.
***************************************************************************/
#ifndef MAME_FRONTEND_UI_MENU_H
#define MAME_FRONTEND_UI_MENU_H
#pragma once
#include "ui/ui.h"
#include "ui/menuitem.h"
#include "ui/widgets.h"
#include "language.h"
#include "render.h"
#include <functional>
#include <map>
#include <memory>
#include <mutex>
#include <optional>
#include <string_view>
#include <utility>
#include <vector>
namespace ui {
/***************************************************************************
TYPE DEFINITIONS
***************************************************************************/
class menu
{
public:
// flags for menu items
enum : uint32_t
{
FLAG_LEFT_ARROW = 1U << 0,
FLAG_RIGHT_ARROW = 1U << 1,
FLAG_INVERT = 1U << 2,
FLAG_DISABLE = 1U << 4,
FLAG_UI_HEADING = 1U << 5,
FLAG_COLOR_BOX = 1U << 6
};
virtual ~menu();
// setting menu heading
template <typename... T>
void set_heading(T &&... args)
{
if (!m_heading)
m_heading.emplace(std::forward<T>(args)...);
else
m_heading->assign(std::forward<T>(args)...);
}
// append a new item to the end of the menu
void item_append(const std::string &text, uint32_t flags, void *ref, menu_item_type type = menu_item_type::UNKNOWN) { item_append(std::string(text), std::string(), flags, ref, type); }
void item_append(const std::string &text, const std::string &subtext, uint32_t flags, void *ref, menu_item_type type = menu_item_type::UNKNOWN) { item_append(std::string(text), std::string(subtext), flags, ref, type); }
void item_append(std::string &&text, uint32_t flags, void *ref, menu_item_type type = menu_item_type::UNKNOWN) { item_append(text, std::string(), flags, ref, type); }
void item_append(std::string &&text, std::string &&subtext, uint32_t flags, void *ref, menu_item_type type = menu_item_type::UNKNOWN);
void item_append(menu_item item) { item_append(item.text(), item.subtext(), item.flags(), item.ref(), item.type()); }
void item_append(menu_item_type type, uint32_t flags = 0);
void item_append_on_off(const std::string &text, bool state, uint32_t flags, void *ref, menu_item_type type = menu_item_type::UNKNOWN);
// set space required for drawing extra content
void set_custom_space(float top, float bottom);
// reset the menus, clearing everything
static void stack_reset(mame_ui_manager &ui) { get_global_state(ui).stack_reset(); }
// push a new menu onto the stack
template <typename T, typename... Params>
static void stack_push(Params &&... args)
{
stack_push(std::make_unique<T>(std::forward<Params>(args)...));
}
template <typename T, typename... Params>
static void stack_push_special_main(Params &&... args)
{
std::unique_ptr<menu> ptr(std::make_unique<T>(std::forward<Params>(args)...));
ptr->set_special_main_menu(true);
stack_push(std::move(ptr));
}
// pop a menu from the stack
static void stack_pop(mame_ui_manager &ui) { get_global_state(ui).stack_pop(); }
// test if one of the menus in the stack requires hide disable
static bool stack_has_special_main_menu(mame_ui_manager &ui) { return get_global_state(ui).stack_has_special_main_menu(); }
// master handler
static delegate<uint32_t (render_container &)> get_ui_handler(mame_ui_manager &mui);
// Used by sliders
void validate_selection(int scandir);
bool do_handle();
protected:
using bitmap_ptr = widgets_manager::bitmap_ptr;
using texture_ptr = widgets_manager::texture_ptr;
// flags to pass to set_process_flags
enum
{
PROCESS_NOKEYS = 1 << 0,
PROCESS_LR_ALWAYS = 1 << 1,
PROCESS_LR_REPEAT = 1 << 2,
PROCESS_CUSTOM_NAV = 1 << 3,
PROCESS_CUSTOM_ONLY = 1 << 4,
PROCESS_ONLYCHAR = 1 << 5,
PROCESS_NOINPUT = 1 << 6,
PROCESS_IGNOREPAUSE = 1 << 7
};
// options for reset
enum class reset_options
{
SELECT_FIRST,
REMEMBER_POSITION,
REMEMBER_REF
};
// menu-related events
struct event
{
void *itemref; // reference for the selected item or nullptr
menu_item *item; // selected item or nullptr
int iptkey; // one of the IPT_* values from inptport.h
char32_t unichar; // unicode character if iptkey == IPT_SPECIAL
render_bounds mouse; // mouse position if iptkey == IPT_CUSTOM
};
menu(mame_ui_manager &mui, render_container &container);
mame_ui_manager &ui() const { return m_ui; }
running_machine &machine() const { return m_ui.machine(); }
render_container &container() const { return m_container; }
bool is_special_main_menu() const { return m_special_main_menu; }
bool is_one_shot() const { return m_one_shot; }
bool is_active() const { return m_active; }
void set_one_shot(bool oneshot) { m_one_shot = oneshot; }
void set_needs_prev_menu_item(bool needs) { m_needs_prev_menu_item = needs; }
void reset(reset_options options);
void reset_parent(reset_options options) { m_parent->reset(options); }
template <typename T> T *topmost_menu() const { return m_global_state.topmost_menu<T>(); }
template <typename T> static T *topmost_menu(mame_ui_manager &ui) { return get_global_state(ui).topmost_menu<T>(); }
void stack_pop() { m_global_state.stack_pop(); }
void stack_reset() { m_global_state.stack_reset(); }
bool stack_has_special_main_menu() const { return m_global_state.stack_has_special_main_menu(); }
menu_item &item(int index) { return m_items[index]; }
menu_item const &item(int index) const { return m_items[index]; }
int item_count() const { return m_items.size(); }
// retrieves the ref of the currently selected menu item or nullptr
void *get_selection_ref() const { return selection_valid() ? m_items[m_selected].ref() : nullptr; }
menu_item &selected_item() { return m_items[m_selected]; }
menu_item const &selected_item() const { return m_items[m_selected]; }
int selected_index() const { return m_selected; }
bool selection_valid() const { return (0 <= m_selected) && (m_items.size() > m_selected); }
bool is_selected(int index) const { return selection_valid() && (m_selected == index); }
bool is_first_selected() const { return 0 == m_selected; }
bool is_last_selected() const { return (m_items.size() - 1) == m_selected; }
// changes the index of the currently selected menu item
void set_selection(void *selected_itemref);
void set_selected_index(int index) { m_selected = index; }
void select_first_item();
void select_last_item();
int hover() const { return m_hover; }
void set_hover(int index) { m_hover = index; }
void clear_hover() { m_hover = m_items.size() + 1; }
// scroll position control
void set_top_line(int index) { top_line = (0 < index) ? (index - 1) : index; }
void centre_selection() { top_line = m_selected - (m_visible_lines / 2); }
// test if the given key is pressed and we haven't already reported a key
bool exclusive_input_pressed(int &iptkey, int key, int repeat);
// layout
float get_customtop() const { return m_customtop; }
float get_custombottom() const { return m_custombottom; }
float line_height() const { return m_line_height; }
float gutter_width() const { return m_gutter_width; }
float tb_border() const { return m_tb_border; }
float lr_border() const { return m_lr_border; }
float lr_arrow_width() const { return m_lr_arrow_width; }
float ud_arrow_width() const { return m_ud_arrow_width; }
float get_string_width(std::string_view s) { return ui().get_string_width(s, line_height()); }
text_layout create_layout(float width = 1.0, text_layout::text_justify justify = text_layout::text_justify::LEFT, text_layout::word_wrapping wrap = text_layout::word_wrapping::WORD);
void draw_text_normal(
std::string_view text,
float x, float y, float width,
text_layout::text_justify justify, text_layout::word_wrapping wrap,
rgb_t color)
{
ui().draw_text_full(
container(),
text,
x, y, width, justify, wrap,
mame_ui_manager::NORMAL, color, ui().colors().text_bg_color(),
nullptr, nullptr,
line_height());
}
float get_text_width(
std::string_view text,
float x, float y, float width,
text_layout::text_justify justify, text_layout::word_wrapping wrap)
{
float result;
ui().draw_text_full(
container(),
text,
x, y, width, justify, wrap,
mame_ui_manager::NONE, rgb_t::white(), rgb_t::black(),
&result, nullptr,
line_height());
return result;
}
std::pair<float, float> get_text_dimensions(
std::string_view text,
float x, float y, float width,
text_layout::text_justify justify, text_layout::word_wrapping wrap)
{
std::pair<float, float> result;
ui().draw_text_full(
container(),
text,
x, y, width, justify, wrap,
mame_ui_manager::NONE, rgb_t::white(), rgb_t::black(),
&result.first, &result.second,
line_height());
return result;
}
// highlight
void highlight(float x0, float y0, float x1, float y1, rgb_t bgcolor);
render_texture *hilight_main_texture() { return m_global_state.hilight_main_texture(); }
// draw arrow
void draw_arrow(float x0, float y0, float x1, float y1, rgb_t fgcolor, uint32_t orientation);
// draw header and footer text
void extra_text_render(float top, float bottom, float origx1, float origy1, float origx2, float origy2, std::string_view header, std::string_view footer);
void extra_text_position(float origx1, float origx2, float origy, float yspan, text_layout &layout,
int direction, float &x1, float &y1, float &x2, float &y2);
// draw a box of text - used for the custom boxes above/below menus
template <typename Iter>
float draw_text_box(
Iter begin, Iter end,
float origx1, float origx2, float y1, float y2,
ui::text_layout::text_justify justify, ui::text_layout::word_wrapping wrap, bool scale,
rgb_t fgcolor, rgb_t bgcolor, float text_size)
{
// size up the text
float const origwidth(origx2 - origx1 - (2.0f * lr_border()));
float maxwidth(origwidth);
for (Iter it = begin; it != end; ++it)
{
std::string_view const &line(*it);
if (!line.empty())
{
text_layout layout(*ui().get_font(), text_size * m_last_aspect, text_size, 1.0, justify, wrap);
layout.add_text(std::string_view(*it), rgb_t::white(), rgb_t::black());
maxwidth = (std::max)(layout.actual_width(), maxwidth);
}
}
if (scale && (origwidth < maxwidth))
{
text_size *= origwidth / maxwidth;
maxwidth = origwidth;
}
// draw containing box
float const boxleft(0.5f - (maxwidth * 0.5f) - lr_border());
float boxright(0.5f + (maxwidth * 0.5f) + lr_border());
ui().draw_outlined_box(container(), boxleft, y1, boxright, y2, bgcolor);
// inset box and draw content
float const textleft(0.5f - (maxwidth * 0.5f));
y1 += tb_border();
for (Iter it = begin; it != end; ++it)
{
ui().draw_text_full(
container(), std::string_view(*it),
textleft, y1, maxwidth, justify, wrap,
mame_ui_manager::NORMAL, fgcolor, ui().colors().text_bg_color(),
nullptr, nullptr, text_size);
y1 += text_size;
}
// in case you want another box of similar width
return maxwidth;
}
template <typename Iter>
float draw_text_box(
Iter begin, Iter end,
float origx1, float origx2, float y1, float y2,
ui::text_layout::text_justify justify, ui::text_layout::word_wrapping wrap, bool scale,
rgb_t fgcolor, rgb_t bgcolor)
{
return draw_text_box(begin, end, origx1, origx2, y1, y2, justify, wrap, scale, fgcolor, bgcolor, line_height());
}
void draw_background();
// draw additional menu content
virtual void recompute_metrics(uint32_t width, uint32_t height, float aspect);
virtual void custom_render(void *selectedref, float top, float bottom, float x, float y, float x2, float y2);
// map mouse to menu coordinates
void map_mouse();
// clear the mouse position
void ignore_mouse();
bool is_mouse_hit() const { return m_mouse_hit; } // is mouse pointer inside menu's render container?
float get_mouse_x() const { return m_mouse_x; } // mouse x location in menu coordinates
float get_mouse_y() const { return m_mouse_y; } // mouse y location in menu coordinates
// mouse hit test - checks whether mouse_x is in [x0, x1) and mouse_y is in [y0, y1)
bool mouse_in_rect(float x0, float y0, float x1, float y1) const
{
return m_mouse_hit && (m_mouse_x >= x0) && (m_mouse_x < x1) && (m_mouse_y >= y0) && (m_mouse_y < y1);
}
// overridable event handling
void set_process_flags(uint32_t flags) { m_process_flags = flags; }
virtual void handle_events(uint32_t flags, event &ev);
virtual void handle_keys(uint32_t flags, int &iptkey);
virtual bool custom_ui_back() { return false; }
virtual bool custom_mouse_down() { return false; }
virtual bool custom_mouse_scroll(int lines) { return false; }
// event notifications
virtual void menu_activated() { }
virtual void menu_deactivated() { }
virtual void menu_dismissed() { }
static bool is_selectable(menu_item const &item)
{
return (!(item.flags() & menu::FLAG_DISABLE) && (item.type() != menu_item_type::SEPARATOR));
}
// get arrows status
template <typename T>
static uint32_t get_arrow_flags(T min, T max, T actual)
{
return ((actual > min) ? FLAG_LEFT_ARROW : 0) | ((actual < max) ? FLAG_RIGHT_ARROW : 0);
}
private:
class global_state : public widgets_manager
{
public:
global_state(mame_ui_manager &ui);
global_state(global_state const &) = delete;
global_state(global_state &&) = delete;
~global_state();
bitmap_argb32 *bgrnd_bitmap() { return m_bgrnd_bitmap.get(); }
render_texture *bgrnd_texture() { return m_bgrnd_texture.get(); }
template <typename T>
T *topmost_menu() const { return dynamic_cast<T *>(m_stack.get()); }
void stack_push(std::unique_ptr<menu> &&menu);
void stack_pop();
void stack_reset();
void clear_free_list();
bool stack_has_special_main_menu() const;
void hide_menu() { m_hide = true; }
uint32_t ui_handler(render_container &container);
protected:
mame_ui_manager &m_ui;
private:
bitmap_ptr m_bgrnd_bitmap;
texture_ptr m_bgrnd_texture;
std::unique_ptr<menu> m_stack;
std::unique_ptr<menu> m_free;
bool m_hide;
};
// this is to satisfy the std::any requirement that objects be copyable
class global_state_wrapper : public global_state
{
public:
global_state_wrapper(mame_ui_manager &ui) : global_state(ui) { }
global_state_wrapper(global_state_wrapper const &that) : global_state(that.m_ui) { }
};
// process a menu, drawing it and returning any interesting events
std::pair<const event *, bool> process();
virtual void draw(uint32_t flags);
// request the specific handling of the game selection main menu
void set_special_main_menu(bool disable);
// to be implemented in derived classes
virtual void populate() = 0;
// to be implemented in derived classes
virtual bool handle(event const *ev) = 0;
void extra_text_draw_box(float origx1, float origx2, float origy, float yspan, std::string_view text, int direction);
bool first_item_visible() const { return top_line <= 0; }
bool last_item_visible() const { return (top_line + m_visible_lines) >= m_items.size(); }
// push a new menu onto the stack
static void stack_push(std::unique_ptr<menu> &&menu) { menu->m_global_state.stack_push(std::move(menu)); }
static global_state &get_global_state(mame_ui_manager &ui);
protected: // TODO: remove need to expose these - only used here and in selmenu.cpp
int top_line; // main box top line
int m_visible_lines; // main box visible lines
int m_visible_items; // number of visible items
private:
global_state &m_global_state; // reference to global state for session
mame_ui_manager &m_ui; // UI we are attached to
render_container &m_container; // render_container we render to
std::unique_ptr<menu> m_parent; // pointer to parent menu in the stack
std::optional<std::string> m_heading; // menu heading
std::vector<menu_item> m_items; // array of items
bool m_rebuilding; // ensure items are only added during rebuild
std::pair<uint32_t, uint32_t> m_last_size; // pixel size of UI container when metrics were computed
float m_last_aspect; // aspect ratio of UI container when metrics were computed
float m_line_height;
float m_gutter_width;
float m_tb_border;
float m_lr_border;
float m_lr_arrow_width;
float m_ud_arrow_width;
uint32_t m_process_flags; // event processing options
int m_selected; // which item is selected
int m_hover; // which item is being hovered over
bool m_special_main_menu; // true if no real emulation running under the menu
bool m_one_shot; // true for menus outside the normal stack
bool m_needs_prev_menu_item; // true to automatically create item to dismiss menu
bool m_active; // whether the menu is currently visible and topmost
event m_event; // the UI event that occurred
float m_customtop; // amount of extra height to add at the top
float m_custombottom; // amount of extra height to add at the bottom
int m_resetpos; // item index to select after repopulating
void *m_resetref; // item reference value to select after repopulating
bool m_mouse_hit;
bool m_mouse_button;
float m_mouse_x;
float m_mouse_y;
};
template <typename Base = menu>
class autopause_menu : public Base
{
protected:
using Base::Base;
virtual void menu_activated() override
{
m_was_paused = this->machine().paused();
if (m_was_paused)
m_unpaused = false;
else if (!m_unpaused)
this->machine().pause();
Base::menu_activated();
}
virtual void menu_deactivated() override
{
m_unpaused = !this->machine().paused();
if (!m_was_paused && !m_unpaused)
this->machine().resume();
Base::menu_deactivated();
}
private:
bool m_was_paused = false;
bool m_unpaused = false;
};
} // namespace ui
#endif // MAME_FRONTEND_UI_MENU_H
|