openMSX
ImGuiSettings.cc
Go to the documentation of this file.
1#include "ImGuiSettings.hh"
2
3#include "ImGuiCpp.hh"
4#include "ImGuiManager.hh"
5#include "ImGuiMessages.hh"
6#include "ImGuiOsdIcons.hh"
7#include "ImGuiSoundChip.hh"
8#include "ImGuiUtils.hh"
9
10#include "BooleanInput.hh"
11#include "BooleanSetting.hh"
12#include "CPUCore.hh"
13#include "Display.hh"
14#include "EventDistributor.hh"
15#include "FileContext.hh"
16#include "FilenameSetting.hh"
17#include "FloatSetting.hh"
19#include "GlobalSettings.hh"
20#include "InputEventFactory.hh"
22#include "IntegerSetting.hh"
23#include "JoyMega.hh"
24#include "KeyCodeSetting.hh"
25#include "KeyboardSettings.hh"
26#include "Mixer.hh"
27#include "MSXCPU.hh"
29#include "MSXJoystick.hh"
30#include "MSXMotherBoard.hh"
31#include "ProxySetting.hh"
32#include "R800.hh"
33#include "Reactor.hh"
34#include "ReadOnlySetting.hh"
35#include "SettingsManager.hh"
36#include "StringSetting.hh"
37#include "Version.hh"
38#include "VideoSourceSetting.hh"
39#include "Z80.hh"
40
41#include "checked_cast.hh"
42#include "foreach_file.hh"
43#include "narrow.hh"
44#include "StringOp.hh"
45#include "unreachable.hh"
46#include "zstring_view.hh"
47
48#include <imgui.h>
49#include <imgui_stdlib.h>
50
51#include <SDL.h>
52
53#include <optional>
54
55using namespace std::literals;
56
57namespace openmsx {
58
60{
61 deinitListener();
62}
63
64void ImGuiSettings::save(ImGuiTextBuffer& buf)
65{
66 savePersistent(buf, *this, persistentElements);
67}
68
69void ImGuiSettings::loadLine(std::string_view name, zstring_view value)
70{
71 loadOnePersistent(name, value, *this, persistentElements);
72}
73
75{
76 setStyle();
77}
78
79void ImGuiSettings::setStyle() const
80{
81 switch (selectedStyle) {
82 case 0: ImGui::StyleColorsDark(); break;
83 case 1: ImGui::StyleColorsLight(); break;
84 case 2: ImGui::StyleColorsClassic(); break;
85 }
86 setColors(selectedStyle);
87}
88
89// Returns the currently pressed key-chord, or 'ImGuiKey_None' if no
90// (non-modifier) key is pressed.
91// If more than (non-modifier) one key is pressed, this returns an arbitrary key
92// (in the current implementation the one with lowest index).
93[[nodiscard]] static ImGuiKeyChord getCurrentlyPressedKeyChord()
94{
95 static constexpr auto mods = std::array{
96 ImGuiKey_LeftCtrl, ImGuiKey_LeftShift, ImGuiKey_LeftAlt, ImGuiKey_LeftSuper,
97 ImGuiKey_RightCtrl, ImGuiKey_RightShift, ImGuiKey_RightAlt, ImGuiKey_RightSuper,
98 ImGuiKey_ReservedForModCtrl, ImGuiKey_ReservedForModShift, ImGuiKey_ReservedForModAlt,
99 ImGuiKey_ReservedForModSuper, ImGuiKey_MouseLeft, ImGuiKey_MouseRight, ImGuiKey_MouseMiddle,
100 ImGuiKey_MouseX1, ImGuiKey_MouseX2, ImGuiKey_MouseWheelX, ImGuiKey_MouseWheelY,
101 };
102 for (int key = ImGuiKey_NamedKey_BEGIN; key < ImGuiKey_NamedKey_END; ++key) {
103 // This is O(M*N), if needed could be optimized to be O(M+N).
104 if (contains(mods, key)) continue; // skip: mods can't be primary keys in a KeyChord
105 if (ImGui::IsKeyPressed(static_cast<ImGuiKey>(key))) {
106 const ImGuiIO& io = ImGui::GetIO();
107 return key
108 | (io.KeyCtrl ? ImGuiMod_Ctrl : 0)
109 | (io.KeyShift ? ImGuiMod_Shift : 0)
110 | (io.KeyAlt ? ImGuiMod_Alt : 0)
111 | (io.KeySuper ? ImGuiMod_Super : 0);
112 }
113 }
114 return ImGuiKey_None;
115}
116
118{
119 bool openConfirmPopup = false;
120
121 im::Menu("Settings", [&]{
122 auto& reactor = manager.getReactor();
123 auto& globalSettings = reactor.getGlobalSettings();
124 auto& renderSettings = reactor.getDisplay().getRenderSettings();
125 const auto& settingsManager = reactor.getGlobalCommandController().getSettingsManager();
126 const auto& hotKey = reactor.getHotKey();
127
128 im::Menu("Video", [&]{
129 im::TreeNode("Look and feel", ImGuiTreeNodeFlags_DefaultOpen, [&]{
130 auto& scaler = renderSettings.getScaleAlgorithmSetting();
131 ComboBox("Scaler", scaler);
132 im::Indent([&]{
133 struct AlgoEnable {
135 bool hasScanline;
136 bool hasBlur;
137 };
139 static constexpr std::array algoEnables = {
140 // scanline / blur
141 AlgoEnable{SIMPLE, true, true },
142 AlgoEnable{SCALE, false, false},
143 AlgoEnable{HQ, false, false},
144 AlgoEnable{RGBTRIPLET, true, true },
145 AlgoEnable{TV, true, false},
146 };
147 auto it = ranges::find(algoEnables, scaler.getEnum(), &AlgoEnable::algo);
148 assert(it != algoEnables.end());
149 im::Disabled(!it->hasScanline, [&]{
150 SliderInt("Scanline (%)", renderSettings.getScanlineSetting());
151 });
152 im::Disabled(!it->hasBlur, [&]{
153 SliderInt("Blur (%)", renderSettings.getBlurSetting());
154 });
155 });
156
157 SliderInt("Scale factor", renderSettings.getScaleFactorSetting());
158 Checkbox(hotKey, "Deinterlace", renderSettings.getDeinterlaceSetting());
159 Checkbox(hotKey, "Deflicker", renderSettings.getDeflickerSetting());
160 });
161 im::TreeNode("Colors", ImGuiTreeNodeFlags_DefaultOpen, [&]{
162 SliderFloat("Noise (%)", renderSettings.getNoiseSetting());
163 SliderFloat("Brightness", renderSettings.getBrightnessSetting());
164 SliderFloat("Contrast", renderSettings.getContrastSetting());
165 SliderFloat("Gamma", renderSettings.getGammaSetting());
166 SliderInt("Glow (%)", renderSettings.getGlowSetting());
167 if (auto* monitor = dynamic_cast<Setting*>(settingsManager.findSetting("monitor_type"))) {
168 ComboBox("Monitor type", *monitor, [](std::string s) {
169 ranges::replace(s, '_', ' ');
170 return s;
171 });
172 }
173 });
174 im::TreeNode("Shape", ImGuiTreeNodeFlags_DefaultOpen, [&]{
175 SliderFloat("Horizontal stretch", renderSettings.getHorizontalStretchSetting(), "%.0f");
176 ComboBox("Display deformation", renderSettings.getDisplayDeformSetting());
177 });
178 im::TreeNode("Misc", ImGuiTreeNodeFlags_DefaultOpen, [&]{
179 Checkbox(hotKey, "Full screen", renderSettings.getFullScreenSetting());
180 if (motherBoard) {
181 ComboBox("Video source to display", motherBoard->getVideoSource());
182 }
183 Checkbox(hotKey, "VSync", renderSettings.getVSyncSetting());
184 SliderInt("Minimum frame-skip", renderSettings.getMinFrameSkipSetting()); // TODO: either leave out this setting, or add a tooltip like, "Leave on 0 unless you use a very slow device and want regular frame skipping");
185 SliderInt("Maximum frame-skip", renderSettings.getMaxFrameSkipSetting()); // TODO: either leave out this setting or add a tooltip like "On slow devices, skip no more than this amount of frames to keep emulation on time.");
186 });
187 im::TreeNode("Advanced (for debugging)", [&]{ // default collapsed
188 Checkbox(hotKey, "Enforce VDP sprites-per-line limit", renderSettings.getLimitSpritesSetting());
189 Checkbox(hotKey, "Disable sprites", renderSettings.getDisableSpritesSetting());
190 ComboBox("Way to handle too fast VDP access", renderSettings.getTooFastAccessSetting());
191 ComboBox("Emulate VDP command timing", renderSettings.getCmdTimingSetting());
192 ComboBox("Rendering accuracy", renderSettings.getAccuracySetting());
193 });
194 });
195 im::Menu("Sound", [&]{
196 auto& mixer = reactor.getMixer();
197 auto& muteSetting = mixer.getMuteSetting();
198 im::Disabled(muteSetting.getBoolean(), [&]{
199 SliderInt("Master volume", mixer.getMasterVolume());
200 });
201 Checkbox(hotKey, "Mute", muteSetting);
202 ImGui::Separator();
203 static constexpr std::array resamplerToolTips = {
204 EnumToolTip{"hq", "best quality, uses more CPU"},
205 EnumToolTip{"blip", "good speed/quality tradeoff"},
206 EnumToolTip{"fast", "fast but low quality"},
207 };
208 ComboBox("Resampler", globalSettings.getResampleSetting(), resamplerToolTips);
209 ImGui::Separator();
210
211 ImGui::MenuItem("Show sound chip settings", nullptr, &manager.soundChip->showSoundChipSettings);
212 });
213 im::Menu("Speed", [&]{
214 im::TreeNode("Emulation", ImGuiTreeNodeFlags_DefaultOpen, [&]{
215 ImGui::SameLine();
216 HelpMarker("These control the speed of the whole MSX machine, "
217 "the running MSX software can't tell the difference.");
218
219 auto& speedManager = globalSettings.getSpeedManager();
220 auto& fwdSetting = speedManager.getFastForwardSetting();
221 int fastForward = fwdSetting.getBoolean() ? 1 : 0;
222 ImGui::TextUnformatted("Speed:"sv);
223 ImGui::SameLine();
224 bool fwdChanged = ImGui::RadioButton("normal", &fastForward, 0);
225 ImGui::SameLine();
226 fwdChanged |= ImGui::RadioButton("fast forward", &fastForward, 1);
227 if (auto fastForwardShortCut = getShortCutForCommand(reactor.getHotKey(), "toggle fastforward");
228 !fastForwardShortCut.empty()) {
229 HelpMarker(strCat("Use '", fastForwardShortCut ,"' to quickly toggle between these two"));
230 }
231 if (fwdChanged) {
232 fwdSetting.setBoolean(fastForward != 0);
233 }
234 im::Indent([&]{
235 im::Disabled(fastForward != 0, [&]{
236 SliderFloat("Speed (%)", speedManager.getSpeedSetting(), "%.1f", ImGuiSliderFlags_Logarithmic);
237 });
238 im::Disabled(fastForward != 1, [&]{
239 SliderFloat("Fast forward speed (%)", speedManager.getFastForwardSpeedSetting(), "%.1f", ImGuiSliderFlags_Logarithmic);
240 });
241 });
242 Checkbox(hotKey, "Go full speed when loading", globalSettings.getThrottleManager().getFullSpeedLoadingSetting());
243 });
244 if (motherBoard) {
245 im::TreeNode("MSX devices", ImGuiTreeNodeFlags_DefaultOpen, [&]{
246 ImGui::SameLine();
247 HelpMarker("These control the speed of the specific components in the MSX machine. "
248 "So the relative speed between components can change. "
249 "And this may lead the emulation problems.");
250
251 MSXCPU& cpu = motherBoard->getCPU();
252 auto showFreqSettings = [&](std::string_view name, auto* core) {
253 if (!core) return;
254 auto& locked = core->getFreqLockedSetting();
255 auto& value = core->getFreqValueSetting();
256 // Note: GUI shows "UNlocked", while the actual settings is "locked"
257 bool unlocked = !locked.getBoolean();
258 if (ImGui::Checkbox(tmpStrCat("unlock custom ", name, " frequency").c_str(), &unlocked)) {
259 locked.setBoolean(!unlocked);
260 }
261 simpleToolTip([&]{ return locked.getDescription(); });
262 im::Indent([&]{
263 im::Disabled(!unlocked, [&]{
264 float fval = float(value.getInt()) / 1.0e6f;
265 if (ImGui::InputFloat(tmpStrCat("frequency (MHz)##", name).c_str(), &fval, 0.01f, 1.0f, "%.2f")) {
266 value.setInt(int(fval * 1.0e6f));
267 }
268 im::PopupContextItem(tmpStrCat("freq-context##", name).c_str(), [&]{
269 const char* F358 = name == "Z80" ? "3.58 MHz (default)"
270 : "3.58 MHz";
271 if (ImGui::Selectable(F358)) {
272 value.setInt(3'579'545);
273 }
274 if (ImGui::Selectable("5.37 MHz")) {
275 value.setInt(5'369'318);
276 }
277 const char* F716 = name == "R800" ? "7.16 MHz (default)"
278 : "7.16 MHz";
279 if (ImGui::Selectable(F716)) {
280 value.setInt(7'159'090);
281 }
282
283 });
284 HelpMarker("Right-click to select commonly used values");
285 });
286 });
287 };
288 showFreqSettings("Z80", cpu.getZ80());
289 showFreqSettings("R800", cpu.getR800()); // might be nullptr
290 });
291 }
292 });
293 im::Menu("Input", [&]{
294 static constexpr std::array kbdModeToolTips = {
295 EnumToolTip{"CHARACTER", "Tries to understand the character you are typing and then attempts to type that character using the current MSX keyboard. May not work very well when using a non-US host keyboard."},
296 EnumToolTip{"KEY", "Tries to map a key you press to the corresponding MSX key"},
297 EnumToolTip{"POSITIONAL", "Tries to map the keyboard key positions to the MSX keyboard key positions"},
298 };
299 if (motherBoard) {
300 const auto& controller = motherBoard->getMSXCommandController();
301 if (auto* turbo = dynamic_cast<IntegerSetting*>(controller.findSetting("renshaturbo"))) {
302 SliderInt("Ren Sha Turbo (%)", *turbo);
303 }
304 if (auto* mappingModeSetting = dynamic_cast<EnumSetting<KeyboardSettings::MappingMode>*>(controller.findSetting("kbd_mapping_mode"))) {
305 ComboBox("Keyboard mapping mode", *mappingModeSetting, kbdModeToolTips);
306 }
307 }
308 ImGui::MenuItem("Configure MSX joysticks...", nullptr, &showConfigureJoystick);
309 });
310 im::Menu("GUI", [&]{
311 auto getExistingLayouts = [] {
312 std::vector<std::string> names;
313 for (auto context = userDataFileContext("layouts");
314 const auto& path : context.getPaths()) {
315 foreach_file(path, [&](const std::string& fullName, std::string_view name) {
316 if (name.ends_with(".ini")) {
317 names.emplace_back(fullName);
318 }
319 });
320 }
322 return names;
323 };
324 auto listExistingLayouts = [&](const std::vector<std::string>& names) {
325 std::optional<std::pair<std::string, std::string>> selectedLayout;
326 im::ListBox("##select-layout", [&]{
327 for (const auto& name : names) {
328 auto displayName = std::string(FileOperations::stripExtension(FileOperations::getFilename(name)));
329 if (ImGui::Selectable(displayName.c_str())) {
330 selectedLayout = std::pair{name, displayName};
331 }
333 if (ImGui::MenuItem("delete")) {
334 confirmText = strCat("Delete layout: ", displayName);
335 confirmAction = [name]{ FileOperations::unlink(name); };
336 openConfirmPopup = true;
337 }
338 });
339 }
340 });
341 return selectedLayout;
342 };
343 im::Menu("Save layout", [&]{
344 if (auto names = getExistingLayouts(); !names.empty()) {
345 ImGui::TextUnformatted("Existing layouts"sv);
346 if (auto selectedLayout = listExistingLayouts(names)) {
347 const auto& [name, displayName] = *selectedLayout;
348 saveLayoutName = displayName;
349 }
350 }
351 ImGui::TextUnformatted("Enter name:"sv);
352 ImGui::InputText("##save-layout-name", &saveLayoutName);
353 ImGui::SameLine();
354 im::Disabled(saveLayoutName.empty(), [&]{
355 if (ImGui::Button("Save as")) {
356 (void)reactor.getDisplay().getWindowPosition(); // to save up-to-date window position
357 ImGui::CloseCurrentPopup();
358
359 auto filename = FileOperations::parseCommandFileArgument(
360 saveLayoutName, "layouts", "", ".ini");
361 if (FileOperations::exists(filename)) {
362 confirmText = strCat("Overwrite layout: ", saveLayoutName);
363 confirmAction = [filename]{
364 ImGui::SaveIniSettingsToDisk(filename.c_str());
365 };
366 openConfirmPopup = true;
367 } else {
368 ImGui::SaveIniSettingsToDisk(filename.c_str());
369 }
370 }
371 });
372 });
373 im::Menu("Restore layout", [&]{
374 ImGui::TextUnformatted("Select layout"sv);
375 auto names = getExistingLayouts();
376 if (auto selectedLayout = listExistingLayouts(names)) {
377 const auto& [name, displayName] = *selectedLayout;
378 manager.loadIniFile = name;
379 ImGui::CloseCurrentPopup();
380 }
381 });
382 im::Menu("Select style", [&]{
383 std::optional<int> newStyle;
384 static constexpr std::array names = {"Dark", "Light", "Classic"}; // must be in sync with setStyle()
385 for (auto i : xrange(narrow<int>(names.size()))) {
386 if (ImGui::Selectable(names[i], selectedStyle == i)) {
387 newStyle = i;
388 }
389 }
390 if (newStyle) {
391 selectedStyle = *newStyle;
392 setStyle();
393 }
394 });
395 ImGui::MenuItem("Select font...", nullptr, &showFont);
396 ImGui::MenuItem("Edit shortcuts...", nullptr, &showShortcut);
397 });
398 im::Menu("Misc", [&]{
399 ImGui::MenuItem("Configure OSD icons...", nullptr, &manager.osdIcons->showConfigureIcons);
400 ImGui::MenuItem("Fade out menu bar", nullptr, &manager.menuFade);
401 ImGui::MenuItem("Show status bar", nullptr, &manager.statusBarVisible);
402 ImGui::MenuItem("Configure messages...", nullptr, &manager.messages->configureWindow.open);
403 });
404 ImGui::Separator();
405 im::Menu("Advanced", [&]{
406 ImGui::TextUnformatted("All settings"sv);
407 ImGui::Separator();
408 std::vector<Setting*> settings;
409 for (auto* setting : settingsManager.getAllSettings()) {
410 if (dynamic_cast<ProxySetting*>(setting)) continue;
411 if (dynamic_cast<ReadOnlySetting*>(setting)) continue;
412 settings.push_back(checked_cast<Setting*>(setting));
413 }
415 for (auto* setting : settings) {
416 if (auto* bSetting = dynamic_cast<BooleanSetting*>(setting)) {
417 Checkbox(hotKey, *bSetting);
418 } else if (auto* iSetting = dynamic_cast<IntegerSetting*>(setting)) {
419 SliderInt(*iSetting);
420 } else if (auto* fSetting = dynamic_cast<FloatSetting*>(setting)) {
421 SliderFloat(*fSetting);
422 } else if (auto* sSetting = dynamic_cast<StringSetting*>(setting)) {
423 InputText(*sSetting);
424 } else if (auto* fnSetting = dynamic_cast<FilenameSetting*>(setting)) {
425 InputText(*fnSetting); // TODO
426 } else if (auto* kSetting = dynamic_cast<KeyCodeSetting*>(setting)) {
427 InputText(*kSetting); // TODO
428 } else if (dynamic_cast<EnumSettingBase*>(setting)) {
430 } else if (auto* vSetting = dynamic_cast<VideoSourceSetting*>(setting)) {
431 ComboBox(*vSetting);
432 } else {
433 assert(false);
434 }
435 }
436 });
437 });
438
439 const auto confirmTitle = "Confirm##settings";
440 if (openConfirmPopup) {
441 ImGui::OpenPopup(confirmTitle);
442 }
443 im::PopupModal(confirmTitle, nullptr, ImGuiWindowFlags_AlwaysAutoResize, [&]{
444 ImGui::TextUnformatted(confirmText);
445
446 bool close = false;
447 if (ImGui::Button("Ok")) {
448 confirmAction();
449 close = true;
450 }
451 ImGui::SameLine();
452 close |= ImGui::Button("Cancel");
453 if (close) {
454 ImGui::CloseCurrentPopup();
455 confirmAction = {};
456 }
457 });
458}
459
461
462// joystick is 0..3
463[[nodiscard]] static std::string settingName(unsigned joystick)
464{
465 return (joystick < 2) ? strCat("msxjoystick", joystick + 1, "_config")
466 : strCat("joymega", joystick - 1, "_config");
467}
468
469// joystick is 0..3
470[[nodiscard]] static std::string joystickToGuiString(unsigned joystick)
471{
472 return (joystick < 2) ? strCat("MSX joystick ", joystick + 1)
473 : strCat("JoyMega controller ", joystick - 1);
474}
475
476[[nodiscard]] static std::string toGuiString(const BooleanInput& input, const JoystickManager& joystickManager)
477{
478 return std::visit(overloaded{
479 [](const BooleanKeyboard& k) {
480 return strCat("keyboard key ", SDLKey::toString(k.getKeyCode()));
481 },
482 [](const BooleanMouseButton& m) {
483 return strCat("mouse button ", m.getButton());
484 },
485 [&](const BooleanJoystickButton& j) {
486 return strCat(joystickManager.getDisplayName(j.getJoystick()), " button ", j.getButton());
487 },
488 [&](const BooleanJoystickHat& h) {
489 return strCat(joystickManager.getDisplayName(h.getJoystick()), " D-pad ", h.getHat(), ' ', toString(h.getValue()));
490 },
491 [&](const BooleanJoystickAxis& a) {
492 return strCat(joystickManager.getDisplayName(a.getJoystick()),
493 " stick axis ", a.getAxis(), ", ",
494 (a.getDirection() == BooleanJoystickAxis::Direction::POS ? "positive" : "negative"), " direction");
495 }
496 }, input);
497}
498
499[[nodiscard]] static bool insideCircle(gl::vec2 mouse, gl::vec2 center, float radius)
500{
501 auto delta = center - mouse;
502 return gl::sum(delta * delta) <= (radius * radius);
503}
504[[nodiscard]] static bool between(float x, float min, float max)
505{
506 return (min <= x) && (x <= max);
507}
508
509struct Rectangle {
512};
513[[nodiscard]] static bool insideRectangle(gl::vec2 mouse, Rectangle r)
514{
515 return between(mouse.x, r.topLeft.x, r.bottomRight.x) &&
516 between(mouse.y, r.topLeft.y, r.bottomRight.y);
517}
518
519
520static constexpr auto fractionDPad = 1.0f / 3.0f;
521static constexpr auto thickness = 3.0f;
522
523static void drawDPad(gl::vec2 center, float size, std::span<const uint8_t, 4> hovered, int hoveredRow)
524{
525 const auto F = fractionDPad;
526 std::array<std::array<ImVec2, 5 + 1>, 4> points = {
527 std::array<ImVec2, 5 + 1>{ // UP
528 center + size * gl::vec2{ 0, 0},
529 center + size * gl::vec2{-F, -F},
530 center + size * gl::vec2{-F, -1},
531 center + size * gl::vec2{ F, -1},
532 center + size * gl::vec2{ F, -F},
533 center + size * gl::vec2{ 0, 0},
534 },
535 std::array<ImVec2, 5 + 1>{ // DOWN
536 center + size * gl::vec2{ 0, 0},
537 center + size * gl::vec2{ F, F},
538 center + size * gl::vec2{ F, 1},
539 center + size * gl::vec2{-F, 1},
540 center + size * gl::vec2{-F, F},
541 center + size * gl::vec2{ 0, 0},
542 },
543 std::array<ImVec2, 5 + 1>{ // LEFT
544 center + size * gl::vec2{ 0, 0},
545 center + size * gl::vec2{-F, F},
546 center + size * gl::vec2{-1, F},
547 center + size * gl::vec2{-1, -F},
548 center + size * gl::vec2{-F, -F},
549 center + size * gl::vec2{ 0, 0},
550 },
551 std::array<ImVec2, 5 + 1>{ // RIGHT
552 center + size * gl::vec2{ 0, 0},
553 center + size * gl::vec2{ F, -F},
554 center + size * gl::vec2{ 1, -F},
555 center + size * gl::vec2{ 1, F},
556 center + size * gl::vec2{ F, F},
557 center + size * gl::vec2{ 0, 0},
558 },
559 };
560
561 auto* drawList = ImGui::GetWindowDrawList();
562 auto hoverColor = ImGui::GetColorU32(ImGuiCol_ButtonHovered);
563
564 auto color = getColor(imColor::TEXT);
565 for (auto i : xrange(4)) {
566 if (hovered[i] || (hoveredRow == i)) {
567 drawList->AddConvexPolyFilled(points[i].data(), 5, hoverColor);
568 }
569 drawList->AddPolyline(points[i].data(), 5 + 1, color, 0, thickness);
570 }
571}
572
573static void drawFilledCircle(gl::vec2 center, float radius, bool fill)
574{
575 auto* drawList = ImGui::GetWindowDrawList();
576 if (fill) {
577 auto hoverColor = ImGui::GetColorU32(ImGuiCol_ButtonHovered);
578 drawList->AddCircleFilled(center, radius, hoverColor);
579 }
580 auto color = getColor(imColor::TEXT);
581 drawList->AddCircle(center, radius, color, 0, thickness);
582}
583static void drawFilledRectangle(Rectangle r, float corner, bool fill)
584{
585 auto* drawList = ImGui::GetWindowDrawList();
586 if (fill) {
587 auto hoverColor = ImGui::GetColorU32(ImGuiCol_ButtonHovered);
588 drawList->AddRectFilled(r.topLeft, r.bottomRight, hoverColor, corner);
589 }
590 auto color = getColor(imColor::TEXT);
591 drawList->AddRect(r.topLeft, r.bottomRight, color, corner, 0, thickness);
592}
593
594static void drawLetterA(gl::vec2 center)
595{
596 auto* drawList = ImGui::GetWindowDrawList();
597 auto tr = [&](gl::vec2 p) { return center + p; };
598 const std::array<ImVec2, 3> lines = { tr({-6, 7}), tr({0, -7}), tr({6, 7}) };
599 auto color = getColor(imColor::TEXT);
600 drawList->AddPolyline(lines.data(), lines.size(), color, 0, thickness);
601 drawList->AddLine(tr({-3, 1}), tr({3, 1}), color, thickness);
602}
603static void drawLetterB(gl::vec2 center)
604{
605 auto* drawList = ImGui::GetWindowDrawList();
606 auto tr = [&](gl::vec2 p) { return center + p; };
607 const std::array<ImVec2, 4> lines = { tr({1, -7}), tr({-4, -7}), tr({-4, 7}), tr({2, 7}) };
608 auto color = getColor(imColor::TEXT);
609 drawList->AddPolyline(lines.data(), lines.size(), color, 0, thickness);
610 drawList->AddLine(tr({-4, -1}), tr({2, -1}), color, thickness);
611 drawList->AddBezierQuadratic(tr({1, -7}), tr({4, -7}), tr({4, -4}), color, thickness);
612 drawList->AddBezierQuadratic(tr({4, -4}), tr({4, -1}), tr({1, -1}), color, thickness);
613 drawList->AddBezierQuadratic(tr({2, -1}), tr({6, -1}), tr({6, 3}), color, thickness);
614 drawList->AddBezierQuadratic(tr({6, 3}), tr({6, 7}), tr({2, 7}), color, thickness);
615}
616static void drawLetterC(gl::vec2 center)
617{
618 auto* drawList = ImGui::GetWindowDrawList();
619 auto tr = [&](gl::vec2 p) { return center + p; };
620 auto color = getColor(imColor::TEXT);
621 drawList->AddBezierCubic(tr({5, -5}), tr({-8, -16}), tr({-8, 16}), tr({5, 5}), color, thickness);
622}
623static void drawLetterX(gl::vec2 center)
624{
625 auto* drawList = ImGui::GetWindowDrawList();
626 auto tr = [&](gl::vec2 p) { return center + p; };
627 auto color = getColor(imColor::TEXT);
628 drawList->AddLine(tr({-4, -6}), tr({4, 6}), color, thickness);
629 drawList->AddLine(tr({-4, 6}), tr({4, -6}), color, thickness);
630}
631static void drawLetterY(gl::vec2 center)
632{
633 auto* drawList = ImGui::GetWindowDrawList();
634 auto tr = [&](gl::vec2 p) { return center + p; };
635 auto color = getColor(imColor::TEXT);
636 drawList->AddLine(tr({-4, -6}), tr({0, 0}), color, thickness);
637 drawList->AddLine(tr({-4, 6}), tr({4, -6}), color, thickness);
638}
639static void drawLetterZ(gl::vec2 center)
640{
641 auto* drawList = ImGui::GetWindowDrawList();
642 auto tr = [&](gl::vec2 p) { return center + p; };
643 const std::array<ImVec2, 4> linesZ2 = { tr({-4, -6}), tr({4, -6}), tr({-4, 6}), tr({4, 6}) };
644 auto color = getColor(imColor::TEXT);
645 drawList->AddPolyline(linesZ2.data(), 4, color, 0, thickness);
646}
647
648namespace msxjoystick {
649
651
652static constexpr std::array<zstring_view, NUM_BUTTONS> buttonNames = {
653 "Up", "Down", "Left", "Right", "A", "B" // show in the GUI
654};
655static constexpr std::array<zstring_view, NUM_BUTTONS> keyNames = {
656 "UP", "DOWN", "LEFT", "RIGHT", "A", "B" // keys in Tcl dict
657};
658
659// Customize joystick look
660static constexpr auto boundingBox = gl::vec2{300.0f, 100.0f};
661static constexpr auto radius = 20.0f;
662static constexpr auto corner = 10.0f;
663static constexpr auto centerA = gl::vec2{200.0f, 50.0f};
664static constexpr auto centerB = gl::vec2{260.0f, 50.0f};
665static constexpr auto centerDPad = gl::vec2{50.0f, 50.0f};
666static constexpr auto sizeDPad = 30.0f;
667
668[[nodiscard]] static std::vector<uint8_t> buttonsHovered(gl::vec2 mouse)
669{
670 std::vector<uint8_t> result(NUM_BUTTONS); // false
671 auto mouseDPad = (mouse - centerDPad) * (1.0f / sizeDPad);
672 if (insideRectangle(mouseDPad, Rectangle{{-1, -1}, {1, 1}}) &&
673 (between(mouseDPad.x, -fractionDPad, fractionDPad) ||
674 between(mouseDPad.y, -fractionDPad, fractionDPad))) { // mouse over d-pad
675 bool t1 = mouseDPad.x < mouseDPad.y;
676 bool t2 = mouseDPad.x < -mouseDPad.y;
677 result[UP] = !t1 && t2;
678 result[DOWN] = t1 && !t2;
679 result[LEFT] = t1 && t2;
680 result[RIGHT] = !t1 && !t2;
681 }
682 result[TRIG_A] = insideCircle(mouse, centerA, radius);
683 result[TRIG_B] = insideCircle(mouse, centerB, radius);
684 return result;
685}
686
687static void draw(gl::vec2 scrnPos, std::span<uint8_t> hovered, int hoveredRow)
688{
689 auto* drawList = ImGui::GetWindowDrawList();
690
691 auto color = getColor(imColor::TEXT);
692 drawList->AddRect(scrnPos, scrnPos + boundingBox, color, corner, 0, thickness);
693
694 drawDPad(scrnPos + centerDPad, sizeDPad, subspan<4>(hovered), hoveredRow);
695
696 auto scrnCenterA = scrnPos + centerA;
697 drawFilledCircle(scrnCenterA, radius, hovered[TRIG_A] || (hoveredRow == TRIG_A));
698 drawLetterA(scrnCenterA);
699
700 auto scrnCenterB = scrnPos + centerB;
701 drawFilledCircle(scrnCenterB, radius, hovered[TRIG_B] || (hoveredRow == TRIG_B));
702 drawLetterB(scrnCenterB);
703}
704
705} // namespace msxjoystick
706
707namespace joymega {
708
709enum {UP, DOWN, LEFT, RIGHT,
710 TRIG_A, TRIG_B, TRIG_C,
713 NUM_BUTTONS};
714
715static constexpr std::array<zstring_view, NUM_BUTTONS> buttonNames = { // show in the GUI
716 "Up", "Down", "Left", "Right",
717 "A", "B", "C",
718 "X", "Y", "Z",
719 "Select", "Start",
720};
721static constexpr std::array<zstring_view, NUM_BUTTONS> keyNames = { // keys in Tcl dict
722 "UP", "DOWN", "LEFT", "RIGHT",
723 "A", "B", "C",
724 "X", "Y", "Z",
725 "SELECT", "START",
726};
727
728// Customize joystick look
729static constexpr auto thickness = 3.0f;
730static constexpr auto boundingBox = gl::vec2{300.0f, 158.0f};
731static constexpr auto centerA = gl::vec2{205.0f, 109.9f};
732static constexpr auto centerB = gl::vec2{235.9f, 93.5f};
733static constexpr auto centerC = gl::vec2{269.7f, 83.9f};
734static constexpr auto centerX = gl::vec2{194.8f, 75.2f};
735static constexpr auto centerY = gl::vec2{223.0f, 61.3f};
736static constexpr auto centerZ = gl::vec2{252.2f, 52.9f};
737static constexpr auto selectBox = Rectangle{gl::vec2{130.0f, 60.0f}, gl::vec2{160.0f, 70.0f}};
738static constexpr auto startBox = Rectangle{gl::vec2{130.0f, 86.0f}, gl::vec2{160.0f, 96.0f}};
739static constexpr auto radiusABC = 16.2f;
740static constexpr auto radiusXYZ = 12.2f;
741static constexpr auto centerDPad = gl::vec2{65.6f, 82.7f};
742static constexpr auto sizeDPad = 34.0f;
743static constexpr auto fractionDPad = 1.0f / 3.0f;
744
745[[nodiscard]] static std::vector<uint8_t> buttonsHovered(gl::vec2 mouse)
746{
747 std::vector<uint8_t> result(NUM_BUTTONS); // false
748 auto mouseDPad = (mouse - centerDPad) * (1.0f / sizeDPad);
749 if (insideRectangle(mouseDPad, Rectangle{{-1, -1}, {1, 1}}) &&
750 (between(mouseDPad.x, -fractionDPad, fractionDPad) ||
751 between(mouseDPad.y, -fractionDPad, fractionDPad))) { // mouse over d-pad
752 bool t1 = mouseDPad.x < mouseDPad.y;
753 bool t2 = mouseDPad.x < -mouseDPad.y;
754 result[UP] = !t1 && t2;
755 result[DOWN] = t1 && !t2;
756 result[LEFT] = t1 && t2;
757 result[RIGHT] = !t1 && !t2;
758 }
759 result[TRIG_A] = insideCircle(mouse, centerA, radiusABC);
760 result[TRIG_B] = insideCircle(mouse, centerB, radiusABC);
761 result[TRIG_C] = insideCircle(mouse, centerC, radiusABC);
762 result[TRIG_X] = insideCircle(mouse, centerX, radiusXYZ);
763 result[TRIG_Y] = insideCircle(mouse, centerY, radiusXYZ);
764 result[TRIG_Z] = insideCircle(mouse, centerZ, radiusXYZ);
765 result[TRIG_START] = insideRectangle(mouse, startBox);
766 result[TRIG_SELECT] = insideRectangle(mouse, selectBox);
767 return result;
768}
769
770static void draw(gl::vec2 scrnPos, std::span<uint8_t> hovered, int hoveredRow)
771{
772 auto* drawList = ImGui::GetWindowDrawList();
773 auto tr = [&](gl::vec2 p) { return scrnPos + p; };
774 auto color = getColor(imColor::TEXT);
775
776 auto drawBezierCurve = [&](std::span<const gl::vec2> points, float thick = 1.0f) {
777 assert((points.size() % 2) == 0);
778 for (size_t i = 0; i < points.size() - 2; i += 2) {
779 auto ap = points[i + 0];
780 auto ad = points[i + 1];
781 auto bp = points[i + 2];
782 auto bd = points[i + 3];
783 drawList->AddBezierCubic(tr(ap), tr(ap + ad), tr(bp - bd), tr(bp), color, thick);
784 }
785 };
786
787 std::array outLine = {
788 gl::vec2{150.0f, 0.0f}, gl::vec2{ 23.1f, 0.0f},
789 gl::vec2{258.3f, 30.3f}, gl::vec2{ 36.3f, 26.4f},
790 gl::vec2{300.0f, 107.0f}, gl::vec2{ 0.0f, 13.2f},
791 gl::vec2{285.2f, 145.1f}, gl::vec2{ -9.9f, 9.9f},
792 gl::vec2{255.3f, 157.4f}, gl::vec2{ -9.0f, 0.0f},
793 gl::vec2{206.0f, 141.8f}, gl::vec2{-16.2f, -5.6f},
794 gl::vec2{150.0f, 131.9f}, gl::vec2{-16.5f, 0.0f},
795 gl::vec2{ 94.0f, 141.8f}, gl::vec2{-16.2f, 5.6f},
796 gl::vec2{ 44.7f, 157.4f}, gl::vec2{ -9.0f, 0.0f},
797 gl::vec2{ 14.8f, 145.1f}, gl::vec2{ -9.9f, -9.9f},
798 gl::vec2{ 0.0f, 107.0f}, gl::vec2{ 0.0f, -13.2f},
799 gl::vec2{ 41.7f, 30.3f}, gl::vec2{ 36.3f, -26.4f},
800 gl::vec2{150.0f, 0.0f}, gl::vec2{ 23.1f, 0.0f}, // closed loop
801 };
802 drawBezierCurve(outLine, thickness);
803
804 drawDPad(tr(centerDPad), sizeDPad, subspan<4>(hovered), hoveredRow);
805 drawList->AddCircle(tr(centerDPad), 43.0f, color);
806 std::array dPadCurve = {
807 gl::vec2{77.0f, 33.0f}, gl::vec2{ 69.2f, 0.0f},
808 gl::vec2{54.8f, 135.2f}, gl::vec2{-66.9f, 0.0f},
809 gl::vec2{77.0f, 33.0f}, gl::vec2{ 69.2f, 0.0f},
810 };
811 drawBezierCurve(dPadCurve);
812
813 drawFilledCircle(tr(centerA), radiusABC, hovered[TRIG_A] || (hoveredRow == TRIG_A));
814 drawLetterA(tr(centerA));
815 drawFilledCircle(tr(centerB), radiusABC, hovered[TRIG_B] || (hoveredRow == TRIG_B));
816 drawLetterB(tr(centerB));
817 drawFilledCircle(tr(centerC), radiusABC, hovered[TRIG_C] || (hoveredRow == TRIG_C));
818 drawLetterC(tr(centerC));
819 drawFilledCircle(tr(centerX), radiusXYZ, hovered[TRIG_X] || (hoveredRow == TRIG_X));
820 drawLetterX(tr(centerX));
821 drawFilledCircle(tr(centerY), radiusXYZ, hovered[TRIG_Y] || (hoveredRow == TRIG_Y));
822 drawLetterY(tr(centerY));
823 drawFilledCircle(tr(centerZ), radiusXYZ, hovered[TRIG_Z] || (hoveredRow == TRIG_Z));
824 drawLetterZ(tr(centerZ));
825 std::array buttonCurve = {
826 gl::vec2{221.1f, 28.9f}, gl::vec2{ 80.1f, 0.0f},
827 gl::vec2{236.9f, 139.5f}, gl::vec2{-76.8f, 0.0f},
828 gl::vec2{221.1f, 28.9f}, gl::vec2{ 80.1f, 0.0f},
829 };
830 drawBezierCurve(buttonCurve);
831
832 auto corner = (selectBox.bottomRight.y - selectBox.topLeft.y) * 0.5f;
833 auto trR = [&](Rectangle r) { return Rectangle{tr(r.topLeft), tr(r.bottomRight)}; };
834 drawFilledRectangle(trR(selectBox), corner, hovered[TRIG_SELECT] || (hoveredRow == TRIG_SELECT));
835 drawList->AddText(ImGui::GetFont(), ImGui::GetFontSize(), tr({123.0f, 46.0f}), color, "Select");
836 drawFilledRectangle(trR(startBox), corner, hovered[TRIG_START] || (hoveredRow == TRIG_START));
837 drawList->AddText(ImGui::GetFont(), ImGui::GetFontSize(), tr({128.0f, 97.0f}), color, "Start");
838}
839
840} // namespace joymega
841
842void ImGuiSettings::paintJoystick(MSXMotherBoard& motherBoard)
843{
844 ImGui::SetNextWindowSize(gl::vec2{316, 323}, ImGuiCond_FirstUseEver);
845 im::Window("Configure MSX joysticks", &showConfigureJoystick, [&]{
846 ImGui::SetNextItemWidth(13.0f * ImGui::GetFontSize());
847 im::Combo("Select joystick", joystickToGuiString(joystick).c_str(), [&]{
848 for (const auto& j : xrange(4)) {
849 if (ImGui::Selectable(joystickToGuiString(j).c_str())) {
850 joystick = j;
851 }
852 }
853 });
854
855 const auto& joystickManager = manager.getReactor().getInputEventGenerator().getJoystickManager();
856 const auto& controller = motherBoard.getMSXCommandController();
857 auto* setting = dynamic_cast<StringSetting*>(controller.findSetting(settingName(joystick)));
858 if (!setting) return;
859 auto& interp = setting->getInterpreter();
860 TclObject bindings = setting->getValue();
861
862 gl::vec2 scrnPos = ImGui::GetCursorScreenPos();
863 gl::vec2 mouse = gl::vec2(ImGui::GetIO().MousePos) - scrnPos;
864
865 // Check if buttons are hovered
866 bool msxOrMega = joystick < 2;
867 auto hovered = msxOrMega ? msxjoystick::buttonsHovered(mouse)
868 : joymega ::buttonsHovered(mouse);
869 const auto numButtons = hovered.size();
870 using SP = std::span<const zstring_view>;
871 auto keyNames = msxOrMega ? SP{msxjoystick::keyNames}
872 : SP{joymega ::keyNames};
873 auto buttonNames = msxOrMega ? SP{msxjoystick::buttonNames}
874 : SP{joymega ::buttonNames};
875
876 // Any joystick button clicked?
877 std::optional<int> addAction;
878 std::optional<int> removeAction;
879 if (ImGui::IsMouseReleased(ImGuiMouseButton_Left)) {
880 for (auto i : xrange(numButtons)) {
881 if (hovered[i]) addAction = narrow<int>(i);
882 }
883 }
884
885 ImGui::Dummy(msxOrMega ? msxjoystick::boundingBox : joymega::boundingBox); // reserve space for joystick drawing
886
887 // Draw table
888 int hoveredRow = -1;
889 const auto& style = ImGui::GetStyle();
890 auto textHeight = ImGui::GetTextLineHeight();
891 float rowHeight = 2.0f * style.FramePadding.y + textHeight;
892 float bottomHeight = style.ItemSpacing.y + 2.0f * style.FramePadding.y + textHeight;
893 im::Table("##joystick-table", 2, ImGuiTableFlags_SizingFixedFit | ImGuiTableFlags_ScrollX, {0.0f, -bottomHeight}, [&]{
894 im::ID_for_range(numButtons, [&](int i) {
895 TclObject key(keyNames[i]);
896 TclObject bindingList = bindings.getDictValue(interp, key);
897 if (ImGui::TableNextColumn()) {
898 auto pos = ImGui::GetCursorPos();
899 ImGui::Selectable("##row", hovered[i], ImGuiSelectableFlags_SpanAllColumns | ImGuiSelectableFlags_AllowOverlap, ImVec2(0, rowHeight));
900 if (ImGui::IsItemHovered()) {
901 hoveredRow = i;
902 }
903
904 ImGui::SetCursorPos(pos);
905 ImGui::AlignTextToFramePadding();
906 ImGui::TextUnformatted(buttonNames[i]);
907 }
908 if (ImGui::TableNextColumn()) {
909 if (ImGui::Button("Add")) {
910 addAction = i;
911 }
912 ImGui::SameLine();
913 auto numBindings = bindingList.size();
914 im::Disabled(numBindings == 0, [&]{
915 if (ImGui::Button("Remove")) {
916 if (numBindings == 1) {
917 bindings.setDictValue(interp, key, TclObject{});
918 setting->setValue(bindings);
919 } else {
920 removeAction = i;
921 }
922 }
923 });
924 ImGui::SameLine();
925 if (numBindings == 0) {
926 ImGui::TextDisabled("no bindings");
927 } else {
928 size_t lastBindingIndex = numBindings - 1;
929 size_t bindingIndex = 0;
930 for (auto binding: bindingList) {
931 ImGui::TextUnformatted(binding);
932 simpleToolTip(toGuiString(*parseBooleanInput(binding), joystickManager));
933 if (bindingIndex < lastBindingIndex) {
934 ImGui::SameLine();
936 ImGui::SameLine();
937 }
938 ++bindingIndex;
939 }
940 }
941 }
942 });
943 });
944 msxOrMega ? msxjoystick::draw(scrnPos, hovered, hoveredRow)
945 : joymega ::draw(scrnPos, hovered, hoveredRow);
946
947 if (ImGui::Button("Default bindings...")) {
948 ImGui::OpenPopup("bindings");
949 }
950 im::Popup("bindings", [&]{
951 auto addOrSet = [&](auto getBindings) {
952 if (ImGui::MenuItem("Add to current bindings")) {
953 // merge 'newBindings' into 'bindings'
954 auto newBindings = getBindings();
955 for (auto k : xrange(int(numButtons))) {
956 TclObject key(keyNames[k]);
957 TclObject dstList = bindings.getDictValue(interp, key);
958 TclObject srcList = newBindings.getDictValue(interp, key);
959 // This is O(N^2), but that's fine (here).
960 for (auto b : srcList) {
961 if (!contains(dstList, b)) {
962 dstList.addListElement(b);
963 }
964 }
965 bindings.setDictValue(interp, key, dstList);
966 }
967 setting->setValue(bindings);
968 }
969 if (ImGui::MenuItem("Replace current bindings")) {
970 setting->setValue(getBindings());
971 }
972 };
973 im::Menu("Keyboard", [&]{
974 addOrSet([] {
975 return TclObject(TclObject::MakeDictTag{},
976 "UP", makeTclList("keyb Up"),
977 "DOWN", makeTclList("keyb Down"),
978 "LEFT", makeTclList("keyb Left"),
979 "RIGHT", makeTclList("keyb Right"),
980 "A", makeTclList("keyb Space"),
981 "B", makeTclList("keyb M"));
982 });
983 });
984 for (auto joyId : joystickManager.getConnectedJoysticks()) {
985 im::Menu(joystickManager.getDisplayName(joyId).c_str(), [&]{
986 addOrSet([&]{
987 return msxOrMega
988 ? MSXJoystick::getDefaultConfig(joyId, joystickManager)
989 : JoyMega::getDefaultConfig(joyId, joystickManager);
990 });
991 });
992 }
993 });
994
995 // Popup for 'Add'
996 static constexpr auto addTitle = "Waiting for input";
997 if (addAction) {
998 popupForKey = *addAction;
999 popupTimeout = 5.0f;
1000 initListener();
1001 ImGui::OpenPopup(addTitle);
1002 }
1003 im::PopupModal(addTitle, nullptr, ImGuiWindowFlags_NoSavedSettings, [&]{
1004 auto close = [&]{
1005 ImGui::CloseCurrentPopup();
1006 popupForKey = unsigned(-1);
1007 deinitListener();
1008 };
1009 if (popupForKey >= numButtons) {
1010 close();
1011 return;
1012 }
1013
1014 ImGui::Text("Enter event for joystick button '%s'", buttonNames[popupForKey].c_str());
1015 ImGui::Text("Or press ESC to cancel. Timeout in %d seconds.", int(popupTimeout));
1016
1017 popupTimeout -= ImGui::GetIO().DeltaTime;
1018 if (popupTimeout <= 0.0f) {
1019 close();
1020 }
1021 });
1022
1023 // Popup for 'Remove'
1024 if (removeAction) {
1025 popupForKey = *removeAction;
1026 ImGui::OpenPopup("remove");
1027 }
1028 im::Popup("remove", [&]{
1029 auto close = [&]{
1030 ImGui::CloseCurrentPopup();
1031 popupForKey = unsigned(-1);
1032 };
1033 if (popupForKey >= numButtons) {
1034 close();
1035 return;
1036 }
1037 TclObject key(keyNames[popupForKey]);
1038 TclObject bindingList = bindings.getDictValue(interp, key);
1039
1040 unsigned remove = -1u;
1041 unsigned counter = 0;
1042 for (const auto& b : bindingList) {
1043 if (ImGui::Selectable(b.c_str())) {
1044 remove = counter;
1045 }
1046 simpleToolTip(toGuiString(*parseBooleanInput(b), joystickManager));
1047 ++counter;
1048 }
1049 if (remove != unsigned(-1)) {
1050 bindingList.removeListIndex(interp, remove);
1051 bindings.setDictValue(interp, key, bindingList);
1052 setting->setValue(bindings);
1053 close();
1054 }
1055
1056 if (ImGui::Selectable("all bindings")) {
1057 bindings.setDictValue(interp, key, TclObject{});
1058 setting->setValue(bindings);
1059 close();
1060 }
1061 });
1062 });
1063}
1064
1065void ImGuiSettings::paintFont()
1066{
1067 im::Window("Select font", &showFont, [&]{
1068 auto selectFilename = [&](FilenameSetting& setting, float width) {
1069 auto display = [](std::string_view name) {
1070 if (name.ends_with(".gz" )) name.remove_suffix(3);
1071 if (name.ends_with(".ttf")) name.remove_suffix(4);
1072 return std::string(name);
1073 };
1074 auto current = setting.getString();
1075 ImGui::SetNextItemWidth(width);
1076 im::Combo(tmpStrCat("##", setting.getBaseName()).c_str(), display(current).c_str(), [&]{
1077 for (const auto& font : getAvailableFonts()) {
1078 if (ImGui::Selectable(display(font).c_str(), current == font)) {
1079 setting.setString(font);
1080 }
1081 }
1082 });
1083 };
1084 auto selectSize = [](IntegerSetting& setting) {
1085 auto display = [](int s) { return strCat(s); };
1086 auto current = setting.getInt();
1087 ImGui::SetNextItemWidth(4.0f * ImGui::GetFontSize());
1088 im::Combo(tmpStrCat("##", setting.getBaseName()).c_str(), display(current).c_str(), [&]{
1089 for (int size : {9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 22, 24, 26, 28, 30, 32}) {
1090 if (ImGui::Selectable(display(size).c_str(), current == size)) {
1091 setting.setInt(size);
1092 }
1093 }
1094 });
1095 };
1096
1097 auto pos = ImGui::CalcTextSize("Monospace").x + 2.0f * ImGui::GetStyle().ItemSpacing.x;
1098 auto width = 12.0f * ImGui::GetFontSize(); // filename ComboBox (boxes are drawn with different font, but we want same width)
1099
1100 ImGui::AlignTextToFramePadding();
1101 ImGui::TextUnformatted("Normal");
1102 ImGui::SameLine(pos);
1103 selectFilename(manager.fontPropFilename, width);
1104 ImGui::SameLine();
1105 selectSize(manager.fontPropSize);
1106 HelpMarker("You can install more fonts by copying .ttf file(s) to your \"<openmsx>/share/skins\" directory.");
1107
1108 ImGui::AlignTextToFramePadding();
1109 ImGui::TextUnformatted("Monospace");
1110 ImGui::SameLine(pos);
1111 im::Font(manager.fontMono, [&]{
1112 selectFilename(manager.fontMonoFilename, width);
1113 });
1114 ImGui::SameLine();
1115 selectSize(manager.fontMonoSize);
1116 HelpMarker("Some GUI elements (e.g. the console) require a monospaced font.");
1117 });
1118}
1119
1120[[nodiscard]] static std::string formatShortcutWithAnnotations(const Shortcuts::Shortcut& shortcut)
1121{
1122 auto result = getKeyChordName(shortcut.keyChord);
1123 // don't show the 'ALWAYS_xxx' values
1124 if (shortcut.type == Shortcuts::Type::GLOBAL) result += ", global";
1125 return result;
1126}
1127
1128[[nodiscard]] static gl::vec2 buttonSize(std::string_view text, float defaultSize_)
1129{
1130 const auto& style = ImGui::GetStyle();
1131 auto textSize = ImGui::CalcTextSize(text).x + 2.0f * style.FramePadding.x;
1132 auto defaultSize = ImGui::GetFontSize() * defaultSize_;
1133 return {std::max(textSize, defaultSize), 0.0f};
1134}
1135
1136void ImGuiSettings::paintEditShortcut()
1137{
1138 using enum Shortcuts::Type;
1139
1140 bool editShortcutWindow = editShortcutId != Shortcuts::ID::INVALID;
1141 if (!editShortcutWindow) return;
1142
1143 im::Window("Edit shortcut", &editShortcutWindow, ImGuiWindowFlags_AlwaysAutoResize, [&]{
1144 auto& shortcuts = manager.getShortcuts();
1145 auto shortcut = shortcuts.getShortcut(editShortcutId);
1146
1147 im::Table("table", 2, [&]{
1148 ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthFixed);
1149 ImGui::TableSetupColumn("", ImGuiTableColumnFlags_WidthStretch);
1150
1151 if (ImGui::TableNextColumn()) {
1152 ImGui::AlignTextToFramePadding();
1154 }
1155 static constexpr auto waitKeyTitle = "Waiting for key";
1156 if (ImGui::TableNextColumn()) {
1157 auto text = getKeyChordName(shortcut.keyChord);
1158 if (ImGui::Button(text.c_str(), buttonSize(text, 4.0f))) {
1159 popupTimeout = 10.0f;
1161 ImGui::OpenPopup(waitKeyTitle);
1162 }
1163 }
1164 bool isOpen = true;
1165 im::PopupModal(waitKeyTitle, &isOpen, ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_AlwaysAutoResize, [&]{
1166 ImGui::Text("Enter key combination for shortcut '%s'",
1167 Shortcuts::getShortcutDescription(editShortcutId).c_str());
1168 ImGui::Text("Timeout in %d seconds.", int(popupTimeout));
1169
1170 popupTimeout -= ImGui::GetIO().DeltaTime;
1171 if (!isOpen || popupTimeout <= 0.0f) {
1172 ImGui::CloseCurrentPopup();
1173 }
1174 if (auto keyChord = getCurrentlyPressedKeyChord(); keyChord != ImGuiKey_None) {
1175 shortcut.keyChord = keyChord;
1176 shortcuts.setShortcut(editShortcutId, shortcut);
1177 editShortcutWindow = false;
1178 ImGui::CloseCurrentPopup();
1179 }
1180 });
1181
1182 if (shortcut.type == one_of(LOCAL, GLOBAL)) { // don't edit the 'ALWAYS_xxx' values
1183 if (ImGui::TableNextColumn()) {
1184 ImGui::AlignTextToFramePadding();
1185 ImGui::TextUnformatted("global");
1186 }
1187 if (ImGui::TableNextColumn()) {
1188 bool global = shortcut.type == GLOBAL;
1189 if (ImGui::Checkbox("##global", &global)) {
1190 shortcut.type = global ? GLOBAL : LOCAL;
1191 shortcuts.setShortcut(editShortcutId, shortcut);
1192 }
1194 "Global shortcuts react when any GUI window has focus.\n"
1195 "Local shortcuts only react when the specific GUI window has focus.\n"sv);
1196 }
1197 }
1198 });
1199 ImGui::Separator();
1200 const auto& defaultShortcut = Shortcuts::getDefaultShortcut(editShortcutId);
1201 im::Disabled(shortcut == defaultShortcut, [&]{
1202 if (ImGui::Button("Restore default")) {
1203 shortcuts.setShortcut(editShortcutId, defaultShortcut);
1204 editShortcutWindow = false;
1205 }
1206 simpleToolTip([&]{ return formatShortcutWithAnnotations(defaultShortcut); });
1207 });
1208
1209 ImGui::SameLine();
1210 im::Disabled(shortcut == Shortcuts::Shortcut{}, [&]{
1211 if (ImGui::Button("Set None")) {
1212 shortcuts.setShortcut(editShortcutId, Shortcuts::Shortcut{});
1213 editShortcutWindow = false;
1214 }
1215 simpleToolTip("Set no binding for this shortcut"sv);
1216 });
1217 });
1218 if (!editShortcutWindow) editShortcutId = Shortcuts::ID::INVALID;
1219}
1220
1221void ImGuiSettings::paintShortcut()
1222{
1223 im::Window("Edit shortcuts", &showShortcut, [&]{
1224 int flags = ImGuiTableFlags_Resizable
1225 | ImGuiTableFlags_RowBg
1226 | ImGuiTableFlags_NoBordersInBodyUntilResize
1227 | ImGuiTableFlags_SizingStretchProp;
1228 im::Table("table", 2, flags, {-FLT_MIN, 0.0f}, [&]{
1229 ImGui::TableSetupColumn("description");
1230 ImGui::TableSetupColumn("key");
1231
1232 const auto& shortcuts = manager.getShortcuts();
1233 im::ID_for_range(to_underlying(Shortcuts::ID::NUM), [&](int i) {
1234 auto id = static_cast<Shortcuts::ID>(i);
1235 auto shortcut = shortcuts.getShortcut(id);
1236
1237 if (ImGui::TableNextColumn()) {
1238 ImGui::AlignTextToFramePadding();
1239 ImGui::TextUnformatted(Shortcuts::getShortcutDescription(id));
1240 }
1241 if (ImGui::TableNextColumn()) {
1242 auto text = formatShortcutWithAnnotations(shortcut);
1243 if (ImGui::Button(text.c_str(), buttonSize(text, 9.0f))) {
1244 editShortcutId = id;
1246 }
1247 }
1248 });
1249 });
1250 });
1251 paintEditShortcut();
1252}
1253
1254void ImGuiSettings::paint(MSXMotherBoard* motherBoard)
1255{
1256 if (selectedStyle < 0) {
1257 // triggers when loading "imgui.ini" did not select a style
1258 selectedStyle = 0; // dark (also the default (recommended) Dear ImGui style)
1259 setStyle();
1260 }
1261 if (motherBoard && showConfigureJoystick) paintJoystick(*motherBoard);
1262 if (showFont) paintFont();
1263 if (showShortcut) paintShortcut();
1264}
1265
1266std::span<const std::string> ImGuiSettings::getAvailableFonts()
1267{
1268 if (availableFonts.empty()) {
1269 for (const auto& context = systemFileContext();
1270 const auto& path : context.getPaths()) {
1271 foreach_file(FileOperations::join(path, "skins"), [&](const std::string& /*fullName*/, std::string_view name) {
1272 if (name.ends_with(".ttf.gz") || name.ends_with(".ttf")) {
1273 availableFonts.emplace_back(name);
1274 }
1275 });
1276 }
1277 // sort and remove duplicates
1278 ranges::sort(availableFonts);
1279 availableFonts.erase(ranges::unique(availableFonts), end(availableFonts));
1280 }
1281 return availableFonts;
1282}
1283
1284bool ImGuiSettings::signalEvent(const Event& event)
1285{
1286 bool msxOrMega = joystick < 2;
1287 using SP = std::span<const zstring_view>;
1288 auto keyNames = msxOrMega ? SP{msxjoystick::keyNames}
1289 : SP{joymega ::keyNames};
1290 if (const auto numButtons = keyNames.size(); popupForKey >= numButtons) {
1291 deinitListener();
1292 return false; // don't block
1293 }
1294
1295 bool escape = false;
1296 if (const auto* keyDown = get_event_if<KeyDownEvent>(event)) {
1297 escape = keyDown->getKeyCode() == SDLK_ESCAPE;
1298 }
1299 if (!escape) {
1300 auto getJoyDeadZone = [&](JoystickId joyId) {
1301 const auto& joyMan = manager.getReactor().getInputEventGenerator().getJoystickManager();
1302 const auto* setting = joyMan.getJoyDeadZoneSetting(joyId);
1303 return setting ? setting->getInt() : 0;
1304 };
1305 auto b = captureBooleanInput(event, getJoyDeadZone);
1306 if (!b) return true; // keep popup active
1307 auto bs = toString(*b);
1308
1309 auto* motherBoard = manager.getReactor().getMotherBoard();
1310 if (!motherBoard) return true;
1311 const auto& controller = motherBoard->getMSXCommandController();
1312 auto* setting = dynamic_cast<StringSetting*>(controller.findSetting(settingName(joystick)));
1313 if (!setting) return true;
1314 auto& interp = setting->getInterpreter();
1315
1316 TclObject bindings = setting->getValue();
1317 TclObject key(keyNames[popupForKey]);
1318 TclObject bindingList = bindings.getDictValue(interp, key);
1319
1320 if (!contains(bindingList, bs)) {
1321 bindingList.addListElement(bs);
1322 bindings.setDictValue(interp, key, bindingList);
1323 setting->setValue(bindings);
1324 }
1325 }
1326
1327 popupForKey = unsigned(-1); // close popup
1328 return true; // block event
1329}
1330
1331void ImGuiSettings::initListener()
1332{
1333 if (listening) return;
1334 listening = true;
1335
1336 auto& distributor = manager.getReactor().getEventDistributor();
1337 // highest priority (higher than HOTKEY and IMGUI)
1338 using enum EventType;
1339 for (auto type : {KEY_DOWN, MOUSE_BUTTON_DOWN,
1341 distributor.registerEventListener(type, *this);
1342 }
1343}
1344
1345void ImGuiSettings::deinitListener()
1346{
1347 if (!listening) return;
1348 listening = false;
1349
1350 auto& distributor = manager.getReactor().getEventDistributor();
1351 using enum EventType;
1352 for (auto type : {JOY_AXIS_MOTION, JOY_HAT, JOY_BUTTON_DOWN,
1354 distributor.unregisterEventListener(type, *this);
1355 }
1356}
1357
1358} // namespace openmsx
BaseSetting * setting
uintptr_t id
const char * c_str() const
std::string_view getBaseName() const
Definition Setting.hh:38
A Setting with a floating point value.
std::unique_ptr< ImGuiSoundChip > soundChip
std::unique_ptr< ImGuiMessages > messages
std::unique_ptr< ImGuiOsdIcons > osdIcons
ImGuiManager & manager
Definition ImGuiPart.hh:30
void save(ImGuiTextBuffer &buf) override
void showMenu(MSXMotherBoard *motherBoard) override
void loadLine(std::string_view name, zstring_view value) override
void loadEnd() override
A Setting with an integer value.
auto * getR800()
Definition MSXCPU.hh:152
auto * getZ80()
Definition MSXCPU.hh:151
VideoSourceSetting & getVideoSource()
MSXCommandController & getMSXCommandController()
GlobalSettings & getGlobalSettings()
Definition Reactor.hh:117
ScaleAlgorithm
Scaler algorithm.
Like std::string_view, but with the extra guarantee that it refers to a zero-terminated string.
auto CalcTextSize(std::string_view str)
Definition ImGuiUtils.hh:39
void TextUnformatted(const std::string &str)
Definition ImGuiUtils.hh:26
vecN< 2, float > vec2
Definition gl_vec.hh:382
constexpr T sum(const vecN< N, T > &x)
Definition gl_vec.hh:472
constexpr vecN< N, T > max(const vecN< N, T > &x, const vecN< N, T > &y)
Definition gl_vec.hh:449
void Table(const char *str_id, int column, ImGuiTableFlags flags, const ImVec2 &outer_size, float inner_width, std::invocable<> auto next)
Definition ImGuiCpp.hh:455
void Window(const char *name, bool *p_open, ImGuiWindowFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:63
void PopupContextItem(const char *str_id, ImGuiPopupFlags popup_flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:421
bool TreeNode(const char *label, ImGuiTreeNodeFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:302
void Combo(const char *label, const char *preview_value, ImGuiComboFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:289
void ListBox(const char *label, const ImVec2 &size, std::invocable<> auto next)
Definition ImGuiCpp.hh:328
void PopupModal(const char *name, bool *p_open, ImGuiWindowFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:404
bool Menu(const char *label, bool enabled, std::invocable<> auto next)
Definition ImGuiCpp.hh:359
void Disabled(bool b, std::invocable<> auto next)
Definition ImGuiCpp.hh:506
void Font(ImFont *font, std::invocable<> auto next)
Definition ImGuiCpp.hh:131
void Indent(float indent_w, std::invocable<> auto next)
Definition ImGuiCpp.hh:224
void Popup(const char *str_id, ImGuiWindowFlags flags, std::invocable<> auto next)
Definition ImGuiCpp.hh:391
void ID_for_range(std::integral auto count, std::invocable< int > auto next)
Definition ImGuiCpp.hh:281
string_view stripExtension(string_view path)
Returns the path without extension.
string_view getFilename(string_view path)
Returns the file portion of a path name.
int unlink(zstring_view path)
Call unlink() in a platform-independent manner.
This file implemented 3 utility functions:
Definition Autofire.cc:11
const FileContext & systemFileContext()
std::optional< BooleanInput > captureBooleanInput(const Event &event, function_ref< int(JoystickId)> getJoyDeadZone)
EventType
Definition Event.hh:454
bool Checkbox(const HotKey &hotKey, BooleanSetting &setting)
Definition ImGuiUtils.cc:58
bool SliderFloat(FloatSetting &setting, const char *format, ImGuiSliderFlags flags)
void centerNextWindowOverCurrent()
bool SliderInt(IntegerSetting &setting, ImGuiSliderFlags flags)
Definition ImGuiUtils.cc:83
void ComboBox(const char *label, Setting &setting, function_ref< std::string(const std::string &)> displayValue, EnumToolTips toolTips)
bool loadOnePersistent(std::string_view name, zstring_view value, C &c, const std::tuple< Elements... > &tup)
void simpleToolTip(std::string_view desc)
Definition ImGuiUtils.hh:79
void savePersistent(ImGuiTextBuffer &buf, C &c, const std::tuple< Elements... > &tup)
std::string getShortCutForCommand(const HotKey &hotkey, std::string_view command)
void HelpMarker(std::string_view desc)
Definition ImGuiUtils.cc:23
std::optional< BooleanInput > parseBooleanInput(std::string_view text)
bool InputText(Setting &setting)
ImU32 getColor(imColor col)
void setColors(int style)
std::string getKeyChordName(ImGuiKeyChord keyChord)
std::string toString(const BooleanInput &input)
bool foreach_file(std::string path, FileAction fileAction)
TclObject makeTclList(Args &&... args)
Definition TclObject.hh:293
FileContext userDataFileContext(string_view subDir)
auto unique(ForwardRange &&range)
Definition ranges.hh:224
auto remove(ForwardRange &&range, const T &value)
Definition ranges.hh:291
auto find(InputRange &&range, const T &value)
Definition ranges.hh:162
constexpr void replace(ForwardRange &&range, const T &old_value, const T &new_value)
Definition ranges.hh:303
constexpr void sort(RandomAccessRange &&range)
Definition ranges.hh:51
size_t size(std::string_view utf8)
constexpr auto to_underlying(E e) noexcept
Definition stl.hh:468
constexpr bool contains(ITER first, ITER last, const VAL &val)
Check if a range contains a given value, using linear search.
Definition stl.hh:35
std::string strCat()
Definition strCat.hh:703
TemporaryString tmpStrCat(Ts &&... ts)
Definition strCat.hh:742
constexpr auto xrange(T e)
Definition xrange.hh:132
constexpr auto end(const zstring_view &x)